configorama 0.3.9 → 0.4.1

package/README.md

@@ -317,6 +317,10 @@ How is this different than the serverless variable system?
     ${merge('one', 'two')} => 'onetwo'
     ```
 
+## Alt libs
+
+- https://github.com/01alchemist/sls-yaml
+
 ## Inspiration
 
 This is forked out of the [serverless framework](https://github.com/serverless/serverless/) variable system.

package/lib/main.js

@@ -29,6 +29,7 @@ const PromiseTracker = require('./utils/PromiseTracker')
 const handleSignalEvents = require('./utils/handleSignalEvents')
 const formatFunctionArgs = require('./utils/formatFunctionArgs')
 const cloudFormationSchema = require('./utils/cloudformationSchema')
+const trimSurroundingQuotes = require('./utils/trimSurroundingQuotes')
 /**
  * Maintainer's notes:
  *
@@ -54,6 +55,7 @@ const selfRefSyntax = RegExp(/^self:/g)
 const funcRegex = /(\w+)\s*\(((?:[^()]+)*)?\s*\)\s*/
 const funcStartOfLineRegex = /^(\w+)\s*\(((?:[^()]+)*)?\s*\)\s*/
 const subFunctionRegex = /(\w+):(\w+)\s*\(((?:[^()]+)*)?\s*\)\s*/
+const base64WrapperRegex = /\[_\[([A-Za-z0-9+/=\s]*)\]_\]/g
 const logLines = '─────────────────────────────────────────────────'
 const DEBUG = false
 
@@ -374,7 +376,7 @@ class Configorama {
           const transform = this.runFunction.bind(this)
           const varSyntax = this.variableSyntax
           // Traverse resolved object and run functions
-
+          // console.log('this.config', this.config)
           traverse(this.config).forEach(function (rawValue) {
             /* Pass through unknown variables */
             if (!configoramaOpts.allowUndefinedValues && typeof rawValue === 'undefined') {
@@ -407,15 +409,13 @@ class Configorama {
                   this.update(funcVal)
                 }
               }
+            
+              
               /* Allow for unknown variables to pass through */
               if (rawValue.match(/>passthrough/)) {
-                const val = rawValue.replace(/^>passthrough/, '')
-                const base64WrapperRegex = /\[_\[(.*)\]_\]/
-                const matches = base64WrapperRegex.exec(val)
-                if (matches) {
-                  const actualValue = Buffer.from(matches[1], 'base64').toString('ascii')
-                  this.update(actualValue)
-                }
+                const newValues = decodeUnknown(rawValue)
+                // console.log('>>>> newValues', newValues)
+                this.update(newValues)
               }
             }
           })
@@ -778,14 +778,13 @@ class Configorama {
    *  value for all instances of the given matched string.
    */
   populateVariable(valueObject, matchedString, valueToPopulate) {
+    let property = valueObject.value
     if (DEBUG) {
       console.log('------')
       console.log('populateVariable: valueToPopulate', valueToPopulate)
-      console.log('matchedString', matchedString)
-    }
-    let property = valueObject.value
-    if (DEBUG) {
-      console.log('property', property)
+      console.log('populateVariable: matchedString', matchedString)
+      console.log('populateVariable: valueObject', valueObject)
+      console.log('populateVariable: property', property)
       console.log('------')
     }
 
@@ -803,10 +802,36 @@ class Configorama {
       //   console.log('xxxx', rep)
       //   console.log('valueToPopulate', valueToPopulate)
       // }
-      property = replaceall(matchedString, valueToPopulate, property)
+  
+
+      let currentMatchedString = matchedString
+      /* Address fall through values if found */
+      if (valueToPopulate.match(/>passthrough/)) {
+        const decoded = decodeUnknown(valueToPopulate)
+        if (decoded === property) {
+          currentMatchedString = valueObject.value
+        }
+      }
+
+      /*
+      console.log('>------')
+      console.log('isString og matchedString', matchedString)
+      console.log('isString replaceThis: matchedString', currentMatchedString)
+      console.log('isString withThis: valueToPopulate', valueToPopulate)
+      console.log('isString decode:', decodeUnknown(valueToPopulate))
+      console.log('isString inThis: property', property)
+      console.log('isString currentMatchedString', currentMatchedString)
+      console.log('>------')
+      /** */
+   
+      // (replaceThis, withThis, inThis)
+      property = replaceall(currentMatchedString, valueToPopulate, property)
+      // console.log('property', property)
+
       // if (property.match(/^> function /g)) {
       //   console.log('REPLACE after', property)
       // }
+    
     // partial replacement, number
     } else if (_.isNumber(valueToPopulate)) {
       property = replaceall(matchedString, String(valueToPopulate), property)
@@ -861,7 +886,9 @@ ${valueObject.path}: ${valueObject.originalSource}
     }
 
     if (property && typeof property === 'string') {
+      // console.log('property', property)
       const prop = cleanVariable(property, this.variableSyntax)
+      // console.log('prop', prop)
       if (property.match(/^> function /g) && prop) {
         // console.log('PRPOpropertyproperty', property)
         // console.log('Prop', prop)
@@ -914,7 +941,9 @@ ${valueObject.path}: ${valueObject.originalSource}
       //   property = newer
       // }
     }
-
+    // console.log('XXXX property', property)
+    // console.log('XXXX path', valueObject.path)
+    // console.log('XXXX originalSource', valueObject.originalSource)
     return {
       value: property,
       path: valueObject.path,
@@ -1220,7 +1249,17 @@ Like so: \${${variableString}, "fallbackValue"\}.`)
 
     /* Pass through unknown variables */
     if (this.opts.passThroughUnknown) {
-      const passThroughUnknown = `>passthrough[_[${Buffer.from(propertyString).toString('base64')}]_]`
+      // console.log('passThroughUnknown propertyString', propertyString)
+      const varMatches = propertyString.match(this.variableSyntax)
+      let passThroughUnknown = propertyString
+      /* If variables found, encode them for passthrough */
+      if (varMatches && varMatches.length) {
+        varMatches.forEach((m) => {
+          passThroughUnknown = passThroughUnknown.replace(m, encodeUnknown(m))
+        })
+      }
+      // console.log('passThroughUnknown propertyString:', propertyString)
+      // console.log('passThroughUnknown:', passThroughUnknown)
       return Promise.resolve(passThroughUnknown)
     }
 
