Re-writing pre-processor to be a bit clearer.

packages/string-templates/src/custom/preprocessor.js

@@ -6,13 +6,21 @@ const {
   includesAny,
 } = require("../utilities")
 
-function handleProcessor(string, match, fn) {
+class Preprocessor {
-  const output = fn(match)
+  constructor(name, fn) {
-  const idx = string.indexOf(match)
+    this.name = name
-  return swapStrings(string, idx, match.length, output)
+    this.fn = fn
   }
 
-function swapToDotNotation(statement) {
+  process(fullString, statement) {
+    const output = this.fn(statement)
+    const idx = fullString.indexOf(statement)
+    return swapStrings(fullString, idx, statement.length, output)
+  }
+}
+
+const PROCESSORS = [
+  new Preprocessor("swap-to-dot-notation", statement => {
     let startBraceIdx = statement.indexOf("[")
     let lastIdx = 0
     while (startBraceIdx !== -1) {
@@ -24,9 +32,9 @@ function swapToDotNotation(statement) {
       startBraceIdx = statement.substring(lastIdx + 1).indexOf("[")
     }
     return statement
-}
+  }),
 
-function handleSpacesInProperties(statement) {
+  new Preprocessor("handle-spaces-in-properties", statement => {
     // exclude helpers and brackets, regex will only find double brackets
     const exclusions = HelperFunctions.concat(["{{", "}}"])
     // find all the parts split by spaces
@@ -52,9 +60,9 @@ function handleSpacesInProperties(statement) {
     }
     // remove the edge case of double brackets being entered (in-case user already has specified)
     return statement.replace(/\[\[/g, "[").replace(/]]/g, "]")
-}
+  }),
 
-function finalise(statement) {
+  new Preprocessor("finalise", statement => {
     let insideStatement = statement.slice(2, statement.length - 2)
     if (insideStatement.charAt(0) === " ") {
       insideStatement = insideStatement.slice(1)
@@ -66,7 +74,8 @@ function finalise(statement) {
       insideStatement = `(${insideStatement})`
     }
     return `{{ all ${insideStatement} }}`
-}
+  })
+]
 
 /**
  * When running handlebars statements to execute on the context of the automation it possible user's may input handlebars
@@ -80,16 +89,15 @@ function finalise(statement) {
  * @returns {string} The string that was input with processed up handlebars statements as required.
  */
 module.exports.preprocess = string => {
-  let preprocessors = [swapToDotNotation, handleSpacesInProperties, finalise]
+  for (let processor of PROCESSORS) {
-  for (let processor of preprocessors) {
+    // re-run search each time incase previous processor updated/removed a match
-    // re-run search each time incase previous cleaner update/removed a match
     let regex = new RegExp(FIND_HBS_REGEX)
     let matches = string.match(regex)
     if (matches == null) {
       continue
     }
     for (let match of matches) {
-      string = handleProcessor(string, match, processor)
+      string = processor.process(string, match)
     }
   }
   return string