Merge pull request #4 from jfet97/fix-algo

7.0.0

README.md

@@ -30,7 +30,7 @@ import omniclone from 'omniclone';
 3. let you to clone objects with circular references (customizable behavior)
 4. let you to copy getters and setters, non enumerables properties and also symbols (customizable behavior)
 5. correct handling of String, Boolean, Number, Error, Promise, Map, Set, WeakMap and WeakSet objects
-6. safe similar sibilings references are not duplicated
+6. similar references are not duplicated
 7. correct cloning of Array objects
 8. correct cloning of RegExp and Date objects
 
@@ -151,9 +151,10 @@ const res = omniclone(source, {
 ```
 Odds are that to properly copy gets&setts you have also to enable the `copyNonEnumerables` flag.
 
-### allowCircularReferences (default false)
+### allowCircularReferences (default true)
 Enable it to allow circular references.\
 Disable it to throw an error if one is met.
+Know that `omniclone` is more performing with this flag __enabled__, so disable it only if you really need.
 ```js
 const res = omniclone(source, {
   allowCircularReferences: true
@@ -179,7 +180,7 @@ omniclone(source, {
     copyNonEnumerables : false,
     copySymbols : false,
     copyGettersSetters : false,
-    allowCircularReferences: false,
+    allowCircularReferences: true,
     discardErrorObjects: true,
 });
 ```

__test__/omniclone.test.js

@@ -14,7 +14,7 @@ describe("omniclone", () => {
 
   it(`should set setPrototype to false, invokeConstructors to true, discardErrorObjects to true,
       copyNonEnumerables to false, copySymbols to false, copyGettersSetters to false and
-      allowCircularReferences to false if the config argument is undefined`, () => {
+      allowCircularReferences to true if the config argument is undefined`, () => {
     (() => {
       let i = 0;
       class Test {
@@ -48,7 +48,7 @@ describe("omniclone", () => {
       const ob1 = {};
       ob1.ob1 = ob1;
       omniclone(ob1);
-    }).toThrow(TypeError("TypeError: circular reference found"));
+    }).not.toThrow(TypeError("TypeError: circular reference found"));
 
     (() => {
       class MyError extends Error {}
@@ -544,16 +544,7 @@ describe("omniclone", () => {
       const ob1 = {};
       ob1.ob1 = ob1;
       expect(() => {
-        omniclone(ob1);
-      }).toThrow(TypeError("TypeError: circular reference found"));
-    })();
-
-    (() => {
-      const ob1 = {};
-      const ob2 = { ob1 };
-      ob1.ob2 = ob2;
-      expect(() => {
-        omniclone(ob1);
+        omniclone(ob1, { allowCircularReferences: false });
       }).toThrow(TypeError("TypeError: circular reference found"));
     })();
   });
@@ -572,7 +563,7 @@ describe("omniclone", () => {
       const ob2 = { ob1 };
       ob1.ob2 = ob2;
       expect(() => {
-        omniclone(ob1, { allowCircularReferences: true });
+        omniclone(ob1);
       }).toBeDefined();
     })();
 
@@ -1037,7 +1028,9 @@ describe("omniclone", () => {
       const map = new Map();
       map.set(map, map);
       expect(() => {
-        omniclone(map);
+        omniclone(map, {
+          allowCircularReferences: false
+        });
       }).toThrow(TypeError("TypeError: circular reference found"));
     })();
 
@@ -1335,7 +1328,9 @@ describe("omniclone", () => {
       const set = new Set();
       set.add(set);
       expect(() => {
-        omniclone(set);
+        omniclone(set, {
+          allowCircularReferences: false
+        });
       }).toThrow(TypeError("TypeError: circular reference found"));
     })();
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "omniclone",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "deep cloning function for js objects",
   "main": "dist/main.js",
   "scripts": {

src/deepClone.js

@@ -2,10 +2,10 @@ const updateReferences = require("./updateReferences");
 const propsHandler = require("./propsHandler");
 
 function deepClone(source, config) {
-  // circular references guard
+  // already visited references map
   // each analized object will store its reference here
-  // so we can check each of its object properties to see if there are
-  // reference to already analized objects
+  // so we can check each of its chilren object to see if there are
+  // references to already analized objects
   const references = new WeakMap();
 
   // A reference to the initial source object
@@ -102,13 +102,15 @@ function deepClone(source, config) {
       );
     }
 
+    // each time an object is cloned I update the references map
+    // with its new reference. The object could still have some old circ refs
+    // but I'll handle this later
+    references.set(source, res);
+
     // circular references update from temp old values to new ones
+    // we don't it if allowCircularReferences is false because the previous check
+    // in omniclone.js would have trown an error
     if (allowCircularReferences) {
-      // each time an object is cloned I update the references map
-      // with its new reference. The object could still have some old circ refs
-      // but I'll handle this later
-      references.set(source, res);
-
       if (start === source) {
         // if I've recursively handled all 'virtual' children
         // I've completely updated the references map

src/handlers/mapEntriesHandler.js

@@ -2,8 +2,7 @@ const errorObjectsHandler = require("./errorsObjectsHandler");
 const regexpObjectsHandler = require("./regexpObjectsHanlder");
 const dateObjectsHandler = require("./dateObjectsHandler");
 const primitiveObjectsHandler = require("./primitiveObjectsHandler");
-const circReferencesHelper = require("./../utility/circReferencesHelper");
-const safeReferencesHelper = require("./../utility/safeReferencesHelper");
+const prevReferencesHelper = require("./../utility/prevReferencesHelper");
 
 module.exports = (
   res,
@@ -16,42 +15,17 @@ module.exports = (
 ) => {
   const mapEntries = data;
 
-  const { allowCircularReferences, discardErrorObjects } = config;
+  const { discardErrorObjects } = config;
 
   for (const [key, value] of mapEntries) {
     if (value && typeof value === "object") {
-      // check for duplicated sibiling object references
-      const safeReference = safeReferencesHelper(safeReferences, value);
-      if (safeReference) {
-        res.set(key, safeReference);
+      // check if I've already found this object
+      const prevRef = prevReferencesHelper(references, value);
+      if (prevRef) {
+        res.set(key, prevRef);
         continue;
       }
 
-      // check for circular references
-      const circRef = circReferencesHelper(
-        references,
-        value,
-        allowCircularReferences
-      );
-      if (circRef) {
-        res.set(key, circRef);
-        continue;
-      }
-
-      if (references.has(value)) {
-        if (!allowCircularReferences) {
-          throw new TypeError("TypeError: circular reference found");
-        } else {
-          // if circulary references are allowed
-          // the temporary result is exactly the circ referred object
-          // it could be an 'old' object (map included)
-          // or an already copied object with or without
-          // some 'old' circ references inside it
-          res.set(key, references.get(value));
-          continue;
-        }
-      }
-
       // check discardErrorObjects flag to see how to handle Error objects
       if (value instanceof Error) {
         errorObjectsHandler(discardErrorObjects);

src/handlers/otherObjectsDescriptorsHandler.js

@@ -2,8 +2,7 @@ const errorObjectsHandler = require("./errorsObjectsHandler");
 const regexpObjectsHandler = require("./regexpObjectsHanlder");
 const dateObjectsHandler = require("./dateObjectsHandler");
 const primitiveObjectsHandler = require("./primitiveObjectsHandler");
-const circReferencesHelper = require("./../utility/circReferencesHelper");
-const safeReferencesHelper = require("./../utility/safeReferencesHelper");
+const prevReferencesHelper = require("./../utility/prevReferencesHelper");
 
 module.exports = (
   res,
@@ -20,7 +19,6 @@ module.exports = (
     copyNonEnumerables,
     copySymbols,
     copyGettersSetters,
-    allowCircularReferences,
     discardErrorObjects
   } = config;
 
@@ -44,21 +42,10 @@ module.exports = (
     if (!copyGettersSetters && (descriptor.get || descriptor.set)) return;
 
     if (value && typeof value === "object") {
-      // check for duplicated sibiling object references
-      const safeReference = safeReferencesHelper(safeReferences, value);
-      if (safeReference) {
-        res[prop] = safeReference;
-        return;
-      }
-
-      // check for circular references -
-      const circRef = circReferencesHelper(
-        references,
-        value,
-        allowCircularReferences
-      );
-      if (circRef) {
-        res[prop] = circRef;
+      // check if I've already found this object
+      const prevRef = prevReferencesHelper(references, value);
+      if (prevRef) {
+        res[prop] = prevRef;
         return;
       }
 

src/handlers/setEntriesHandler.js

@@ -2,7 +2,7 @@ const errorObjectsHandler = require("./errorsObjectsHandler");
 const regexpObjectsHandler = require("./regexpObjectsHanlder");
 const dateObjectsHandler = require("./dateObjectsHandler");
 const primitiveObjectsHandler = require("./primitiveObjectsHandler");
-const circReferencesHelper = require("./../utility/circReferencesHelper");
+const prevReferencesHelper = require("./../utility/prevReferencesHelper");
 
 module.exports = (
   res,
@@ -14,20 +14,16 @@ module.exports = (
 ) => {
   const setEntries = data;
 
-  const { allowCircularReferences, discardErrorObjects } = config;
+  const { discardErrorObjects } = config;
 
   // for set key == value
 
   for (const value of setEntries) {
     if (value && typeof value === "object") {
-      // check for circular references
-      const circRef = circReferencesHelper(
-        references,
-        value,
-        allowCircularReferences
-      );
-      if (circRef) {
-        res.add(circRef);
+      // check if I've already found this object
+      const prevRef = prevReferencesHelper(references, value);
+      if (prevRef) {
+        res.add(prevRef);
         continue;
       }
 

src/omniclone.js

@@ -13,7 +13,7 @@ function omniclone(
     copyNonEnumerables = false,
     copySymbols = false,
     copyGettersSetters = false,
-    allowCircularReferences = false,
+    allowCircularReferences = true,
     discardErrorObjects = true
   } = {}
 ) {
@@ -85,7 +85,8 @@ function omniclone(
     // so we have to force the allowCircularReferences if there are not
     const depsMap = createDependenciesMap(obj, copyNonEnumerables, copySymbols);
     // eslint-disable-next-line no-param-reassign
-    allowCircularReferences = checkCircRef(depsMap);
+    if (checkCircRef(depsMap))
+      throw new TypeError("TypeError: circular reference found");
   }
 
   const config = {

src/utility/dependenciesMapHandler.js

@@ -43,7 +43,7 @@ function dependenciesMapHandler(map) {
 }
 
 function checkCircRefs(map) {
-  return !dependenciesMapHandler(map).size;
+  return dependenciesMapHandler(map).size;
 }
 
 module.exports = checkCircRefs;

src/utility/prevReferencesHelper.js

@@ -0,0 +1,8 @@
+module.exports = (references, value) => {
+  if (references.has(value)) {
+    // if I've previously found thid object value
+    // I can return it because I've stored it in the references map
+    return references.get(value); // is an object, that is always a truthy value
+  }
+  return null;
+};