config 1.20.3 → 1.24.0

package/History.md

@@ -1,3 +1,30 @@
+1.24.0 / 2016-11-02
+===================
+
+  * Prevent accidental publish to private repository
+
+1.23.0 / 2016-11-02
+===================
+
+  * Re-publishing because npmjs didn't see 1.22
+
+1.22.0 / 2016-10-25
+===================
+
+  * original/previous value for deferredConfig @simon-scherzinger
+  * util.loadFileConfigs: support optional source dir @wmertens
+  * Adding raw wrapper to prevent object modification in config @patrickpilch
+
+1.21.0 / 2016-06-01
+===================
+
+  * Added XML configuration @tusharmath
+
+1.20.4 / 2016-05-23
+===================
+
+  * Fixed a regression with extending prototype methods @tahoemph
+
 1.20.3 / 2016-05-18
 ===================
 

package/README.md

@@ -123,7 +123,7 @@ Articles
 
 Contributors
 ------------
-<table id="contributors"><tr><td><img src=https://avatars.githubusercontent.com/u/373538?v=3><a href="https://github.com/lorenwest">lorenwest</a></td><td><img src=https://avatars.githubusercontent.com/u/25829?v=3><a href="https://github.com/markstos">markstos</a></td><td><img src=https://avatars.githubusercontent.com/u/447151?v=3><a href="https://github.com/elliotttf">elliotttf</a></td><td><img src=https://avatars.githubusercontent.com/u/66902?v=3><a href="https://github.com/leachiM2k">leachiM2k</a></td><td><img src=https://avatars.githubusercontent.com/u/791137?v=3><a href="https://github.com/josx">josx</a></td><td><img src=https://avatars.githubusercontent.com/u/133277?v=3><a href="https://github.com/enyo">enyo</a></td></tr><tr><td><img src=https://avatars.githubusercontent.com/u/1077378?v=3><a href="https://github.com/arthanzel">arthanzel</a></td><td><img src=https://avatars.githubusercontent.com/u/355800?v=3><a href="https://github.com/diversario">diversario</a></td><td><img src=https://avatars.githubusercontent.com/u/1656140?v=3><a href="https://github.com/eheikes">eheikes</a></td><td><img src=https://avatars.githubusercontent.com/u/138707?v=3><a href="https://github.com/th507">th507</a></td><td><img src=https://avatars.githubusercontent.com/u/842998?v=3><a href="https://github.com/nsabovic">nsabovic</a></td><td><img src=https://avatars.githubusercontent.com/u/506460?v=3><a href="https://github.com/Osterjour">Osterjour</a></td></tr><tr><td><img src=https://avatars.githubusercontent.com/u/175627?v=3><a href="https://github.com/axelhzf">axelhzf</a></td><td><img src=https://avatars.githubusercontent.com/u/7782055?v=3><a href="https://github.com/benkroeger">benkroeger</a></td><td><img src=https://avatars.githubusercontent.com/u/1246875?v=3><a href="https://github.com/jaylynch">jaylynch</a></td><td><img src=https://avatars.githubusercontent.com/u/145742?v=3><a href="https://github.com/jberrisch">jberrisch</a></td><td><img src=https://avatars.githubusercontent.com/u/1918551?v=3><a href="https://github.com/nitzan-shaked">nitzan-shaked</a></td><td><img src=https://avatars.githubusercontent.com/u/3058150?v=3><a href="https://github.com/Alaneor">Alaneor</a></td></tr><tr><td><img src=https://avatars.githubusercontent.com/u/498929?v=3><a href="https://github.com/roncli">roncli</a></td><td><img src=https://avatars.githubusercontent.com/u/1355559?v=3><a href="https://github.com/superoven">superoven</a></td><td><img src=https://avatars.githubusercontent.com/u/4425455?v=3><a href="https://github.com/ncuillery">ncuillery</a></td><td><img src=https://avatars.githubusercontent.com/u/125062?v=3><a href="https://github.com/keis">keis</a></td><td><img src=https://avatars.githubusercontent.com/u/16861?v=3><a href="https://github.com/abh">abh</a></td><td><img src=https://avatars.githubusercontent.com/u/57770?v=3><a href="https://github.com/bertrandom">bertrandom</a></td></tr><tr><td><img src=https://avatars.githubusercontent.com/u/959858?v=3><a href="https://github.com/laktak">laktak</a></td><td><img src=https://avatars.githubusercontent.com/u/157303?v=3><a href="https://github.com/cmcculloh">cmcculloh</a></td><td><img src=https://avatars.githubusercontent.com/u/270632?v=3><a href="https://github.com/thetalecrafter">thetalecrafter</a></td><td><img src=https://avatars.githubusercontent.com/u/28898?v=3><a href="https://github.com/DMajrekar">DMajrekar</a></td><td><img src=https://avatars.githubusercontent.com/u/5358976?v=3><a href="https://github.com/dsimidzija">dsimidzija</a></td><td><img src=https://avatars.githubusercontent.com/u/535667?v=3><a href="https://github.com/jasonhansel">jasonhansel</a></td></tr></table>
+<table id="contributors"><tr><td><img src=https://avatars.githubusercontent.com/u/373538?v=3><a href="https://github.com/lorenwest">lorenwest</a></td><td><img src=https://avatars.githubusercontent.com/u/25829?v=3><a href="https://github.com/markstos">markstos</a></td><td><img src=https://avatars.githubusercontent.com/u/447151?v=3><a href="https://github.com/elliotttf">elliotttf</a></td><td><img src=https://avatars.githubusercontent.com/u/66902?v=3><a href="https://github.com/leachiM2k">leachiM2k</a></td><td><img src=https://avatars.githubusercontent.com/u/791137?v=3><a href="https://github.com/josx">josx</a></td><td><img src=https://avatars.githubusercontent.com/u/133277?v=3><a href="https://github.com/enyo">enyo</a></td></tr><tr><td><img src=https://avatars.githubusercontent.com/u/2675698?v=3><a href="https://github.com/rundef">rundef</a></td><td><img src=https://avatars.githubusercontent.com/u/1077378?v=3><a href="https://github.com/arthanzel">arthanzel</a></td><td><img src=https://avatars.githubusercontent.com/u/1656140?v=3><a href="https://github.com/eheikes">eheikes</a></td><td><img src=https://avatars.githubusercontent.com/u/355800?v=3><a href="https://github.com/diversario">diversario</a></td><td><img src=https://avatars.githubusercontent.com/u/138707?v=3><a href="https://github.com/th507">th507</a></td><td><img src=https://avatars.githubusercontent.com/u/842998?v=3><a href="https://github.com/nsabovic">nsabovic</a></td></tr><tr><td><img src=https://avatars.githubusercontent.com/u/506460?v=3><a href="https://github.com/Osterjour">Osterjour</a></td><td><img src=https://avatars.githubusercontent.com/u/175627?v=3><a href="https://github.com/axelhzf">axelhzf</a></td><td><img src=https://avatars.githubusercontent.com/u/7782055?v=3><a href="https://github.com/benkroeger">benkroeger</a></td><td><img src=https://avatars.githubusercontent.com/u/1246875?v=3><a href="https://github.com/jaylynch">jaylynch</a></td><td><img src=https://avatars.githubusercontent.com/u/145742?v=3><a href="https://github.com/jberrisch">jberrisch</a></td><td><img src=https://avatars.githubusercontent.com/u/1918551?v=3><a href="https://github.com/nitzan-shaked">nitzan-shaked</a></td></tr><tr><td><img src=https://avatars.githubusercontent.com/u/3058150?v=3><a href="https://github.com/Alaneor">Alaneor</a></td><td><img src=https://avatars.githubusercontent.com/u/498929?v=3><a href="https://github.com/roncli">roncli</a></td><td><img src=https://avatars.githubusercontent.com/u/1355559?v=3><a href="https://github.com/superoven">superoven</a></td><td><img src=https://avatars.githubusercontent.com/u/4425455?v=3><a href="https://github.com/ncuillery">ncuillery</a></td><td><img src=https://avatars.githubusercontent.com/u/125062?v=3><a href="https://github.com/keis">keis</a></td><td><img src=https://avatars.githubusercontent.com/u/16861?v=3><a href="https://github.com/abh">abh</a></td></tr><tr><td><img src=https://avatars.githubusercontent.com/u/57770?v=3><a href="https://github.com/bertrandom">bertrandom</a></td><td><img src=https://avatars.githubusercontent.com/u/959858?v=3><a href="https://github.com/laktak">laktak</a></td><td><img src=https://avatars.githubusercontent.com/u/157303?v=3><a href="https://github.com/cmcculloh">cmcculloh</a></td><td><img src=https://avatars.githubusercontent.com/u/270632?v=3><a href="https://github.com/thetalecrafter">thetalecrafter</a></td><td><img src=https://avatars.githubusercontent.com/u/28898?v=3><a href="https://github.com/DMajrekar">DMajrekar</a></td><td><img src=https://avatars.githubusercontent.com/u/5358976?v=3><a href="https://github.com/dsimidzija">dsimidzija</a></td></tr></table>
 
 License
 -------

