From 15958c9d4a1ddb8b0459b0e08742b1430e613a4c Mon Sep 17 00:00:00 2001 From: Rutam Kathale Date: Thu, 29 Feb 2024 01:54:11 +0530 Subject: [PATCH] feat: add @stdlib/utils/some-in-by Add support to test whether some "own" and inherited properties of a provided object satisfies a predicate function. Fixes: #825 --- .../@stdlib/utils/some-in-by/README.md | 234 +++++++++++++ .../utils/some-in-by/benchmark/benchmark.js | 105 ++++++ .../@stdlib/utils/some-in-by/docs/repl.txt | 45 +++ .../utils/some-in-by/docs/types/index.d.ts | 104 ++++++ .../utils/some-in-by/docs/types/test.ts | 66 ++++ .../utils/some-in-by/examples/index.js | 37 ++ .../@stdlib/utils/some-in-by/lib/index.js | 46 +++ .../@stdlib/utils/some-in-by/lib/main.js | 84 +++++ .../@stdlib/utils/some-in-by/package.json | 75 +++++ .../@stdlib/utils/some-in-by/test/test.js | 317 ++++++++++++++++++ 10 files changed, 1113 insertions(+) create mode 100644 lib/node_modules/@stdlib/utils/some-in-by/README.md create mode 100644 lib/node_modules/@stdlib/utils/some-in-by/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/utils/some-in-by/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/utils/some-in-by/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/utils/some-in-by/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/utils/some-in-by/examples/index.js create mode 100644 lib/node_modules/@stdlib/utils/some-in-by/lib/index.js create mode 100644 lib/node_modules/@stdlib/utils/some-in-by/lib/main.js create mode 100644 lib/node_modules/@stdlib/utils/some-in-by/package.json create mode 100644 lib/node_modules/@stdlib/utils/some-in-by/test/test.js diff --git a/lib/node_modules/@stdlib/utils/some-in-by/README.md b/lib/node_modules/@stdlib/utils/some-in-by/README.md new file mode 100644 index 00000000000..350f3a9c65f --- /dev/null +++ b/lib/node_modules/@stdlib/utils/some-in-by/README.md @@ -0,0 +1,234 @@ + + +# someInBy + +> Test whether an object contains at least `n` properties which pass a test implemented by a predicate function. + +
+ +
+ + + +
+ +## Usage + +```javascript +var someInBy = require( '@stdlib/utils/some-in-by' ); +``` + +#### someInBy( obj, n, predicate\[, thisArg ] ) + +Tests whether an `obj` contains at least `n` properties which pass a test implemented by a `predicate` function. + +```javascript +function isNegative( value ) { + return ( value < 0 ); +} + +var obj = { + 'a': 1, + 'b': -2, + 'c': 3, + 'd': -1 +}; + +var bool = someInBy( obj, 2, isNegative ); +// returns true +``` + +Once the function finds `n` successful properties, the function **immediately** returns `true`. + +```javascript +function isPositive( value ) { + if ( value < 0 ) { + throw new Error( 'should never reach this line' ); + } + return ( value > 0 ); +} + +var obj = { + 'a': 1, + 'b': 2, + 'c': -3, + 'd': 4 +}; + +var bool = someInBy( obj, 2, isPositive ); +// returns true +``` + +The invoked `function` is provided three arguments: + +- `value`: object property value +- `key`: object property key +- `obj`: input object + +To set the function execution context, provide a `thisArg`. + +```javascript +function sum( value ) { + this.sum += value; + this.count += 1; + return ( value < 0 ); +} + +var obj = { + 'a': 1, + 'b': 2, + 'c': 3, + 'd': -5 +}; + +var context = { + 'sum': 0, + 'count': 0 +}; + +var bool = someInBy( obj, 1, sum, context ); +// returns true + +var mean = context.sum / context.count; +// returns 0.25 +``` + +
+ + + +
+ +## Notes + +- If provided an empty `obj`, the function returns `false`. + + ```javascript + function alwaysTrue() { + return true; + } + var bool = someInBy( {}, 1, alwaysTrue ); + // returns false + ``` + +- The function does **not** skip `undefined` properties. + + ```javascript + function log( value, key ) { + console.log( '%s: %s', key, value ); + return ( value < 0 ); + } + + var obj = { + 'a': 1, + 'b': void 0, + 'c': void 0, + 'd': 4, + 'e': -1 + }; + + var bool = someInBy( obj, 1, log ); + // logs + // a: 1 + // b: void 0 + // c: void 0 + // d: 4 + // e: -1 + ``` + +- The function provides limited support for dynamic objects (i.e., objects whose properties change during execution). + +
+ + + +
+ +## Examples + +```javascript +var randu = require( '@stdlib/random/base/randu' ); +var someInBy = require( '@stdlib/utils/some-in-by' ); + +function threshold( value ) { + return ( value > 0.95 ); +} + +var bool; +var obj = {}; +var i; + +for ( i = 0; i < 100; i++ ) { + obj[ 'key' + i ] = randu(); +} + +bool = someInBy( obj, 5, threshold ); +// returns +``` + +
+ + + +
+ +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/utils/some-in-by/benchmark/benchmark.js b/lib/node_modules/@stdlib/utils/some-in-by/benchmark/benchmark.js new file mode 100644 index 00000000000..0e8e5fc973f --- /dev/null +++ b/lib/node_modules/@stdlib/utils/some-in-by/benchmark/benchmark.js @@ -0,0 +1,105 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var bench = require( '@stdlib/bench' ); +var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive; +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pkg = require( './../package.json' ).name; +var someInBy = require( './../lib' ); + + +// MAIN // + +bench( pkg, function benchmark( b ) { + var bool; + var obj; + var i; + + function predicate( v ) { + return isnan( v ); + } + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + obj = { + 'a': i, + 'b': i + 1, + 'c': i + 2, + 'd': NaN, + 'e': i + 4, + 'f': NaN + }; + bool = someInBy( obj, 2, predicate ); + if ( typeof bool !== 'boolean' ) { + b.fail( 'should return a boolean' ); + } + } + b.toc(); + if ( !isBoolean( bool ) ) { + b.fail( 'should return a boolean' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg + '::loop', function benchmark( b ) { + var total; + var count; + var bool; + var obj; + var key; + var i; + + total = 2; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + obj = { + 'a': i, + 'b': i + 1, + 'c': i + 2, + 'd': NaN, + 'e': i + 4, + 'f': NaN + }; + bool = false; + count = 0; + for ( key in obj ) { + if ( Object.prototype.hasOwnProperty.call( obj, key ) && isnan(obj[ key ] )) { + count += 1; + if ( count === total ) { + bool = true; + break; + } + } + } + if ( typeof bool !== 'boolean' ) { + b.fail( 'should return a boolean' ); + } + } + b.toc(); + if ( !isBoolean( bool ) ) { + b.fail( 'should be a boolean' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/utils/some-in-by/docs/repl.txt b/lib/node_modules/@stdlib/utils/some-in-by/docs/repl.txt new file mode 100644 index 00000000000..457d56a6e8b --- /dev/null +++ b/lib/node_modules/@stdlib/utils/some-in-by/docs/repl.txt @@ -0,0 +1,45 @@ + +{{alias}}( obj, n, predicate[, thisArg ] ) + Tests whether an object contains at least `n` properties + (own and inherited) which pass a test + implemented by a predicate function. + + The predicate function is provided three arguments: + + - `value`: object value + - `key`: object key + - `obj`: the input object + + The function immediately returns upon finding `n` successful properties. + + If provided an empty object, the function returns `false`. + + Parameters + ---------- + obj: Object + Input object over which to iterate. + + n: number + Minimum number of successful properties. + + predicate: Function + The test function. + + thisArg: any (optional) + Execution context. + + Returns + ------- + bool: boolean + The function returns `true` if an object contains at least `n` + successful properties; otherwise, the function returns `false`. + + Examples + -------- + > function negative( v ) { return ( v < 0 ); }; + > var obj = { 'a': 1, 'b': 2, 'c': -3, 'd': 4, 'e': -1 }; + > var bool = {{alias}}( obj, 2, negative ) + true + + See Also + -------- diff --git a/lib/node_modules/@stdlib/utils/some-in-by/docs/types/index.d.ts b/lib/node_modules/@stdlib/utils/some-in-by/docs/types/index.d.ts new file mode 100644 index 00000000000..caa9a26c50d --- /dev/null +++ b/lib/node_modules/@stdlib/utils/some-in-by/docs/types/index.d.ts @@ -0,0 +1,104 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +// TypeScript Version: 4.1 + +/// + +/** +* Checks whether a property in an object passes a test. +* +* @returns boolean indicating whether a property in an object passes a test +*/ +type Nullary = ( this: U ) => boolean; + +/** +* Checks whether a property in an object passes a test. +* +* @param value - object value +* @returns boolean indicating whether a property in an object passes a test +*/ +type Unary = ( this: U, value: T ) => boolean; + +/** +* Checks whether a property in an object passes a test. +* +* @param value - object value +* @param key - object key +* @returns boolean indicating whether a property in an object passes a test +*/ +type Binary = ( this: U, value: T, key: string ) => boolean; + +/** +* Checks whether a property in an object passes a test. +* +* @param value - object value +* @param key - object key +* @param obj - input object +* @returns boolean indicating whether a property in an object passes a test +*/ +type Ternary = ( this: U, value: T, key: string, obj: Record ) => boolean; + +/** +* Checks whether a property in an object passes a test. +* +* @param value - object value +* @param key - object key +* @param obj - input object +* @returns boolean indicating whether a property in an object passes a test +*/ +type Predicate = Nullary | Unary | Binary | Ternary; + +/** +* Tests whether an object contains at least `n` properties (own and inherited) which pass a test implemented by a predicate function. +* +* ## Notes +* +* - The predicate function is provided three arguments: +* +* - `value`: object value +* - `key`: object key +* - `obj`: the input object +* +* - The function immediately returns upon finding `n` successful properties. +* +* - If provided an empty object, the function returns `false`. +* +* @param obj - input object +* @param n - number of properties +* @param predicate - test function +* @param thisArg - execution context +* @throws second argument must be a positive integer +* @returns boolean indicating whether an object contains at least `n` properties which pass a test +* +* @example +* function isNegative( v ) { +* return ( v < 0 ); +* } +* +* var obj = { 'a': 1, 'b': 2, 'c': -3, 'd': 4, 'e': -1 }; +* +* var bool = someInBy( obj, 2, isNegative ); +* // returns true +*/ +declare function someInBy( obj: Record, n: number, predicate: Predicate, thisArg?: ThisParameterType> ): boolean; + + +// EXPORTS // + +export = someInBy; diff --git a/lib/node_modules/@stdlib/utils/some-in-by/docs/types/test.ts b/lib/node_modules/@stdlib/utils/some-in-by/docs/types/test.ts new file mode 100644 index 00000000000..f519796ddae --- /dev/null +++ b/lib/node_modules/@stdlib/utils/some-in-by/docs/types/test.ts @@ -0,0 +1,66 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +import someInBy = require( './index' ); + +const hasUpperCase = ( v: string, key: string ): boolean => { + return ( key.toUpperCase() === key ); +}; + +// TESTS // + +// The function returns a boolean... +{ + someInBy( { 'a': 0, 'B': 1, 'C': 1 }, 2, hasUpperCase ); // $ExpectType boolean + someInBy( { 'a': -1, 'B': 1, 'c': 2 }, 3, hasUpperCase, {} ); // $ExpectType boolean +} + +// The compiler throws an error if the function is provided a first argument which is not an object... +{ + someInBy( 2, 2, hasUpperCase ); // $ExpectError + someInBy( false, 2, hasUpperCase ); // $ExpectError + someInBy( true, 2, hasUpperCase ); // $ExpectError +} + +// The compiler throws an error if the function is provided a second argument which is not a number... +{ + someInBy( { 'a': -1, 'B': 1, 'c': 2 }, ( x: number ): number => x, hasUpperCase ); // $ExpectError + someInBy( { 'a': -1, 'B': 1, 'c': 2 }, false, hasUpperCase ); // $ExpectError + someInBy( { 'a': -1, 'B': 1, 'c': 2 }, true, hasUpperCase ); // $ExpectError + someInBy( { 'a': -1, 'B': 1, 'c': 2 }, 'abc', hasUpperCase ); // $ExpectError + someInBy( { 'a': -1, 'B': 1, 'c': 2 }, {}, hasUpperCase ); // $ExpectError + someInBy( { 'a': -1, 'B': 1, 'c': 2 }, [], hasUpperCase ); // $ExpectError +} + +// The compiler throws an error if the function is provided a third argument which is not a function... +{ + someInBy( { 'a': 1, 'B': 2, 'c': 3 }, 1, 2 ); // $ExpectError + someInBy( { 'a': 1, 'B': 2, 'c': 3 }, 1, false ); // $ExpectError + someInBy( { 'a': 1, 'B': 2, 'c': 3 }, 1, true ); // $ExpectError + someInBy( { 'a': 1, 'B': 2, 'c': 3 }, 1, 'abc' ); // $ExpectError + someInBy( { 'a': 1, 'B': 2, 'c': 3 }, 1, {} ); // $ExpectError + someInBy( { 'a': 1, 'B': 2, 'c': 3 }, 1, [] ); // $ExpectError +} + +// The compiler throws an error if the function is provided an invalid number of arguments... +{ + someInBy(); // $ExpectError + someInBy( { 'a': 1, 'B': 2, 'c': 3 } ); // $ExpectError + someInBy( { 'a': 1, 'B': 2, 'c': 3 }, 1 ); // $ExpectError + someInBy( { 'a': 1, 'B': 2, 'c': 3 }, 1, hasUpperCase, {}, 3 ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/utils/some-in-by/examples/index.js b/lib/node_modules/@stdlib/utils/some-in-by/examples/index.js new file mode 100644 index 00000000000..dd2e214f8a0 --- /dev/null +++ b/lib/node_modules/@stdlib/utils/some-in-by/examples/index.js @@ -0,0 +1,37 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +var randu = require( '@stdlib/random/base/randu' ); +var someInBy = require( './../lib' ); + +function threshold( value ) { + return ( value > 0.95 ); +} + +var bool; +var obj = {}; +var i; + +for ( i = 0; i < 100; i++ ) { + obj[ 'key' + i ] = randu(); +} + +bool = someInBy( obj, 5, threshold ); +console.log( bool ); diff --git a/lib/node_modules/@stdlib/utils/some-in-by/lib/index.js b/lib/node_modules/@stdlib/utils/some-in-by/lib/index.js new file mode 100644 index 00000000000..d4f09da60a0 --- /dev/null +++ b/lib/node_modules/@stdlib/utils/some-in-by/lib/index.js @@ -0,0 +1,46 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +/** +* Test whether an object contains at least `n` properties (own or inherited) which pass a test implemented by a predicate function. +* +* @module @stdlib/utils/some-in-by +* +* @example +* var someInBy = require( '@stdlib/utils/some-in-by' ); +* +* function isNegative( v ) { +* return ( v < 0 ); +* } +* +* var obj = { a: 1, b: -2, c: 3, d: 4, e: -1 }; +* +* var bool = someInBy( obj, 2, isNegative ); +* // returns true +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/utils/some-in-by/lib/main.js b/lib/node_modules/@stdlib/utils/some-in-by/lib/main.js new file mode 100644 index 00000000000..19545887f0a --- /dev/null +++ b/lib/node_modules/@stdlib/utils/some-in-by/lib/main.js @@ -0,0 +1,84 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var isObject = require( '@stdlib/assert/is-object' ); +var isPositiveInteger = require( '@stdlib/assert/is-positive-integer' ).isPrimitive; +var isFunction = require( '@stdlib/assert/is-function' ); +var format = require( '@stdlib/string/format' ); + + +// MAIN // + +/** +* Tests whether an object contains at least `n` properties (own or inherited) which pass a test implemented by a predicate function. +* +* @param {Object} obj - input object +* @param {PositiveInteger} n - number of properties +* @param {Function} predicate - test function +* @param {*} [thisArg] - execution context +* @throws {TypeError} first argument must be an object +* @throws {TypeError} second argument must be a positive integer +* @throws {TypeError} third argument must be a function +* @returns {boolean} boolean indicating whether an object contains at least `n` properties which pass a test +* +* @example +* function isNegative( v ) { +* return ( v < 0 ); +* } +* +* var obj = { a: 1, b: -2, c: 3, d: 4, e: -1 }; +* +* var bool = someInBy( obj, 2, isNegative ); +* // returns true +*/ +function someInBy( obj, n, predicate, thisArg ) { + var count; + var out; + var key; + if ( !isObject( obj ) ) { + throw new TypeError( format( 'invalid argument. First argument must be an object. Value: `%s`.', obj ) ); + } + if ( !isPositiveInteger( n ) ) { + throw new TypeError( format( 'invalid argument. Second argument must be a positive integer. Value: `%s`.', n ) ); + } + if ( !isFunction( predicate ) ) { + throw new TypeError( format( 'invalid argument. Third argument must be a function. Value: `%s`.', predicate ) ); + } + count = 0; + for ( key in obj ) { + if ( Object.prototype.hasOwnProperty.call(obj, key) || Object.prototype.hasOwnProperty.call(Object.getPrototypeOf(obj), key) ) { + out = predicate.call( thisArg, obj[ key ], key, obj ); + if ( out ) { + count += 1; + if ( count === n ) { + return true; + } + } + } + } + return false; +} + + +// EXPORTS // + +module.exports = someInBy; diff --git a/lib/node_modules/@stdlib/utils/some-in-by/package.json b/lib/node_modules/@stdlib/utils/some-in-by/package.json new file mode 100644 index 00000000000..72dbcda3fb8 --- /dev/null +++ b/lib/node_modules/@stdlib/utils/some-in-by/package.json @@ -0,0 +1,75 @@ +{ + "name": "@stdlib/utils/some-in-by", + "version": "0.0.0", + "description": "Test whether an object contains at least n properties (own and inherited) which pass a test implemented by a predicate function.", + "license": "Apache-2.0", + "author": { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + }, + "contributors": [ + { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + } + ], + "main": "./lib", + "directories": { + "benchmark": "./benchmark", + "doc": "./docs", + "example": "./examples", + "lib": "./lib", + "test": "./test" + }, + "types": "./docs/types", + "scripts": {}, + "homepage": "https://github.com/stdlib-js/stdlib", + "repository": { + "type": "git", + "url": "git://github.com/stdlib-js/stdlib.git" + }, + "bugs": { + "url": "https://github.com/stdlib-js/stdlib/issues" + }, + "dependencies": {}, + "devDependencies": {}, + "engines": { + "node": ">=0.10.0", + "npm": ">2.7.0" + }, + "os": [ + "aix", + "darwin", + "freebsd", + "linux", + "macos", + "openbsd", + "sunos", + "win32", + "windows" + ], + "keywords": [ + "stdlib", + "stdutils", + "stdutil", + "utilities", + "utility", + "utils", + "util", + "test", + "predicate", + "any", + "every", + "all", + "object.some", + "object.every", + "some", + "property", + "own", + "inherited", + "iterate", + "collection", + "array-like", + "validate" + ] +} diff --git a/lib/node_modules/@stdlib/utils/some-in-by/test/test.js b/lib/node_modules/@stdlib/utils/some-in-by/test/test.js new file mode 100644 index 00000000000..52b87f019c6 --- /dev/null +++ b/lib/node_modules/@stdlib/utils/some-in-by/test/test.js @@ -0,0 +1,317 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var noop = require( '@stdlib/utils/noop' ); +var someInBy = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof someInBy, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function throws an error if not provided an object', function test( t ) { + var values; + var i; + + values = [ + '5', + 5, + NaN, + true, + false, + null, + void 0, + [], + function noop() {} + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), TypeError, 'throws a type error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + someInBy( value, 2, noop ); + }; + } +}); + +tape( 'the function throws an error if not provided a second argument which is a positive integer', function test( t ) { + var values; + var i; + + values = [ + '5', + -5, + 0, + 3.14, + NaN, + true, + false, + null, + void 0, + {}, + [], + function noop() {} + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), TypeError, 'throws a type error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + someInBy( { + 'a': 1, + 'b': 2, + 'c': 3 + }, value, noop ); + }; + } +}); + +tape( 'the function throws an error if not provided a predicate function', function test( t ) { + var values; + var i; + + values = [ + '5', + 5, + NaN, + true, + false, + null, + void 0, + {}, + [], + /.*/, + new Date() + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), TypeError, 'throws a type error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + someInBy( { + 'a': 1, + 'b': 2, + 'c': 3 + }, 2, value ); + }; + } +}); + +tape( 'if provided an empty object, the function returns `false`', function test( t ) { + var bool; + var obj; + + function foo() { + t.fail( 'should not be invoked' ); + } + obj = {}; + bool = someInBy( obj, 1, foo ); + + t.strictEqual( bool, false, 'returns false' ); + t.end(); +}); + +tape( 'the function returns `true` if an object contains at least `n` properties which pass a test', function test( t ) { + var bool; + var obj; + + obj = { + 'a': 1, + 'b': -2, + 'c': 3, + 'd': -1 + }; + + function isNegative( value ) { + return ( value < 0 ); + } + + bool = someInBy( obj, 2, isNegative ); + + t.strictEqual( bool, true, 'returns true' ); + t.end(); +}); + +tape( 'the function returns `false` if an object does not contain at least `n` properties which pass a test (Case: At least 1)', function test( t ) { + var bool; + var obj; + + obj = { + 'a': -1, + 'b': -2, + 'c': -3 + }; + + function isPositive( value ) { + return ( value > 0 ); + } + + bool = someInBy( obj, 1, isPositive ); + + t.strictEqual( bool, false, 'returns false' ); + t.end(); +}); + +tape( 'the function returns `false` if an object does not contain at least `n` properties which pass a test (Case: At least 2)', function test( t ) { + var bool; + var obj; + + obj = { + 'a': -1, + 'b': -2, + 'c': -3 + }; + + function isPositive( value ) { + return ( value > 0 ); + } + + bool = someInBy( obj, 2, isPositive ); + + t.strictEqual( bool, false, 'returns false' ); + t.end(); +}); + +tape( 'the function supports providing an execution context', function test( t ) { + var bool; + var ctx; + var obj; + + function sum( value ) { + /* eslint-disable no-invalid-this */ + this.sum += value; + this.count += 1; + return ( value < 0 ); + } + + ctx = { + 'sum': 0, + 'count': 0 + }; + obj = { + 'a': 1.0, + 'b': -2.0, + 'c': 3.0, + 'd': -1.0 + }; + + bool = someInBy( obj, 2, sum, ctx ); + + t.strictEqual( bool, true, 'returns true' ); + t.strictEqual( ctx.sum/ctx.count, 0.25, 'expected result' ); + + t.end(); +}); + +tape( 'the function provides basic support for dynamic objects', function test( t ) { + var bool; + var obj; + + obj = { + 'a': 1, + 'b': 2, + 'c': 3 + }; + + function isNegative( value, key, collection ) { + if ( key === 'c' ) { + collection[ 'd' ] = value-1; + } + return ( value < 0 ); + } + + bool = someInBy( obj, 1, isNegative ); + + t.deepEqual( obj, { + 'a': 1, + 'b': 2, + 'c': 3, + 'd': 2 + }, 'expected result' ); + t.strictEqual( bool, false, 'returns false' ); + + t.end(); +}); + +tape( 'the function does not skip undefined properties', function test( t ) { + var expected; + var bool; + var obj; + + obj = { + 'a': 1, + 'b': void 0, + 'c': void 0, + 'd': 4, + 'e': -1 + }; + expected = { + 'a': 1, + 'b': void 0, + 'c': void 0, + 'd': 4, + 'e': -1 + }; + + function verify( value, key ) { + t.strictEqual( value, expected[ key ], 'provides expected value' ); + return ( value < 0 ); + } + + bool = someInBy( obj, 1, verify ); + + t.strictEqual( bool, true, 'returns true' ); + t.end(); +}); + +tape( 'the function returns `false` if provided a regular expression or a date object with no properties passing the test', function test( t ) { + var values; + var i; + + values = [ + /.*/, + new Date() + ]; + + for ( i = 0; i < values.length; i++ ) { + t.equal( someInBy( values[ i ], 1, threshold ), false, 'returns false when provided ' + values[ i ] ); + } + t.end(); + + function threshold( value ) { + return ( typeof value === 'number' ); + } +});