@serenity-js/assertions 3.0.0-rc.21 → 3.0.0-rc.22

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.0.0-rc.22](https://github.com/serenity-js/serenity-js/compare/v3.0.0-rc.21...v3.0.0-rc.22) (2022-07-15)
+
+
+### Features
+
+* **assertions:** isCloseTo(expected, tolerance) ([bb0e935](https://github.com/serenity-js/serenity-js/commit/bb0e935e197b195da598ccbec6c6cf7704dd875b))
+
+
+
+
+
 # [3.0.0-rc.21](https://github.com/serenity-js/serenity-js/compare/v3.0.0-rc.20...v3.0.0-rc.21) (2022-07-11)
 
 **Note:** Version bump only for package @serenity-js/assertions

package/lib/expectations/index.d.ts

@@ -7,6 +7,7 @@ export * from './equals';
 export * from './includes';
 export * from './isAfter';
 export * from './isBefore';
+export * from './isCloseTo';
 export * from './isFalse';
 export * from './isGreaterThan';
 export * from './isLessThan';

package/lib/expectations/index.js

@@ -23,6 +23,7 @@ __exportStar(require("./equals"), exports);
 __exportStar(require("./includes"), exports);
 __exportStar(require("./isAfter"), exports);
 __exportStar(require("./isBefore"), exports);
+__exportStar(require("./isCloseTo"), exports);
 __exportStar(require("./isFalse"), exports);
 __exportStar(require("./isGreaterThan"), exports);
 __exportStar(require("./isLessThan"), exports);

package/lib/expectations/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/expectations/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wCAAsB;AACtB,4CAA0B;AAC1B,8DAA4C;AAC5C,8DAA4C;AAC5C,6CAA2B;AAC3B,2CAAyB;AACzB,6CAA2B;AAC3B,4CAA0B;AAC1B,6CAA2B;AAC3B,4CAA0B;AAC1B,kDAAgC;AAChC,+CAA6B;AAC7B,8CAA4B;AAC5B,2CAAyB;AACzB,4CAA0B;AAC1B,wCAAsB;AACtB,uCAAqB;AACrB,+CAA6B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/expectations/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wCAAsB;AACtB,4CAA0B;AAC1B,8DAA4C;AAC5C,8DAA4C;AAC5C,6CAA2B;AAC3B,2CAAyB;AACzB,6CAA2B;AAC3B,4CAA0B;AAC1B,6CAA2B;AAC3B,8CAA4B;AAC5B,4CAA0B;AAC1B,kDAAgC;AAChC,+CAA6B;AAC7B,8CAA4B;AAC5B,2CAAyB;AACzB,4CAA0B;AAC1B,wCAAsB;AACtB,uCAAqB;AACrB,+CAA6B"}

package/lib/expectations/isCloseTo.d.ts

@@ -0,0 +1,17 @@
+import { Answerable, Expectation } from '@serenity-js/core';
+/**
+ * @desc
+ *  Expectation that the actual value is within a given ± absolute tolerance range of the expected value.
+ *
+ * @example
+ *  import { actorCalled } from '@serenity-js/core'
+ *  import { Ensure, isCloseTo } from '@serenity-js/assertions'
+ *
+ *  await actorCalled('Iris').attemptsTo(
+ *      Ensure.that(10.123, isCloseTo(10, 0.2))
+ *  )
+ *
+ * @param {Answerable<number>} expected
+ * @param {Answerable<number>} [absoluteTolerance=1e-9]
+ */
+export declare function isCloseTo(expected: Answerable<number>, absoluteTolerance?: Answerable<number>): Expectation<number>;

package/lib/expectations/isCloseTo.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isCloseTo = void 0;
+const core_1 = require("@serenity-js/core");
+/**
+ * @desc
+ *  Expectation that the actual value is within a given ± absolute tolerance range of the expected value.
+ *
+ * @example
+ *  import { actorCalled } from '@serenity-js/core'
+ *  import { Ensure, isCloseTo } from '@serenity-js/assertions'
+ *
+ *  await actorCalled('Iris').attemptsTo(
+ *      Ensure.that(10.123, isCloseTo(10, 0.2))
+ *  )
+ *
+ * @param {Answerable<number>} expected
+ * @param {Answerable<number>} [absoluteTolerance=1e-9]
+ */
+function isCloseTo(expected, absoluteTolerance = 1e-9) {
+    return new IsCloseTo(expected, absoluteTolerance);
+}
+exports.isCloseTo = isCloseTo;
+/**
+ * @package
+ */
+class IsCloseTo extends core_1.Expectation {
+    constructor(expected, absoluteTolerance) {
+        super((0, core_1.d) `have value close to ${expected} ±${absoluteTolerance}`, async (actor, actual) => {
+            const actualValue = await actor.answer(actual);
+            const expectedValue = await actor.answer(this.expected);
+            const tolerance = await actor.answer(this.absoluteTolerance);
+            const description = `have value close to ${expectedValue} ±${tolerance}`;
+            // short-circuit exact equality
+            if (actualValue === expectedValue) {
+                return new core_1.ExpectationMet(description, expectedValue, actualValue);
+            }
+            if (!(Number.isFinite(actualValue) && Number.isFinite(expectedValue))) {
+                return new core_1.ExpectationNotMet(description, expectedValue, actualValue);
+            }
+            const difference = Math.abs(actualValue - expectedValue);
+            const isClose = difference <= tolerance;
+            return isClose
+                ? new core_1.ExpectationMet(description, expectedValue, actualValue)
+                : new core_1.ExpectationNotMet(description, expectedValue, actualValue);
+        });
+        this.expected = expected;
+        this.absoluteTolerance = absoluteTolerance;
+    }
+}
+//# sourceMappingURL=isCloseTo.js.map

package/lib/expectations/isCloseTo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isCloseTo.js","sourceRoot":"","sources":["../../src/expectations/isCloseTo.ts"],"names":[],"mappings":";;;AAAA,4CAAoH;AAEpH;;;;;;;;;;;;;;GAcG;AACH,SAAgB,SAAS,CAAC,QAA4B,EAAE,oBAAwC,IAAI;IAChG,OAAO,IAAI,SAAS,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC;AACtD,CAAC;AAFD,8BAEC;AAED;;GAEG;AACH,MAAM,SAAU,SAAQ,kBAAmB;IAEvC,YACqB,QAA4B,EAC5B,iBAAqC;QAEtD,KAAK,CACD,IAAA,QAAC,EAAA,uBAAwB,QAAS,KAAM,iBAAkB,EAAE,EAC5D,KAAK,EAAE,KAAuB,EAAE,MAA0B,EAAE,EAAE;YAE1D,MAAM,WAAW,GAAa,MAAM,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YACzD,MAAM,aAAa,GAAW,MAAM,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAChE,MAAM,SAAS,GAAe,MAAM,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;YAEzE,MAAM,WAAW,GAAG,uBAAwB,aAAc,KAAM,SAAU,EAAE,CAAA;YAE5E,+BAA+B;YAC/B,IAAI,WAAW,KAAK,aAAa,EAAE;gBAC/B,OAAO,IAAI,qBAAc,CAAC,WAAW,EAAE,aAAa,EAAE,WAAW,CAAC,CAAC;aACtE;YAED,IAAI,CAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,EAAE;gBACpE,OAAO,IAAI,wBAAiB,CAAC,WAAW,EAAE,aAAa,EAAE,WAAW,CAAC,CAAC;aACzE;YAED,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,WAAW,GAAG,aAAa,CAAC,CAAA;YAExD,MAAM,OAAO,GAAG,UAAU,IAAI,SAAS,CAAC;YAExC,OAAO,OAAO;gBACV,CAAC,CAAC,IAAI,qBAAc,CAAC,WAAW,EAAE,aAAa,EAAE,WAAW,CAAC;gBAC7D,CAAC,CAAC,IAAI,wBAAiB,CAAC,WAAW,EAAE,aAAa,EAAE,WAAW,CAAC,CAAC;QACzE,CAAC,CACJ,CAAC;QA9Be,aAAQ,GAAR,QAAQ,CAAoB;QAC5B,sBAAiB,GAAjB,iBAAiB,CAAoB;IA8B1D,CAAC;CACJ"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serenity-js/assertions",
-  "version": "3.0.0-rc.21",
+  "version": "3.0.0-rc.22",
   "description": "Screenplay-style assertion library",
   "author": {
     "name": "Jan Molak",
@@ -46,7 +46,7 @@
     "npm": "^6 || ^7 || ^8"
   },
   "dependencies": {
-    "@serenity-js/core": "3.0.0-rc.21",
+    "@serenity-js/core": "3.0.0-rc.22",
     "tiny-types": "^1.18.4"
   },
   "devDependencies": {
@@ -58,5 +58,5 @@
     "ts-node": "10.8.2",
     "typescript": "^4.7.4"
   },
-  "gitHead": "ddf72178856dd97ee448029f5029236c3c8b8c8b"
+  "gitHead": "3eb059a552b02c3ef7ee3cf2d8dcaaba9fcb2059"
 }

package/src/expectations/index.ts

@@ -7,6 +7,7 @@ export * from './equals';
 export * from './includes';
 export * from './isAfter';
 export * from './isBefore';
+export * from './isCloseTo';
 export * from './isFalse';
 export * from './isGreaterThan';
 export * from './isLessThan';

package/src/expectations/isCloseTo.ts

@@ -0,0 +1,60 @@
+import { Answerable, AnswersQuestions, d, Expectation, ExpectationMet, ExpectationNotMet } from '@serenity-js/core';
+
+/**
+ * @desc
+ *  Expectation that the actual value is within a given ± absolute tolerance range of the expected value.
+ *
+ * @example
+ *  import { actorCalled } from '@serenity-js/core'
+ *  import { Ensure, isCloseTo } from '@serenity-js/assertions'
+ *
+ *  await actorCalled('Iris').attemptsTo(
+ *      Ensure.that(10.123, isCloseTo(10, 0.2))
+ *  )
+ *
+ * @param {Answerable<number>} expected
+ * @param {Answerable<number>} [absoluteTolerance=1e-9]
+ */
+export function isCloseTo(expected: Answerable<number>, absoluteTolerance: Answerable<number> = 1e-9): Expectation<number> {
+    return new IsCloseTo(expected, absoluteTolerance);
+}
+
+/**
+ * @package
+ */
+class IsCloseTo extends Expectation<number> {
+
+    constructor(
+        private readonly expected: Answerable<number>,
+        private readonly absoluteTolerance: Answerable<number>,
+    ) {
+        super(
+            d`have value close to ${ expected } ±${ absoluteTolerance }`,
+            async (actor: AnswersQuestions, actual: Answerable<number>) => {
+
+                const actualValue: number   = await actor.answer(actual);
+                const expectedValue: number = await actor.answer(this.expected);
+                const tolerance: number     = await actor.answer(this.absoluteTolerance);
+
+                const description = `have value close to ${ expectedValue } ±${ tolerance }`
+
+                // short-circuit exact equality
+                if (actualValue === expectedValue) {
+                    return new ExpectationMet(description, expectedValue, actualValue);
+                }
+
+                if (! (Number.isFinite(actualValue) && Number.isFinite(expectedValue))) {
+                    return new ExpectationNotMet(description, expectedValue, actualValue);
+                }
+
+                const difference = Math.abs(actualValue - expectedValue)
+
+                const isClose = difference <= tolerance;
+
+                return isClose
+                    ? new ExpectationMet(description, expectedValue, actualValue)
+                    : new ExpectationNotMet(description, expectedValue, actualValue);
+            }
+        );
+    }
+}