Merge pull request #5 from arshadkazmi42/skipkeys

skip keys handler and eslint support

Author: arshadkazmi42

.eslintrc.json

@@ -0,0 +1,22 @@
+{
+  "env": {
+    "node": true,
+    "mocha": true,
+    "es6": true
+  },
+  "parserOptions": {
+    "arrowFunctions": true,
+    "ecmaFeatures": true,
+    "ecmaVersion": 8,
+    "sourceType": "module"
+  },
+  "extends": "eslint:recommended",
+  "rules": {
+    "indent": ["error", 2],
+    "linebreak-style": ["error", "unix"],
+    "quotes": ["error", "single"],
+    "semi": ["error", "always"],
+    "no-cond-assign": ["error", "always"],
+    "no-console": "off"
+  }
+}

index.js

@@ -5,38 +5,57 @@
  * @param {String} searchValue 
  * @param {String} newValue 
  */
-const jnestedReplace = (input, searchValue, newValue) => {
+const jnestedReplace = (input, searchValue, newValue, skipKeys=[]) => {
 
   // Validate for input, searchValue and newValue
   // throws error if any value is undefined/null
   if (!input || !searchValue || !newValue) {
-    throw 'JSON, searchValue, newValue cannot be null';
+    throw new Error('JSON, searchValue, newValue cannot be null');
+  }
+
+  // If input is not json
+  if (!isObject(input) && !isArray(input)) {
+    throw new Error('Invalid JSON');
   }
 
   // Iterate over the object and find and replace values
   for (let key in input) {
 
     // If type is object, call the same function recursively
-    if (typeof input[key] === 'object') {
-      input[key] = jnestedReplace(input[key], searchValue, newValue);
+    if (isObject(input[key])) {
+      input[key] = jnestedReplace(input[key], searchValue, newValue, skipKeys);
       continue;
     }
 
     // If type is array, call the same function recursively 
     // for every element of array
-    if (typeof input[key] === 'array') {
+    if (isArray(input[key])) {
       for (let i=0; i<input[key].length; i++) {
-        input[key][i] = jnestedReplace(input, searchValue, newValue);
+        input[key][i] = jnestedReplace(input, searchValue, newValue, skipKeys);
       }
       continue;
     }
 
-    // Find and replace the value
-    input[key] = input[key].replace(searchValue, newValue);
+    // If the key needs to be skipped.
+    // Do not process and continue to next element
+    if (skipKeys.indexOf(key) === -1) {
+      input[key] = input[key].replace(searchValue, newValue);
+    }
   }
 
   return input;
-}
+};
+
+
+// Checks if data is an object
+const isObject = (data) => {
+  return data instanceof Object;
+};
+
+// checks if data is an array
+const isArray = (data) => {
+  return data instanceof Array;
+};
 
 
 module.exports = jnestedReplace;

package.json

@@ -4,6 +4,8 @@
   "description": "Searches and replace values at every level of nested json ",
   "main": "index.js",
   "scripts": {
+    "lint": "eslint --ignore-path .gitignore .",
+    "pretest": "eslint --ignore-path .gitignore .",
     "test": "node_modules/mocha/bin/mocha tests/"
   },
   "repository": {
@@ -25,6 +27,8 @@
   "homepage": "https://github.com/arshadkazmi42/json-nested-replace#readme",
   "devDependencies": {
     "chai": "^4.2.0",
-    "mocha": "^5.2.0"
+    "mocha": "^5.2.0",
+    "eslint": "^5.11.1",
+    "eslint-config-strongloop": "^2.1.0"
   }
 }

tests/test.js

@@ -67,22 +67,38 @@ const REPLACE_ARRYA_JSON = {
 
 describe('replace in nested json', () => {
   it('should replace all the occurences in object', () => {
-    const replacedValue = jnestedReplace(INPUT_JSON, 'json-nested-replace', 'jnested-replace')
-    expect(replacedValue).to.deep.equal(REPLACED_JSON)
-  });
-  it('should replace all the occurences in string', () => {
-    const replacedValue = jnestedReplace(INPUT_JSON.name, 'json-nested-replace', 'jnested-replace')
-    expect(replacedValue).to.deep.equal(REPLACED_JSON.name)
+    const replacedValue = jnestedReplace(Object.assign({}, INPUT_JSON), 'json-nested-replace', 'jnested-replace');
+    expect(replacedValue).to.deep.equal(REPLACED_JSON);
   });
   it('should replace all the occurences in object and array', () => {
-    const replacedValue = jnestedReplace(ARRAY_JSON, 'json-nested', 'jnested')
-    expect(replacedValue).to.deep.equal(REPLACE_ARRYA_JSON)
+    const replacedValue = jnestedReplace(Object.assign({}, ARRAY_JSON), 'json-nested', 'jnested');
+    expect(replacedValue).to.deep.equal(REPLACE_ARRYA_JSON);
   });
   it('should throw error of empty input values', () => {
     try {
-      jnestedReplace()
+      jnestedReplace();
+    } catch (err) {
+      expect(err.message).to.equal('JSON, searchValue, newValue cannot be null');
+    }
+  });
+  it('should throw error if input is not json', () => {
+    try {
+      jnestedReplace(INPUT_JSON.name, 'json-nested-replace', 'jnested-replace');
     } catch (err) {
-      expect(err).to.equal('JSON, searchValue, newValue cannot be null');
+      expect(err.message).to.equal('Invalid JSON');
     }
   });
+  it('should skip keys while replacing', () => {
+    const INPUT_JSON = {
+      'name': 'json-nested-replace',
+      'author': 'Arshad Kazmi',
+      'repository': {
+        'url': 'https://github.com/arshadkazmi42/json-nested-replace',
+        'language': 'js'
+      }
+    };
+    const replacedValue = jnestedReplace(Object.assign({}, INPUT_JSON), 'json-nested-replace', 'jnested-replace', ['url']);
+    expect(replacedValue.repository.url).to.equal(INPUT_JSON.repository.url);
+    expect(replacedValue.name).to.be.equal('jnested-replace');
+  });
 });