Merge pull request #16 from fastcodejava/master

Modified jsonapter.js, added params support.

Author: au2

README.md

@@ -75,6 +75,7 @@ The following are the list of all keys that have special meaning in template obj
 - [`firstOf`](#firstOf)
 - [`assign`](#assign)
 - [`ignoreDeep`](#ignoreDeep)
+- [`paramKey`](#paramKey)
 
 <a name="dataKey" />
 #### `dataKey` rule
@@ -219,6 +220,23 @@ var r2 = j2j.run(template, {
 console.log(r2); // null
 ```
 
+<a name="paramKey" />
+#### `paramKey` rule
+
+This rule selects a particular property of params, which can be passed as a optional third parameter to the run function as shown below :
+```js
+var template = {
+    paramKey: 'a'
+};
+
+var r0 = j2j.run(template, {}, {
+    a: 1
+});
+console.log(r0); // 1
+
+```
+
+
 <a name="value" />
 #### `value` rule
 
@@ -973,7 +991,7 @@ Each engine instance `j2j` contains all the implementation details as functions
 - `actionKeys`
 - `dataKeyToInput`
 - `dataKeyArrayToInput`
-- `context
+- `context`
 
 `run` is the entry point. `content`, `arrayContent`, `value`, `constant`, `firstOf` and `assign` are called action keys and listed in `actionKeys` array.  Only one of `actionKeys` can appear on a template on the same level.  None of these keys are designed to be overridden except `context`.  However you can add additional functionality by adding new data and action keys.
 

lib/jsonapter.js

@@ -10,30 +10,46 @@ var prototype = {
             return _.get(input, dataKey, null);
         }
     },
-    dataKeyArrayToInput: function (input, dataKeyArray) {
-        var n = dataKeyArray.length;
+    paramKeyToInput: function (input, paramKey, params) {
+        return _.get(params, paramKey, null);
+    },
+    genericKeyArrayToInput: function (input, keyArray, fn) {
+        var n = keyArray.length;
         for (var i = 0; i < n; ++i) {
-            var dataKey = dataKeyArray[i];
-            var inputCandidate = this.dataKeyToInput(input, dataKey);
+            var dataKey = keyArray[i];
+            var inputCandidate = fn(input, dataKey);
             if ((inputCandidate !== null) && (inputCandidate !== undefined)) {
                 return inputCandidate;
             }
         }
         return null;
     },
+    dataKeyArrayToInput: function (input, dataKeyArray) {
+        return this.genericKeyArrayToInput(input, dataKeyArray, this.dataKeyToInput);
+    },
+    paramKeyArrayToInput: function (input, paramKeyArray) {
+        return this.genericKeyArrayToInput(input, paramKeyArray, this.paramKeyToInput);
+    },
     evaluateDataKey: function (input, dataKey) {
         if (Array.isArray(dataKey)) {
             return this.dataKeyArrayToInput(input, dataKey);
         } else {
             return this.dataKeyToInput(input, dataKey);
         }
     },
-    evaluateValue: function (value, input) {
+    evaluateParamKey: function (input, paramKey, params) {
+        if (Array.isArray(paramKey)) {
+            return this.paramKeyArrayToInput(input, paramKey);
+        } else {
+            return this.paramKeyToInput(input, paramKey, params);
+        }
+    },
+    evaluateValue: function (value, input, params) {
         var valueType = (typeof value);
         if (valueType === 'function') {
             return value(input);
         } else if (valueType === 'object') {
-            return this.run(value, input);
+            return this.run(value, input, params);
         } else {
             return value;
         }
@@ -52,14 +68,14 @@ var prototype = {
         }
         return null;
     },
-    content: function (template, input) {
+    content: function (template, input, params) {
         var that = this;
         var content = template.content;
         var hasValue = false;
         var keys = Object.keys(content);
         var result = keys.reduce(function (r, key) {
             var contentValue = template.content[key];
-            var value = that.evaluateValue(contentValue, input);
+            var value = that.evaluateValue(contentValue, input, params);
             if (value !== null) {
                 if (!that.options.pruneValues || !Array.isArray(that.options.pruneValues)) {
                     if (template.ignoreDeep) {
@@ -84,11 +100,11 @@ var prototype = {
         }, {});
         return hasValue ? result : null;
     },
-    arrayContent: function (template, input) {
+    arrayContent: function (template, input, params) {
         var that = this;
         var content = template.arrayContent;
         var result = content.reduce(function (r, e) {
-            var value = that.evaluateValue(e, input);
+            var value = that.evaluateValue(e, input, params);
             if (value !== null) {
                 if (Array.isArray(value)) {
                     Array.prototype.push.apply(r, value);
@@ -100,11 +116,11 @@ var prototype = {
         }, []);
         return result.length ? result : null;
     },
-    assign: function (template, input) {
+    assign: function (template, input, params) {
         var templateAssign = template.assign;
         var that = this;
         var assignValues = templateAssign.reduce(function (r, assignValue) {
-            var v = that.evaluateValue(assignValue, input);
+            var v = that.evaluateValue(assignValue, input, params);
             if ((v !== null) && (typeof v === 'object')) {
                 r.push(v);
             }
@@ -116,11 +132,11 @@ var prototype = {
         var v = _.assign.apply(null, assignValues);
         return v;
     },
-    firstOf: function (template, input) {
+    firstOf: function (template, input, params) {
         var templateFirstOf = template.firstOf;
         for (var i = 0; i < templateFirstOf.length; ++i) {
             var t = templateFirstOf[i];
-            var value = this.evaluateValue(t, input);
+            var value = this.evaluateValue(t, input, params);
             if (value !== null) {
                 return value;
             }
@@ -130,9 +146,9 @@ var prototype = {
     constant: function (template, input) {
         return template.constant;
     },
-    value: function (template, input) {
+    value: function (template, input, params) {
         var templateValue = template.value;
-        return this.evaluateValue(templateValue, input);
+        return this.evaluateValue(templateValue, input, params);
     },
     runForArray: function (template, input) {
         var hasActionKeys = false;
@@ -188,7 +204,7 @@ var prototype = {
         }
         return false;
     },
-    run: function (template, input) {
+    run: function (template, input, params) {
         if (!this.evaluateExistsWhen(template, input)) {
             return null;
         }
@@ -198,6 +214,9 @@ var prototype = {
         if ((input !== null) && (input !== undefined) && template.dataKey) {
             input = this.evaluateDataKey(input, template.dataKey);
         }
+        if ((input !== null) && (input !== undefined) && template.paramKey && params) {
+            input = this.evaluateParamKey(input, template.paramKey, params);
+        }
         if ((input !== null) && template.dataTransform) {
             input = template.dataTransform(input, this.context);
         }
@@ -217,7 +236,7 @@ var prototype = {
             for (var i = 0; i < this.actionKeys.length; ++i) {
                 var actionKey = this.actionKeys[i];
                 if (template.hasOwnProperty(actionKey)) {
-                    result = this[actionKey](template, input);
+                    result = this[actionKey](template, input, params);
                     break;
                 }
             }

package.json

@@ -11,6 +11,9 @@
         "verify": "grunt"
     },
     "author": "Afsin Ustundag <[email protected]>",
+    "contributors": [
+        "Gautam Dev <[email protected]>"
+    ],
     "license": "Apache-2.0",
     "engines": {
         "node": ">= 0.10.0"

test/test-paramKey.js

@@ -0,0 +1,35 @@
+"use strict";
+
+var chai = require('chai');
+
+var json2json = require('../index');
+
+var case_0 = require('./test_cases/case-paramKey-0');
+var case_1 = require('./test_cases/case-paramKey-1');
+
+var params = {timestamp: "2016-08-24T15:38:07-05:00"};
+
+var expect = chai.expect;
+
+describe('paramKey', function () {
+    var engine = json2json.instance();
+
+    it('case-paramKey-0: paramKey ', function () {
+        var template = case_0.template;
+        var n = case_0.inputs.length;
+        for (var i = 0; i < n; ++i) {
+            var actual = engine.run(template, case_0.inputs[i], params);
+            expect(actual).to.deep.equal(case_0.expecteds[i]);
+        }
+    });
+
+    it('case-paramKey-1: paramKey ', function () {
+        var template = case_1.template;
+        var n = case_1.inputs.length;
+        for (var i = 0; i < n; ++i) {
+            var actual = engine.run(template, case_1.inputs[i], params);
+            expect(actual).to.deep.equal(case_1.expecteds[i]);
+        }
+    });
+
+});

test/test_cases/case-paramKey-0.js

@@ -0,0 +1,24 @@
+"use strict";
+
+exports.template = {
+    content: {
+        created : {
+            paramKey: 'timestamp'
+        },
+        updated : {
+            paramKey: 'timestamp'
+        }
+    }
+};
+
+exports.inputs = [];
+exports.expecteds = [];
+
+exports.inputs[0] = {
+};
+
+exports.expecteds[0] = {
+    created: '2016-08-24T15:38:07-05:00',
+    updated: '2016-08-24T15:38:07-05:00'
+};
+

test/test_cases/case-paramKey-1.js

@@ -0,0 +1,25 @@
+"use strict";
+
+exports.template = {
+    arrayContent: [{
+        content : {
+            created: {paramKey: 'timestamp'}
+        }
+    },{
+        content : {
+            updated : { paramKey: 'timestamp'}
+    }}
+    ]
+};
+
+exports.inputs = [];
+exports.expecteds = [];
+
+exports.inputs[0] = {
+};
+
+exports.expecteds[0] = [
+    {created: '2016-08-24T15:38:07-05:00'},
+    {updated: '2016-08-24T15:38:07-05:00'}
+];
+