@sprucelabs/test-utils 5.1.552 → 5.2.0

package/build/assert/assert.js

@@ -258,7 +258,7 @@ const assert = {
 };
 exports.default = assert;
 function buildErrorMessage(defaultMessage, customMessage) {
-    return customMessage
+    return ((customMessage
         ? `${customMessage}\n\n${defaultMessage}`
-        : defaultMessage;
+        : defaultMessage) + '\n\n');
 }

package/build/esm/assert/assert.js

@@ -239,7 +239,7 @@ const assert = {
 };
 export default assert;
 function buildErrorMessage(defaultMessage, customMessage) {
-    return customMessage
+    return ((customMessage
         ? `${customMessage}\n\n${defaultMessage}`
-        : defaultMessage;
+        : defaultMessage) + '\n\n');
 }

package/build/esm/index.d.ts

@@ -7,3 +7,5 @@ export * from './assert/assert';
 export { default as test } from './decorators';
 export { default as assertUtil } from './assert/assert.utility';
 export { default as StackCleaner } from './StackCleaner';
+export { default as Spier } from './utilities/spies/Spier';
+export { default as Spy } from './utilities/spies/Spy';

package/build/esm/index.js

@@ -7,3 +7,5 @@ export * from './assert/assert.js';
 export { default as test } from './decorators.js';
 export { default as assertUtil } from './assert/assert.utility.js';
 export { default as StackCleaner } from './StackCleaner.js';
+export { default as Spier } from './utilities/spies/Spier.js';
+export { default as Spy } from './utilities/spies/Spy.js';

package/build/esm/utilities/spies/Spier.d.ts

@@ -0,0 +1,6 @@
+import Spy from './Spy';
+export default class Spier {
+    private static spyInstances;
+    static Spier(): Spier;
+    spy<T extends Record<string, any>>(object: T, method: keyof T): Spy<T, keyof T>;
+}

package/build/esm/utilities/spies/Spier.js

@@ -0,0 +1,20 @@
+import Spy from './Spy.js';
+class Spier {
+    static Spier() {
+        for (const spy of Spier.spyInstances) {
+            spy.reset();
+        }
+        Spier.spyInstances = [];
+        return new Spier();
+    }
+    spy(object, method) {
+        if (!object) {
+            throw new Error('You must pass a function to spy on');
+        }
+        const spy = new Spy(object, method);
+        Spier.spyInstances.push(spy);
+        return spy;
+    }
+}
+Spier.spyInstances = [];
+export default Spier;

package/build/esm/utilities/spies/Spy.d.ts

@@ -0,0 +1,11 @@
+export default class Spy<T extends Record<string, any>, M extends keyof T> {
+    private method;
+    private hitCount;
+    private originalMethod;
+    private object;
+    private lastArgs?;
+    constructor(object: T, method: M);
+    assertCalledTotalTimes(expected: number): void;
+    assertLastCalledWith(args: string[]): void;
+    reset(): void;
+}

package/build/esm/utilities/spies/Spy.js

@@ -0,0 +1,26 @@
+import assert from '../../assert/assert.js';
+export default class Spy {
+    constructor(object, method) {
+        this.hitCount = 0;
+        this.originalMethod = object[method].bind(object);
+        this.method = method;
+        this.object = object;
+        //@ts-ignore
+        this.object[method] = (...args) => {
+            this.hitCount++;
+            this.lastArgs = args;
+            return this.originalMethod(...args);
+        };
+    }
+    assertCalledTotalTimes(expected) {
+        if (this.hitCount !== expected) {
+            throw new Error(`${String(this.method)} was not called ${expected} time(s)! It was called ${this.hitCount} time(s).`);
+        }
+    }
+    assertLastCalledWith(args) {
+        assert.isEqualDeep(this.lastArgs, args, `${String(this.method)} was not called with the expected argument`);
+    }
+    reset() {
+        this.object[this.method] = this.originalMethod;
+    }
+}

package/build/index.d.ts

@@ -7,3 +7,5 @@ export * from './assert/assert';
 export { default as test } from './decorators';
 export { default as assertUtil } from './assert/assert.utility';
 export { default as StackCleaner } from './StackCleaner';
