Add mappedTrim. Use mappedTrim for ojs, mermaid, and dot. Closes #1648. Closes #1452.

Author: cscheid

src/core/handlers/base.ts

@@ -21,6 +21,7 @@ import {
   mappedConcat,
   mappedLines,
   MappedString,
+  mappedTrim,
 } from "../lib/mapped-text.ts";
 import {
   addLanguageComment,
@@ -585,7 +586,7 @@ export const baseHandler: LanguageHandler = {
           classes: cellInputClasses,
           attrs: cellInputAttrs,
         });
-        cellInput.push(pandocRawStr(mappedConcat(inputLines)));
+        cellInput.push(pandocRawStr(mappedTrim(mappedConcat(inputLines))));
         cellBlock.push(cellInput);
         break;
       }
@@ -602,7 +603,7 @@ export const baseHandler: LanguageHandler = {
           ...frontMatterLines,
           ...inputLines,
         ]);
-        cellFence.push(pandocRawStr(fencedInput));
+        cellFence.push(pandocRawStr(mappedTrim(fencedInput)));
         cellInput.push(cellFence);
         cellBlock.push(cellInput);
         break;

src/core/lib/mapped-text.ts

@@ -392,3 +392,56 @@ export function breakOnDelimiter(
   }
   return substrings;
 }
+
+function findSpaceStart(string: MappedString): number {
+  const result = string.value.match(/^\s+/);
+  if (result === null || result.length === 0) {
+    return 0;
+  }
+  return result[0].length;
+}
+
+function findSpaceEnd(string: MappedString): number {
+  const result = string.value.match(/\s+$/);
+  if (result === null || result.length === 0) {
+    return 0;
+  }
+  return result[0].length;
+}
+
+/**
+ * mappedTrim(): MappedString version of String.trim()
+ */
+export function mappedTrim(string: MappedString): MappedString {
+  const start = findSpaceStart(string);
+  const end = findSpaceEnd(string);
+  if (start === 0 && end === 0) {
+    return string;
+  }
+  if (start > string.value.length - end) {
+    return mappedSubstring(string, 0, 0);
+  }
+  return mappedSubstring(string, start, string.value.length - end);
+}
+
+/**
+ * mappedTrimStart(): MappedString version of String.trimStart()
+ */
+export function mappedTrimStart(string: MappedString): MappedString {
+  const start = findSpaceStart(string);
+  if (start === 0) {
+    return string;
+  }
+  return mappedSubstring(string, start, string.value.length);
+}
+
+/**
+ * mappedTrimEnd(): MappedString version of String.trimEnd()
+ */
+export function mappedTrimEnd(string: MappedString): MappedString {
+  const end = findSpaceEnd(string);
+  if (end === 0) {
+    return string;
+  }
+  return mappedSubstring(string, 0, string.value.length - end);
+}

src/execute/ojs/compile.ts

@@ -76,6 +76,7 @@ import {
 import {
   EitherString,
   join as mappedJoin,
+  mappedTrim,
 } from "../../core/lib/mapped-text.ts";
 import { getDivAttributes } from "../../core/handlers/base.ts";
 import { pathWithForwardSlashes } from "../../core/path.ts";
@@ -276,7 +277,7 @@ export async function ojsCompile(
             `source-offset="${cell.sourceOffset}"`,
           ],
         });
-        preDiv.push(pandocRawStr(cell.sourceVerbatim.value));
+        preDiv.push(pandocRawStr(cell.sourceVerbatim.value.trim()));
         div.push(preDiv);
         const errMsgDiv = pandocDiv({
           classes: ["cell-output", "cell-output-error"],
@@ -499,7 +500,7 @@ export async function ojsCompile(
           classes: ourClasses,
           attrs: ourAttrs,
         });
-        srcDiv.push(pandocRawStr(cell.sourceVerbatim.value));
+        srcDiv.push(pandocRawStr(cell.sourceVerbatim.value.trim()));
         div.push(srcDiv);
       }
 
@@ -557,7 +558,7 @@ export async function ojsCompile(
               cellSrcStr.value.substring(
                 innerInfo[0].start,
                 innerInfo[innerInfo.length - 1].end,
-              ),
+              ).trim(),
             ));
             div.push(srcDiv);
           }
