ramda-adjunct 3.3.0 → 4.0.0

package/lib/trunc.js

@@ -2,16 +2,12 @@
 
 exports.__esModule = true;
 exports.truncPonyfill = exports["default"] = void 0;
-
 var _ramda = require("ramda");
-
 var _Math = _interopRequireDefault(require("./internal/ponyfills/Math.trunc"));
-
 var _isFunction = _interopRequireDefault(require("./isFunction"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-
 var truncPonyfill = (0, _ramda.curryN)(1, _Math["default"]);
+
 /**
  * Returns the integer part of a number by removing any fractional digits.
  *
@@ -32,7 +28,6 @@ var truncPonyfill = (0, _ramda.curryN)(1, _Math["default"]);
  * RA.trunc(NaN); //=> NaN
  * RA.trunc('foo'); //=> NaN
  */
-
 exports.truncPonyfill = truncPonyfill;
 var trunc = (0, _isFunction["default"])(Math.trunc) ? (0, _ramda.curryN)(1, (0, _ramda.bind)(Math.trunc, Math)) : truncPonyfill;
 var _default = trunc;

package/lib/unzipObjWith.js

@@ -2,13 +2,9 @@
 
 exports.__esModule = true;
 exports["default"] = void 0;
-
 var _ramda = require("ramda");
-
 var _lengthEq = _interopRequireDefault(require("./lengthEq"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-
 /**
  * Creates a new list out of the supplied object by applying the function to each key/value pairing.
  *

package/lib/viewOr.js

@@ -2,9 +2,7 @@
 
 exports.__esModule = true;
 exports["default"] = void 0;
-
 var _ramda = require("ramda");
-
 /**
  * Returns a "view" of the given data structure, determined by the given lens.
  * The lens's focus determines which portion of the data structure is visible.
@@ -29,6 +27,7 @@ var _ramda = require("ramda");
  * RA.viewOr('some', R.lensProp('y'), { y: null }); // => 'some'
  * RA.viewOr('some', R.lensProp('y'), { y: false }); // => false
  */
+
 var viewOr = (0, _ramda.curryN)(3, function (defaultValue, lens, data) {
   return (0, _ramda.defaultTo)(defaultValue, (0, _ramda.view)(lens, data));
 });

package/lib/weave.js

@@ -2,9 +2,7 @@
 
 exports.__esModule = true;
 exports["default"] = void 0;
-
 var _ramda = require("ramda");
-
 /**
  * Weaves a configuration into function returning the runnable monad like `Reader` or `Free`.
  * This allows us to pre-bind the configuration in advance and use the weaved function

package/lib/weaveLazy.js

@@ -2,9 +2,7 @@
 
 exports.__esModule = true;
 exports["default"] = void 0;
-
 var _ramda = require("ramda");
-
 /**
  * Weaves a configuration into function returning the runnable monad like `Reader` or `Free`.
  * This allows us to pre-bind the configuration in advance and use the weaved function

package/lib/zipObjWith.js

@@ -2,9 +2,7 @@
 
 exports.__esModule = true;
 exports["default"] = void 0;
-
 var _ramda = require("ramda");
-
 /**
  * Creates a new object out of a list of keys and a list of values by applying the function
  * to each equally-positioned pair in the lists.

package/package.json

@@ -14,7 +14,7 @@
     "cookbook",
     "functional"
   ],
-  "version": "3.3.0",
+  "version": "4.0.0",
   "homepage": "https://github.com/char0n/ramda-adjunct",
   "license": "BSD-3-Clause",
   "repository": {
@@ -70,7 +70,7 @@
     "test": "better-npm-run test",
     "test:web": "better-npm-run test:web",
     "test:ramda": "bnr test:ramda",
-    "test:types": "dtslint ./types",
+    "test:types": "eslint --no-eslintrc --no-ignore -c ./types/dtslint.eslint.js ./types/test/*.ts",
     "test:bundle-create": "better-npm-run test:bundle-create",
     "test:bundle-clean": "better-npm-run test:bundle-clean",
     "coverage": "better-npm-run coverage",
@@ -83,8 +83,8 @@
   },
   "betterScripts": {
     "docs": "jsdoc -c jsdoc.json && node ./scripts/jsdoc-inject-dist.js",
-    "lint": "eslint ./ && tslint --project types/tsconfig.json -c types/tslint.json types/**/*.ts",
-    "lint:fix": "eslint ./ --fix && tslint --fix --project types/tsconfig.json -c types/tslint.json types/**/*.ts",
+    "lint": "eslint ./ && eslint --no-ignore --no-eslintrc -c ./types/.eslintrc.js ./types/test/**/*.ts",
+    "lint:fix": "eslint --fix ./ && eslint --no-ignore --no-eslintrc --fix -c ./types/.eslintrc.js ./types/test/**/*.ts",
     "changelog": "conventional-changelog -p angular -i ./CHANGELOG.md -s",
     "test": {
       "command": "mocha",
@@ -93,8 +93,8 @@
       }
     },
     "test:web": "testem ci",
-    "test:ramda": "bnr test:ramda0.28.0",
-    "test:ramda0.28.0": "npm install ramda@0.28.0 && npm test",
+    "test:ramda": "bnr test:ramda0.29.0",
+    "test:ramda0.29.0": "npm install ramda@0.29.0 && npm test",
     "test:bundle-create": "webpack --config webpack.config-test.web.js --progress",
     "test:bundle-clean": "rimraf tmp-test-bundle.js",
     "coverage": {
@@ -121,63 +121,65 @@
     "clean": "rimraf .nyc_output .tmp docs coverage tmp-test-bundle.js dist lib es"
   },
   "peerDependencies": {
-    "ramda": ">= 0.28.0 <= 0.28.0"
+    "ramda": ">= 0.29.0"
   },
   "devDependencies": {
-    "@babel/cli": "7.18.10",
-    "@babel/core": "=7.19.1",
-    "@babel/plugin-transform-modules-commonjs": "=7.18.6",
-    "@babel/preset-env": "=7.19.1",
-    "@babel/register": "7.18.9",
-    "@commitlint/cli": "=17.1.2",
-    "@commitlint/config-conventional": "=17.1.0",
+    "@babel/cli": "7.21.0",
+    "@babel/core": "=7.21.4",
+    "@babel/plugin-transform-modules-commonjs": "=7.21.2",
+    "@babel/preset-env": "=7.21.4",
+    "@babel/register": "7.21.0",
+    "@commitlint/cli": "=17.5.1",
+    "@commitlint/config-conventional": "=17.4.4",
+    "@typescript-eslint/eslint-plugin": "=5.57.1",
+    "@typescript-eslint/parser": "=5.57.1",
     "assert": "=2.0.0",
-    "babel-loader": "=8.2.5",
+    "babel-loader": "=9.1.2",
     "babel-plugin-annotate-pure-calls": "0.4.0",
     "babel-plugin-istanbul": "6.1.1",
     "better-npm-run": "0.1.1",
-    "chai": "4.3.6",
+    "chai": "4.3.7",
     "codecov": "3.8.3",
     "conventional-changelog-cli": "2.2.2",
-    "core-js": "=3.25.1",
+    "core-js": "=3.30.0",
     "docdash": "git+https://github.com/char0n/docdash.git#534b44382138a55dd8d93642c979e51e46471185",
-    "dtslint": "=4.2.1",
-    "eslint": "=8.23.1",
+    "eslint": "=8.37.0",
     "eslint-config-airbnb-base": "=15.0.0",
-    "eslint-config-prettier": "=8.5.0",
-    "eslint-plugin-import": "=2.26.0",
+    "eslint-config-prettier": "=8.8.0",
+    "eslint-plugin-dtslint": "=3.0.1",
+    "eslint-plugin-import": "=2.27.5",
     "eslint-plugin-mocha": "=10.1.0",
     "eslint-plugin-prettier": "4.2.1",
     "eslint-plugin-ramda": "2.5.1",
-    "fantasy-land": "5.0.0",
+    "fantasy-land": "5.0.1",
     "fantasy-laws": "=2.0.1",
     "folktale": "=2.3.2",
-    "glob": "=8.0.3",
-    "husky": "8.0.1",
+    "glob": "=9.3.4",
+    "husky": "8.0.3",
     "istanbul": "=0.4.5",
-    "jsdoc": "=3.6.11",
+    "jsdoc": "=4.0.2",
     "jsverify": "0.8.4",
     "license-cli": "1.1.6",
-    "lint-staged": "13.0.3",
-    "mocha": "=10.0.0",
-    "mocha-junit-reporter": "2.0.2",
+    "lint-staged": "13.2.0",
+    "mocha": "=10.2.0",
+    "mocha-junit-reporter": "2.2.0",
     "mocha-multi-reporters": "1.5.1",
     "monet": "0.9.3",
     "nyc": "15.1.0",
-    "prettier": "=2.7.1",
+    "prettier": "=2.8.7",
     "process": "=0.11.10",
-    "ramda": "=0.28.0",
+    "ramda": "=0.29.0",
     "ramda-fantasy": "=0.8.0",
-    "regenerator-runtime": "=0.13.9",
-    "rimraf": "3.0.2",
+    "regenerator-runtime": "=0.13.11",
+    "rimraf": "4.4.1",
     "sanctuary-show": "3.0.0",
-    "sinon": "=14.0.0",
-    "terser-webpack-plugin": "5.3.6",
-    "testem": "=3.9.0",
-    "tslint": "=6.1.3",
-    "typescript": "=4.8.3",
-    "webpack": "=5.74.0",
-    "webpack-cli": "4.10.0"
+    "sinon": "=15.0.3",
+    "terser-webpack-plugin": "5.3.7",
+    "testem": "=3.10.1",
+    "typescript": "=4.9.5",
+    "webpack": "=5.77.0",
+    "webpack-cli": "5.0.1",
+    "taffydb": "npm:@jsdoc/salty@0.2.1"
   },
   "browserslist": "> 0.25%, ie 10, ie 11, not op_mini all",
   "tonicExampleFilename": "tonicExample.js",

package/src/concatAll.js

@@ -24,7 +24,8 @@ const leftIdentitySemigroup = { concat: identity };
  *
  * concatAll([[1], [2], [3]]); //=> [1, 2, 3]
  * concatAll(['1', '2', '3']); //=> '123'
- * concatAll([]); //=> undefined;
+ * concatAll([]); //=> undefined
+ * concatAll(null); //=> undefined
  */
 const concatAll = pipe(
   reduce(concat, leftIdentitySemigroup),

package/src/ensureArray.js

@@ -19,6 +19,6 @@ import isNotArray from './isNotArray';
  * RA.ensureArray(42); //=> [42]
  * RA.ensureArray([42]); //=> [42]
  */
-const ensureArray = when(isNotArray, of);
+const ensureArray = when(isNotArray, of(Array));
 
 export default ensureArray;

package/src/flattenProp.js

@@ -23,6 +23,6 @@ import flattenPath from './flattenPath';
  *   { a: 1, b: { c: 3, d: 4 } }
  * ); // => { a: 1, c: 3, d: 4, b: { c: 3, d: 4 } };
  */
-const flattenProp = curry((prop, obj) => flattenPath(of(prop), obj));
+const flattenProp = curry((prop, obj) => flattenPath(of(Array, prop), obj));
 
 export default flattenProp;

package/src/index.js

@@ -161,6 +161,7 @@ export { default as toArray } from './toArray';
 export { default as allUnique } from './allUnique';
 export { default as notAllUnique } from './notAllUnique';
 export { default as sortByProps } from './sortByProps';
+export { default as sortByProp } from './sortByProp';
 export { default as sortByPaths } from './sortByPaths';
 export { default as skipTake } from './skipTake';
 export { default as rangeStep } from './rangeStep';

package/src/isFalse.js

@@ -1,4 +1,4 @@
-import { identical } from 'ramda';
+import { identical, curryN } from 'ramda';
 
 /**
  * Checks if input value is the Boolean primitive `false`. Will return false for all values created
@@ -26,6 +26,6 @@ import { identical } from 'ramda';
  * RA.isFalse(new Boolean(false)); // => false
  */
 
-const isFalse = identical(false);
+const isFalse = curryN(1, identical(false));
 
 export default isFalse;

package/src/isGeneratorFunction.js

@@ -1,21 +1,4 @@
-import {
-  type,
-  is,
-  F as stubFalse,
-  either,
-  identical,
-  pipe,
-  curryN,
-} from 'ramda';
-
-let GeneratorFunction = null;
-let legacyCheck = null;
-try {
-  GeneratorFunction = new Function('return function* () {}')().constructor; // eslint-disable-line no-new-func
-  legacyCheck = is(GeneratorFunction);
-} catch (e) {
-  legacyCheck = stubFalse;
-}
+import { type, identical, pipe, curryN } from 'ramda';
 
 /**
  * Checks if input value is `Generator Function`.
@@ -37,7 +20,7 @@ try {
  */
 const isGeneratorFunction = curryN(
   1,
-  either(pipe(type, identical('GeneratorFunction')), legacyCheck)
+  pipe(type, identical('GeneratorFunction'))
 );
 
 export default isGeneratorFunction;

package/src/isNegativeZero.js

@@ -1,4 +1,4 @@
-import { identical } from 'ramda';
+import { identical, curryN } from 'ramda';
 
 /**
  * Checks if value is a negative zero (-0).
@@ -18,6 +18,6 @@ import { identical } from 'ramda';
  * RA.isNegativeZero(0); //=> false
  * RA.isNegativeZero(null); //=> false
  */
-const isNegativeZero = identical(-0);
+const isNegativeZero = curryN(1, identical(-0));
 
 export default isNegativeZero;

package/src/isPositiveZero.js

@@ -1,4 +1,4 @@
-import { identical } from 'ramda';
+import { identical, curryN } from 'ramda';
 
 /**
  * Checks if value is a positive zero (+0).
@@ -18,6 +18,6 @@ import { identical } from 'ramda';
  * RA.isPositiveZero(-0); //=> false
  * RA.isPositiveZero(null); //=> false
  */
-const isPositiveZero = identical(+0);
+const isPositiveZero = curryN(1, identical(+0));
 
 export default isPositiveZero;

package/src/isTrue.js

@@ -1,4 +1,4 @@
-import { identical } from 'ramda';
+import { identical, curryN } from 'ramda';
 
 /**
  * Checks if input value is the Boolean primitive `true`. Will return false for Boolean objects
@@ -22,6 +22,6 @@ import { identical } from 'ramda';
  * RA.isTrue(new Boolean(true)); // => false
  */
 
-const isTrue = identical(true);
+const isTrue = curryN(1, identical(true));
 
 export default isTrue;

package/src/lensTraverse.js

@@ -18,8 +18,10 @@ import Identity from './fantasy-land/Identity';
  * @since {@link https://char0n.github.io/ramda-adjunct/2.7.0|2.7.0}
  * @category Relation
  * @typedef Lens s a = Functor f => (a -> f a) -> s -> f s
+ * @sig fantasy-land/of :: TypeRep f => f ~> a → f a
  * @sig Applicative f => (a -> f a) -> Lens s a
- * @param {!function} of The Applicative-returning function
+ * @sig Applicative f => TypeRep f -> Lens s a
+ * @param {!Object|!Function} TypeRepresentative with an `of` or `fantasy-land/of` method
  * @return {!function} The Traversable lens
  * @see {@link http://ramdajs.com/docs/#lens|R.lens}, {@link http://ramdajs.com/docs/#traverse|R.traverse}
  *
@@ -35,10 +37,20 @@ import Identity from './fantasy-land/Identity';
  *
  * R.set(maybeLens, Maybe.Just(1), [Maybe.just(2), Maybe.Just(3)]); // => Maybe.Just([1, 1])
  */
-const lensTraverse = curryN(1, (of) =>
-  curry((toFunctorFn, target) =>
-    Identity.of(traverse(of, pipe(toFunctorFn, prop('value')), target))
-  )
-);
+/* eslint-disable no-nested-ternary */
+const lensTraverse = curryN(1, (F) => {
+  const of =
+    typeof F['fantasy-land/of'] === 'function'
+      ? F['fantasy-land/of']
+      : typeof F.of === 'function'
+      ? F.of
+      : F;
+  const TypeRep = { 'fantasy-land/of': of };
+
+  return curry((toFunctorFn, target) =>
+    Identity.of(traverse(TypeRep, pipe(toFunctorFn, prop('value')), target))
+  );
+});
+/* eslint-enable */
 
 export default lensTraverse;

package/src/mergeProp.js

@@ -25,6 +25,6 @@ import mergePath from './mergePath';
  *  { outer: { foo: 2 } }
  * ); //=> { outer: { foo: 3, bar: 4 } };
  */
-const mergeProp = curry((p, subj, obj) => mergePath(of(p), subj, obj));
+const mergeProp = curry((p, subj, obj) => mergePath(of(Array, p), subj, obj));
 
 export default mergeProp;

package/src/pathNotEq.js

@@ -9,10 +9,10 @@ import { pathEq, complement } from 'ramda';
  * @memberOf RA
  * @since {@link https://char0n.github.io/ramda-adjunct/2.4.0|v2.4.0}
  * @category Relation
- * @sig [Idx] => a => {a} => Boolean
- * @sig Idx = String | Int
- * @param {Array} path The path of the nested property to use
+ * @sig a => [Idx] => {a} => Boolean
+ * @sig Idx = String | Int | Symbol
  * @param {a} val The value to compare the nested property with
+ * @param {Array} path The path of the nested property to use
  * @param {Object} object The object to check the nested property in
  * @return {boolean} Returns Boolean `false` if the value equals the nested object property, `true` otherwise
  * @see {@link http://ramdajs.com/docs/#pathEq|R.pathEq}
@@ -22,7 +22,7 @@ import { pathEq, complement } from 'ramda';
  * const user2 = { address: { zipCode: 55555 } };
  * const user3 = { name: 'Bob' };
  * const users = [ user1, user2, user3 ];
- * const isFamous = R.pathNotEq(['address', 'zipCode'], 90210);
+ * const isFamous = R.pathNotEq(90210, ['address', 'zipCode']);
  * R.filter(isFamous, users); //=> [ user2, user3 ]
  */
 /* eslint-enable max-len */

package/src/propNotEq.js

@@ -8,9 +8,9 @@ import { propEq, complement } from 'ramda';
  * @memberOf RA
  * @since {@link https://char0n.github.io/ramda-adjunct/2.3.0|v2.3.0}
  * @category Relation
- * @sig  String -> a -> Object -> Boolean
- * @param {String} name The property to pick
+ * @sig  a -> String -> Object -> Boolean
  * @param {a} val The value to compare to
+ * @param {String} name The property to pick
  * @param {Object} object The object, that presumably contains value under the property
  * @return {boolean} Comparison result
  * @see {@link http://ramdajs.com/docs/#propEq|R.propEq}
@@ -21,7 +21,7 @@ import { propEq, complement } from 'ramda';
  * const rusty = { name: 'Rusty', age: 10, hair: 'brown' };
  * const alois = { name: 'Alois', age: 15, disposition: 'surly' };
  * const kids = [abby, fred, rusty, alois];
- * const hasNotBrownHair = RA.propNotEq('hair', 'brown');
+ * const hasNotBrownHair = RA.propNotEq('brown', 'hair');
  *
  * R.filter(hasNotBrownHair, kids); //=> [abby, alois]
  */

package/src/sortByProp.js

@@ -0,0 +1,45 @@
+import { __, append, identity, useWith } from 'ramda';
+
+import sortByProps from './sortByProps';
+
+/**
+ * Sort a list of objects by a property.
+ *
+ * @func sortByProp
+ * @memberOf RA
+ * @since {@link https://char0n.github.io/ramda-adjunct/3.4.0|v3.4.0}
+ * @category List
+ * @sig k -> [{k: v}] -> [{k: v}]
+ * @param {Array.<string>} prop The property in the list param to sort by
+ * @param {Array.<object>} list A list of objects to be sorted
+ * @return {Array.<object>} A new list sorted by the property in the prop param
+ * @example
+ *
+ * // sorting list of tuples
+ * const sortByFirstItem = sortByProp(0);
+ * const listOfTuples = [[-1, 1], [-2, 2], [-3, 3]];
+ * sortByFirstItem(listOfTuples); // => [[-3, 3], [-2, 2], [-1, 1]]
+ *
+ * // sorting list of objects
+ * const sortByName = sortByProp('name');
+ * const alice = {
+ *   name: 'ALICE',
+ *   age: 101,
+ * };
+ * const bob = {
+ *   name: 'Bob',
+ *   age: -10,
+ * };
+ * const clara = {
+ *   name: 'clara',
+ *   age: 314.159,
+ * };
+ * const people = [clara, bob, alice];
+ * sortByName(people); // => [alice, bob, clara]
+ */
+
+const addValueInAnArray = append(__, []);
+
+const sortByProp = useWith(sortByProps, [addValueInAnArray, identity]);
+
+export default sortByProp;

package/src/sortByProps.js

@@ -1,4 +1,4 @@
-import { reduce, either, curry, prop, sort, comparator, map, lt } from 'ramda';
+import { comparator, curry, either, lt, map, prop, reduce, sort } from 'ramda';
 
 /**
  * Sort a list of objects by a list of props (if first prop value is equivalent, sort by second, etc).

package/src/spreadProp.js

@@ -20,6 +20,6 @@ import spreadPath from './spreadPath';
  *
  * RA.spreadProp('b', { a: 1, b: { c: 3, d: 4 } }); // => { a: 1, c: 3, d: 4 };
  */
-const spreadProp = curry((prop, obj) => spreadPath(of(prop), obj));
+const spreadProp = curry((prop, obj) => spreadPath(of(Array, prop), obj));
 
 export default spreadProp;