configorama 0.4.3 → 0.4.5

package/lib/main.js

@@ -30,6 +30,7 @@ const handleSignalEvents = require('./utils/handleSignalEvents')
 const formatFunctionArgs = require('./utils/formatFunctionArgs')
 const cloudFormationSchema = require('./utils/cloudformationSchema')
 const trimSurroundingQuotes = require('./utils/trimSurroundingQuotes')
+const deepLog = require('./utils/deep-log')
 /**
  * Maintainer's notes:
  *
@@ -423,6 +424,7 @@ class Configorama {
           if (DEBUG) {
             console.log(`Variable process ran ${this.callCount} times`)
             // console.log('FINAL Value', this.config)
+            // console.log(this.deep)
           }
         })
       }).then(() => {
@@ -609,6 +611,11 @@ class Configorama {
   }
   populateObjectImpl(objectToPopulate) {
     this.callCount = this.callCount + 1
+    
+    if (DEBUG) {
+      deepLog(`objectToPopulate ${this.callCount}`, objectToPopulate)
+    }
+
     const leaves = this.getProperties(objectToPopulate, true, objectToPopulate)
     const populations = this.populateVariables(leaves)
 
@@ -676,8 +683,10 @@ class Configorama {
    * @returns {*} The populated value with the given results rendered according to the given matches
    */
   renderMatches(valueObject, matches, results) {
-    // console.log('RENDER', matches)
-    // console.log('RESULTS', results)
+    /*
+    console.log('RENDER', matches)
+    console.log('RESULTS', results)
+    /** */
     let result = valueObject.value
     for (let i = 0; i < matches.length; i += 1) {
       this.warnIfNotFound(matches[i].variable, results[i])
@@ -687,7 +696,14 @@ class Configorama {
       if (results[i] && typeof results[i] === 'object' && results[i].__internal_only_flag) {
         valueToPop = results[i].value
       }
+    
       result = this.populateVariable(valueObject, matches[i].match, valueToPop)
+      /*
+      console.log('> valueToPop', valueToPop)
+      console.log('> valueObject', valueObject)
+      console.log('populateVariable r', result)
+      console.log(this.deep)
+      /** */
     }
     return result
   }
@@ -707,7 +723,9 @@ class Configorama {
     }
     const property = valueObject.value
     const matches = this.getMatches(property)
-    // console.log('matchesmatches', matches)
+    /*
+    console.log('matchesmatches', matches)
+    /** */
     if (!_.isArray(matches)) {
       return Promise.resolve(property)
     }
@@ -715,6 +733,10 @@ class Configorama {
     return Promise.all(populations)
       .then(results => this.renderMatches(valueObject, matches, results))
       .then((result) => {
+        /*
+        console.log('renderMatches result', result)
+        /** */
+
         if (root && matches.length) {
           return this.populateValue({ value: result.value }, root)
         }
@@ -755,9 +777,10 @@ class Configorama {
     */
 
     const parts = splitByComma(variable)
-    // console.log('parts', parts)
+
     if (parts.length > 1) {
       if (DEBUG) {
+        console.log('parts', parts)
         console.log('parts variable:', variable)
         console.log('parts property:', valueObject.value)
         console.log('All parts:', parts)
@@ -766,7 +789,7 @@ class Configorama {
       return this.overwrite(parts, valueObject)
     }
 
-    return this.getValueFromSource(parts[0], valueObject)
+    return this.getValueFromSource(parts[0], valueObject, 'splitAndGet')
   }
   /**
    * Populate a given property, given the matched string to replace and the value to replace the
@@ -780,17 +803,32 @@ class Configorama {
   populateVariable(valueObject, matchedString, valueToPopulate) {
     let property = valueObject.value
     if (DEBUG) {
-      console.log('------')
+      console.log('────────START populateVariable──────────────')
       console.log('populateVariable: valueToPopulate', valueToPopulate)
-      console.log('populateVariable: matchedString', matchedString)
       console.log('populateVariable: valueObject', valueObject)
       console.log('populateVariable: property', property)
-      console.log('------')
+      console.log('populateVariable: matchedString', matchedString)
     }
 
     // total replacement
     if (property === matchedString) {
+      const v = valueObject.value || ''
+      const originalSrc = valueObject.originalSource || ''
       property = valueToPopulate
+      /* Handle ${self:custom.ref, ''} with deep values */
+      if (v.match(deepRefSyntax) && originalSrc.match(this.variableSyntax) && !v.match(/deep\:(\d*)\..*}$/)) {
+        // console.log('MAJAJAAJJAAJAJJAJA', this.deep)
+        // console.log('originalSrc', originalSrc)
+        // console.log('value', v)
+        let deepIndex = Number(v.match(/deep\:(\d*)/)[1])
+        let item = this.deep[deepIndex]
+        
+        if (item.match(deepRefSyntax)) {
+          deepIndex = Number(item.match(/deep\:(\d*)/)[1])
+          item = this.deep[deepIndex]
+        }
+        property = this.deep[deepIndex]
+      }
     // partial replacement, string
     } else if (_.isString(valueToPopulate)) {
       // if (property.match(/^> function /g)) {
@@ -869,7 +907,8 @@ class Configorama {
           path: valueObject.path,
           originalSource: valueObject.originalSource,
           // set __internal_only_flag to note this is object we make not a resolved value
-          __internal_only_flag: true
+          __internal_only_flag: true,
+          caller: 'nestedVar'
         }
       }
 
@@ -949,7 +988,9 @@ ${valueObject.path}: ${valueObject.originalSource}
       path: valueObject.path,
       originalSource: valueObject.originalSource,
       // set __internal_only_flag to note this is object we make not a resolved value
-      __internal_only_flag: true
+      __internal_only_flag: true,
+      caller: 'end',
+      count: this.callCount
     }
   }
   // ###############
@@ -969,7 +1010,7 @@ ${valueObject.path}: ${valueObject.originalSource}
     // console.log('propertyString', typeof propertyString)
     const variableValues = variableStrings.map((variableString) => {
       // This runs on nested variable resolution
-      return this.getValueFromSource(variableString, valueObject)
+      return this.getValueFromSource(variableString, valueObject, 'overwrite')
     })
 
     // console.log('variableValues', variableValues)
@@ -981,6 +1022,7 @@ ${valueObject.path}: ${valueObject.originalSource}
         // console.log('valuevaluevaluevaluevaluevaluevaluevalue', value)
         if (_.isString(value) && value.match(this.variableSyntax)) {
           deepProperties += 1
+          // console.log('makeDeepVariable overwrite', value)
           const deepVariable = this.makeDeepVariable(value)
           const newValue = cleanVariable(deepVariable, this.variableSyntax)
           // console.log('variableStrings', variableStrings)
@@ -999,7 +1041,7 @@ ${valueObject.path}: ${valueObject.originalSource}
    * @param variableString The variable string to retrieve a value for.
    * @returns {Promise.<TResult>|*} A promise resolving to the given variables value.
    */
-  getValueFromSource(variableString, valueObject) {
+  getValueFromSource(variableString, valueObject, caller) {
     const propertyString = valueObject.value
     const pathValue = valueObject.path
     // return resolved value
@@ -1011,7 +1053,7 @@ ${valueObject.path}: ${valueObject.originalSource}
     let newHasFilter
     // Else lookup value from various sources
     if (DEBUG) {
-      console.log('>>>>> getValueFromSource')
+      console.log(`>>>>> getValueFromSource() call - ${caller}`)
       console.log('variableString:', variableString)
       console.log('propertyString:', propertyString)
       console.log('pathValue:', pathValue)
@@ -1063,6 +1105,8 @@ ${valueObject.path}: ${valueObject.originalSource}
       return false
     })
 
+    // console.log('found', found)
+
     if (found && resolverFunction) {
       // TODO finalize resolverFunction API
       const valuePromise = resolverFunction(
@@ -1076,6 +1120,7 @@ ${valueObject.path}: ${valueObject.originalSource}
           /* match deep refs as empty {}, they need resolving via functions */
           (typeof val === 'object' && _.isEmpty(val) && variableString.match(/deep\:/))
         ) {
+          // console.log('variableString', variableString)
           const cleanV = cleanVariable(propertyString, this.variableSyntax)
           const valueCount = splitByComma(cleanV)
 
@@ -1113,7 +1158,7 @@ Like so: \${${variableString}, "fallbackValue"\}.`)
         // console.log('propertyString', propertyString)
         // console.log('resolved val', val)
         // console.log('------')
-
+        // console.log('newHasFilter', newHasFilter)
         // No filters found. return value
         if (!newHasFilter) {
           return Promise.resolve(val)
@@ -1200,7 +1245,7 @@ Like so: \${${variableString}, "fallbackValue"\}.`)
         const fallbackStr = getFallbackString(split, nestedVar)
         return this.getValueFromSource(variableString, {
           value: fallbackStr
-        })
+        }, 'nestedVar')
       }
 
       // TODO verify we need this still with file(file.js, param)
@@ -1212,7 +1257,7 @@ Like so: \${${variableString}, "fallbackValue"\}.`)
           // recurse on fallback and check again
           return this.getValueFromSource(`${variableString})`, {
             value: propertyString
-          })
+          }, 'cleanClean.match(fileRefSyntax)')
         }
       }
       // const fallbackValue = split[1] || split[0]
@@ -1227,10 +1272,13 @@ Like so: \${${variableString}, "fallbackValue"\}.`)
 
       // has fallback but needs deeper lookup. Call getValueFromSource again
       if (fallbackValue) {
+        if (DEBUG) {
+          console.log('fallbackValue', fallbackValue)
+        }
         // recurse on fallback and check again
         return this.getValueFromSource(fallbackValue, {
           value: propertyString
-        })
+        }, 'fallbackValue')
       }
     }
 
