rambda 8.3.0 → 8.5.0

package/package.json

@@ -1,108 +1,109 @@
 {
-	"name": "rambda",
-	"version": "8.3.0",
-	"scripts": {
-		"benchmark": "cd ../rambda-scripts && RAMBDA_RUN_ALL=ON RAMBDA_RUN_INDEXES=ON yarn benchmark",
-		"benchmark:all": "yarn build:step && cd ../rambda-scripts && yarn benchmark:all",
-		"benchmark:check": "yarn build:step && METHOD=compose yarn benchmark:check:apply",
-		"benchmark:check:apply": "cd ../rambda-scripts && yarn check-benchmark",
-		"build": "yarn build:main && yarn build:web",
-		"build:main": "cross-env NODE_ENV=build rollup -c files/rollup.config.mjs",
-		"build:step": "yarn populatereadme && yarn build:main",
-		"build:web": "cross-env NODE_ENV=build rollup -c files/rollup.web.config.mjs",
-		"d": "yarn out && yarn lint && run d",
-		"docs": "npx docsify-cli init ./docs && yarn fix-docsify",
-		"fix-docsify": "cd ../rambda-scripts && yarn fix-docsify:rambda",
-		"git:add": "git add -A",
-		"github": "cd ../rambda-scripts && yarn github",
-		"immutable": "cd ../rambda-scripts && yarn immutable:rambda",
-		"immutable:x": "cd ../rambda-scripts && yarn immutable:rambdax",
-		"lint": "yarn git:add && yarn lint:staged && yarn git:add",
-		"lint:all": "cd ../rambda-scripts && yarn lint",
-		"lint:staged": "cd ../rambda-scripts && yarn lint:staged",
-		"new": "cd ../rambda-scripts && yarn new",
-		"out": "yarn populatedocs && yarn populatereadme && yarn immutable && yarn build",
-		"populatedocs": "cd ../rambda-scripts && yarn populate:docs",
-		"populatedocs:x": "cd ../rambda-scripts && yarn populate:docs:rambdax",
-		"populatereadme": "cd ../rambda-scripts && yarn populate:readme",
-		"populatereadme:x": "cd ../rambda-scripts && yarn populate:readme:rambdax",
-		"publish:experimental": "node files/publish",
-		"run:ramda:test": "cd ../rambda-scripts && yarn run:ramda:test",
-		"test": "jest -o -u --watch",
-		"test:all": "jest source/*.spec.js -u --bail=false",
-		"test:ci": "jest source/*.spec.js --coverage --no-cache -w 1",
-		"test:typings": "dtslint --localTs ./node_modules/typescript/lib --expectOnly ./source",
-		"usedby": "cd ../rambda-scripts && yarn usedby",
-		"x": "yarn populatedocs:x && yarn populatereadme:x && yarn immutable:x"
-	},
-	"dependencies": {},
-	"devDependencies": {
-		"@babel/core": "7.21.8",
-		"@babel/plugin-proposal-object-rest-spread": "7.20.7",
-		"@babel/preset-env": "7.21.5",
-		"@rollup/plugin-babel": "6.0.3",
-		"@rollup/plugin-commonjs": "25.0.0",
-		"@rollup/plugin-node-resolve": "15.0.2",
-		"@rollup/plugin-replace": "5.0.2",
-		"@types/jest": "29.5.1",
-		"combinate": "1.1.11",
-		"cross-env": "7.0.3",
-		"dtslint": "4.2.1",
-		"fast-check": "^3.11.0",
-		"helpers-fn": "1.8.1",
-		"is-ci": "3.0.1",
-		"jest": "29.5.0",
-		"jest-extended": "3.2.4",
-		"lodash": "4.17.21",
-		"rambdax": "9.1.1",
-		"ramda": "0.29.0",
-		"rollup": "3.22.0",
-		"rollup-plugin-cleanup": "3.2.1",
-		"rollup-plugin-sourcemaps": "0.6.3",
-		"rollup-plugin-uglify": "6.0.4",
-		"types-ramda": "0.29.2",
-		"typescript": "5.0.4"
-	},
-	"jest": {
-		"testEnvironment": "node",
-		"testRegex": ".*\\.(spec|test)\\.js$",
-		"setupFilesAfterEnv": [
-			"./files/testSetup.js"
-		],
-		"collectCoverageFrom": [
-			"source/*.js",
-			"!_internals",
-			"!benchmarks"
-		]
-	},
-	"repository": {
-		"type": "git",
-		"url": "git+https://github.com/selfrefactor/rambda.git"
-	},
-	"license": "MIT",
-	"author": "self_refactor",
-	"description": "Lightweight and faster alternative to Ramda with included TS definitions",
-	"keywords": [
-		"ramda",
-		"fp",
-		"functional",
-		"utility",
-		"lodash"
-	],
-	"homepage": "https://github.com/selfrefactor/rambda#readme",
-	"files": [
-		"dist",
-		"src",
-		"README.md",
-		"CHANGELOG.md",
-		"index.d.ts",
-		"immutable.d.ts",
-		"rambda.js",
-		"immutable.js"
-	],
-	"sideEffects": false,
-	"main": "./dist/rambda.js",
-	"umd": "./dist/rambda.umd.js",
-	"module": "./rambda.js",
-	"types": "./index.d.ts"
+  "name": "rambda",
+  "version": "8.5.0",
+  "scripts": {
+    "benchmark": "cd ../rambda-scripts && RAMBDA_RUN_ALL=ON RAMBDA_RUN_INDEXES=ON yarn benchmark",
+    "benchmark:all": "yarn build:step && cd ../rambda-scripts && yarn benchmark:all",
+    "benchmark:check": "yarn build:step && METHOD=compose yarn benchmark:check:apply",
+    "benchmark:check:apply": "cd ../rambda-scripts && yarn check-benchmark",
+    "build": "yarn build:main && yarn build:web",
+    "build:main": "cross-env NODE_ENV=build rollup -c files/rollup.config.mjs",
+    "build:step": "yarn populatereadme && yarn build:main",
+    "build:web": "cross-env NODE_ENV=build rollup -c files/rollup.web.config.mjs",
+    "d": "yarn out && yarn lint && run d",
+    "docs": "npx docsify-cli init ./docs && yarn fix-docsify",
+    "fix-docsify": "cd ../rambda-scripts && yarn fix-docsify:rambda",
+    "git:add": "git add -A",
+    "github": "cd ../rambda-scripts && yarn github",
+    "immutable": "cd ../rambda-scripts && yarn immutable:rambda",
+    "immutable:x": "cd ../rambda-scripts && yarn immutable:rambdax",
+    "lint": "yarn git:add && yarn lint:staged && yarn git:add",
+    "lint:all": "cd ../rambda-scripts && yarn lint",
+    "lint:staged": "cd ../rambda-scripts && yarn lint:staged",
+    "new": "cd ../rambda-scripts && yarn new",
+    "out": "yarn populatedocs && yarn populatereadme && yarn immutable && yarn build",
+    "before": "yarn out && yarn docs",
+    "populatedocs": "cd ../rambda-scripts && yarn populate:docs",
+    "populatedocs:x": "cd ../rambda-scripts && yarn populate:docs:rambdax",
+    "populatereadme": "cd ../rambda-scripts && yarn populate:readme",
+    "populatereadme:x": "cd ../rambda-scripts && yarn populate:readme:rambdax",
+    "run:ramda:test": "cd ../rambda-scripts && yarn run:ramda:test",
+    "test": "jest -o -u --watch",
+    "test:all": "jest source/*.spec.js -u --bail=false",
+    "test:ci": "jest source/*.spec.js --coverage --no-cache -w 1",
+    "test:typings": "dtslint --localTs ./node_modules/typescript/lib --expectOnly ./source",
+    "ts": "yarn test:typings",
+    "usedby": "cd ../rambda-scripts && yarn usedby",
+    "x": "yarn populatedocs:x && yarn populatereadme:x && yarn immutable:x"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "@babel/core": "7.21.8",
+    "@babel/plugin-proposal-object-rest-spread": "7.20.7",
+    "@babel/preset-env": "7.21.5",
+    "@definitelytyped/dtslint": "0.0.176",
+    "@rollup/plugin-babel": "6.0.3",
+    "@rollup/plugin-commonjs": "25.0.0",
+    "@rollup/plugin-node-resolve": "15.0.2",
+    "@rollup/plugin-replace": "5.0.2",
+    "@types/jest": "29.5.1",
+    "combinate": "1.1.11",
+    "cross-env": "7.0.3",
+    "fast-check": "^3.11.0",
+    "helpers-fn": "1.8.1",
+    "is-ci": "3.0.1",
+    "jest": "29.5.0",
+    "jest-extended": "3.2.4",
+    "lodash": "4.17.21",
+    "rambdax": "9.1.1",
+    "ramda": "0.29.0",
+    "rollup": "3.22.0",
+    "rollup-plugin-cleanup": "3.2.1",
+    "rollup-plugin-sourcemaps": "0.6.3",
+    "rollup-plugin-uglify": "6.0.4",
+    "types-ramda": "0.29.2",
+    "typescript": "5.2.2"
+  },
+  "jest": {
+    "testEnvironment": "node",
+    "testRegex": ".*\\.(spec|test)\\.js$",
+    "setupFilesAfterEnv": [
+      "./files/testSetup.js"
+    ],
+    "collectCoverageFrom": [
+      "source/*.js",
+      "!_internals",
+      "!benchmarks"
+    ]
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/selfrefactor/rambda.git"
+  },
+  "license": "MIT",
+  "author": "self_refactor",
+  "description": "Lightweight and faster alternative to Ramda with included TS definitions",
+  "keywords": [
+    "ramda",
+    "fp",
+    "functional",
+    "utility",
+    "lodash"
+  ],
+  "homepage": "https://github.com/selfrefactor/rambda#readme",
+  "files": [
+    "dist",
+    "src",
+    "README.md",
+    "CHANGELOG.md",
+    "index.d.ts",
+    "immutable.d.ts",
+    "rambda.js",
+    "immutable.js"
+  ],
+  "sideEffects": false,
+  "main": "./dist/rambda.js",
+  "umd": "./dist/rambda.umd.js",
+  "module": "./rambda.js",
+  "types": "./index.d.ts"
 }

