Merge pull request #17 from jonschlinkert/key-properties

doowb · web-flow · commit e37096858141 · 2021-01-11T10:49:38.000-05:00
Property keys
diff --git a/.travis.yml b/.travis.yml
@@ -17,4 +17,5 @@ node_js:
 matrix:
   fast_finish: true
   allow_failures:
+    - node_js: 'node'
     - node_js: '0.8'
diff --git a/index.js b/index.js
@@ -32,7 +32,7 @@ module.exports = function mergeDeep(orig, objects) {
 
 function merge(target, obj) {
   for (var key in obj) {
-    if (key === '__proto__' || !hasOwn(obj, key)) {
+    if (!isValidKey(key) || !hasOwn(obj, key)) {
       continue;
     }
 
@@ -57,3 +57,7 @@ function hasOwn(obj, key) {
 function isObject(val) {
   return typeOf(val) === 'object' || typeOf(val) === 'function';
 }
+
+function isValidKey(key) {
+  return key !== '__proto__' && key !== 'constructor' && key !== 'prototype';
+}
diff --git a/test.js b/test.js
@@ -134,4 +134,68 @@ describe('mergeDeep', function() {
     var actual = merge(fixture);
     assert.deepEqual(actual, fixture);
   });
+
+  it('should not clone invalid keys', function() {
+    var obj1 = { a: { b: 1 } };
+    var obj2 = JSON.parse('{ "a": { "c": 2 }, "constructor": { "keys": 42 } }');
+
+    var actual = merge({}, obj1, obj2);
+    assert.deepEqual(actual, { a: { b: 1, c: 2 } });
+    assert.notDeepEqual(actual.a, obj1.a);
+    assert.notDeepEqual(actual.a, obj2.a);
+    assert.notEqual(actual.keys, 42);
+    assert.notEqual(actual.constructor.keys, 42);
+  });
+
+  it('should allow being used for custom constructors', function() {
+    // The following setup code is a simple way to demonstrate multiple inheritance by merging the prototype of one class onto another
+    function Shape() {
+      this.type = '';
+    }
+
+    function Position(x, y) {
+      this.x = x || 0;
+      this.y = y || 0;
+    }
+
+    Position.prototype.stringify = function() {
+      return '(' + this.x + ', ' + this.y + ')';
+    };
+
+    function Moveable(x, y) {
+      Position.call(this, x, y);
+    }
+
+    // By making Moveable inherit from Position, allows us to test what happens when `constructor` is passed to `isValidKey`.
+    Moveable.prototype = Object.create(Position.prototype);
+    Moveable.prototype.constructor = Moveable;
+    Moveable.prototype = merge(Moveable.prototype, Position.prototype);
+
+    Moveable.prototype.move = function(x, y) {
+      this.x += x;
+      this.y += y;
+    };
+
+    Moveable.prototype.position = function() {
+      return this.stringify();
+    };
+
+    function Rectangle() {
+      Shape.call(this);
+      Moveable.call(this);
+      this.type = 'rectangle';
+    }
+
+    // Single inheritance using Object.create
+    Rectangle.prototype = Object.create(Shape.prototype);
+    Rectangle.prototype.constructor = Rectangle;
+
+    // This is the test to ensure that `merge-deep` can be used with prototypal inheritance
+    Rectangle.prototype = merge(Rectangle.prototype, Moveable.prototype);
+
+    var rectangle = new Rectangle();
+    assert.equal(rectangle.position(), '(0, 0)');
+    rectangle.move(10, 20);
+    assert.equal(rectangle.position(), '(10, 20)');
+  });
 });

Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ module.exports = function mergeDeep(orig, objects) {`
`32`	`32`
`33`	`33`	`function merge(target, obj) {`
`34`	`34`	`for (var key in obj) {`
`35`		`- if (key === '__proto__' \|\| !hasOwn(obj, key)) {`
	`35`	`+ if (!isValidKey(key) \|\| !hasOwn(obj, key)) {`
`36`	`36`	`continue;`
`37`	`37`	`}`
`38`	`38`
`@@ -57,3 +57,7 @@ function hasOwn(obj, key) {`
`57`	`57`	`function isObject(val) {`
`58`	`58`	`return typeOf(val) === 'object' \|\| typeOf(val) === 'function';`
`59`	`59`	`}`
	`60`	`+`
	`61`	`+function isValidKey(key) {`
	`62`	`+ return key !== '__proto__' && key !== 'constructor' && key !== 'prototype';`
	`63`	`+}`