@@ -629,7 +630,7 @@ export async function ojsCompile(
               classes: srcConfig.classes,
             });
             srcDiv.push(
-              pandocRawStr(cellSrcStr),
+              pandocRawStr(mappedTrim(cellSrcStr)),
             );
             div.push(srcDiv);
           }

src/resources/formats/html/ojs/quarto-ojs-runtime.js

@@ -1,4 +1,4 @@
-// @quarto/quarto-ojs-runtime v0.0.10 Copyright 2022 undefined
+// @quarto/quarto-ojs-runtime v0.0.11 Copyright 2022 undefined
 var EOL = {},
     EOF = {},
     QUOTE = 34,
@@ -1668,7 +1668,9 @@ class PandocCodeDecorator {
     const startIndex = startEntry.index;
     const endIndex = endEntry && endEntry.index || this._elementEntryPoints.length;
     for (let i = startIndex; i < endIndex; ++i) {
-      yield this._elementEntryPoints[i];
+      if (this._elementEntryPoints[i] !== void 0) {
+        yield this._elementEntryPoints[i];
+      }
     }
   }
   decorateSpan(start, end, classes) {
@@ -1705,11 +1707,11 @@ class PandocCodeDecorator {
       this._elementEntryPoints.sort((a, b) => a.offset - b.offset);
     };
     const startEntry = this.locateEntry(start);
-    if (startEntry !== void 0 && startEntry.entry.offset != start) {
+    if (startEntry !== void 0 && startEntry.entry !== void 0 && startEntry.entry.offset != start) {
       splitEntry(startEntry.entry, start);
     }
     const endEntry = this.locateEntry(end);
-    if (endEntry !== void 0 && endEntry.entry.offset !== end) {
+    if (endEntry !== void 0 && startEntry.entry !== void 0 && endEntry.entry.offset !== end) {
       splitEntry(endEntry.entry, end);
     }
   }

tests/unit/mapped-strings/mapped-text.test.ts

@@ -5,13 +5,18 @@
 *
 */
 import { unitTest } from "../../test.ts";
-import { assert } from "testing/asserts.ts";
+import { assert, assertEquals } from "testing/asserts.ts";
 import {
   asMappedString,
   mappedDiff,
   mappedString,
 } from "../../../src/core/mapped-text.ts";
-import { mappedSubstring } from "../../../src/core/lib/mapped-text.ts";
+import {
+  mappedSubstring,
+  mappedTrim,
+  mappedTrimEnd,
+  mappedTrimStart,
+} from "../../../src/core/lib/mapped-text.ts";
 
 // deno-lint-ignore require-await
 unitTest("mapped-text - mappedString()", async () => {
@@ -188,3 +193,28 @@ viewof x = Inputs.range([0, 100], label = "hello!", value = 20)
 
   mappedDiff(asMappedString(text1), text2);
 });
+
+// deno-lint-ignore require-await
+unitTest("mapped-text - mappedTrim{,Start,End}()", async () => {
+  const whitespace = "\u000A\u000D\u2028\u2029\u0009\u000B\u000C\uFEFF \t";
+  const content = "a \n";
+  for (let i = 0; i < 1000; ++i) {
+    const startTrimLength = Math.random() * 10;
+    const endTrimLength = Math.random() * 10;
+    const contentLength = Math.random() * 10;
+    const strContent = [];
+    for (let j = 0; j < startTrimLength; ++j) {
+      strContent.push(whitespace[~~(Math.random() * whitespace.length)]);
+    }
+    for (let j = 0; j < contentLength; ++j) {
+      strContent.push(content[~~(Math.random() * content.length)]);
+    }
+    for (let j = 0; j < endTrimLength; ++j) {
+      strContent.push(whitespace[~~(Math.random() * whitespace.length)]);
+    }
+    const mappedStr = asMappedString(strContent.join(""));
+    assertEquals(mappedTrim(mappedStr).value, mappedStr.value.trim());
+    assertEquals(mappedTrimStart(mappedStr).value, mappedStr.value.trimStart());
+    assertEquals(mappedTrimEnd(mappedStr).value, mappedStr.value.trimEnd());
+  }
+});