dot-object 0.3.0 → 0.6.0

package/.npmignore

@@ -0,0 +1,6 @@
+.*
+*.ts
+ATTIC
+lib
+Gruntfile.js
+node_modules

package/bin/dotob

@@ -0,0 +1,84 @@
+#!/usr/bin/env node
+// vim: set filetype=javascript:
+'use strict';
+
+var glob = require('glob');
+var fs = require('fs');
+
+/**
+ *
+ *  dotob <pattern> -f require -t dependencies.npm
+ *
+ */
+var dotob = require('../index.js')();
+var program = require('commander');
+var pkg = require('../package.json');
+
+program
+  .version(pkg.version)
+  .usage('[options]')
+  .option('-p, --pattern [pattern]', 'Pattern to match')
+  .option('-f, --from [path]', 'From path')
+  .option('-t, --to [path]', 'To path')
+  .option('-m, --merge', 'Merge into target')
+  .option('-v, --verbose', 'Be verbose')
+  .option('-d, --dry', 'Dry run do not modify files')
+  .parse(process.argv);
+
+function must(program, option) {
+  if(!program.hasOwnProperty(option)) {
+    console.log([
+      'The', option, 'is required'
+    ].join(' '));
+    process.exit(1);
+  }
+}
+
+must(program, 'pattern');
+must(program, 'from');
+must(program, 'to');
+
+var g = glob(program.pattern);
+
+function finish(program, file, orig, json) {
+
+  return function(err) {
+    if (err) {
+      throw err;
+    } else {
+      if (program.verbose) {
+        if (JSON.stringify(orig) !== JSON.stringify(json)) {
+          console.log(file + ': updated.');
+        } else {
+          console.log(file + ': no matches.');
+        }
+      }
+    }
+  };
+}
+
+function processFile(file) {
+
+  fs.readFile(file, 'utf8', function(err, contents) {
+    var json, orig;
+    try {
+      orig = JSON.parse(contents);
+      json = JSON.parse(contents);
+      dotob.move(program.from, program.to, json, program.merge);
+      if(program.dry) {
+        console.log(json);
+        finish(program, file, orig, json)();
+      } else {
+        fs.writeFile(file, JSON.stringify(json, null, 2), finish(
+          program, file, orig, json
+        ));
+      }
+    } catch (e) {
+      console.log(file + ': ', e);
+    }
+  });
+}
+
+g.on('match', function(file) {
+  processFile(file);
+});

package/index.js

