Merge pull request #23 from explore-node-js/master

eugene-matvejev · web-flow · commit 23b1e9f2ca65 · 2018-06-11T08:29:02.000+01:00
sync with main repo
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 [codecov.io-master-badge]: https://codecov.io/gh/explore-node-js/node.js-parameter-handler/branch/master/graph/badge.svg
 [codecov.io-master-link]: https://codecov.io/gh/explore-node-js/node.js-parameter-handler
 
-|                  | master                            
+|                  | master
 |---               |---
 | __tests__        |
 | _< Circle CI >_  | [![build][circle.ci-master-badge]][circle.ci-master-link]
@@ -21,7 +21,7 @@ can be used as config builder, inspired by [@Incenteev/ParameterHandler](https:/
 
 ## used technologies
  * jest _[for tests only]_
- 
+
 ## how to execute tests
  `npm test` or, to execute tests with coverage `npm test -- --coverage`
 
@@ -36,8 +36,18 @@ obverve below sample of _package.json_
     "extra": {
         "node_parameter_handler": [
             {
-                "source": "tests/fixtures/settings.json.dist", # source 
-                "output": "var/settings.json",                 # output
+                "source": "tests/fixtures/settings.json.dist", # source
+                "output": "var/settings1.json",                # output
+                "envMap": {
+                    "touched": "BASE_URL", # json path to ENV VARIABLE
+                    "test.touched": "PWD",
+                    "test.test.touched": "HOME"
+                }
+            },
+            {
+                "source": "tests/fixtures/settings.json.dist", # source
+                "output": "var/settings2.json",                # output
+                "skipUndefined": true,                         # if variable is not defined do not change
                 "envMap": {
                     "touched": "BASE_URL", # json path to ENV VARIABLE
                     "test.touched": "PWD",
diff --git a/circle.yml b/circle.yml
@@ -1,8 +1,10 @@
 machine:
     node:
-        version: 6.9
+        version: 8.11
 
 dependencies:
+    pre:
+        - echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" >> ~/.npmrc
     cache_directories:
         - ~/.npm/
 
@@ -12,3 +14,9 @@ test:
     override:
         - npm test -- --coverage
         - codecov
+
+deployment:
+    production:
+        branch: master
+        commands:
+            - npm publish
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "node-parameter-handler",
-    "version": "1.0.1",
+    "version": "1.0.2",
     "description": "build JSON files which can be used as settings",
     "main": "index.js",
     "repository": {
diff --git a/src/processor.js b/src/processor.js
@@ -14,7 +14,7 @@ module.exports = class Processor {
         this.files = [];
         console.log(chalk.yellow(`>>> PROCESSING FILES`));
 
-        this.config.forEach(config => {
+        this.config.forEach((config) => {
             let file = this.processFile(config);
 
             this.files.push(file);
@@ -28,7 +28,7 @@ module.exports = class Processor {
         this.files.forEach(file => {
             console.log(chalk.green(`>>>>> ${file.getOutputPath()}`));
 
-            fs.writeFile(file.getOutputPath(), JSON.stringify(file.getContent(), null, 2), 'UTF-8')
+            fs.writeFile(file.getOutputPath(), JSON.stringify(file.getContent(), null, 2), 'UTF-8');
         });
     }
 
@@ -37,19 +37,19 @@ module.exports = class Processor {
      *
      * @returns {File}
      */
-    processFile(config) {
+    processFile({source, output, envMap, skipUndefined}) {
         const file = new File();
 
-        const pathSource = this.resolvePath(config.source);
-        const pathOutput = this.resolvePath(config.output);
+        const pathSource = this.resolvePath(source);
+        const pathOutput = this.resolvePath(output);
 
         const packageJsonPath = this.resolvePath(pathSource);
         const packageJsonContent = fs.readFileSync(packageJsonPath);
 
         /** @param {{extra: {}}} content */
         const packageJson = JSON.parse(packageJsonContent);
-        const solvedJson = this.resolveOverwritten(config.envMap);
-        const completedJson = this.constructor.getMergedData(packageJson, solvedJson);
+        const solvedJson = Processor.resolveOverwritten(envMap, skipUndefined);
+        const completedJson = deepmerge(packageJson, solvedJson);
 
         file.setSourcePath(pathSource)
             .setOutputPath(pathOutput)
@@ -69,24 +69,20 @@ module.exports = class Processor {
         return `${this.cwd}/${path}`;
     }
 
-    resolveOverwritten(envMapping) {
-        const object = {};
+    static resolveOverwritten(envMap, skipUndefined) {
+        const obj = {};
 
-        Object.keys(envMapping).forEach(abstractPath => {
-            const envVariable = envMapping[abstractPath];
-            const value = this.constructor.getEnvironmentValue(envVariable);
+        Object.keys(envMap).forEach((abstractPath) => {
+            const envVariable = envMap[abstractPath];
+            const value = Processor.getEnvironmentValue(envVariable);
 
-            undefined !== value && overwriteFieldValue(abstractPath, value, object);
+            (undefined !== value || !skipUndefined) && overwriteFieldValue(abstractPath, value, obj);
         });
 
-        return object;
+        return obj;
     }
 
-    static getEnvironmentValue(index) {
-        return process.env[index] || undefined;
-    }
-
-    static getMergedData(data, overwrittenData) {
-        return deepmerge(data, overwrittenData);
+    static getEnvironmentValue(i) {
+        return process.env[i] || undefined;
     }
 };
diff --git a/tests/__snapshots__/processor.test.js.snap b/tests/__snapshots__/processor.test.js.snap
@@ -0,0 +1,28 @@
+exports[`processor ::process match snapshot 1`] = `
+Array [
+  Object {
+    "test": Object {
+      "test": Object {
+        "touched": undefined,
+        "untouched": "untouched",
+      },
+      "touched": "test",
+      "untouched": "untouched",
+    },
+    "touched": "test",
+    "untouched": "untouched",
+  },
+  Object {
+    "test": Object {
+      "test": Object {
+        "touched": "to be replaced",
+        "untouched": "untouched",
+      },
+      "touched": "to be replaced",
+      "untouched": "untouched",
+    },
+    "touched": "test",
+    "untouched": "untouched",
+  },
+]
+`;
diff --git a/tests/fixtures/package.json b/tests/fixtures/package.json
@@ -3,11 +3,21 @@
         "node_parameter_handler": [
             {
                 "source": "tests/fixtures/settings.json.dist",
-                "output": "var/settings.json",
+                "output": "var/settings1.json",
                 "envMap": {
-                    "touched": "BASE_URL",
-                    "test.touched": "PWD",
-                    "test.test.touched": "HOME"
+                    "touched": "NODE_ENV",
+                    "test.touched": "NODE_ENV",
+                    "test.test.touched": "NODE_ENV_NOT_EXISTS"
+                }
+            },
+            {
+                "source": "tests/fixtures/settings.json.dist",
+                "output": "var/settings2.json",
+                "skipUndefined": true,
+                "envMap": {
+                    "touched": "NODE_ENV",
+                    "test.touched": "NODE_ENV_NOT_EXISTS",
+                    "test.test.touched": "NODE_ENV_NOT_EXISTS"
                 }
             }
         ]
diff --git a/tests/processor.test.js b/tests/processor.test.js
@@ -8,10 +8,32 @@ describe('processor', () => {
     describe('::resolvePath', () => {
         const processor = new Processor(config, cwd);
 
-        [ '/', 'test', 'test/', 'test/test', '/test/test' ].forEach(path => {
+        [ '/', 'test', 'test/', 'test/test', '/test/test' ].forEach((path) => {
             it(`should be converted '${path}' to absolute path`, () => {
                 expect(processor.resolvePath(path)).toMatch(/^\/.*/);
-            })
+            });
         });
-    })
+    });
+
+    describe('::getEnvironmentValue', () => {
+        [
+            { env: 'NODE_ENV', expected: 'test' },
+            { env: 'NODE_ENV_NOT_EXISTS', expected: undefined },
+        ].forEach(({ env, expected }) => {
+            it(`should be return '${expected}' when read value of '${env}' env. variable`, () => {
+                expect(Processor.getEnvironmentValue(env)).toBe(expected);
+            });
+        });
+    });
+
+    describe('::process', () => {
+        const processor = new Processor(config, cwd);
+
+        it(`match snapshot`, () => {
+            processor.process();
+            const content = processor.files.map((el) => el.content);
+
+            expect(content).toMatchSnapshot();
+        });
+    });
 });

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "node-parameter-handler",`
`3`		`- "version": "1.0.1",`
	`3`	`+ "version": "1.0.2",`
`4`	`4`	`"description": "build JSON files which can be used as settings",`
`5`	`5`	`"main": "index.js",`
`6`	`6`	`"repository": {`