assert-logic 1.0.0 → 1.1.0

package/README.md

@@ -2,8 +2,7 @@
 
 ![Downloads](https://img.shields.io/npm/dw/assert-logic?style=flat-square) ![Version@npm](https://img.shields.io/npm/v/assert-logic?label=version%40npm&style=flat-square) ![Version@git](https://img.shields.io/github/package-json/v/szikszail/assert-logic/main?label=version%40git&style=flat-square) ![CI](https://img.shields.io/github/actions/workflow/status/szikszail/assert-logic/ci.yml?branch=main&label=ci&style=flat-square) ![Docs](https://img.shields.io/github/actions/workflow/status/szikszail/assert-logic/docs.yml?branch=main&label=docs&style=flat-square)
 
-This handy tool can be used to implement additional logic into your assertions, either using Chai, Jest, Assert, or
-plain JavaScript.
+This handy tool can be used to implement additional logic into your assertions, either using Chai, Jest, Assert, or plain JavaScript.
 
 ## Usage
 
@@ -50,8 +49,10 @@ In all other cases, the value is considered passed.
 
 ### Operations
 
-The API contains the following functions: `and`, `or`, `not`, `xor`, `nand`, `nor`, `xnor`, and also the `evaluate`
-function. All accept any number of sync/async functions, Promises, or values as arguments.
+The API contains the following functions: `and`, `or`, `not`, `xor`, `nand`, `nor`, `xnor`, `every`, `some`, and also the `evaluate`
+function. 
+
+The following ones accept any number of sync/async functions, Promises, or values as arguments.
 
 | Operation | Description                                             |
 |-----------|---------------------------------------------------------|
@@ -63,6 +64,23 @@ function. All accept any number of sync/async functions, Promises, or values as
 | nor       | Passes if all of its arguments fail                     |
 | xnor      | Passes if all of its arguments pass or all of them fail |
 
+The `every` and `some` functions are used to evaluate an array of values. The values must be the first parameter, but both functions accept a second parameter that is a function that will be called with each value. If the function is not passed as the second parameter, the value will be interpreted as boolean values.
+ 
+The `every` function is a shorthand for `and` with the values as arguments, while the `some` function is a shorthand for `or` with the values as arguments.
+
+```javascript
+const {every, some} = require('assert-logic');
+const {expect} = require('expect');
+
+const items = [{id: 1, name: 'Item 1', price: 10}, {id: 2, name: 'Item 2', price: -20}, /* ... */];
+every(items, item => {
+    expect(item.id, "Item should have ID as positive number").toBeGreaterThan(0);
+}).evaluate(); // will not throw
+some(items, item => {
+    expect(item.price, "Item should have a positive price").toBeGreaterThan(0);
+}).evaluate(); // will throw
+```
+
 #### Append
 
 The `append` function can be used to append additional logic to an existing variadic logic (all except `pass`).

package/assertion/every.d.ts

@@ -0,0 +1,5 @@
+import { ANDAssertion } from "./and";
+import type { AssertionGeneratorFunction } from "../types";
+export declare class EVERYAssertion<T> extends ANDAssertion {
+    constructor(items: T[], fn: AssertionGeneratorFunction<T>);
+}

package/assertion/every.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EVERYAssertion = void 0;
+const and_1 = require("./and");
+class EVERYAssertion extends and_1.ANDAssertion {
+    constructor(items, fn) {
+        super(...(items ? items.map((item) => () => (fn || Boolean)(item)) : []));
+    }
+}
+exports.EVERYAssertion = EVERYAssertion;
+//# sourceMappingURL=every.js.map

package/assertion/every.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"every.js","sourceRoot":"","sources":["../../src/assertion/every.ts"],"names":[],"mappings":";;;AAAA,+BAAmC;AAGnC,MAAa,cAAkB,SAAQ,kBAAY;IAC/C,YAAY,KAAU,EAAE,EAAiC;QACrD,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,IAAI,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9E,CAAC;CACJ;AAJD,wCAIC"}

package/assertion/some.d.ts

@@ -0,0 +1,5 @@
+import { ORAssertion } from "./or";
+import type { AssertionGeneratorFunction } from "../types";
+export declare class SOMEAssertion<T> extends ORAssertion {
+    constructor(items: T[], fn: AssertionGeneratorFunction<T>);
+}

package/assertion/some.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SOMEAssertion = void 0;
+const or_1 = require("./or");
+class SOMEAssertion extends or_1.ORAssertion {
+    constructor(items, fn) {
+        super(...(items ? items.map((item) => () => (fn || Boolean)(item)) : []));
+    }
+}
+exports.SOMEAssertion = SOMEAssertion;
+//# sourceMappingURL=some.js.map