@@ -2,7 +2,9 @@
 
 function DotObject(seperator, override) {
 
-  if(!(this instanceof DotObject)) return new DotObject(seperator, override);
+  if (!(this instanceof DotObject)) {
+    return new DotObject(seperator, override);
+  }
 
   if (typeof seperator === 'undefined') { seperator = '.'; }
   if (typeof override === 'undefined') { override = false; }
@@ -10,7 +12,7 @@ function DotObject(seperator, override) {
   this.override = override;
 }
 
-DotObject.prototype._fill = function (a, obj, v, mod) {
+DotObject.prototype._fill = function(a, obj, v, mod) {
   var k = a.shift();
 
   if (a.length > 0) {
@@ -20,7 +22,9 @@ DotObject.prototype._fill = function (a, obj, v, mod) {
       if (this.override) {
         obj[k] = {};
       } else {
-        throw new Error('Trying to redefine \'' + k + '\' which is a ' + typeof obj[k]);
+        throw new Error(
+          'Trying to redefine `' + k + '` which is a ' + typeof obj[k]
+        );
       }
     }
 
@@ -34,7 +38,7 @@ DotObject.prototype._fill = function (a, obj, v, mod) {
   }
 };
 
-DotObject.prototype.process = function (v, mod) {
+DotObject.prototype.process = function(v, mod) {
   var i;
 
   if (typeof mod === 'function') {
@@ -48,10 +52,10 @@ DotObject.prototype.process = function (v, mod) {
   return v;
 };
 
-DotObject.prototype.object = function (obj, mods) {
+DotObject.prototype.object = function(obj, mods) {
   var self = this;
 
-  Object.keys(obj).forEach(function (k, i) {
+  Object.keys(obj).forEach(function(k) {
     var mod = mods === undefined ? null : mods[k];
 
     if (k.indexOf(self.seperator) !== -1) {
@@ -63,7 +67,15 @@ DotObject.prototype.object = function (obj, mods) {
   });
 };
 
-DotObject.prototype.str = function (str, v, obj, mod) {
+/**
+ *
+ * @param {String} str
+ * @param {String} v
+ * @param {Object} obj
+ * @param {Function|Array} mod
+ *
+ */
+DotObject.prototype.str = function(str, v, obj, mod) {
   if (str.indexOf(this.seperator) !== -1) {
     this._fill(str.split(this.seperator), obj, v, mod);
   } else if (this.override) {
@@ -81,15 +93,17 @@ DotObject.prototype.str = function (str, v, obj, mod) {
  * @param {Object} obj
  * @param {Boolean} remove
  */
-DotObject.prototype.pick = function (path, obj, remove) {
-  var i, keys, val;
+DotObject.prototype.pick = function(path, obj, remove) {
+  var i;
+  var keys;
+  var val;
 
   if (path.indexOf(this.seperator) !== -1) {
     keys = path.split(this.seperator);
     for (i = 0; i < keys.length; i++) {
-      if(obj.hasOwnProperty(keys[i])) {
-        if(i === (keys.length - 1)) {
-          if(remove) {
+      if (obj.hasOwnProperty(keys[i])) {
+        if (i === (keys.length - 1)) {
+          if (remove) {
             val = obj[keys[i]];
             delete obj[keys[i]];
             return val;
@@ -105,7 +119,7 @@ DotObject.prototype.pick = function (path, obj, remove) {
     }
     return obj;
   } else {
-    if(remove) {
+    if (remove) {
       val = obj[path];
       delete obj[path];
       return val;
@@ -125,11 +139,12 @@ DotObject.prototype.pick = function (path, obj, remove) {
  * @param {String} source
  * @param {String} target
  * @param {Object} obj
+ * @param {Boolean} merge
  *
  */
-DotObject.prototype.move = function (source, target, obj) {
+DotObject.prototype.move = function(source, target, obj, merge) {
 
-  this.set(target, this.pick(source, obj, true), obj);
+  this.set(target, this.pick(source, obj, true), obj, merge);
 
   return obj;
 
@@ -144,44 +159,101 @@ DotObject.prototype.move = function (source, target, obj) {
  *
  * @param {String} source
  * @param {String} target
- * @param {Object} obj
+ * @param {Object} obj1
+ * @param {Object} obj2
+ * @param {Boolean} merge
+ */
+DotObject.prototype.transfer = function(source, target, obj1, obj2, merge) {
+
+  this.set(target, this.pick(source, obj1, true), obj2, merge);
+
+  return obj2;
+
+};
+
+/**
+ *
+ * Copy a property from one object to another object.
+ *
+ * If the source path does not exist (undefined)
+ * the property on the other object will not be set.
  *
+ * @param {String} source
+ * @param {String} target
+ * @param {Object} obj1
+ * @param {Object} obj2
+ * @param {Boolean} merge
  */
-DotObject.prototype.transfer = function (source, target, obj1, obj2) {
+DotObject.prototype.copy = function(source, target, obj1, obj2, merge) {
 
-  this.set(target, this.pick(source, obj1, true), obj2);
+  this.set(target, this.pick(source, obj1, false), obj2, merge);
 
   return obj2;
 
 };
 
+function isObject(val) {
+  return Object.prototype.toString.call(val) === '[object Object]';
+}
+
 /**
  *
  * Set a property on an object using dot notation.
  *
+ * @param {String} path
+ * @param {Mixed} val
+ * @param {Object} obj
+ * @param {Boolean} merge
  */
-DotObject.prototype.set = function (path, val, obj) {
-  var i, keys;
+DotObject.prototype.set = function(path, val, obj, merge) {
+  var i;
+  var k;
+  var keys;
 
   // Do not operate if the value is undefined.
-  if(typeof val === 'undefined') return obj;
+  if (typeof val === 'undefined') {
+    return obj;
+  }
 
   if (path.indexOf(this.seperator) !== -1) {
     keys = path.split(this.seperator);
     for (i = 0; i < keys.length; i++) {
-      if(i === (keys.length - 1)) {
-        obj[keys[i]] = val;
-      } else if(
+      if (i === (keys.length - 1)) {
+        if (merge && isObject(val) && isObject(obj[keys[i]])) {
+          for (k in val) {
+            if (val.hasOwnProperty(k)) {
+              obj[keys[i]][k] = val[k];
+            }
+          }
+
+        } else if (Array.isArray(obj[keys[i]]) && Array.isArray(val)) {
+          for (var j = 0; j < val.length; j++) {
+            obj[keys[i]].push(val[j]);
+          }
+        } else {
+          obj[keys[i]] = val;
+        }
+      } else if (
         // force the value to be an object
         !obj.hasOwnProperty(keys[i]) ||
-        Object.prototype.toString.call(obj[keys[i]]) !== '[object Object]') {
+        !isObject(obj[keys[i]])) {
         obj[keys[i]] = {};
       }
       obj = obj[keys[i]];
     }
     return obj;
   } else {
-    obj[path] = val;
+    if (merge && isObject(val)) {
+      for (k in val) {
+        if (val.hasOwnProperty(k)) {
+          obj[path][k] = val[k];
+        }
+      }
+    } else if (Array.isArray(obj[path]) && Array.isArray(val)) {
+      obj[path].push(val);
+    } else {
+      obj[path] = val;
+    }
     return obj;
   }
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "dot-object",
   "description": "dot-object makes it possible to transform and read (JSON) objects using dot notation.",
-  "version": "0.3.0",
+  "version": "0.6.0",
   "author": {
     "name": "Rob Halff",
     "email": "rob.halff@gmail.com"
@@ -15,16 +15,18 @@
   },
   "main": "index",
   "scripts": {
-    "test": "mocha"
+    "test": "gulp test"
   },
   "devDependencies": {
     "underscore.string": "latest",
     "mocha": "1.x.x",
     "should": "1.x.x",
-    "grunt": "0.x.x",
-    "grunt-release": "0.x.x",
-    "grunt-contrib-watch": "0.x.x",
-    "grunt-shell": "0.x.x"
+    "gulp-jshint": "^1.9.0",
+    "gulp-mocha": "^1.1.1",
+    "gulp": "^3.8.10",
+    "gulp-jscs": "^1.3.0",
+    "jscs": "^1.7.3",
+    "jscs-jsdoc": "0.0.23"
   },
   "keywords": [
     "json",
@@ -32,5 +34,8 @@
     "transform",
     "dot notation",
     "dot"
-  ]
+  ],
+  "dependencies": {
+    "commander": "^2.5.0"
+  }
 }

package/test/dot-json.js

@@ -1,10 +1,12 @@
+'use strict';
+
 require('should');
 var _s = require('underscore.string');
 var DJ = require('../index.js');
 
-describe("Dot Object test:", function () {
+describe('Dot Object test:', function() {
 
-  it("Should Dot object keys", function (done) {
+  it('Should Dot object keys', function() {
 
     var dj = new DJ();
 
@@ -19,26 +21,24 @@ describe("Dot Object test:", function () {
     dj.object(row);
 
     row.should.eql({
-      "id": 2,
-      "contact": {
-        "name": {
-          "first": "John",
-          "last": "Doe"
+      'id': 2,
+      'contact': {
+        'name': {
+          'first': 'John',
+          'last': 'Doe'
         },
-        "email": "example@gmail.com",
-        "info": {
-          "about": {
-            "me": "classified"
+        'email': 'example@gmail.com',
+        'info': {
+          'about': {
+            'me': 'classified'
           }
         }
       }
     });
 
-    done();
-
   });
 
-  it("Should Dot Object a string", function (done) {
+  it('Should Dot Object a string', function() {
 
     var obj = {};
 
@@ -47,38 +47,34 @@ describe("Dot Object test:", function () {
     dj.str('this.is.my.string', 'value', obj);
 
     obj.should.eql({
-      "this": {
-        "is": {
-          "my": {
-            "string": "value"
+      'this': {
+        'is': {
+          'my': {
+            'string': 'value'
           }
         }
       }
     });
 
-    done();
-
   });
 
-  it("DJ.str Redefinition should fail", function (done) {
+  it('DJ.str Redefinition should fail', function() {
 
     var obj = {
       'already': 'set'
     };
 
-    (function () {
+    (function() {
 
       var dj = new DJ();
 
       dj.str('already.new', 'value', obj);
 
-    }).should.throw("Trying to redefine 'already' which is a string");
-
-    done();
+    }).should.throw('Trying to redefine `already` which is a string');
 
   });
 
-  it("DJ.str should process a modifier", function (done) {
+  it('DJ.str should process a modifier', function() {
 
     var obj = {};
 
@@ -87,42 +83,42 @@ describe("Dot Object test:", function () {
     dj.str('this.is.my.string', 'value', obj, _s.capitalize);
 
     obj.should.eql({
-      "this": {
-        "is": {
-          "my": {
-            "string": "Value"
+      'this': {
+        'is': {
+          'my': {
+            'string': 'Value'
           }
         }
       }
     });
 
-    done();
-
   });
 
-  it("DOT.str should process multiple modifiers", function (done) {
+  it('DOT.str should process multiple modifiers', function() {
 
     var obj = {};
 
     var dj = new DJ();
 
-    dj.str('this.is.my.string', '  this is a test   ', obj, [_s.trim, _s.underscored]);
+    dj.str(
+      'this.is.my.string',
+      '  this is a test   ',
+      obj, [_s.trim, _s.underscored]
+    );
 
     obj.should.eql({
-      "this": {
-        "is": {
-          "my": {
-            "string": "this_is_a_test"
+      'this': {
+        'is': {
+          'my': {
+            'string': 'this_is_a_test'
           }
         }
       }
     });
 
-    done();
-
   });
 
-  it("DJ.object should process a modifier", function (done) {
+  it('DJ.object should process a modifier', function() {
 
     var row = {
       'page.title': 'my page',
@@ -130,92 +126,56 @@ describe("Dot Object test:", function () {
     };
 
     var mods = {
-      "page.title": _s.titleize,
-      "page.slug": _s.slugify
+      'page.title': _s.titleize,
+      'page.slug': _s.slugify
     };
 
     var dj = new DJ();
 
     dj.object(row, mods);
 
-    row.should.eql({
-      "page": {
-        "title": "My Page",
-        "slug": "my-page"
-      }
-    });
-
-    done();
+    row.should.eql({'page': {'title': 'My Page', 'slug': 'my-page'}});
 
   });
 
-  it("DJ.object should not process non dot notation value with modifier when DJ.override is false", function (done) {
+  it('should not process non dot value with modifier when override is false',
+    function() {
 
-    var row = {
-      'title': 'my page',
-      'slug': 'My Page'
-    };
+      var row = {'title': 'my page', 'slug': 'My Page'};
 
-    var mods = {
-      "title": _s.titleize,
-      "slug": _s.slugify
-    };
+      var mods = {'title': _s.titleize, 'slug': _s.slugify};
 
-    var dj = new DJ();
-    dj.object(row, mods);
-
-    row.should.eql({
-      "title": "my page",
-      "slug": "My Page"
-    });
+      var dj = new DJ();
+      dj.object(row, mods);
 
-    done();
+      row.should.eql({'title': 'my page', 'slug': 'My Page'});
 
-  });
+    }
+  );
 
-  it("DJ.object should process multiple modifiers", function (done) {
+  it('DJ.object should process multiple modifiers', function() {
 
-    var row = {
-      'page.name': '    My Page    '
-    };
+    var row = {'page.name': '    My Page    '};
 
-    var mods = {
-      "page.name": [_s.trim, _s.underscored]
-    };
+    var mods = {'page.name': [_s.trim, _s.underscored]};
 
     var dj = new DJ();
     dj.object(row, mods);
 
-    row.should.eql({
-      "page": {
-        "name": "my_page"
-      }
-    });
-
-    done();
+    row.should.eql({'page': {'name': 'my_page'}});
 
   });
 
-  it("DJ.object should work with a different seperator", function (done) {
+  it('DJ.object should work with a different seperator', function() {
 
-    var row = {
-      'page=>name': '    My Page    '
-    };
+    var row = {'page=>name': '    My Page    '};
 
-    var mods = {
-      "page=>name": [_s.trim, _s.underscored]
-    };
+    var mods = {'page=>name': [_s.trim, _s.underscored]};
 
-    var dj = new DJ("=>", false);
+    var dj = new DJ('=>', false);
     dj.object(row, mods);
 
-    row.should.eql({
-      "page": {
-        "name": "my_page"
-      }
-    });
-
-    done();
+    row.should.eql({'page': {'name': 'my_page'}});
 
   });
 

package/test/merge.js

@@ -0,0 +1,104 @@
+'use strict';
+
+require('should');
+var dj = require('../index.js')();
+
+describe('Should be able to merge:', function() {
+
+  it('to property', function() {
+
+    var link = {
+      other: {
+        three: 'Three Things',
+        four: 'Four Things'
+      },
+      things: {
+        one: 'One Thing',
+        two: 'Two Things'
+      }
+    };
+
+    var expected = {
+      things: {
+        one: 'One Thing',
+        two: 'Two Things',
+        three: 'Three Things',
+        four: 'Four Things'
+      }
+    };
+
+    dj.move('other',  'things', link, true);
+
+    link.should.eql(expected);
+
+  });
+
+  it('to nested property', function() {
+
+    var link = {
+      other: {
+        three: 'Three Things',
+        four: 'Four Things'
+      },
+      things: {
+        one: 'One Thing',
+        two: 'Two Things',
+        target: {
+          im: 'already here'
+        }
+      }
+    };
+
+    var expected = {
+      things: {
+        one: 'One Thing',
+        two: 'Two Things',
+        target: {
+          im: 'already here',
+          three: 'Three Things',
+          four: 'Four Things'
+        }
+      }
+    };
+
+    dj.move('other',  'things.target', link, true);
+
+    link.should.eql(expected);
+
+  });
+
+  it('array to array', function() {
+
+    var link = {
+      other: [
+        'Three Things',
+        'Four Things'
+      ],
+      things: {
+        one: 'One Thing',
+        two: 'Two Things',
+        target: [
+          'already here'
+        ]
+      }
+    };
+
+    var expected = {
+      things: {
+        one: 'One Thing',
+        two: 'Two Things',
+        target: [
+          'already here',
+          'Three Things',
+          'Four Things'
+        ]
+      }
+    };
+
+    dj.move('other',  'things.target', link, true);
+
+    link.should.eql(expected);
+
+  });
+
+});

package/test/move.js

@@ -1,10 +1,11 @@
+'use strict';
+
 require('should');
-var _s = require('underscore.string');
 var dj = require('../index.js')();
 
-describe("DJ value picker:", function () {
+describe('DJ value picker:', function() {
 
-  it("Should be able to move properties", function (done) {
+  it('Should be able to move properties', function() {
 
     var link = {
       id: '527423a65e380f0000588e47',
@@ -16,8 +17,8 @@ describe("DJ value picker:", function () {
 
     var expected = {
      id: '527423a65e380f0000588e47',
-     source: { id: '526dd5c6b4c4aa8770000001', port: 'github' },
-     target: { id: '527402d6b15d1800008755cf', port: 'in' }
+     source: {id: '526dd5c6b4c4aa8770000001', port: 'github'},
+     target: {id: '527402d6b15d1800008755cf', port: 'in'}
     };
 
     dj.move('source', 'source.id', link);
@@ -27,11 +28,9 @@ describe("DJ value picker:", function () {
 
     link.should.eql(expected);
 
-    done();
-
   });
 
-  it("Undefined properties should be ignored", function (done) {
+  it('Undefined properties should be ignored', function() {
 
     var link = {
       source: '526dd5c6b4c4aa8770000001',
@@ -41,8 +40,8 @@ describe("DJ value picker:", function () {
     };
 
     var expected = {
-     source: { id: '526dd5c6b4c4aa8770000001' },
-     target: { port: 'in' },
+     source: {id: '526dd5c6b4c4aa8770000001'},
+     target: {port: 'in'},
      out: 'github'
     };
 
@@ -53,8 +52,6 @@ describe("DJ value picker:", function () {
 
     link.should.eql(expected);
 
-    done();
-
   });
 
 });

package/test/override.js

@@ -1,11 +1,12 @@
+'use strict';
+
 require('should');
 var _s = require('underscore.string');
 var DJ = require('../index.js');
 
-describe("DJ test:", function () {
-
+describe('DJ test:', function() {
 
-  it("Redefinition should _not_ fail if override is true", function (done) {
+  it('Redefinition should _not_ fail if override is true', function() {
 
     var dj = new DJ('.', true);
 
@@ -17,15 +18,13 @@ describe("DJ test:", function () {
     dj.str('already.new', 'value', obj);
 
     obj.should.eql({
-      "some": "value",
-      "already": { "new": "value" }
+      'some': 'value',
+      'already': {'new': 'value'}
     });
 
-    done();
-
   });
 
-  it("Redefinition should _not_ fail if override is true", function (done) {
+  it('Redefinition should _not_ fail if override is true', function() {
 
     var dj = new DJ('.', true);
 
@@ -38,37 +37,35 @@ describe("DJ test:", function () {
     dj.str('some', 'new_value', obj);
 
     obj.should.eql({
-      "some": "new_value",
-      "already": { "new": "value" }
+      'some': 'new_value',
+      'already': {'new': 'value'}
     });
 
-    done();
-
   });
 
-  it("DJ.object _should_ process non dot notation value with modifier when DJ.override is true", function (done) {
+  it('should process non dot notation value with modifier if override is true',
+    function() {
 
-    var dj = new DJ('.', true);
+      var dj = new DJ('.', true);
 
-    var row = {
-      'title': 'my page',
-      'slug': 'My Page'
-    };
+      var row = {
+        'title': 'my page',
+        'slug': 'My Page'
+      };
 
-    var mods = {
-      "title": _s.titleize,
-      "slug": _s.slugify
-    };
+      var mods = {
+        'title': _s.titleize,
+        'slug': _s.slugify
+      };
 
-    dj.object(row, mods);
+      dj.object(row, mods);
 
-    row.should.eql({
-      "title": "My Page",
-      "slug": "my-page"
-    });
+      row.should.eql({
+        'title': 'My Page',
+        'slug': 'my-page'
+      });
 
-    done();
-
-  });
+    }
+  );
 
 });

package/test/pick.js

@@ -1,10 +1,11 @@
+'use strict';
+
 require('should');
-var _s = require('underscore.string');
 var DJ = require('../index.js');
 
-describe("DJ value picker:", function () {
+describe('DJ value picker:', function() {
 
-  it("Should be able to pick a value", function (done) {
+  it('Should be able to pick a value', function() {
 
     var dj = new DJ('.', true);
 
@@ -17,11 +18,9 @@ describe("DJ value picker:", function () {
 
     val.should.eql('value');
 
-    done();
-
   });
 
-  it("Should be able to pick dotted value", function (done) {
+  it('Should be able to pick dotted value', function() {
 
     var dj = new DJ();
 
@@ -35,8 +34,6 @@ describe("DJ value picker:", function () {
 
     val.should.eql('value');
 
-    done();
-
   });
 
 });