@@ -1274,7 +1322,10 @@ Like so: \${${variableString}, "fallbackValue"\}.`)
   }
 
   getValueFromSelf(variableString, o, x, data) {
-    // console.log('self', variableString)
+    /*
+    console.log('getValueFromSelf variableString', variableString)
+    /** */
+
     // console.log('self data', data)
 
     const split = variableString.split(':')
@@ -1296,7 +1347,13 @@ Like so: \${${variableString}, "fallbackValue"\}.`)
       }
     }
 
-    return this.getDeeperValue(deepProperties, valueToPopulate)
+    return this.getDeeperValue(deepProperties, valueToPopulate).then((res) => {
+      /*
+      console.log('self getDeeperValue variableString', variableString)
+      console.log('self getDeeperValue result', res)
+      /** */
+      return res
+    })
   }
 
   getValueFromFile(variableString) {
@@ -1468,17 +1525,28 @@ Please use ":" to reference sub properties`
   }
   getVariableFromDeep(variableString) {
     const index = this.getDeepIndex(variableString)
+    /*
+    console.log('FIND INDEX', index)
+    console.log(this.deep)
+    /** */
     return this.deep[index]
   }
   getValueFromDeep(variableString) {
     const deepPrefixReplace = RegExp(/(?:^deep:)\d+\.?/g)
     const variable = this.getVariableFromDeep(variableString)
     const deepRef = variableString.replace(deepPrefixReplace, '')
+    /*
+    console.log("GET getValueFromDeep", variableString)
+    console.log('deepRef', deepRef)
+    console.log('variablex', variable)
+    /** */
     let ret = this.populateValue({ value: variable })
+    // console.log('variable ret', ret)
     if (deepRef.length) { // if there is a deep reference remaining
       ret = ret.then((result) => {
         // console.log('DEEP RESULT', result)
         if (_.isString(result.value) && result.value.match(this.variableSyntax)) {
+          // console.log('makeDeepVariable getValueFromDeep', result.value)
           const deepVariable = this.makeDeepVariable(result.value)
           return Promise.resolve(appendDeepVariable(deepVariable, deepRef))
         }
@@ -1492,8 +1560,10 @@ Please use ":" to reference sub properties`
     // console.log('MAKE DEEP', variable)
     let index = this.deep.findIndex((item) => variable === item)
     if (index < 0) {
+      // console.log('this.deep.push', variable)
       index = this.deep.push(variable) - 1
     }
+    // console.log("makeDeepVariable SET INDEX", index)
     const variableContainer = variable.match(this.variableSyntax)[0]
     const variableString = cleanVariable(variableContainer, this.variableSyntax)
     const deepVar = variableContainer.replace(variableString, `deep:${index}`)
@@ -1518,8 +1588,17 @@ Please use ":" to reference sub properties`
    * will later resolve to the deeper value
    */
   getDeeperValue(deepProperties, valueToPopulate) {
+    /*
+    console.log('deepProperties', deepProperties)
+    console.log('valueToPopulate', valueToPopulate)
+    /** */
+
     const veryDeep = deepProperties.reduce(async (reducedValueParam, subProperty) => {
       let reducedValue = await reducedValueParam
+      // console.log('reducedValue', reducedValue)
+      // console.log(typeof reducedValue)
+      // console.log('subProperty', `"${subProperty}"`)
+
       if (_.isString(reducedValue) && reducedValue.match(deepRefSyntax)) { // build mode
         reducedValue = appendDeepVariable(reducedValue, subProperty)
       } else { // get mode
@@ -1531,9 +1610,17 @@ Please use ":" to reference sub properties`
             path: undefined,
             originalSource: undefined,
             // set __internal_only_flag to note this is object we make not a resolved value
-            __internal_only_flag: true
+            __internal_only_flag: true,
+            caller: 'getDeeperValue',
           }
