Tests for editor utils (#5129)

Author: wldcordeiro

src/utils/editor/getTokenLocation.js src/utils/editor/get-token-location.jssrc/utils/editor/getTokenLocation.js renamed to src/utils/editor/get-token-location.js

@@ -5,7 +5,7 @@
 // @flow
 
 export * from "./source-documents";
-export * from "./getTokenLocation.js";
+export * from "./get-token-location";
 export * from "./source-search";
 export * from "../ui";
 export * from "./create-editor";
@@ -51,9 +51,10 @@ export function traverseResults(e, ctx, query, dir, modifiers) {
   }
 }
 
-export function toEditorLine(sourceId: string, lineOrOffset: number): ?number {
+export function toEditorLine(sourceId: string, lineOrOffset: number): number {
   if (isWasm(sourceId)) {
-    return wasmOffsetToLine(sourceId, lineOrOffset);
+    // TODO ensure offset is always "mappable" to edit line.
+    return wasmOffsetToLine(sourceId, lineOrOffset) || 0;
   }
 
   return lineOrOffset ? lineOrOffset - 1 : 1;
@@ -104,9 +105,7 @@ export function toSourceLocation(
   };
 }
 
-export function markText(editor: any, className, location: EditorRange) {
-  const { start, end } = location;
-
+export function markText(editor: any, className, { start, end }: EditorRange) {
   return editor.codeMirror.markText(
     { ch: start.column, line: start.line },
     { ch: end.column, line: end.line },

src/utils/editor/index.js

@@ -104,7 +104,11 @@ function updateCursor(cm, state, keepSelection) {
   }
 }
 
-function getMatchIndex(count: number, currentIndex: number, rev: boolean) {
+export function getMatchIndex(
+  count: number,
+  currentIndex: number,
+  rev: boolean
+) {
   if (!rev) {
     if (currentIndex == count - 1) {
       return 0;
@@ -210,7 +214,11 @@ function searchNext(ctx, rev, query, newQuery, modifiers) {
  * @memberof utils/source-search
  * @static
  */
-function removeOverlay(ctx: any, query: string, modifiers: SearchModifiers) {
+export function removeOverlay(
+  ctx: any,
+  query: string,
+  modifiers: SearchModifiers
+) {
   const state = getSearchState(ctx.cm, query, modifiers);
   ctx.cm.removeOverlay(state.overlay);
   const { line, ch } = ctx.cm.getCursor();
@@ -241,7 +249,7 @@ function clearSearch(cm, query: string, modifiers: SearchModifiers) {
  * @memberof utils/source-search
  * @static
  */
-function find(
+export function find(
   ctx: any,
   query: string,
   keepSelection: boolean,
@@ -257,7 +265,7 @@ function find(
  * @memberof utils/source-search
  * @static
  */
-function findNext(
+export function findNext(
   ctx: any,
   query: string,
   keepSelection: boolean,
@@ -272,7 +280,7 @@ function findNext(
  * @memberof utils/source-search
  * @static
  */
-function findPrev(
+export function findPrev(
   ctx: any,
   query: string,
   keepSelection: boolean,
@@ -281,4 +289,4 @@ function findPrev(
   return doSearch(ctx, true, query, keepSelection, modifiers);
 }
 
-export { buildQuery, find, findNext, findPrev, removeOverlay, getMatchIndex };
+export { buildQuery };

src/utils/editor/source-search.js

@@ -0,0 +1,54 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`createEditor Adds codeFolding 1`] = `
+Object {
+  "enableCodeFolding": true,
+  "extraKeys": Object {
+    "Cmd-F": false,
+    "Cmd-G": false,
+    "Esc": false,
+  },
+  "foldGutter": true,
+  "gutters": Array [
+    "breakpoints",
+    "hit-markers",
+    "CodeMirror-linenumbers",
+    "CodeMirror-foldgutter",
+  ],
+  "lineNumbers": true,
+  "lineWrapping": false,
+  "matchBrackets": true,
+  "mode": "javascript",
+  "readOnly": true,
+  "showAnnotationRuler": true,
+  "styleActiveLine": false,
+  "theme": "mozilla",
+  "value": " ",
+}
+`;
+
+exports[`createEditor Returns a SourceEditor 1`] = `
+Object {
+  "enableCodeFolding": false,
+  "extraKeys": Object {
+    "Cmd-F": false,
+    "Cmd-G": false,
+    "Esc": false,
+  },
+  "foldGutter": false,
+  "gutters": Array [
+    "breakpoints",
+    "hit-markers",
+    "CodeMirror-linenumbers",
+  ],
+  "lineNumbers": true,
+  "lineWrapping": false,
+  "matchBrackets": true,
+  "mode": "javascript",
+  "readOnly": true,
+  "showAnnotationRuler": true,
+  "styleActiveLine": false,
+  "theme": "mozilla",
+  "value": " ",
+}
+`;

src/utils/editor/tests/__snapshots__/create-editor.spec.js.snap

@@ -0,0 +1,21 @@
+import { createEditor } from "../create-editor";
+import SourceEditor from "../source-editor";
+
+import { features } from "../../prefs";
+
+describe("createEditor", () => {
+  test("Returns a SourceEditor", () => {
+    const editor = createEditor();
+    expect(editor).toBeInstanceOf(SourceEditor);
+    expect(editor.opts).toMatchSnapshot();
+    expect(editor.opts.gutters).not.toContain("CodeMirror-foldgutter");
+  });
+
+  test("Adds codeFolding", () => {
+    features.codeFolding = true;
+    const editor = createEditor();
+    expect(editor).toBeInstanceOf(SourceEditor);
+    expect(editor.opts).toMatchSnapshot();
+    expect(editor.opts.gutters).toContain("CodeMirror-foldgutter");
+  });
+});