package/rambda.js

@@ -45,15 +45,19 @@ export * from './src/descend.js'
 export * from './src/difference.js'
 export * from './src/differenceWith.js'
 export * from './src/dissoc.js'
+export * from './src/dissocPath.js'
 export * from './src/divide.js'
 export * from './src/drop.js'
 export * from './src/dropLast.js'
 export * from './src/dropLastWhile.js'
 export * from './src/dropRepeats.js'
+export * from './src/dropRepeatsBy.js'
 export * from './src/dropRepeatsWith.js'
 export * from './src/dropWhile.js'
 export * from './src/either.js'
+export * from './src/empty.js'
 export * from './src/endsWith.js'
+export * from './src/eqBy.js'
 export * from './src/eqProps.js'
 export * from './src/equals.js'
 export * from './src/evolve.js'
@@ -147,6 +151,7 @@ export * from './src/props.js'
 export * from './src/range.js'
 export * from './src/reduce.js'
 export * from './src/reject.js'
+export * from './src/removeIndex.js'
 export * from './src/repeat.js'
 export * from './src/replace.js'
 export * from './src/reverse.js'

package/src/_internals/compare.js

@@ -0,0 +1,3 @@
+export function compare(a, b){
+  return String(a) === String(b)
+}

package/src/_internals/createPath.js

