Merge pull request #142 from segmentio/jfarah/remove-clone-dep

refactor: remove third party dependency ndhoule/clone and move it inside ajs-core

Author: Julio Farah

HISTORY.md

@@ -1,3 +1,7 @@
+# 3.12.5 / 2020-05-04
+
+- refactor: remove third party dependency ndhoule/clone
+
 # 3.12.4 / 2020-04-23
 
 - test: add add/apply middleware stress test

lib/analytics.js

@@ -17,7 +17,7 @@ var IntegrationMiddlewareChain = require('./middleware')
 var Page = require('segmentio-facade').Page;
 var Track = require('segmentio-facade').Track;
 var bindAll = require('bind-all');
-var clone = require('@ndhoule/clone');
+var clone = require('./utils/clone');
 var extend = require('extend');
 var cookie = require('./cookie');
 var metrics = require('./metrics');

lib/cookie.js

@@ -5,7 +5,7 @@
  */
 
 var bindAll = require('bind-all');
-var clone = require('@ndhoule/clone');
+var clone = require('./utils/clone');
 var cookie = require('@segment/cookie');
 var debug = require('debug')('analytics.js:cookie');
 var defaults = require('@ndhoule/defaults');

lib/entity.js

@@ -4,7 +4,7 @@
  * Module dependencies.
  */
 
-var clone = require('@ndhoule/clone');
+var clone = require('./utils/clone');
 var cookie = require('./cookie');
 var debug = require('debug')('analytics:entity');
 var defaults = require('@ndhoule/defaults');

lib/memory.js

@@ -5,7 +5,7 @@
  */
 
 var bindAll = require('bind-all');
-var clone = require('@ndhoule/clone');
+var clone = require('./utils/clone');
 
 /**
  * HOP.

lib/utils/clone.js

@@ -0,0 +1,70 @@
+'use strict';
+
+var type = require('component-type');
+
+/**
+ * Deeply clone an object.
+ *
+ * @param {*} obj Any object.
+ *
+ * COPYRIGHT: https://github.com/ndhoule/clone/blob/master/LICENSE.md
+ * The MIT License (MIT)
+ * Copyright (c) 2015 Nathan Houle
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+var clone = function clone(obj) {
+  var t = type(obj);
+
+  var copy;
+  if (t === 'object') {
+    copy = {};
+    for (var key in obj) {
+      if (obj.hasOwnProperty(key)) {
+        copy[key] = clone(obj[key]);
+      }
+    }
+    return copy;
+  }
+
+  if (t === 'array') {
+    copy = new Array(obj.length);
+    for (var i = 0, l = obj.length; i < l; i++) {
+      copy[i] = clone(obj[i]);
+    }
+    return copy;
+  }
+
+  if (t === 'regexp') {
+    // from millermedeiros/amd-utils - MIT
+    var flags = '';
+    flags += obj.multiline ? 'm' : '';
+    flags += obj.global ? 'g' : '';
+    flags += obj.ignoreCase ? 'i' : '';
+    return new RegExp(obj.source, flags);
+  }
+
+  if (t === 'date') {
+    return new Date(obj.getTime());
+  }
+
+  // string, number, boolean, etc.
+  return obj;
+};
+
+module.exports = clone;

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@segment/analytics.js-core",
   "author": "Segment <friends@segment.com>",
-  "version": "3.12.4",
+  "version": "3.12.5",
   "description": "The hassle-free way to integrate analytics into any web application.",
   "keywords": [
     "analytics",
@@ -29,7 +29,6 @@
   },
   "homepage": "https://github.com/segmentio/analytics.js-core#readme",
   "dependencies": {
-    "@ndhoule/clone": "^1.0.0",
     "@ndhoule/defaults": "^2.0.1",
     "@ndhoule/each": "^2.0.1",
     "@ndhoule/extend": "^2.0.0",

test/clone.test.js

@@ -0,0 +1,116 @@
+'use strict';
+
+var assert = require('proclaim');
+var clone = require('../lib/utils/clone');
+
+describe('clone', function() {
+  it('should be a function', function() {
+    assert.equal(typeof clone, 'function');
+  });
+
+  it('should have an arity of 1', function() {
+    assert.equal(clone.length, 1);
+  });
+
+  describe('object', function() {
+    it('should return an object with the same contents as the input', function() {
+      var input = { a: 1, b: 2, c: 3 };
+      var cloned = clone(input);
+
+      assert.deepEqual(cloned, input);
+    });
+
+    it('should deeply clone nested objects', function() {
+      var date = new Date();
+      var input = {
+        a: {
+          b: [1, 2, date, { hello: 'world' }]
+        }
+      };
+      var cloned = clone(input);
+
+      assert.deepEqual(cloned, input);
+
+      assert.deepEqual(cloned, input);
+      assert.notStrictEqual(cloned.a, input.a);
+      assert.notStrictEqual(cloned.a.b, input.a.b);
+      assert.notStrictEqual(cloned.a.b[2], input.a.b[2]);
+      assert.strictEqual(cloned.a.b[2].getTime(), input.a.b[2].getTime());
+      assert.deepEqual(cloned.a.b[3], input.a.b[3]);
+      assert.notStrictEqual(cloned.a.b[3], input.a.b[3]);
+    });
+
+    it('object with functions', function() {
+      var func = function() {
+        return 'original';
+      };
+      var input = { func: func };
+      var cloned = clone(input);
+
+      assert.strictEqual(cloned.func, func);
+    });
+  });
+
+  describe('array', function() {
+    it('should return an array with the same contents as the input', function() {
+      var input = [1, 2, 3, '4'];
+      var cloned = clone(input);
+
+      assert.deepEqual(cloned, input);
+    });
+
+    it('should deeply clone nested complex data structures', function() {
+      var input = [{}];
+      var cloned = clone(input);
+
+      assert.notStrictEqual(cloned[0], input[0]);
+      assert.deepEqual(cloned[0], input[0]);
+    });
+
+    it('should return a new array object', function() {
+      var input = [1, 2, 3, '4'];
+      var cloned = clone(input);
+
+      assert.notStrictEqual(cloned, input);
+    });
+  });
+
+  describe('regexp', function() {
+    it('regexp', function() {
+      var input = /hello/i;
+      var cloned = clone(input);
+
+      assert.strictEqual(cloned.toString(), input.toString());
+    });
+
+    it('should return a new regexp object', function() {
+      var input = /hello/i;
+      var cloned = clone(input);
+
+      assert.notStrictEqual(cloned, input);
+    });
+  });
+
+  describe('date', function() {
+    it('should return a date with the same time as the input date', function() {
+      var input = new Date();
+      var cloned = clone(input);
+
+      assert.strictEqual(cloned.getTime(), input.getTime());
+    });
+
+    it('should return a new date object', function() {
+      var input = new Date();
+      var cloned = clone(input);
+
+      assert.notStrictEqual(cloned, input);
+    });
+  });
+
+  describe('other data types', function() {
+    it('should pass other data types through untouched', function() {
+      assert.strictEqual(clone('a'), 'a');
+      assert.strictEqual(clone({ a: 1 }).a, 1);
+    });
+  });
+});