package/defer.js

@@ -1,7 +1,7 @@
 // Create a deferredConfig prototype so that we can check for it when reviewing the configs later.
 function DeferredConfig () {
 }
-DeferredConfig.prototype.resolve = function (config) {};
+DeferredConfig.prototype.resolve = function (config, original) {};
 
 // Accept a function that we'll use to resolve this value later and return a 'deferred' configuration value to resolve it later.
 function deferConfig (func) {

package/lib/config.js

@@ -13,8 +13,10 @@ var Yaml = null,    // External libraries are lazy-loaded
     JSON5 = null,
     TOML = null,
     HJSON = null,
+    XML = null,
     deferConfig = require('../defer').deferConfig,
     DeferredConfig = require('../defer').DeferredConfig,
+    RawConfig = require('../raw').RawConfig,
     Utils = require('util'),
     Path = require('path'),
     FileSystem = require('fs');
@@ -186,6 +188,10 @@ Config.prototype.get = function(property) {
     checkMutability = false;
   }
 
+  if (value instanceof RawConfig) {
+    value = value.resolve();
+  }
+
   // Return the value
   return value;
 };
@@ -531,16 +537,18 @@ util.makeImmutable = function(object, property, value) {
   for (var i = 0; i < properties.length; i++) {
     var propertyName = properties[i],
         value = object[propertyName];
+    
+    if (!(value instanceof RawConfig)) {
+      Object.defineProperty(object, propertyName, {
+        value: value,
+        writable : false,
+        configurable: false
+      });
 
-    Object.defineProperty(object, propertyName, {
-      value: value,
-      writable : false,
-      configurable: false
-    });
-
-    // Call recursively if an object.
-    if (util.isObject(value)) {
-      util.makeImmutable(value);
+      // Call recursively if an object.
+      if (util.isObject(value)) {
+        util.makeImmutable(value);
+      }
     }
   }
 
@@ -624,7 +632,7 @@ util.getConfigSources = function() {
  * @method loadFileConfigs
  * @return config {Object} The configuration object
  */
-util.loadFileConfigs = function() {
+util.loadFileConfigs = function(configDir) {
 
   // Initialize
   var t = this,
@@ -632,7 +640,7 @@ util.loadFileConfigs = function() {
 
   // Initialize parameters from command line, environment, or default
   NODE_ENV = util.initParam('NODE_ENV', 'development');
-  CONFIG_DIR = util.initParam('NODE_CONFIG_DIR', Path.join( process.cwd(), 'config') );
+  CONFIG_DIR = configDir || util.initParam('NODE_CONFIG_DIR', Path.join( process.cwd(), 'config') );
   if (CONFIG_DIR.indexOf('.') === 0) {
     CONFIG_DIR = Path.join(process.cwd() , CONFIG_DIR);
   }
@@ -677,7 +685,7 @@ util.loadFileConfigs = function() {
 
   baseNames.push('local', 'local-' + NODE_ENV);
 
-  var extNames = ['js', 'json', 'json5', 'hjson', 'toml', 'coffee', 'iced', 'yaml', 'yml', 'cson', 'properties'];
+  var extNames = ['js', 'json', 'json5', 'hjson', 'toml', 'coffee', 'iced', 'yaml', 'yml', 'cson', 'properties', 'xml'];
   baseNames.forEach(function(baseName) {
     extNames.forEach(function(extName) {
 
@@ -700,42 +708,45 @@ util.loadFileConfigs = function() {
   });
 
   // Override configurations from the $NODE_CONFIG environment variable
-  var envConfig = {};
-  if (process.env.NODE_CONFIG) {
-    try {
-      envConfig = JSON.parse(process.env.NODE_CONFIG);
-    } catch(e) {
-      console.error('The $NODE_CONFIG environment variable is malformed JSON');
+  // NODE_CONFIG only applies to the base config
+  if (!configDir) {
+    var envConfig = {};
+    if (process.env.NODE_CONFIG) {
+      try {
+        envConfig = JSON.parse(process.env.NODE_CONFIG);
+      } catch(e) {
+        console.error('The $NODE_CONFIG environment variable is malformed JSON');
+      }
+      util.extendDeep(config, envConfig);
+      configSources.push({
+        name: "$NODE_CONFIG",
+        parsed: envConfig,
+      });
     }
-    util.extendDeep(config, envConfig);
-    configSources.push({
-      name: "$NODE_CONFIG",
-      parsed: envConfig,
-    });
-  }
 
-  // Override configurations from the --NODE_CONFIG command line
-  var cmdLineConfig = util.getCmdLineArg('NODE_CONFIG');
-  if (cmdLineConfig) {
-    try {
-      cmdLineConfig = JSON.parse(cmdLineConfig);
-    } catch(e) {
-      console.error('The --NODE_CONFIG={json} command line argument is malformed JSON');
+    // Override configurations from the --NODE_CONFIG command line
+    var cmdLineConfig = util.getCmdLineArg('NODE_CONFIG');
+    if (cmdLineConfig) {
+      try {
+        cmdLineConfig = JSON.parse(cmdLineConfig);
+      } catch(e) {
+        console.error('The --NODE_CONFIG={json} command line argument is malformed JSON');
+      }
+      util.extendDeep(config, cmdLineConfig);
+      configSources.push({
+        name: "--NODE_CONFIG argument",
+        parsed: cmdLineConfig,
+      });
     }
-    util.extendDeep(config, cmdLineConfig);
-    configSources.push({
-      name: "--NODE_CONFIG argument",
-      parsed: cmdLineConfig,
-    });
+
+    // Place the mixed NODE_CONFIG into the environment
+    env['NODE_CONFIG'] = JSON.stringify(util.extendDeep(envConfig, cmdLineConfig, {}));
   }
 
   // Override with environment variables if there is a custom-environment-variables.EXT mapping file
   var customEnvVars = util.getCustomEnvVars(CONFIG_DIR, extNames);
   util.extendDeep(config, customEnvVars);
 
-  // Place the mixed NODE_CONFIG into the environment
-  env['NODE_CONFIG'] = JSON.stringify(util.extendDeep(envConfig, cmdLineConfig, {}));
-
   // Extend the original config with the contents of runtime.json (backwards compatibility)
   var runtimeJson = util.parseFile(RUNTIME_JSON_FILENAME) || {};
   util.extendDeep(config, runtimeJson);
@@ -773,7 +784,7 @@ util.resolveDeferredConfigs = function (config) {
         }
       } else {
         if (prop[property] instanceof DeferredConfig ) {
-          prop[property]= prop[property].resolve.call(completeConfig,completeConfig)
+          prop[property]= prop[property].resolve.call(completeConfig,completeConfig, prop[property]._original);
         }
         else {
           // Nothing to do. Keep the property how it is.
@@ -796,7 +807,7 @@ util.resolveDeferredConfigs = function (config) {
  * .js = File to run that has a module.exports containing the config object
  * .coffee = File to run that has a module.exports with coffee-script containing the config object
  * .iced = File to run that has a module.exports with iced-coffee-script containing the config object
- * All other supported file types (yaml, toml, json, cson, hjson, json5, properties)
+ * All other supported file types (yaml, toml, json, cson, hjson, json5, properties, xml)
  * are parsed with util.parseString.
  *
  * If the file doesn't exist, a null will be returned.  If the file can't be
@@ -911,6 +922,7 @@ util.parseFile = function(fullFilename) {
  * hjson = Parsed with a HJSON parser
  * json5 = Parsed with a JSON5 parser
  * properties = Parsed with the 'properties' node package
+ * xml = Parsed with a XML parser
  *
  * If the file doesn't exist, a null will be returned.  If the file can't be
  * parsed, an exception will be thrown.
@@ -1016,6 +1028,18 @@ util.parseString = function (content, format) {
       PPARSER = require('properties');
     }
     configObject = PPARSER.parse(content, { namespaces: true, variables: true, sections: true });
+  } else if (format === 'xml') {
+
+    if (!XML) {
+      XML = require('x2js');
+    }
+
+    var x2js = new XML();
+    configObject = x2js.xml2js(content);
+    var rootKeys = Object.keys(configObject);
+    if(rootKeys.length == 1) {
+      configObject = configObject[rootKeys[0]];
+    }
   }
 
   return configObject;
@@ -1041,6 +1065,9 @@ util.parseString = function (content, format) {
  * @return toObject
  */
 util.attachProtoDeep = function(toObject, depth) {
+  if (toObject instanceof RawConfig) {
+    return toObject;
+  }
 
   // Recursion detection
   var t = this;
@@ -1402,8 +1429,14 @@ util.extendDeep = function(mergeInto) {
     // Cycle through each element of the object to merge from
     for (var prop in mergeFrom) {
 
-      // Extend recursively if both elements are objects and target is not really a deferred function
+      // save original value in deferred elements
+      var fromIsDeferredFunc = mergeFrom[prop] instanceof DeferredConfig;
       var isDeferredFunc = mergeInto[prop] instanceof DeferredConfig;
+
+      if (fromIsDeferredFunc && mergeInto.hasOwnProperty(prop)) {
+        mergeFrom[prop]._original = isDeferredFunc ? mergeInto[prop]._original : mergeInto[prop];
+      }
+      // Extend recursively if both elements are objects and target is not really a deferred function
       if (mergeFrom[prop] instanceof Date) {
         mergeInto[prop] = mergeFrom[prop];
       } else if (util.isObject(mergeInto[prop]) && util.isObject(mergeFrom[prop]) && !isDeferredFunc) {
@@ -1416,11 +1449,10 @@ util.extendDeep = function(mergeInto) {
       }
 
       // Copy property descriptor otherwise, preserving accessors
-      else {
-        var descriptor = Object.getOwnPropertyDescriptor(Object(mergeFrom), prop);
-        if (descriptor) {
-          Object.defineProperty(mergeInto, prop, descriptor);
-        }
+      else if (Object.getOwnPropertyDescriptor(Object(mergeFrom), prop)){
+          Object.defineProperty(mergeInto, prop, Object.getOwnPropertyDescriptor(Object(mergeFrom), prop));
+      } else {
+          mergeInto[prop] = mergeFrom[prop];
       }
     }
   });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "config",
-  "version": "1.20.3",
+  "version": "1.24.0",
   "main": "./lib/config.js",
   "description": "Configuration control for production node deployments",
   "author": "Loren West <open_source@lorenwest.com>",
@@ -28,7 +28,9 @@
     "js-yaml": "^3.2.2",
     "properties": "~1.2.1",
     "toml": "^2.0.6",
-    "vows": ">=0.8.1"
+    "underscore": "^1.8.3",
+    "vows": ">=0.8.1",
+    "x2js": "^2.0.1"
   },
   "repository": {
     "type": "git",

package/raw.js

@@ -0,0 +1,15 @@
+/**
+ * This is meant to wrap configuration objects that should be left as is,
+ * meaning that the object or its protoype will not be modified in any way
+ */
+function RawConfig () {
+}
+
+function raw(rawObj) {
+  var obj = Object.create(RawConfig.prototype);
+  obj.resolve = function () { return rawObj; }
+  return obj;
+}
+
+module.exports.RawConfig = RawConfig;
+module.exports.raw = raw;