Merge pull request #41 from dictor93/feat/differenceWith-matches-uniq

Feat/difference with matches uniq

Author: vigan-abd

CHANGELOG

@@ -1,3 +1,9 @@
+#1.21.0
+- fix: cloneDeep should not skip nonserializable entities
+- feat: add uniq
+- feat: add differenceWith
+- feat: add matches
+
 #1.20.0
 - feat: add transformKeysToSnake
 - feat: add sample

README.md

@@ -9,6 +9,7 @@ Currently supported utils:
 - `clone` - Shallow clone the object
 - `cloneDeep` - deep clone functionality for objects
 - `difference` - creates an array of values from the first argument not included in the second argument
+- `differenceWith` - creates an array of values from the first argument not included in the second one using comparator function
 - `findLastIndex` - Returns the index of the last element in the array that satisfies the provided testing function.
 - `flow` - generate a composite function that returns the result of provided functions called by the chain; each previous function result passes as the argument of the next function in the chain
 - `freezeDeep` - deep freezes objects
@@ -31,6 +32,7 @@ Currently supported utils:
 - `isUndefined` - checks if an input is undefined
 - `mapKeys` - creates new object with the same values but with keys mapped by the provided function
 - `mapValues` - Maps the values of an object or array using the provided iteratee function or property path
+- `matches` - creates a function that makes a deep partial comparison on a given object with the source
 - `max` - computes the maximum value of array. If array is empty or falsey, undefined is returned
 - `mean` - Returns the mean of an array of numbers
 - `merge` - deep merge functionality for objects
@@ -47,8 +49,10 @@ Currently supported utils:
 - `sumBy` - calculate sum of array items using iteratee function or string shortcut
 - `transformKeysToSnake` - transform every object key to snake case with option to be recursive
 - `union` - Returns the union of the given arrays
+- `uniq` - Returns unique values of the array
 - `uniqBy` - get unique values of array by the iteratee function or property path
 - `uniqWith` - Returns a new array with unique values, using a comparator function
+- `unset` - Remove a property by the path in any depth, returns true if succeed, false otherwise
 - `update` - Update the object with the updater by path
 - `validateInput` - validates the input based on the regex format options: `NUMBER | EMAIL | PATH | NAME | NAME_WITH_DIGITS | INPUT | ADDRESS | PHONE_CODE | PHONE | IMAGE | FILE | FILENAME | PASSWORD`
 - `without` - creates an array of values from the first argument excluding all given arguments

index.d.ts

@@ -4,6 +4,7 @@ export function capitalize (str: string): string
 export function clone (obj: Object): Object
 export function cloneDeep (obj: Object): Object
 export function difference (array: Array<any>, values: Array<any>): Array<any>
+export function differenceWith (array: Array<any>, items: Array<any>, comparator: Function): Array<any>
 export function findLastIndex (array: Array<any>, predicate: Function): number
 export function flow (funcs: Array<Function>): Function
 export function freezeDeep (obj: Object): Object
@@ -27,6 +28,7 @@ export function isString (val: any): boolean
 export function isUndefined (val: any): boolean
 export function mapKeys(obj: Object, mapper: (val: any, key: string) => string): Object
 export function mapValues(obj: Object, mapper: (val: any, key: string) => any): Object
+export function matches(src: Object): (obj: Object) => boolean
 export function max (array: Array<any>): any
 export function mean (values: Array<number>): number
 export function merge (obj: Object, ...sources: Object[]): Object
@@ -43,8 +45,10 @@ export function sum (values: Array<string>): number
 export function sumBy (values: Array, iteratee: Function | string): number
 export function transformKeysToSnake (obj: Object, opts?: {recursive?: boolean}) : Object
 export function union (...arrays: Array[]): Array
+export function uniq (array: Array): Array
 export function uniqBy (array: Array, iteratee: Function | string): Array
 export function uniqWith (array: Array, comparator: Function): Array
+export function unset(object: Object, path: string | Array<string | number>): boolean
 export function update (obj: Object, path: string | Array<string | number>, updater: Function): Object
 export function validateInput ( input: string, format: 'NUMBER' | 'EMAIL' | 'PATH' | 'NAME' | 'NAME_WITH_DIGITS' | 'INPUT' | 'ADDRESS' | 'PHONE_CODE' | 'PHONE' | 'IMAGE' | 'FILE' | 'FILENAME' | 'PASSWORD' | 'URL' ): Boolean
 export function without (array: Array, ...values: Array): Array

index.js

@@ -6,15 +6,16 @@ const capitalize = require('./src/capitalize')
 const clone = require('./src/clone')
 const cloneDeep = require('./src/cloneDeep')
 const difference = require('./src/difference')
+const differenceWith = require('./src/differenceWith')
 const findLastIndex = require('./src/findLastIndex')
 const flow = require('./src/flow')
 const freezeDeep = require('./src/freezeDeep')
 const get = require('./src/get')
 const getArrayHasIntersect = require('./src/getArrayHasIntersect')
 const getArrayUniq = require('./src/getArrayUniq')
 const getErrorMessage = require('./src/getErrorMessage')
-const invert = require('./src/invert')
 const groupBy = require('./src/groupBy')
+const invert = require('./src/invert')
 const isEmpty = require('./src/isEmpty')
 const isEqual = require('./src/isEqual')
 const isFinite = require('./src/isFinite')