@@ -1,3 +1,7 @@
+import { isInteger } from './isInteger.js'
+
 export function createPath(path, delimiter = '.'){
-  return typeof path === 'string' ? path.split(delimiter) : path
+  return typeof path === 'string' ?
+    path.split(delimiter).map(x => isInteger(x) ? Number(x) : x) :
+    path
 }

package/src/_internals/createPathInput.js

@@ -0,0 +1,7 @@
+import { isInteger } from './isInteger.js'
+
+export function createPathInput(path){
+  return typeof path === 'string' ?
+    path.split('.').map(x => isInteger(Number(x)) ? Number(x) : x) :
+    path
+}

package/src/_internals/includes.js

@@ -0,0 +1,12 @@
+import { compare } from './compare.js'
+
+export function includes(a, list){
+  let index = -1
+  const { length } = list
+
+  while (++index < length)
+    if (compare(list[ index ], a))
+      return true
+
+  return false
+}

package/src/_internals/isInteger.js

@@ -3,3 +3,8 @@ function _isInteger(n){
 }
 
 export const isInteger = Number.isInteger || _isInteger
+
+/**
+ * Check if `index` is integer even if it is a string.
+ */
+export const isIndexInteger = index => Number.isInteger(Number(index))

package/src/assoc.js

@@ -1,6 +1,6 @@
 import { curry } from './curry.js'
 
