Add Instance.set() dresende#517

Author: dxg

lib/Instance.js

@@ -458,6 +458,39 @@ function Instance(Model, opts) {
 		return false;
 	}
 
+	// ('data.a.b', 5) => opts.data.a.b = 5
+	var setPropertyByPath = function (path, value) {
+		if (typeof path == 'string') {
+			path = path.split('.');
+		} else if (!Array.isArray(path)) {
+			return;
+		}
+
+		var propName = path.shift();
+		var prop = Model.allProperties[propName] || opts.extra[propName];
+		var currKey, currObj;
+
+		if (!prop) {
+			return;
+		}
+		if (path.length == 0) {
+			instance[propName] = value;
+			return;
+		}
+		currObj = instance[propName];
+
+		while(currObj && path.length > 0 ) {
+			currKey = path.shift();
+
+			if (path.length > 0) {
+				currObj = currObj[currKey];
+			} else if (currObj[currKey] !== value) {
+				currObj[currKey] = value;
+				opts.changes.push(propName);
+			}
+		}
+	}
+
 	var addInstanceProperty = function (key) {
 		var defaultValue = null;
 		var prop = Model.allProperties[key];
@@ -619,6 +652,11 @@ function Instance(Model, opts) {
 		enumerable: false,
 		writable: true
 	});
+	Object.defineProperty(instance, "set", {
+		value: setPropertyByPath,
+		enumerable: false,
+		writable: true
+	});
 	Object.defineProperty(instance, "isInstance", {
 		value: true,
 		enumerable: false

test/integration/instance.js

@@ -16,7 +16,8 @@ describe("Model instance", function() {
 				name   : String,
 				age    : { type: 'integer', required: false },
 				height : { type: 'integer', required: false },
-				weight : { type: 'number',  required: false }
+				weight : { type: 'number',  required: false },
+				data   : { type: 'object',  required: false }
 			}, {
 				cache: false,
 				validations: {
@@ -144,6 +145,115 @@ describe("Model instance", function() {
 		});
 	});
 
+	describe("#set", function () {
+		var person = null;
+		var data = null;
+
+		function clone(obj) { return JSON.parse(JSON.stringify(obj)) };
+
+		beforeEach(function (done) {
+			data = {
+				a: {
+					b: {
+						c: 3,
+						d: 4
+					}
+				},
+				e: 5
+			};
+			Person.create({ name: 'Dilbert', data: data }, function (err, p) {
+				if (err) return done(err);
+
+				person = p;
+				done();
+			});
+		});
+
+		it("should do nothing with flat paths when setting to same value", function () {
+			should.equal(person.saved(), true);
+			person.set('name', 'Dilbert');
+			should.equal(person.name, 'Dilbert');
+			should.equal(person.saved(), true);
+		});
+
+		it("should mark as dirty with flat paths when setting to different value", function () {
+			should.equal(person.saved(), true);
+			person.set('name', 'Dogbert');
+			should.equal(person.name, 'Dogbert');
+			should.equal(person.saved(), false);
+			should.equal(person.__opts.changes.join(','), 'name');
+		});
+
+		it("should do nothin with deep paths when setting to same value", function () {
+			should.equal(person.saved(), true);
+			person.set('data.e', 5);
+
+			var expected = clone(data);
+			expected.e = 5;
+
+			should.equal(JSON.stringify(person.data), JSON.stringify(expected));
+			should.equal(person.saved(), true);
+		});
+
+		it("should mark as dirty with deep paths when setting to different value", function () {
+			should.equal(person.saved(), true);
+			person.set('data.e', 6);
+
+			var expected = clone(data);
+			expected.e = 6;
+
+			should.equal(JSON.stringify(person.data), JSON.stringify(expected));
+			should.equal(person.saved(), false);
+			should.equal(person.__opts.changes.join(','), 'data');
+		});
+
+		it("should do nothing with deeper paths when setting to same value", function () {
+			should.equal(person.saved(), true);
+			person.set('data.a.b.d', 4);
+
+			var expected = clone(data);
+			expected.a.b.d = 4;
+
+			should.equal(JSON.stringify(person.data), JSON.stringify(expected));
+			should.equal(person.saved(), true);
+		});
+
+		it("should mark as dirty with deeper paths when setting to different value", function () {
+			should.equal(person.saved(), true);
+			person.set('data.a.b.d', 6);
+
+			var expected = clone(data);
+			expected.a.b.d = 6;
+
+			should.equal(JSON.stringify(person.data), JSON.stringify(expected));
+			should.equal(person.saved(), false);
+			should.equal(person.__opts.changes.join(','), 'data');
+		});
+
+		it("should mark as dirty with array path when setting to different value", function () {
+			should.equal(person.saved(), true);
+			person.set(['data', 'a', 'b', 'd'], 6);
+
+			var expected = clone(data);
+			expected.a.b.d = 6;
+
+			should.equal(JSON.stringify(person.data), JSON.stringify(expected));
+			should.equal(person.saved(), false);
+			should.equal(person.__opts.changes.join(','), 'data');
+		});
+
+		it("should do nothing with invalid paths", function () {
+			should.equal(person.saved(), true);
+			person.set('data.a.b.d.y.z', 1);
+			person.set('data.y.z', 1);
+			person.set('z', 1);
+			person.set(4, 1);
+			person.set(null, 1);
+			person.set(undefined, 1);
+			should.equal(person.saved(), true);
+		});
+	});
+
 	describe("#isShell", function () {
 		it("should return true for shell models", function () {
 			should.equal(Person(4).isShell(), true);