@@ -1261,7 +1300,7 @@ Like so: \${${variableString}, "fallbackValue"\}.`)
   }
 
   getValueFromFile(variableString) {
-    // console.log('From file', variableString)
+    // console.log('From file', `"${variableString}"`)
     let matchedFileString = variableString.match(fileRefSyntax)[0]
     // console.log('matchedFileString', matchedFileString)
 
@@ -1287,12 +1326,15 @@ Like so: \${${variableString}, "fallbackValue"\}.`)
     }
     // console.log('argsToPass', argsToPass)
 
-    const relativePath = matchedFileString
+    const relativePath = trimSurroundingQuotes(matchedFileString
       .replace(fileRefSyntax, (match, varName) => varName.trim())
-      .replace('~', os.homedir())
+      .replace('~', os.homedir()))
+      
 
     let fullFilePath = (path.isAbsolute(relativePath) ? relativePath : path.join(this.configPath, relativePath))
 
+    // console.log('fullFilePath', fullFilePath)
+
     if (fs.existsSync(fullFilePath)) {
       // Get real path to handle potential symlinks (but don't fatal error)
       fullFilePath = fs.realpathSync(fullFilePath)
@@ -1587,6 +1629,39 @@ Remove or update the \${${variableString}} to fix
   return isRealVariable
 }
 
+function encodeUnknown(v) {
+  return `>passthrough[_[${Buffer.from(v).toString('base64')}]_]`
+}
+
+function decodeUnknown(rawValue) {
+  const x = findUnknownValues(rawValue)
+  let val = rawValue.replace(/>passthrough/g, '')
+  if (x.length) {
+    x.forEach(({ match, value }) => {
+      // console.log('match', match)
+      const decodedValue = Buffer.from(value, 'base64').toString('ascii')
+      // console.log('decodedValue', decodedValue)
+      val = val.replace(match, decodedValue)
+    })
+  }
+  return val
+}
+
+function findUnknownValues(text) {
+  let matches
+  let links = []
+  while ((matches = base64WrapperRegex.exec(text)) !== null) {
+    if (matches.index === base64WrapperRegex.lastIndex) {
+      base64WrapperRegex.lastIndex++ // avoid infinite loops with zero-width matches
+    }
+    links.push({
+      match: matches[0], 
+      value: matches[1] 
+    })
+  }
+  return links
+}
+
 function isPromise(obj) { // eslint-disable-line
   return !!obj && (typeof obj === 'object' || typeof obj === 'function') && typeof obj.then === 'function'
 }

package/lib/utils/trimSurroundingQuotes.js

@@ -0,0 +1,5 @@
+module.exports = function trimQuotes(str = '') {
+  return str
+    .replace(/^(")([^"\n]*?)(\1)$/, "$2")
+    .replace(/^(')([^'\n]*?)(\1)$/, "$2")
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "configorama",
-  "version": "0.3.9",
+  "version": "0.4.1",
   "description": "Variable support for configuration files",
   "main": "lib/index.js",
   "files": [
@@ -12,6 +12,7 @@
   "scripts": {
     "docs": "node ./scripts/docs.js",
     "test": "ava -v",
+    "test:api": "ava ./tests/api/api.test.js -v",
     "watch": "npm test -- --watch -v",
     "publish": "git push origin && git push origin --tags",
     "release:patch": "npm version patch && npm publish",