-function assocFn(
+export function assocFn(
   prop, newValue, obj
 ){
   return Object.assign(

package/src/assocPath.js

@@ -1,19 +1,15 @@
 import { cloneList } from './_internals/cloneList.js'
+import { createPath } from './_internals/createPath.js'
 import { isArray } from './_internals/isArray.js'
-import { isInteger } from './_internals/isInteger.js'
-import { assoc } from './assoc.js'
+import { isIndexInteger } from './_internals/isInteger.js'
+import { assocFn } from './assoc.js'
 import { curry } from './curry.js'
 
-function assocPathFn(
+export function assocPathFn(
   path, newValue, input
 ){
-  const pathArrValue =
-    typeof path === 'string' ?
-      path.split('.').map(x => isInteger(Number(x)) ? Number(x) : x) :
-      path
-  if (pathArrValue.length === 0){
-    return newValue
-  }
+  const pathArrValue = createPath(path)
+  if (pathArrValue.length === 0) return newValue
 
   const index = pathArrValue[ 0 ]
   if (pathArrValue.length > 1){
@@ -23,7 +19,7 @@ function assocPathFn(
       !input.hasOwnProperty(index)
 
     const nextInput = condition ?
-      isInteger(pathArrValue[ 1 ]) ?
+      isIndexInteger(pathArrValue[ 1 ]) ?
         [] :
         {} :
       input[ index ]
@@ -35,14 +31,14 @@ function assocPathFn(
     )
   }
 
-  if (isInteger(index) && isArray(input)){
+  if (isIndexInteger(index) && isArray(input)){
     const arr = cloneList(input)
     arr[ index ] = newValue
 
     return arr
   }
 
-  return assoc(
+  return assocFn(
     index, newValue, input
   )
 }

package/src/dissocPath.js

@@ -0,0 +1,47 @@
+import { createPath } from '../src/_internals/createPath.js'
+import { isArray } from './_internals/isArray.js'
+import { isIndexInteger } from './_internals/isInteger.js'
+import { omit } from './omit.js'
+import { path } from './path.js'
+import { removeIndex } from './removeIndex.js'
+import { update } from './update.js'
+
+export function dissocPath(pathInput, input){
+  if (arguments.length === 1) return _obj => dissocPath(pathInput, _obj)
+
+  const pathArrValue = createPath(pathInput)
+  // this {...input} spread could be done to satisfy ramda specs, but this is done on so many places
+  // TODO: add warning that Rambda simply returns input if path is empty
+  if (pathArrValue.length === 0) return input
+
+  const pathResult = path(pathArrValue, input)
+  if (pathResult === undefined) return input
+
+  const index = pathArrValue[ 0 ]
+  const condition =
+    typeof input !== 'object' ||
+    input === null ||
+    !input.hasOwnProperty(index)
+  if (pathArrValue.length > 1){
+    const nextInput = condition ?
+      isIndexInteger(pathArrValue[ 1 ]) ?
+        [] :
+        {} :
+      input[ index ]
+    const nextPathInput = Array.prototype.slice.call(pathArrValue, 1)
+    const intermediateResult = dissocPath(
+      nextPathInput, nextInput, input
+    )
+    if (isArray(input)) return update(
+      index, intermediateResult, input
+    )
+
+    return {
+      ...input,
+      [ index ] : intermediateResult,
+    }
+  }
+  if (isArray(input)) return removeIndex(index, input)
+
+  return omit([ index ], input)
+}

package/src/dropRepeatsBy.js

@@ -0,0 +1,21 @@
+import { equals } from './equals.js'
+
+export function dropRepeatsBy(fn, list){
+  if (arguments.length === 1) return _list => dropRepeatsBy(fn, _list)
+
+  let lastEvaluated = null
+
+  return list.slice().filter(item => {
+    if (lastEvaluated === null){
+      lastEvaluated = fn(item)
+
+      return true
+    }
+    const evaluatedResult = fn(item)
+    if (equals(lastEvaluated, evaluatedResult)) return false
+
+    lastEvaluated = evaluatedResult
+
+    return true
+  })
+}

package/src/empty.js

@@ -0,0 +1,15 @@
+import { type } from './type.js'
+
+export function empty(list){
+  if (typeof list === 'string') return ''
+
+  if (Array.isArray(list)){
+    const { name } = list.constructor
+    if (name === 'Uint8Array') return Uint8Array.from('')
+
+    if (name === 'Float32Array') return new Float32Array([])
+
+    return []
+  }
+  if (type(list) === 'Object') return {}
+}

package/src/eqBy.js

@@ -0,0 +1,10 @@
+import { curry } from './curry.js'
+import { equals } from './equals.js'
+
+export function eqByFn(
+  fn, a, b
+){
+  return equals(fn(a), fn(b))
+}
+
+export const eqBy = curry(eqByFn)

package/src/equals.js

@@ -2,43 +2,39 @@ import { isArray } from './_internals/isArray.js'
 import { type } from './type.js'
 
 export function _lastIndexOf(valueToFind, list){
-  if (!isArray(list)){
+  if (!isArray(list))
     throw new Error(`Cannot read property 'indexOf' of ${ list }`)
-  }
+
   const typeOfValue = type(valueToFind)
-  if (![ 'Object', 'Array', 'NaN', 'RegExp' ].includes(typeOfValue))
+  if (![ 'Array', 'NaN', 'Object', 'RegExp' ].includes(typeOfValue))
     return list.lastIndexOf(valueToFind)
 
   const { length } = list
   let index = length
   let foundIndex = -1
 
-  while (--index > -1 && foundIndex === -1){
-    if (equals(list[ index ], valueToFind)){
+  while (--index > -1 && foundIndex === -1)
+    if (equals(list[ index ], valueToFind))
       foundIndex = index
-    }
-  }
 
   return foundIndex
 }
 
 export function _indexOf(valueToFind, list){
-  if (!isArray(list)){
+  if (!isArray(list))
     throw new Error(`Cannot read property 'indexOf' of ${ list }`)
-  }
+
   const typeOfValue = type(valueToFind)
-  if (![ 'Object', 'Array', 'NaN', 'RegExp' ].includes(typeOfValue))
+  if (![ 'Array', 'NaN', 'Object', 'RegExp' ].includes(typeOfValue))
     return list.indexOf(valueToFind)
 
   let index = -1
   let foundIndex = -1
   const { length } = list
 
-  while (++index < length && foundIndex === -1){
-    if (equals(list[ index ], valueToFind)){
+  while (++index < length && foundIndex === -1)
+    if (equals(list[ index ], valueToFind))
       foundIndex = index
-    }
-  }
 
   return foundIndex
 }
@@ -46,17 +42,16 @@ export function _indexOf(valueToFind, list){
 function _arrayFromIterator(iter){
   const list = []
   let next
-  while (!(next = iter.next()).done){
+  while (!(next = iter.next()).done)
     list.push(next.value)
-  }
 
   return list
 }
 
-function _equalsSets(a, b){
-  if (a.size !== b.size){
+function _compareSets(a, b){
+  if (a.size !== b.size)
     return false
-  }
+
   const aList = _arrayFromIterator(a.values())
   const bList = _arrayFromIterator(b.values())
 
@@ -65,11 +60,11 @@ function _equalsSets(a, b){
   return filtered.length === 0
 }
 
-function parseError(maybeError){
-  const typeofError = maybeError.__proto__.toString()
-  if (![ 'Error', 'TypeError' ].includes(typeofError)) return []
+function compareErrors(a, b){
+  if (a.message !== b.message) return false
+  if (a.toString !== b.toString) return false
 
-  return [ typeofError, maybeError.message ]
+  return a.toString() === b.toString()
 }
 
 function parseDate(maybeDate){
@@ -90,40 +85,36 @@ export function equals(a, b){
   const aType = type(a)
 
   if (aType !== type(b)) return false
-  if (aType === 'Function'){
+  if (aType === 'Function')
     return a.name === undefined ? false : a.name === b.name
-  }
 
-  if ([ 'NaN', 'Undefined', 'Null' ].includes(aType)) return true
+  if ([ 'NaN', 'Null', 'Undefined' ].includes(aType)) return true
 
-  if (aType === 'Number'){
+  if ([ 'BigInt', 'Number' ].includes(aType)){
     if (Object.is(-0, a) !== Object.is(-0, b)) return false
 
     return a.toString() === b.toString()
   }
 
-  if ([ 'String', 'Boolean' ].includes(aType)){
+  if ([ 'Boolean', 'String' ].includes(aType))
     return a.toString() === b.toString()
-  }
 
   if (aType === 'Array'){
     const aClone = Array.from(a)
     const bClone = Array.from(b)
 
-    if (aClone.toString() !== bClone.toString()){
+    if (aClone.toString() !== bClone.toString())
       return false
-    }
 
     let loopArrayFlag = true
     aClone.forEach((aCloneInstance, aCloneIndex) => {
-      if (loopArrayFlag){
+      if (loopArrayFlag)
         if (
           aCloneInstance !== bClone[ aCloneIndex ] &&
           !equals(aCloneInstance, bClone[ aCloneIndex ])
-        ){
+        )
           loopArrayFlag = false
-        }
-      }
+
     })
 
     return loopArrayFlag
@@ -132,34 +123,31 @@ export function equals(a, b){
   const aRegex = parseRegex(a)
   const bRegex = parseRegex(b)
 
-  if (aRegex[ 0 ]){
+  if (aRegex[ 0 ])
     return bRegex[ 0 ] ? aRegex[ 1 ] === bRegex[ 1 ] : false
-  } else if (bRegex[ 0 ]) return false
+  else if (bRegex[ 0 ]) return false
 
   const aDate = parseDate(a)
   const bDate = parseDate(b)
 
-  if (aDate[ 0 ]){
+  if (aDate[ 0 ])
     return bDate[ 0 ] ? aDate[ 1 ] === bDate[ 1 ] : false
-  } else if (bDate[ 0 ]) return false
+  else if (bDate[ 0 ]) return false
 
-  const aError = parseError(a)
-  const bError = parseError(b)
+  if (a instanceof Error){
+    if (!(b instanceof Error)) return false
 
-  if (aError[ 0 ]){
-    return bError[ 0 ] ?
-      aError[ 0 ] === bError[ 0 ] && aError[ 1 ] === bError[ 1 ] :
-      false
-  }
-  if (aType === 'Set'){
-    return _equalsSets(a, b)
+    return compareErrors(a, b)
   }
+
+  if (aType === 'Set')
+    return _compareSets(a, b)
+
   if (aType === 'Object'){
     const aKeys = Object.keys(a)
 
-    if (aKeys.length !== Object.keys(b).length){
+    if (aKeys.length !== Object.keys(b).length)
       return false
-    }
 
     let loopObjectFlag = true
     aKeys.forEach(aKeyInstance => {
@@ -167,9 +155,9 @@ export function equals(a, b){
         const aValue = a[ aKeyInstance ]
         const bValue = b[ aKeyInstance ]
 
-        if (aValue !== bValue && !equals(aValue, bValue)){
+        if (aValue !== bValue && !equals(aValue, bValue))
           loopObjectFlag = false
-        }
+
       }
     })