forked from evilsoft/crocks
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* move from propPathOr -> getPathOr * update docs for getPathOr * address PR feedback
- Loading branch information
1 parent
f6d1ea3
commit 40fccb0
Showing
8 changed files
with
236 additions
and
100 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| /** @license ISC License (c) copyright 2019 original and current authors */ | ||
| /** @author Ian Hofmann-Hicks */ | ||
|
|
||
| const curry = require('../core/curry') | ||
| const isArray = require('../core/isArray') | ||
| const isDefined = require('../core/isDefined') | ||
| const isEmpty = require('../core/isEmpty') | ||
| const isInteger = require('../core/isInteger') | ||
| const isNil = require('../core/isNil') | ||
| const isString = require('../core/isString') | ||
|
|
||
| const errFn = name => | ||
| `${name}: Array of Non-empty Strings or Integers required for second argument` | ||
|
|
||
| function fn(name) { | ||
| function getPathOr(def, keys, target) { | ||
| if(!isArray(keys)) { | ||
| throw new TypeError(errFn(name)) | ||
| } | ||
|
|
||
| if(isNil(target)) { | ||
| return def | ||
| } | ||
|
|
||
| let value = target | ||
| for(let i = 0; i < keys.length; i++) { | ||
| const key = keys[i] | ||
|
|
||
| if(!(isString(key) && !isEmpty(key) || isInteger(key))) { | ||
| throw new TypeError(errFn(name)) | ||
| } | ||
|
|
||
| if(isNil(value)) { | ||
| return def | ||
| } | ||
|
|
||
| value = value[key] | ||
|
|
||
| if(!isDefined(value)) { | ||
| return def | ||
| } | ||
| } | ||
|
|
||
| return value | ||
| } | ||
|
|
||
| return curry(getPathOr) | ||
| } | ||
|
|
||
| // getPathOr :: a -> [ String | Integer ] -> b -> c | ||
| const getPathOr = | ||
| fn('getPathOr') | ||
|
|
||
| getPathOr.origFn = | ||
| fn | ||
|
|
||
| module.exports = | ||
| getPathOr |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| const test = require('tape') | ||
| const helpers = require('../test/helpers') | ||
|
|
||
| const bindFunc = helpers.bindFunc | ||
|
|
||
| const equals = require('../core/equals') | ||
| const isFunction = require('../core/isFunction') | ||
| const unit = require('../core/_unit') | ||
|
|
||
| const getPathOr = require('./getPathOr') | ||
|
|
||
| test('getPathOr function', t => { | ||
| const def = 'default value' | ||
| const fn = getPathOr(def, [ 'key' ]) | ||
| const empty = getPathOr(def, []) | ||
|
|
||
| t.ok(isFunction(getPathOr), 'is a function') | ||
|
|
||
| t.equals(fn(undefined), def, 'returns the default value when data is undefined') | ||
| t.equals(fn(null), def, 'returns the default value when data is null') | ||
| t.equals(fn(NaN), def, 'returns the default value when data is NaN') | ||
|
|
||
| t.equals(empty(undefined), def, 'returns default with empty path and undefined') | ||
| t.equals(empty(null), def, 'returns default with empty path and null') | ||
| t.equals(empty(NaN), def, 'returns default with empty path and NaN') | ||
|
|
||
| t.end() | ||
| }) | ||
|
|
||
| test('getPathOr errors', t => { | ||
| const def = 'default value' | ||
| const fn = bindFunc(x => getPathOr(def, x, {})) | ||
|
|
||
| const err = /getPathOr: Array of Non-empty Strings or Integers required for second argument/ | ||
| t.throws(fn(def, undefined, {}), err, 'throws with undefined in second argument') | ||
| t.throws(fn(def, null, {}), err, 'throws with null in second argument') | ||
| t.throws(fn(def, 0, {}), err, 'throws with falsey number in second argument') | ||
| t.throws(fn(def, 1, {}), err, 'throws with truthy number in second argument') | ||
| t.throws(fn(def, '', {}), err, 'throws with falsey string in second argument') | ||
| t.throws(fn(def, 'string', {}), err, 'throws with truthy string in second argument') | ||
| t.throws(fn(def, false, {}), err, 'throws with false in second argument') | ||
| t.throws(fn(def, true, {}), err, 'throws with true in second argument') | ||
| t.throws(fn(def, {}, {}), err, 'throws with an object in second argument') | ||
| t.throws(fn(def, unit, {}), err, 'throws with an function in second argument') | ||
|
|
||
| t.throws(fn([ undefined ]), err, 'throws with an array of undefined in second argument') | ||
| t.throws(fn([ null ]), err, 'throws with array of null in second argument') | ||
| t.throws(fn([ false ]), err, 'throws with an array of false in second argument') | ||
| t.throws(fn([ true ]), err, 'throws with an array of true in second argument') | ||
| t.throws(fn([ '' ]), err, 'throws with an array of empty string in second argument') | ||
| t.throws(fn([ 1.543 ]), err, 'throws with an array of float in second argument') | ||
| t.throws(fn([ {} ]), err, 'throws with an array of object in second argument') | ||
| t.throws(fn([ unit ]), err, 'throws with an array of function in second argument') | ||
| t.throws(fn([ [ 'key' ] ], {}), err, 'throws with a nested array in second argument') | ||
|
|
||
| t.end() | ||
| }) | ||
|
|
||
| test('getPathOr object traversal', t => { | ||
| const def = { b: 1 } | ||
|
|
||
| const fn = getPathOr(def, [ 'a', 'b' ]) | ||
| const empty = getPathOr(def, []) | ||
|
|
||
| t.same(fn({ a: { b: { c: 32 } } }), { c: 32 }, 'returns the value when keypath is found') | ||
| t.equals(fn({ a: { b: null } }), null, 'returns null when keypath is found and value is null') | ||
| t.ok(equals(fn({ a: { b: NaN } }), NaN), 'returns NaN when keypath is found and value is NaN') | ||
|
|
||
| t.equals(fn({ a: { c: true } }), def, 'returns the default value when keypath is not found') | ||
| t.equals(fn({ a: { b: undefined } }), def, 'returns the default value when keypath is found and value is undefined') | ||
|
|
||
| t.equals(fn({ a: undefined }), def, 'returns the default value when keypath contains an undefined') | ||
| t.equals(fn({ a: null }), def, 'returns the default value when keypath contains a null') | ||
| t.equals(fn({ a: NaN }), def, 'returns the default value when keypath contains a NaN') | ||
|
|
||
| t.same(empty({ a: 32 }), { a: 32 }, 'returns the original object when an empty array is provided as path') | ||
|
|
||
| t.same(fn({ c: { b: 2 } }), def, 'returns the default value when default is an object that has the same property as a nested property in target') | ||
|
|
||
| t.end() | ||
| }) | ||
|
|
||
| test('getPathOr array traversal', t => { | ||
| const def = 99 | ||
|
|
||
| const fn = getPathOr(def, [ 0, '1' ]) | ||
| const empty = getPathOr(def, []) | ||
|
|
||
| t.equals(fn([ [ '', 13 ] ]), 13, 'returns the value when index is found') | ||
| t.equals(fn([ [ false, null ] ]), null , 'returns null when index is found and value is null') | ||
| t.ok(equals(fn([ [ false, NaN ] ]), NaN), 'returns NaN when index is found and value is NaN') | ||
|
|
||
| t.equals(fn([ true ]), def, 'returns the default value when index is not found') | ||
| t.equals(fn([ [ 0, undefined ] ]), def, 'returns the default value when index is found and value is undefined') | ||
|
|
||
| t.equals(fn([ undefined ]), def, 'returns the default value when key path contains a null') | ||
| t.equals(fn([ null ]), def, 'returns the default value when key path contains a null') | ||
| t.equals(fn([ NaN ]), def, 'returns the default value when key path contains a NaN') | ||
|
|
||
| t.same(empty([ 1, { a: 23 } ]), [ 1, { a: 23 } ], 'returns the original array when an empty array is provided as path') | ||
|
|
||
| t.end() | ||
| }) | ||
|
|
||
| test('getPathOr mixed traversal', t => { | ||
| const def = 'default value' | ||
| const fn = getPathOr(def, [ 'a', 1 ]) | ||
|
|
||
| t.equals(fn({ a: [ 0, false ] }), false, 'returns value when found with mixed path') | ||
| t.equals(fn({ c: [ true ] }), def, 'returns default when not found with mixed path') | ||
|
|
||
| t.end() | ||
| }) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.