package/assertion/some.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"some.js","sourceRoot":"","sources":["../../src/assertion/some.ts"],"names":[],"mappings":";;;AAAA,6BAAiC;AAGjC,MAAa,aAAiB,SAAQ,gBAAW;IAC7C,YAAY,KAAU,EAAE,EAAiC;QACrD,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,IAAI,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9E,CAAC;CACJ;AAJD,sCAIC"}

package/index.d.ts

@@ -1,4 +1,4 @@
-import type { AssertionValue } from "./types";
+import type { AssertionValue, AssertionGeneratorFunction } from "./types";
 import { PASSAssertion } from "./assertion/pass";
 import { NOTAssertion } from "./assertion/not";
 import { ORAssertion } from "./assertion/or";
@@ -7,6 +7,8 @@ import { XORAssertion } from "./assertion/xor";
 import { NORAssertion } from "./assertion/nor";
 import { NANDAssertion } from "./assertion/nand";
 import { XNORAssertion } from "./assertion/xnor";
+import { EVERYAssertion } from "./assertion/every";
+import { SOMEAssertion } from "./assertion/some";
 export declare const pass: (value: AssertionValue) => PASSAssertion;
 export declare const not: (value: AssertionValue) => NOTAssertion;
 export declare const or: (...values: AssertionValue[]) => ORAssertion;
@@ -15,3 +17,5 @@ export declare const nor: (...values: AssertionValue[]) => NORAssertion;
 export declare const nand: (...values: AssertionValue[]) => NANDAssertion;
 export declare const xor: (...values: AssertionValue[]) => XORAssertion;
 export declare const xnor: (...values: AssertionValue[]) => XNORAssertion;
+export declare const every: <T>(items: T[], fn?: AssertionGeneratorFunction<T>) => EVERYAssertion<T>;
+export declare const some: <T>(items: T[], fn?: AssertionGeneratorFunction<T>) => SOMEAssertion<T>;

package/index.js

@@ -1,7 +1,7 @@
 "use strict";
 // import debug = require("debug");
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.xnor = exports.xor = exports.nand = exports.nor = exports.and = exports.or = exports.not = exports.pass = void 0;
+exports.some = exports.every = exports.xnor = exports.xor = exports.nand = exports.nor = exports.and = exports.or = exports.not = exports.pass = void 0;
 const pass_1 = require("./assertion/pass");
 const not_1 = require("./assertion/not");
 const or_1 = require("./assertion/or");
@@ -10,6 +10,8 @@ const xor_1 = require("./assertion/xor");
 const nor_1 = require("./assertion/nor");
 const nand_1 = require("./assertion/nand");
 const xnor_1 = require("./assertion/xnor");
