strong-mock 8.0.0-beta.1 → 8.0.0

package/README.md

@@ -44,10 +44,10 @@ console.log(foo.bar(23)); // 'I am strong!'
   - [Verifying expectations](#verifying-expectations)
   - [Resetting expectations](#resetting-expectations)
   - [Argument matchers](#argument-matchers)
-  - [Mock options](#mock-options)
-    - [Strictness](#strictness)
-    - [Concrete matcher](#concrete-matcher)
-    - [Defaults](#defaults)
+- [Mock options](#mock-options)
+  - [Unexpected property return value](#unexpected-property-return-value)
+  - [Exact params](#exact-params)
+  - [Concrete matcher](#concrete-matcher)
 - [FAQ](#faq)
   - [Why do I have to set all expectations first?](#why-do-i-have-to-set-all-expectations-first)
   - [Can I partially mock an existing object/function?](#can-i-partially-mock-an-existing-objectfunction)
@@ -63,7 +63,7 @@ console.log(foo.bar(23)); // 'I am strong!'
 
 ### Type safety
 
-The created mock matches the mocked type so all expectations are type safe. Moreover, refactorings in an IDE will also cover your expectations.
+The mock expectations will share the same type guarantees as your production code, and you can safely refactor in an IDE knowing that all usages will be updated.
 
 ![Renaming production code and test code](media/rename-refactor.gif)
 
@@ -85,7 +85,7 @@ fn(4, 5, 6);
 
 ### Type safe argument matchers
 
-Optional argument matchers allow you to create complex expectations, while still maintaining type safety.
+You can use argument matchers to partially match values, or create complex expectations, while still maintaining type safety.
 
 ![Type safe matcher showing a type error](media/type-safe-matchers.png)
 
@@ -125,11 +125,9 @@ console.log(foo.bar(23)); // awesome
 console.log(foo.bar(23)); // even more awesome
 ```
 
-By default, each call is expected to be called only once. You can expect a call to be made multiple times using the [invocation count](#setting-invocation-count-expectations) helpers.
-
 ### Setting invocation count expectations
 
-You can expect a call to be made multiple times by using the invocation count helpers `between`, `atLeast`, `times`, `anyTimes` etc.:
+By default, each call is expected to be made only once. You can expect a call to be made multiple times by using the invocation count helpers `between`, `atLeast`, `times`, `anyTimes` etc.:
 
 ```typescript
 const fn = mock<(x: number) => number>();
@@ -142,6 +140,8 @@ console.log(fn(1)); // 1
 console.log(fn(1)); // throws because the expectation is finished
 ```
 
+You'll notice there is no `never()` helper - if you expect a call to not be made simply don't set an expectation on it and the mock will throw if the call happens.
+
 ### Mocking interfaces
 
 Pass in the interface to the generic argument of `mock`:
@@ -161,8 +161,6 @@ console.log(foo.bar(23)); // 'awesome'
 console.log(foo.baz); // 100
 ```
 
-Since the mock is type safe the compiler will guarantee that you're only mocking things that actually exist on the interface.
-
 ### Mocking functions
 
 You can also mock functions similarly to interfaces:
@@ -179,7 +177,7 @@ console.log(fn(1)); // 2
 
 ### Mocking promises
 
-If you're mocking something that returns a promise then you'll be able to use the promise helpers to set the return value.
+If you're mocking something that returns a promise then you'll be able to use the `thenResolve` promise helper to set the return value.
 
 ```typescript
 type Fn = (x: number) => Promise<number>;
@@ -193,29 +191,33 @@ console.log(await fn()); // 2
 
 ### Throwing errors
 
+Use `thenThrow` or `thenReject` to throw an `Error` instance. You can customize the error message, or even pass a derived class.
+
 ```typescript
 type Fn = (x: number) => void;
 type FnWithPromise = (x: number) => Promise<void>;
 
+class MyError extends Error {}
+
 const fn = mock<Fn>();
 const fnWithPromise = mock<FnWithPromise>();
 
+// All of these will throw an Error instance.
 when(() => fn(1)).thenThrow();
-when(() => fnWithPromise(1)).thenReject();
+when(() => fn(2)).thenThrow(MyError);
+when(() => fnWithPromise(1)).thenReject('oops');
 ```
 
-You'll notice there is no `never()` helper - if you expect a call to not be made simply don't set an expectation on it and the mock will throw if the call happens.
-
 ### Verifying expectations
 
-Calling `verify(mock)` will make sure that all expectations set on `mock` have been met. If not, the function will throw an error and print the unmet expectations.
+Calling `verify(myMock)` will make sure that all expectations set on the mock have been met, and that no additional calls have been made.
 
 ```typescript
 const fn = mock<(x: number) => number>();
 
 when(() => fn(1)).thenReturn(1).between(2, 10);
 
-verify(fn); // throws
+verify(fn); // throws UnmetExpectations
 ```
 
 It will also throw if any unexpected calls happened that were maybe caught in the code under test.
@@ -229,10 +231,16 @@ try {
   // your code might transition to an error state here
 }
 
-verify(fn); // throws
+verify(fn); // throws UnexpectedCalls
 ```
 
-It is recommended that you call `verify()` on your mocks at the end of every test. This will make sure you don't have any unused expectations in your tests and that your code did not silently catch any of the errors that are thrown when an unexpected call happens. You can use `verifyAll()` to check all existing mocks e.g. in an `afterEach` hook.
+It is recommended that you call `verify()` on your mocks at the end of every test. This will make sure you don't have any unused expectations in your tests and that your code did not silently catch any of the errors that are thrown when an unexpected call happens. You can use `verifyAll()` to check all existing mocks.
+
+```typescript
+afterEach(() => {
+  verifyAll();
+})
+```
 
 ![verify error](./media/verify.png)
 
@@ -250,11 +258,17 @@ reset(fn);
 fn(1); // throws
 ```
 
-If you create common mocks that are shared by multiple tests you should reset them before using them e.g. in a `beforeEach` hook. You can use `resetAll()` to reset all existing mocks.
+If you create common mocks that are shared by multiple tests you should reset them before each test. You can use `resetAll()` to reset all existing mocks.
+
+```typescript
+beforeEach(() => {
+  resetAll();
+})
+```
 
 ### Argument matchers
 
-Sometimes you're not interested in specifying all the arguments in an expectation. Maybe they've been covered in another test, maybe they're hard to specify e.g. callbacks. In those cases you can use argument matchers to either ignore some arguments or use custom matchers to check them.
+Sometimes you're not interested in specifying all the arguments in an expectation. Maybe they've been covered in another test, maybe they're hard to specify e.g. callbacks, or maybe you want to match just a property from an argument.
 
 ```typescript
 const fn = mock<
@@ -293,7 +307,7 @@ The following table illustrates the differences between the equality matchers:
 
 | expected           | actual               | `It.is`   | `It.deepEquals` | `It.deepEquals({ strict: false })` |
 |--------------------|----------------------|-----------|-----------------|------------------------------------|
-| `"foo"`            | `"bar"`              | equal     | equal           | equal                              |
+| `"foo"`            | `"foo"`              | equal     | equal           | equal                              |
 | `{ foo: "bar" }`   | `{ foo: "bar" }`     | not equal | equal           | equal                              |
 | `{ }`              | `{ foo: undefined }` | not equal | not equal       | equal                              |
 | `new (class {})()` | `new (class {})()`   | not equal | not equal       | equal                              |
@@ -333,65 +347,105 @@ console.log(fn(23, (x) => x + 1)); // 42
 console.log(matcher.value?.(3)); // 4
 ```
 
-### Mock options
+## Mock options
+
+The following options can be set per mock, or globally with `setDefaults`.
+
+```typescript
+import { mock, when, setDefaults } from 'strong-mock';
+
+setDefaults({
+  exactParams: true
+});
+
+// Uses the new default.
+const superStrictMock = mock<() => void>();
+// Overrides the default.
+const strictMock = mock<() => void>({ exactParams: false });
+```
 
-#### Strictness
+### Unexpected property return value
 
-strong-mock has a few levels of "strictness" that control what values are returned when an unexpected property is accessed or an unexpected call is made. The strictness can be configured for each mock, or for all mocks with `setDefaults`.
+You can control what happens whenever an unexpected property is accessed, or an unexpected call is made.
 
 ```typescript
-import { mock, when } from 'strong-mock';
-import { Strictness } from './options';
+import { mock, when, UnexpectedProperty } from 'strong-mock';
 
 type Foo = {
   bar: (value: number) => number;
 }
 
 // This is the default.
-const strictFoo = mock<Foo>({ strictness: Strictness.STRICT });
+const callsThrow = mock<Foo>({
+  unexpectedProperty: UnexpectedProperty.CALL_THROW
+});
 
 // Accessing properties with no expectations is fine.
-strictFoo.bar;
+callsThrow.bar;
 // Throws "Didn't expect bar(42) to be called".
-strictFoo.bar(42);
+callsThrow.bar(42);
 
-const superStrictFoo = mock<Foo>({ strictness: Strictness.SUPER_STRICT });
+const propertiesThrow = mock<Foo>({
+  unexpectedProperty: UnexpectedProperty.THROW
+});
 
 // Throws "Didn't expect property bar to be accessed".
-superStrictFoo.bar;
+propertiesThrow.bar;
 // Throws "Didn't expect property bar to be accessed".
-superStrictFoo.bar(42);
+propertiesThrow.bar(42);
 ```
 
-#### Concrete matcher
+### Exact params
 
-You can set the matcher that will be used in expectations with concrete values e.g. `42` or `{ foo: "bar" }`. Passing in a [matcher argument](#argument-matchers) will always take priority.
+By default, function/method expectations will allow more arguments to be received than expected. Since the expectations are type safe, the TypeScript compiler will never allow expecting less arguments than required. Unspecified optional arguments will be considered ignored, as if they've been replaced with [argument matchers](#argument-matchers).
 
 ```typescript
-import { mock, when, It } from 'strong-mock';
+import { mock } from 'strong-mock';
 
-// Use strict equality instead of deep equality.
-const fn = mock<(x: number[]) => boolean>({ concreteMatcher: It.is });
-when(() => fn([1, 2, 3])).thenReturn(true);
+const fn = mock<(value?: number) => number>();
+
+when(() => fn()).thenReturn(42).twice();
 
-fn([1, 2, 3]); // throws because different arrays
+// Since the expectation doesn't expect any arguments,
+// both of the following are fine
+console.log(fn()); // 42
+console.log(fn(1)); // 42
 ```
 
-#### Defaults
+If you're not using TypeScript, or you want to be super strict, you can set `exactParams: true`.
+
+```typescript
+import { mock } from 'strong-mock';
+
+const fn = mock<(optionalValue?: number) => number>({
+  exactParams: true
+});
 
-Mock options can be set for all mocks with `setDefaults`.
+when(() => fn()).thenReturn(42).twice();
+
+console.log(fn()); // 42
+console.log(fn(1)); // throws
+```
+
+### Concrete matcher
+
+You can configure the [matcher](#argument-matchers) that will be used in expectations with concrete values e.g. `42` or `{ foo: "bar" }`. This matcher can always be overwritten inside an expectation with another matcher.
 
 ```typescript
-import { mock, when, setDefaults, Strictness } from 'strong-mock';
+import { mock, when, It } from 'strong-mock';
 
-setDefaults({
-  strictness: Strictness.SUPER_STRICT
+// Use strict equality instead of deep equality.
+const fn = mock<(x: number[], y: string) => boolean>({
+  concreteMatcher: It.is
 });
+when(() => fn([1, 2, 3], 'foo')).thenReturn(true);
 
-// Uses the new default.
-const superStrictMock = mock<() => void>();
-// Overrides the default.
-const strictMock = mock<() => void>({ strictness: Strictness.STRICT });
+fn([1, 2, 3], 'foo'); // throws because different array instances
+
+const arr = [1, 2, 3];
+// The matcher will only apply to non-matcher arguments.
+when(() => fn(arr, It.isString())).thenReturn(true);
+console.log(fn(arr, 'any string')); // true
 ```
 
 ## FAQ
@@ -402,7 +456,7 @@ This library is different from other mocking/spying libraries you might have use
 
 This design decision has a few reasons behind it. First, it forces you to be aware of what your code needs from its dependencies. Spying libraries encourage checking those needs at the end of the test after the code has already called the mocks. This can lead to tests missing dependency calls that just happen to not throw any error at runtime with the dummy values that the spies return.
 
-Secondly, it will highlight potential design problems such as violations of the SOLID principles. If you find yourself duplicating expectations between tests and passing dummy values to them because your test is not concerned with them then you might want to look into splitting the code to only depend on things it really needs.
+Secondly, it will highlight potential design problems such as violations of the SOLID principles. If you find yourself duplicating expectations between tests and passing dummy values to them because your test is not concerned with them, then you might want to look into splitting the code to only depend on things it really needs.
 
 ### Can I partially mock an existing object/function?
 
@@ -414,7 +468,7 @@ You currently can't do that. Please use a normal method instead e.g. `setFoo()`
 
 ### Why do I have to set a return value even if it's `undefined`?
 
-To make side effects explicit and to prevent future refactoring headaches. If you had just `when(() => fn())` and you later changed `fn()` to return a `number` then your expectation would become incorrect and the compiler couldn't check that for you.
+To make side effects explicit and to prevent future refactoring headaches. If you had just `when(() => fn())`, and you later changed `fn()` to return a `number`, then your expectation would become incorrect and the compiler couldn't check that for you.
 
 ### How do I provide a function for the mock to call?
 
@@ -464,7 +518,7 @@ when(() => fn(
 fn({ foo: "bar", baz: undefined }) === true
 ```
 
-You can set this behavior to be the default by configuring the [concrete matcher](#concrete-matcher), and set it on all mocks using [setDefaults](#defaults):
+You can set this behavior to be the default by configuring the [concrete matcher](#concrete-matcher).
 
 ```ts
 setDefaults({

package/dist/errors.d.ts

@@ -1,7 +1,7 @@
-import { Expectation } from './expectation/expectation';
-import { CallMap } from './expectation/repository/expectation-repository';
-import { Property } from './proxy';
-import { PendingExpectation } from './when/pending-expectation';
+import type { Expectation } from './expectation/expectation';
+import type { CallMap } from './expectation/repository/expectation-repository';
+import type { Property } from './proxy';
+import type { PendingExpectation } from './when/pending-expectation';
 export declare class UnfinishedExpectation extends Error {
     constructor(pendingExpectation: PendingExpectation);
 }

package/dist/expectation/expectation.d.ts

@@ -1,10 +1,6 @@
-import { Property } from '../proxy';
-import { Matcher } from './matcher';
-export declare type ReturnValue = {
-    value: any;
-    isPromise?: boolean;
-    isError?: boolean;
-};
+import type { Property } from '../proxy';
+import type { Matcher } from './matcher';
+import type { ReturnValue } from './repository/return-value';
 /**
  * Compare received arguments against matchers.
  */

package/dist/expectation/it.d.ts

@@ -1,4 +1,4 @@
-import { Matcher, TypeMatcher } from './matcher';
+import type { Matcher, TypeMatcher } from './matcher';
 declare type DeepPartial<T> = T extends object ? {
     [K in keyof T]?: DeepPartial<T[K]>;
 } : T;

package/dist/expectation/repository/expectation-repository.d.ts

@@ -1,5 +1,5 @@
-import { Property } from '../../proxy';
-import { Expectation, ReturnValue } from '../expectation';
+import type { Property } from '../../proxy';
+import type { Expectation } from '../expectation';
 export declare type Call = {
     arguments: any[] | undefined;
 };
@@ -41,17 +41,17 @@ export interface ExpectationRepository {
      *
      * @example
      * add(new Expectation('getData', [1, 2], 23);
-     * get('getData').value(1, 2) === 23
+     * get('getData')(1, 2) === 23
      *
      * @example
      * add(new Expectation('hasData', undefined, true);
-     * get('hasData').value === true
+     * get('hasData') === true
      *
      * @example
      * add(new Expectation('getData', undefined, () => 42);
-     * get('getData').value(1, 2, '3', false, NaN) === 42
+     * get('getData')(1, 2, '3', false, NaN) === 42
      */
-    get(property: Property): ReturnValue;
+    get(property: Property): unknown;
     /**
      * Get a return value for a function call.
      *

package/dist/expectation/repository/flexible-repository.d.ts

@@ -1,17 +1,18 @@
-import { Strictness } from '../../mock/options';
-import { Property } from '../../proxy';
-import { Expectation } from '../expectation';
-import { CallMap, ExpectationRepository } from './expectation-repository';
+import { UnexpectedProperty } from '../../mock/options';
+import type { Property } from '../../proxy';
+import type { Expectation } from '../expectation';
+import type { CallMap, ExpectationRepository } from './expectation-repository';
 declare type CountableExpectation = {
     expectation: Expectation;
     matchCount: number;
 };
 /**
- * An expectation repository for configurable levels of strictness.
+ * An expectation repository with a configurable behavior for
+ * unexpected property access.
  */
 export declare class FlexibleRepository implements ExpectationRepository {
-    private strictness;
-    constructor(strictness?: Strictness);
+    private unexpectedProperty;
+    constructor(unexpectedProperty?: UnexpectedProperty);
     protected readonly expectations: Map<Property, CountableExpectation[]>;
     private readonly expectedCallStats;
     private readonly unexpectedCallStats;

package/dist/expectation/repository/return-value.d.ts

@@ -0,0 +1,13 @@
+export declare type ReturnValue = {
+    value: any;
+    isPromise?: boolean;
+    isError?: boolean;
+};
+/**
+ * Unbox the expectation's return value.
+ *
+ * If the value is an error then throw it.
+ *
+ * If the value is a promise then resolve/reject it.
+ */
+export declare const unboxReturnValue: ({ isError, isPromise, value, }: ReturnValue) => any;

package/dist/expectation/strong-expectation.d.ts

@@ -1,6 +1,7 @@
-import { Property } from '../proxy';
-import { Expectation, ReturnValue } from './expectation';
-import { Matcher } from './matcher';
+import type { Property } from '../proxy';
+import type { Expectation } from './expectation';
+import type { Matcher } from './matcher';
+import type { ReturnValue } from './repository/return-value';
 /**
  * Matches a call with more parameters than expected because it is assumed the
  * compiler will check that those parameters are optional.
@@ -16,10 +17,11 @@ export declare class StrongExpectation implements Expectation {
     property: Property;
     args: Matcher[] | undefined;
     returnValue: ReturnValue;
+    private exactParams;
     private matched;
     min: number;
     max: number;
-    constructor(property: Property, args: Matcher[] | undefined, returnValue: ReturnValue);
+    constructor(property: Property, args: Matcher[] | undefined, returnValue: ReturnValue, exactParams?: boolean);
     setInvocationCount(min: number, max?: number): void;
     matches(args: any[] | undefined): boolean;
     isUnmet(): boolean;

package/dist/index.d.ts

@@ -6,4 +6,4 @@ export { It } from './expectation/it';
 export { setDefaults } from './mock/defaults';
 export type { Matcher } from './expectation/matcher';
 export type { MockOptions } from './mock/options';
-export { Strictness } from './mock/options';
+export { UnexpectedProperty } from './mock/options';