Refactor findClosestScope -> findClosestFunction (#5789)

Author: iocalebs

src/components/Editor/EditorMenu.js

@@ -9,7 +9,7 @@ import { isOriginalId } from "devtools-source-map";
 
 import { copyToTheClipboard } from "../../utils/clipboard";
 import { findFunctionText } from "../../utils/function";
-import { findClosestScope } from "../../utils/breakpoint/astBreakpointLocation";
+import { findClosestFunction } from "../../utils/ast";
 import {
   getSourceLocationFromMouseEvent,
   toSourceLine
@@ -248,10 +248,10 @@ export default connect(
         findFunctionText(
           line,
           selectedSource.toJS(),
-          getSymbols(state, selectedSource.toJS())
+          getSymbols(state, selectedSource)
         ),
       getFunctionLocation: line =>
-        findClosestScope(getSymbols(state, selectedSource.toJS()).functions, {
+        findClosestFunction(getSymbols(state, selectedSource).functions, {
           line,
           column: Infinity
         })

src/utils/ast.js

@@ -6,8 +6,14 @@
 
 import { without, range } from "lodash";
 
-import type { Source, Position } from "../types";
-import type { PausePoint, SymbolDeclarations } from "../workers/parser";
+import type { Location, Source, Position } from "../types";
+import type {
+  AstPosition,
+  AstLocation,
+  PausePoint,
+  SymbolDeclarations,
+  SymbolDeclaration
+} from "../workers/parser";
 
 export function findBestMatchExpression(
   symbols: SymbolDeclarations,
@@ -48,3 +54,46 @@ export function findEmptyLines(
   const sourceLines = range(1, lineCount + 1);
   return without(sourceLines, ...breakpointLines);
 }
+
+export function containsPosition(a: AstLocation, b: AstPosition) {
+  const startsBefore =
+    a.start.line < b.line ||
+    (a.start.line === b.line && a.start.column <= b.column);
+  const endsAfter =
+    a.end.line > b.line || (a.end.line === b.line && a.end.column >= b.column);
+
+  return startsBefore && endsAfter;
+}
+
+export function findClosestFunction(
+  functions: SymbolDeclaration[],
+  location: Location
+) {
+  return functions.reduce((found, currNode) => {
+    if (
+      currNode.name === "anonymous" ||
+      !containsPosition(currNode.location, {
+        line: location.line,
+        column: location.column || 0
+      })
+    ) {
+      return found;
+    }
+
+    if (!found) {
+      return currNode;
+    }
+
+    if (found.location.start.line > currNode.location.start.line) {
+      return found;
+    }
+    if (
+      found.location.start.line === currNode.location.start.line &&
+      found.location.start.column > currNode.location.start.column
+    ) {
+      return found;
+    }
+
+    return currNode;
+  }, null);
+}

src/utils/breakpoint/astBreakpointLocation.js

@@ -5,59 +5,12 @@
 // @flow
 
 import { getSymbols } from "../../workers/parser";
+import { findClosestFunction } from "../ast";
 
-import type {
-  AstPosition,
-  AstLocation,
-  SymbolDeclarations,
-  SymbolDeclaration
-} from "../../workers/parser";
+import type { SymbolDeclarations } from "../../workers/parser";
 
 import type { Location, Source, ASTLocation } from "../../types";
 
-export function containsPosition(a: AstLocation, b: AstPosition) {
-  const startsBefore =
-    a.start.line < b.line ||
-    (a.start.line === b.line && a.start.column <= b.column);
-  const endsAfter =
-    a.end.line > b.line || (a.end.line === b.line && a.end.column >= b.column);
-
-  return startsBefore && endsAfter;
-}
-
-export function findClosestScope(
-  functions: SymbolDeclaration[],
-  location: Location
-) {
-  return functions.reduce((found, currNode) => {
-    if (
-      currNode.name === "anonymous" ||
-      !containsPosition(currNode.location, {
-        line: location.line,
-        column: location.column || 0
-      })
-    ) {
-      return found;
-    }
-
-    if (!found) {
-      return currNode;
-    }
-
-    if (found.location.start.line > currNode.location.start.line) {
-      return found;
-    }
-    if (
-      found.location.start.line === currNode.location.start.line &&
-      found.location.start.column > currNode.location.start.column
-    ) {
-      return found;
-    }
-
-    return currNode;
-  }, null);
-}
-
 export function getASTLocation(
   source: Source,
   symbols: SymbolDeclarations,
@@ -69,7 +22,7 @@ export function getASTLocation(
 
   const functions = [...symbols.functions];
 
-  const scope = findClosestScope(functions, location);
+  const scope = findClosestFunction(functions, location);
   if (scope) {
     // we only record the line, but at some point we may
     // also do column offsets

src/utils/function.js

@@ -2,11 +2,14 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at <http://mozilla.org/MPL/2.0/>. */
 
-import { findClosestScope } from "./breakpoint/astBreakpointLocation";
+import { findClosestFunction } from "./ast";
 import { correctIndentation } from "./indentation";
 
 export function findFunctionText(line, source, symbols) {
-  const func = findClosestScope(symbols.functions, { line, column: Infinity });
+  const func = findClosestFunction(symbols.functions, {
+    line,
+    column: Infinity
+  });
   if (!func) {
     return null;
   }