+const every_1 = require("./assertion/every");
+const some_1 = require("./assertion/some");
 const lines_builder_1 = require("lines-builder");
 (0, lines_builder_1.setDefaultOptions)({
     // Need to force EOL to be Unix style, because Windows style is not supported by YAML
@@ -34,4 +36,8 @@ const xor = (...values) => new xor_1.XORAssertion(...values);
 exports.xor = xor;
 const xnor = (...values) => new xnor_1.XNORAssertion(...values);
 exports.xnor = xnor;
+const every = (items, fn) => new every_1.EVERYAssertion(items, fn);
+exports.every = every;
+const some = (items, fn) => new some_1.SOMEAssertion(items, fn);
+exports.some = some;
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,mCAAmC;;;AAKnC,2CAA+C;AAC/C,yCAA6C;AAC7C,uCAA2C;AAC3C,yCAA6C;AAC7C,yCAA6C;AAC7C,yCAA6C;AAC7C,2CAA+C;AAC/C,2CAA+C;AAE/C,iDAAgD;AAEhD,IAAA,iCAAiB,EAAC;IAChB,qFAAqF;IACrF,GAAG,EAAE,IAAI;IACT,QAAQ,EAAE,KAAK;IACf,oBAAoB,EAAE,IAAI;IAC1B,MAAM,EAAE,CAAC;CACV,CAAC,CAAC;AAEI,MAAM,IAAI,GAAG,CAAC,KAAqB,EAAE,EAAE,CAAC,IAAI,oBAAa,CAAC,KAAK,CAAC,CAAC;AAA3D,QAAA,IAAI,QAAuD;AACjE,MAAM,GAAG,GAAG,CAAC,KAAqB,EAAE,EAAE,CAAC,IAAI,kBAAY,CAAC,KAAK,CAAC,CAAC;AAAzD,QAAA,GAAG,OAAsD;AAC/D,MAAM,EAAE,GAAG,CAAC,GAAG,MAAwB,EAAE,EAAE,CAAC,IAAI,gBAAW,CAAC,GAAG,MAAM,CAAC,CAAC;AAAjE,QAAA,EAAE,MAA+D;AACvE,MAAM,GAAG,GAAG,CAAC,GAAG,MAAwB,EAAE,EAAE,CAAC,IAAI,kBAAY,CAAC,GAAG,MAAM,CAAC,CAAC;AAAnE,QAAA,GAAG,OAAgE;AACzE,MAAM,GAAG,GAAG,CAAC,GAAG,MAAwB,EAAE,EAAE,CAAC,IAAI,kBAAY,CAAC,GAAG,MAAM,CAAC,CAAC;AAAnE,QAAA,GAAG,OAAgE;AACzE,MAAM,IAAI,GAAG,CAAC,GAAG,MAAwB,EAAE,EAAE,CAAC,IAAI,oBAAa,CAAC,GAAG,MAAM,CAAC,CAAC;AAArE,QAAA,IAAI,QAAiE;AAC3E,MAAM,GAAG,GAAG,CAAC,GAAG,MAAwB,EAAE,EAAE,CAAC,IAAI,kBAAY,CAAC,GAAG,MAAM,CAAC,CAAC;AAAnE,QAAA,GAAG,OAAgE;AACzE,MAAM,IAAI,GAAG,CAAC,GAAG,MAAwB,EAAE,EAAE,CAAC,IAAI,oBAAa,CAAC,GAAG,MAAM,CAAC,CAAC;AAArE,QAAA,IAAI,QAAiE"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,mCAAmC;;;AAKnC,2CAA+C;AAC/C,yCAA6C;AAC7C,uCAA2C;AAC3C,yCAA6C;AAC7C,yCAA6C;AAC7C,yCAA6C;AAC7C,2CAA+C;AAC/C,2CAA+C;AAC/C,6CAAiD;AACjD,2CAA+C;AAE/C,iDAAgD;AAEhD,IAAA,iCAAiB,EAAC;IAChB,qFAAqF;IACrF,GAAG,EAAE,IAAI;IACT,QAAQ,EAAE,KAAK;IACf,oBAAoB,EAAE,IAAI;IAC1B,MAAM,EAAE,CAAC;CACV,CAAC,CAAC;AAEI,MAAM,IAAI,GAAG,CAAC,KAAqB,EAAE,EAAE,CAAC,IAAI,oBAAa,CAAC,KAAK,CAAC,CAAC;AAA3D,QAAA,IAAI,QAAuD;AACjE,MAAM,GAAG,GAAG,CAAC,KAAqB,EAAE,EAAE,CAAC,IAAI,kBAAY,CAAC,KAAK,CAAC,CAAC;AAAzD,QAAA,GAAG,OAAsD;AAC/D,MAAM,EAAE,GAAG,CAAC,GAAG,MAAwB,EAAE,EAAE,CAAC,IAAI,gBAAW,CAAC,GAAG,MAAM,CAAC,CAAC;AAAjE,QAAA,EAAE,MAA+D;AACvE,MAAM,GAAG,GAAG,CAAC,GAAG,MAAwB,EAAE,EAAE,CAAC,IAAI,kBAAY,CAAC,GAAG,MAAM,CAAC,CAAC;AAAnE,QAAA,GAAG,OAAgE;AACzE,MAAM,GAAG,GAAG,CAAC,GAAG,MAAwB,EAAE,EAAE,CAAC,IAAI,kBAAY,CAAC,GAAG,MAAM,CAAC,CAAC;AAAnE,QAAA,GAAG,OAAgE;AACzE,MAAM,IAAI,GAAG,CAAC,GAAG,MAAwB,EAAE,EAAE,CAAC,IAAI,oBAAa,CAAC,GAAG,MAAM,CAAC,CAAC;AAArE,QAAA,IAAI,QAAiE;AAC3E,MAAM,GAAG,GAAG,CAAC,GAAG,MAAwB,EAAE,EAAE,CAAC,IAAI,kBAAY,CAAC,GAAG,MAAM,CAAC,CAAC;AAAnE,QAAA,GAAG,OAAgE;AACzE,MAAM,IAAI,GAAG,CAAC,GAAG,MAAwB,EAAE,EAAE,CAAC,IAAI,oBAAa,CAAC,GAAG,MAAM,CAAC,CAAC;AAArE,QAAA,IAAI,QAAiE;AAC3E,MAAM,KAAK,GAAG,CAAI,KAAU,EAAE,EAAkC,EAAE,EAAE,CAAC,IAAI,sBAAc,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;AAA7F,QAAA,KAAK,SAAwF;AACnG,MAAM,IAAI,GAAG,CAAI,KAAU,EAAE,EAAkC,EAAE,EAAE,CAAC,IAAI,oBAAa,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;AAA3F,QAAA,IAAI,QAAuF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "assert-logic",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "This repository/project is a template/placeholder for new NPM packages.",
   "main": "index.js",
   "types": "index.d.ts",