-        } else if (subProperty !== '' || '' in reducedValue) {
+        } else if (subProperty !== '' || (typeof reducedValue === 'object' && '' in reducedValue)) {
+          try {
+            // if JSON parse it
+            reducedValue = JSON.parse(reducedValue)
+          } catch (e) {}
+
+          reducedValue = reducedValue[subProperty]
+        } else if (_.isString(reducedValue)) {
           try {
             // if JSON parse it
             reducedValue = JSON.parse(reducedValue)
@@ -1542,10 +1629,11 @@ Please use ":" to reference sub properties`
           reducedValue = reducedValue[subProperty]
         }
         if (typeof reducedValue === 'string' && reducedValue.match(this.variableSyntax)) {
+          // console.log('makeDeepVariable reducedValue', reducedValue)
           reducedValue = this.makeDeepVariable(reducedValue)
         }
       }
-
+      // console.log('fin', reducedValue)
       return Promise.resolve(reducedValue)
     }, Promise.resolve(valueToPopulate))
 
@@ -1553,17 +1641,22 @@ Please use ":" to reference sub properties`
   }
 
   warnIfNotFound(variableString, valueToPopulate) {
+    let varType
+    if (variableString.match(envRefSyntax)) {
+      varType = 'environment variable'
+    } else if (variableString.match(optRefSyntax)) {
+      varType = 'option'
+    } else if (variableString.match(selfRefSyntax)) {
+      varType = 'config attribute'
+    } else if (variableString.match(fileRefSyntax)) {
+      varType = 'file'
+    } else if (variableString.match(deepRefSyntax)) {
+      varType = 'deep'
+    }
     if (!isValidValue(valueToPopulate)) {
-      let varType
-      if (variableString.match(envRefSyntax)) {
-        varType = 'environment variable'
-      } else if (variableString.match(optRefSyntax)) {
-        varType = 'option'
-      } else if (variableString.match(selfRefSyntax)) {
-        varType = 'config attribute'
-      } else if (variableString.match(fileRefSyntax)) {
-        varType = 'file'
-      }
+      // console.log("MISSING", variableString)
+      // console.log(this.deep)
+      // console.log(valueToPopulate)
 
       const notFoundMsg = `No ${varType} found to satisfy the '\${${variableString}}' variable. Attempting fallback value`
       if (DEBUG) {
@@ -1617,7 +1710,7 @@ function verifyVariable(variableString, valueObject, variableTypes, config) {
   })
   // If not found in variable resolvers and is missing a colon throw
   if (!isRealVariable && variableString.match(/:/)) {
-    console.log('variableString', variableString)
+    // console.log('variableString', variableString)
     throw new Error(`
 Variable \${${variableString}} is invalid variable syntax.
 Value Path: ${(valueObject.path) ? valueObject.path.join('.') : 'na'}

package/lib/resolvers/valueFromGit.js

@@ -22,7 +22,7 @@ async function _getValueFromGit(variableString) {
   const variable = variableString.split(`${GIT_PREFIX}:`)[1]
   let value = null
   // console.log('variableStringvariableString', variableString)
-  if (variable.match(/^remote/)) {
+  if (variable.match(/^remote/i)) {
     const hasParams = functionRegex.exec(variableString)
     const remoteName = (hasParams && hasParams[2]) ? formatFunctionArgs(hasParams[2]) : 'origin'
     value = await getGitRemote(remoteName)
@@ -30,22 +30,42 @@ async function _getValueFromGit(variableString) {
   }
 
   const verifyMsg = `Verify the cwd has a .git directory\n`
+  const normalizedVar = (variable || '').toLowerCase()
 
-  switch (variable) {
-    case 'describe':
-      try {
-        value = await _exec('git describe --always')
-      } catch (err) {
-        throw new Error(`\${git:describeLight} error. ${verifyMsg}`)
-      }
-      break
-    case 'describeLight':
-      try {
-        value = await _exec('git describe --always --tags')
-      } catch (err) {
-        throw new Error(`\${git:describeLight} error. ${verifyMsg}`)
-      }
-      break
+  switch (normalizedVar) {
+    // Repo owner/name
+    case 'repo':
+    case 'repository':
+    case 'reposlug':
+    case 'repo-slug':
+      const urla = await getGitRemote()
+      const parseda = GitUrlParse(urla)
+      value = parseda.full_name
+      break;
+    // Repo name
+    case 'name':
+    case 'reponame': // repoName
+    case 'repo-name':
+      value = await _exec('basename `git rev-parse --show-toplevel`')
+      break;
+    // Repo org or owner
+    case 'org':
+    case 'owner':
+    case 'organization':
+    case 'repoowner': // repoOwner
+    case 'repo-owner':
+      const url = await getGitRemote()
+      const parsed = GitUrlParse(url)
+      value = parsed.organization || parsed.owner
+      break;
+    // Repo url
+    case 'url':
+    case 'repourl': // repoUrl
+    case 'repo-url':
+      value = await getGitRemote()
+      break;
+    // Current commit sha
+    case 'sha':
     case 'sha1':
       try {
         value = await _exec('git rev-parse --short HEAD')
@@ -53,38 +73,70 @@ async function _getValueFromGit(variableString) {
         throw new Error(`\${git:sha1} error ${verifyMsg}`)
       }
       break
+    // Current commit full sha
     case 'commit':
+    case 'commitsha':
+    case 'commit-sha':
+    case 'commithash':
+    case 'commit-hash':
       try {
         value = await _exec('git rev-parse HEAD')
       } catch (err) {
         throw new Error(`\${git:commit} error. ${verifyMsg}`)
       }
       break
+    // Branches
     case 'branch':
+    case 'branchname':
+    case 'branch-name':
+    case 'currentbranch': // currentBranch
+    case 'current-branch':
       try {
         value = await _exec('git rev-parse --abbrev-ref HEAD')
       } catch (err) {
         throw new Error(`\${git:branch} error. ${verifyMsg}`)
       }
       break
+    // Commit msg
+    case 'msg':
     case 'message':
+    case 'commitmessage': // commitMessage
+    case 'commit-message':
+    case 'commitmsg': // commitMsg
+    case 'commit-msg':
       try {
         value = await _exec('git log -1 --pretty=%B')
       } catch (err) {
         throw new Error(`\${git:message} error. ${verifyMsg}`)
       }
-      break
+      break;
+    // Git tags
+    case 'tag':
+    case 'describe':
+      try {
+        value = await _exec('git describe --always')
+      } catch (err) {
+        throw new Error(`\${git:describeLight} error. ${verifyMsg}`)
+      }
+      break;
+    // Git tags
+    case 'describeLight':
+    case 'describelight':
+    case 'describe-light':
+      try {
+        value = await _exec('git describe --always --tags')
+      } catch (err) {
+        throw new Error(`\${git:describeLight} error. ${verifyMsg}`)
+      }
+      break;
+    // Is branch dirty
     case 'isDirty':
+    case 'isdirty':
+    case 'is-dirty':
       const writeTree = await _exec('git write-tree')
       const changes = await _exec(`git diff-index ${writeTree} --`)
       value = `${changes.length > 0}`
       break
-    case 'repository':
-      value = await _exec('basename `git rev-parse --show-toplevel`')
-      break
-    case 'url': case 'repoUrl':
-      value = await getGitRemote()
-      break
     default:
       throw new Error(`Git variable ${variable} is unknown. Candidates are 'describe', 'describeLight', 'sha1', 'commit', 'branch', 'message', 'repository'`)
   }

package/lib/utils/deep-log.js

@@ -0,0 +1,10 @@
+const util = require('util')
+
+module.exports = function deepLog(objOrLabel, logVal) {
+  let obj = objOrLabel
+  if (typeof objOrLabel === 'string') {
+    obj = logVal
+    console.log(objOrLabel)
+  }
+  console.log(util.inspect(obj, false, null, true))
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "configorama",
-  "version": "0.4.3",
+  "version": "0.4.5",
   "description": "Variable support for configuration files",
   "main": "lib/index.js",
   "files": [