[add] merge strategy: deep merge or rewrite

gumeniukcom · Feb 19, 2016 · 353e37b · 353e37b
1 parent 6b0f0d9
commit 353e37b
Show file tree

Hide file tree

Showing 4 changed files with 56 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -35,3 +35,14 @@ By default using `NODE_ENV`, but if you need to use another environment name:
       .setEnv('YOUR_ENV_NAME')
       .getConfig();
    ```
+# Merge config strategy
+
+By default using `deep merge` strategy. But if you want non deep merge ( rewrite), you should use:
+
+   ```
+   var config = new Config(__dirname,['production', 'develop']);
+   module.exports = config
+      .setDeepMerge(false)
+      .getConfig();
+   ```
+
diff --git a/index.js b/index.js
@@ -5,6 +5,8 @@
 
 "use strict";
 
+var merger = require('extend');
+
 class Config {
 
     constructor(pathToConfigDir, availableConfigs) {
@@ -16,13 +18,19 @@ class Config {
         this.availableConfigs = availableConfigs;// || ['production', 'rc', 'develop'];
         this.configHierarchy = ['production'];
         this.pathToConfigDir = pathToConfigDir;
+        this.deepMerge = true;
     }
 
     setEnvName(envName) {
         this.envName = envName;
         return this;
     }
 
+    setDeepMerge(deep) {
+        this.deepMerge = deep;
+        return this;
+    }
+
 
     getConfig() {
         var env = this.getEnvironmentFromGlobalEnv();
@@ -82,6 +90,7 @@ class Config {
     _initConfig() {
         var result = {};
         var pathToConfigDir = this.pathToConfigDir;
+        var self = this;
         this.configHierarchy
             .forEach(function (configName) {
                 var path = pathToConfigDir + '/' + configName;
@@ -91,7 +100,7 @@ class Config {
                     throw new Error('Config: config "'+configName+'" not found');
                 }
 
-                Object.assign(result, config);
+                merger(self.deepMerge?true:false,result, config);
 
                 result.environment = configName;
             });

diff --git a/package.json b/package.json
@@ -31,7 +31,9 @@
     "url": "https://github.com/ViGo5190/mconf/issues"
   },
   "homepage": "https://github.com/ViGo5190/mconf#readme",
-  "dependencies": {},
+  "dependencies": {
+    "extend": "^3.0.0"
+  },
   "devDependencies": {
     "chai": "^3.5.0",
     "coveralls": "^2.11.6",

diff --git a/test/mconf.js b/test/mconf.js
@@ -163,7 +163,7 @@ describe('services/cache', function () {
         });
 
 
-        it('return really union config', function() {
+        it('return really union config with deep merge', function() {
             mockery.registerMock('../config/production', {
                 foo: "bar",
                 first: {
@@ -182,7 +182,8 @@ describe('services/cache', function () {
             var expectedConfig = {
                 foo: "bar",
                 first: {
-                    name: 'new value'
+                    name: 'new value',
+                    bar: 'foo'
                 },
                 bar: "foo",
                 "environment": "develop"
@@ -191,6 +192,35 @@ describe('services/cache', function () {
             var config = new Config(default_path,default_available_config);
             assert.deepEqual(config.getConfig(), expectedConfig);
         });
+
+        it('return really union config with undeep merge', function() {
+            mockery.registerMock('../config/production', {
+                foo: "bar",
+                first: {
+                    name: 'value',
+                    bar: 'foo'
+                }
+            });
+
+            mockery.registerMock('../config/develop', {
+                bar: "foo",
+                first: {
+                    name: 'new value'
+                }
+            });
+
+            var expectedConfig = {
+                foo: "bar",
+                first: {
+                    name: 'new value'
+                },
+                bar: "foo",
+                "environment": "develop"
+
+            };
+            var config = new Config(default_path,default_available_config);
+            assert.deepEqual(config.setDeepMerge(false).getConfig(), expectedConfig);
+        });
     })
 
 });