@@ -29,6 +30,7 @@ const isString = require('./src/isString')
 const isUndefined = require('./src/isUndefined')
 const mapKeys = require('./src/mapKeys')
 const mapValues = require('./src/mapValues')
+const matches = require('./src/matches')
 const max = require('./src/max')
 const mean = require('./src/mean')
 const merge = require('./src/merge')
@@ -45,12 +47,13 @@ const sum = require('./src/sum')
 const sumBy = require('./src/sumBy')
 const transformKeysToSnake = require('./src/transformKeysToSnake')
 const union = require('./src/union')
+const uniq = require('./src/uniq')
 const uniqBy = require('./src/uniqBy')
 const uniqWith = require('./src/uniqWith')
+const unset = require('./src/unset')
 const update = require('./src/update')
 const validateInput = require('./src/validateInput')
 const without = require('./src/without')
-const unset = require('./src/unset')
 
 module.exports = {
   assignInWith,
@@ -59,15 +62,16 @@ module.exports = {
   clone,
   cloneDeep,
   difference,
+  differenceWith,
   findLastIndex,
   flow,
   freezeDeep,
   get,
   getArrayHasIntersect,
   getArrayUniq,
   getErrorMessage,
-  invert,
   groupBy,
+  invert,
   isEmpty,
   isEqual,
   isFinite,
@@ -82,6 +86,7 @@ module.exports = {
   isUndefined,
   mapKeys,
   mapValues,
+  matches,
   max,
   mean,
   merge,
@@ -98,10 +103,11 @@ module.exports = {
   sumBy,
   transformKeysToSnake,
   union,
+  uniq,
   uniqBy,
   uniqWith,
+  unset,
   update,
   validateInput,
-  without,
-  unset
+  without
 }

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@bitfinexcom/lib-js-util-base",
-  "version": "1.20.0",
+  "version": "1.21.0",
   "description": "general utils",
   "main": "index.js",
   "scripts": {

package.json

@@ -1,16 +1,46 @@
+/* eslint-disable no-prototype-builtins */
+
 'use strict'
 
 const isObject = require('./isObject')
 
-const cloneDeep = (obj) => {
-  if (obj instanceof Function) {
-    return {}
+const cloneDeep = (obj, clones = new WeakMap()) => {
+  if (obj instanceof Function) return {}
+  if (!isObject(obj)) return obj
+
+  if (clones.has(obj)) return clones.get(obj)
+  if (obj instanceof Date) return new Date(obj.getTime())
+  if (obj instanceof RegExp) return new RegExp(obj)
+  if (obj instanceof Map) {
+    const newMap = new Map()
+    clones.set(obj, newMap)
+    obj.forEach((value, key) => {
+      newMap.set(cloneDeep(key, clones), cloneDeep(value, clones))
+    })
+    return newMap
+  }
+  if (obj instanceof Set) {
+    const newSet = new Set()
+    clones.set(obj, newSet)
+    obj.forEach(value => {
+      newSet.add(cloneDeep(value, clones))
+    })
+    return newSet
   }
-  if (!isObject(obj)) {
-    return obj
+  if (Buffer.isBuffer(obj)) return Buffer.from(obj)
+  if (ArrayBuffer.isView(obj) && !(obj instanceof DataView)) {
+    return new obj.constructor(obj)
+  }
+
+  const clonedObj = Array.isArray(obj) ? [] : Object.create(Object.getPrototypeOf(obj))
+  clones.set(obj, clonedObj)
+  Object.defineProperties(clonedObj, Object.getOwnPropertyDescriptors(obj))
+
+  for (const key of Object.keys(clonedObj)) {
+    clonedObj[key] = cloneDeep(clonedObj[key], clones)
   }
 
-  return JSON.parse(JSON.stringify(obj))
+  return clonedObj
 }
 
 module.exports = cloneDeep

src/cloneDeep.js

@@ -0,0 +1,31 @@
+'use strict'
+
+/**
+ * @callback IComparator
+ * @param {any} attrItem
+ * @param {any} valuesItem
+ * @returns {boolean}
+ */
+
+/**
+ * Returns the elements of `array` that are not present in other array
+ * using a comparator function or strict equality.
+ *
+ * @param {Array<any>} arr
+ * @param {Array<any>} items
+ * @param {IComparator} comparator
+ * @returns
+ */
+const differenceWith = (arr, items, comparator) => {
+  if (!Array.isArray(arr)) {
+    return []
+  }
+  if (!Array.isArray(items) || items.length === 0) {
+    return arr
+  }
+  const _comparator = typeof comparator !== 'function' ? (arrItem, valuesItem) => arrItem === valuesItem : comparator
+
+  return arr.filter(el => !items.find(value => _comparator(el, value)))
+}
+
+module.exports = differenceWith

src/differenceWith.js

@@ -0,0 +1,15 @@
+'use strict'
+
+const isMatch = require('./isMatch')
+
+/**
+ * Generates a function that makes a deep partial comparison on a given object with the source
+ *
+ * @param {object} src
+ * @returns {boolean}
+ */
+const matches = (src) => (obj) => {
+  return isMatch(obj, src)
+}
+
+module.exports = matches

src/matches.js

@@ -0,0 +1,13 @@
+'use strict'
+
+/**
+ * Returns a new array with unique values from the argument array using strict equality.
+ *
+ * @param {array<T>} array
+ * @returns {array<T>}
+ */
+const uniq = (array) => {
+  return Array.from(new Set(array))
+}
+
+module.exports = uniq