+export { default as Spier } from './utilities/spies/Spier';
+export { default as Spy } from './utilities/spies/Spy';

package/build/index.js

@@ -17,7 +17,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.StackCleaner = exports.assertUtil = exports.test = exports.assert = exports.default = exports.generateId = exports.errorAssertUtil = exports.errorAssert = void 0;
+exports.Spy = exports.Spier = exports.StackCleaner = exports.assertUtil = exports.test = exports.assert = exports.default = exports.generateId = exports.errorAssertUtil = exports.errorAssert = void 0;
 var errorAssert_1 = require("./utilities/errorAssert");
 Object.defineProperty(exports, "errorAssert", { enumerable: true, get: function () { return __importDefault(errorAssert_1).default; } });
 var errorAssert_utility_1 = require("./utilities/errorAssert.utility");
@@ -35,3 +35,7 @@ var assert_utility_1 = require("./assert/assert.utility");
 Object.defineProperty(exports, "assertUtil", { enumerable: true, get: function () { return __importDefault(assert_utility_1).default; } });
 var StackCleaner_1 = require("./StackCleaner");
 Object.defineProperty(exports, "StackCleaner", { enumerable: true, get: function () { return __importDefault(StackCleaner_1).default; } });
+var Spier_1 = require("./utilities/spies/Spier");
+Object.defineProperty(exports, "Spier", { enumerable: true, get: function () { return __importDefault(Spier_1).default; } });
+var Spy_1 = require("./utilities/spies/Spy");
+Object.defineProperty(exports, "Spy", { enumerable: true, get: function () { return __importDefault(Spy_1).default; } });

package/build/utilities/spies/Spier.d.ts

@@ -0,0 +1,6 @@
+import Spy from './Spy';
+export default class Spier {
+    private static spyInstances;
+    static Spier(): Spier;
+    spy<T extends Record<string, any>>(object: T, method: keyof T): Spy<T, keyof T>;
+}

package/build/utilities/spies/Spier.js

@@ -0,0 +1,25 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Spy_1 = __importDefault(require("./Spy"));
+class Spier {
+    static Spier() {
+        for (const spy of Spier.spyInstances) {
+            spy.reset();
+        }
+        Spier.spyInstances = [];
+        return new Spier();
+    }
+    spy(object, method) {
+        if (!object) {
+            throw new Error('You must pass a function to spy on');
+        }
+        const spy = new Spy_1.default(object, method);
+        Spier.spyInstances.push(spy);
+        return spy;
+    }
+}
+Spier.spyInstances = [];
+exports.default = Spier;

package/build/utilities/spies/Spy.d.ts

@@ -0,0 +1,11 @@
+export default class Spy<T extends Record<string, any>, M extends keyof T> {
+    private method;
+    private hitCount;
+    private originalMethod;
+    private object;
+    private lastArgs?;
+    constructor(object: T, method: M);
+    assertCalledTotalTimes(expected: number): void;
+    assertLastCalledWith(args: string[]): void;
+    reset(): void;
+}

package/build/utilities/spies/Spy.js

@@ -0,0 +1,32 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const assert_1 = __importDefault(require("../../assert/assert"));
+class Spy {
+    constructor(object, method) {
+        this.hitCount = 0;
+        this.originalMethod = object[method].bind(object);
+        this.method = method;
+        this.object = object;
+        //@ts-ignore
+        this.object[method] = (...args) => {
+            this.hitCount++;
+            this.lastArgs = args;
+            return this.originalMethod(...args);
+        };
+    }
+    assertCalledTotalTimes(expected) {
+        if (this.hitCount !== expected) {
+            throw new Error(`${String(this.method)} was not called ${expected} time(s)! It was called ${this.hitCount} time(s).`);
+        }
+    }
+    assertLastCalledWith(args) {
+        assert_1.default.isEqualDeep(this.lastArgs, args, `${String(this.method)} was not called with the expected argument`);
+    }
+    reset() {
+        this.object[this.method] = this.originalMethod;
+    }
+}
+exports.default = Spy;

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "5.1.552",
+  "version": "5.2.0",
   "files": [
     "build"
   ],