@sepiariver/unique-set 1.0.0 → 1.1.0

package/README.md

@@ -1,5 +1,10 @@
 # @sepiariver/unique-set
-Extends the add method on the native JavaScript Set object to compare using fast-deep-equal
+
+Extends the `has` and `add` methods on the native JavaScript `Set` object to use [fast-deep-equal](https://www.npmjs.com/package/fast-deep-equal) as the equality algorithm.
+
+The extended methods iterate through the elements of the `UniqueSet` until equality is found. If no elements match, the entire `UniqueSet` would have been iterated to determine so. However fast `fast-deep-equal` is, calling it in a loop like this makes performance many times poorer than the native `Set`. For datasets greater than a thousand elements, there is probably a better way to achieve what you're trying to do. Otherwise, `UniqueSet` is convenient.
+
+Requires @babel/core 7+
 
 ## Installation
 
@@ -7,7 +12,7 @@ Extends the add method on the native JavaScript Set object to compare using fast
 npm install @sepiariver/unique-set
 ```
 
-### Usage
+## Usage
 
 ```js
 const UniqueSet = require('@sepiariver/unique-set');
@@ -33,14 +38,21 @@ const data = [
   [1, 2, 3],
 ];
 
-let common = new Set();
-data.forEach((el) => {
-  common.add(el);
-});
-console.log(common);
-
-let unique = new UniqueSet();
+let unique1 = new UniqueSet();
 data.forEach((el) => {
-  unique.add(el);
+  unique1.add(el);
 });
+let unique2 = new UniqueSet(data);
+console.log(unique1.size); // 6 instead of 8 with Set
+console.log(unique2.size); // 6
 ```
+
+## Testing
+
+1. Clone this repo
+2. `npm install`
+3. `npm run test`
+
+## Contributing
+
+Submit pull requests to https://github.com/sepiariver/unique-set/pulls

package/dist/index.js

@@ -0,0 +1,90 @@
+"use strict";
+
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+
+var _fastDeepEqual = _interopRequireDefault(require("fast-deep-equal"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+
+function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it["return"] != null) it["return"](); } finally { if (didErr) throw err; } } }; }
+
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
+
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
+
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+
+function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); Object.defineProperty(subClass, "prototype", { writable: false }); if (superClass) _setPrototypeOf(subClass, superClass); }
+
+function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }
+
+function _possibleConstructorReturn(self, call) { if (call && (_typeof(call) === "object" || typeof call === "function")) { return call; } else if (call !== void 0) { throw new TypeError("Derived constructors may only return object or undefined"); } return _assertThisInitialized(self); }
+
+function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }
+
+function _wrapNativeSuper(Class) { var _cache = typeof Map === "function" ? new Map() : undefined; _wrapNativeSuper = function _wrapNativeSuper(Class) { if (Class === null || !_isNativeFunction(Class)) return Class; if (typeof Class !== "function") { throw new TypeError("Super expression must either be null or a function"); } if (typeof _cache !== "undefined") { if (_cache.has(Class)) return _cache.get(Class); _cache.set(Class, Wrapper); } function Wrapper() { return _construct(Class, arguments, _getPrototypeOf(this).constructor); } Wrapper.prototype = Object.create(Class.prototype, { constructor: { value: Wrapper, enumerable: false, writable: true, configurable: true } }); return _setPrototypeOf(Wrapper, Class); }; return _wrapNativeSuper(Class); }
+
+function _construct(Parent, args, Class) { if (_isNativeReflectConstruct()) { _construct = Reflect.construct; } else { _construct = function _construct(Parent, args, Class) { var a = [null]; a.push.apply(a, args); var Constructor = Function.bind.apply(Parent, a); var instance = new Constructor(); if (Class) _setPrototypeOf(instance, Class.prototype); return instance; }; } return _construct.apply(null, arguments); }
+
+function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
+
+function _isNativeFunction(fn) { return Function.toString.call(fn).indexOf("[native code]") !== -1; }
+
+function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }
+
+function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }
+
+var UniqueSet = /*#__PURE__*/function (_Set) {
+  _inherits(UniqueSet, _Set);
+
+  var _super = _createSuper(UniqueSet);
+
+  function UniqueSet() {
+    _classCallCheck(this, UniqueSet);
+
+    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+      args[_key] = arguments[_key];
+    }
+
+    return _super.call.apply(_super, [this].concat(args));
+  }
+
+  _createClass(UniqueSet, [{
+    key: "has",
+    value: function has(o) {
+      var _iterator = _createForOfIteratorHelper(this),
+          _step;
+
+      try {
+        for (_iterator.s(); !(_step = _iterator.n()).done;) {
+          var i = _step.value;
+
+          if ((0, _fastDeepEqual["default"])(o, i)) {
+            return true;
+          }
+        }
+      } catch (err) {
+        _iterator.e(err);
+      } finally {
+        _iterator.f();
+      }
+
+      return false;
+    }
+  }, {
+    key: "add",
+    value: function add(o) {
+      if (!this.has(o)) {
+        Set.prototype.add.call(this, o);
+      }
+    }
+  }]);
+
+  return UniqueSet;
+}( /*#__PURE__*/_wrapNativeSuper(Set));
+
+module.exports = UniqueSet;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sepiariver/unique-set",
-  "version": "1.0.0",
-  "description": "Extends the add method on the native JavaScript Set object to compare using fast-deep-equal",
+  "version": "1.1.0",
+  "description": "Extends the has and add methods on the native JavaScript Set object to deeply compare using fast-deep-equal",
   "main": "index.js",
   "scripts": {
     "test": "jest",

package/src/index.js

@@ -1,21 +1,22 @@
 import equal from "fast-deep-equal";
 
 class UniqueSet extends Set {
-  constructor() {
-    super();
+  constructor(...args) {
+    super(...args);
   }
-  add(o) {
-    let isUnique = true;
-    for (let i of this) {
+  has(o) {
+    for (const i of this) {
       if (equal(o, i)) {
-        isUnique = false;
-        break;
+        return true;
       }
     }
-    if (isUnique) {
+    return false;
+  }
+  add(o) {
+    if (!this.has(o)) {
       Set.prototype.add.call(this, o);
     }
   }
 }
 
-module.exports = UniqueSet;
+module.exports = UniqueSet;

package/.babelrc

@@ -1,5 +0,0 @@
-{
-    "presets": [
-        "@babel/preset-env"
-    ]
-}

package/babel.config.js

@@ -1,3 +0,0 @@
-module.exports = {
-  presets: [["@babel/preset-env", { targets: { node: "current" } }]],
-};

package/test/basic.spec.js

@@ -1,71 +0,0 @@
-import UniqueSet from "../dist";
-
-describe("UniqueSet", () => {
-  it("adds unique objects", () => {
-    const data = [
-      "string",
-      "another string",
-      "string",
-      1,
-      2,
-      1,
-      {
-        foo: "bar",
-        bar: "baz",
-        baz: "lurman",
-      },
-      {
-        bar: "baz",
-        baz: "lurman",
-        foo: "bar",
-      },
-      [1, 2, 3],
-      [1, 2, 3],
-    ];
-
-    const expected = [
-      "string",
-      "another string",
-      1,
-      2,
-      {
-        foo: "bar",
-        bar: "baz",
-        baz: "lurman",
-      },
-      [1, 2, 3],
-    ];
-
-    let unique = new UniqueSet();
-    data.forEach((el) => {
-      unique.add(el);
-    });
-    expect(expected).toEqual(Array.from(unique));
-    expect(unique.size).toBe(6);
-  });
-
-  it("complies with MDN reference", () => {
-    const mySet1 = new UniqueSet();
-
-    mySet1.add(1); // Set [ 1 ]
-    mySet1.add(5); // Set [ 1, 5 ]
-    mySet1.add(5); // Set [ 1, 5 ]
-    mySet1.add("some text"); // Set [ 1, 5, 'some text' ]
-    const o = { a: 1, b: 2 };
-    mySet1.add(o);
-
-    mySet1.add({ a: 1, b: 2 }); // o is referencing a different object, we treat this differently
-
-    expect(mySet1.has(1)).toBeTruthy();
-    expect(mySet1.has(3)).toBeFalsy();
-    expect(mySet1.has(5)).toBeTruthy();
-    expect(mySet1.has(Math.sqrt(25))).toBeTruthy();
-    expect(mySet1.has("Some Text".toLowerCase())).toBeTruthy();
-    expect(mySet1.has(o)).toBeTruthy();
-    expect(mySet1.size).toBe(4); // unique
-
-    mySet1.delete(5); // removes 5 from the set
-    expect(mySet1.has(5)).toBeFalsy();
-    expect(mySet1.size).toBe(3);
-  });
-});