strong-mock 7.3.0 → 8.0.0-beta.0

package/README.md

@@ -6,7 +6,7 @@
 </div>
 
 ```typescript
-import { mock, when, instance } from 'strong-mock';
+import { mock, when } from 'strong-mock';
 
 interface Foo {
   bar: (x: number) => string;
@@ -14,9 +14,9 @@ interface Foo {
 
 const foo = mock<Foo>();
 
-when(foo.bar(23)).thenReturn('I am strong!');
+when(() => foo.bar(23)).thenReturn('I am strong!');
 
-console.log(instance(foo).bar(23)); // 'I am strong!'
+console.log(foo.bar(23)); // 'I am strong!'
 ```
 
 ----
@@ -27,12 +27,12 @@ console.log(instance(foo).bar(23)); // 'I am strong!'
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 **Table of Contents**
 
-- [Installation](#installation)
-- [Requirements](#requirements)
 - [Features](#features)
   - [Type safety](#type-safety)
   - [Useful error messages](#useful-error-messages)
   - [Type safe argument matchers](#type-safe-argument-matchers)
+- [Installation](#installation)
+- [Requirements](#requirements)
 - [API](#api)
   - [Setting expectations](#setting-expectations)
   - [Setting multiple expectations](#setting-multiple-expectations)
@@ -52,25 +52,11 @@ console.log(instance(foo).bar(23)); // 'I am strong!'
   - [Why do I have to set a return value even if it's `undefined`?](#why-do-i-have-to-set-a-return-value-even-if-its-undefined)
   - [How do I provide a function for the mock to call?](#how-do-i-provide-a-function-for-the-mock-to-call)
   - [Why does accessing an unused method throw?](#why-does-accessing-an-unused-method-throw)
-  - [Can I spread/enumerate a mock instance?](#can-i-spreadenumerate-a-mock-instance)
+  - [Can I spread/enumerate a mock?](#can-i-spreadenumerate-a-mock)
   - [How can I ignore `undefined` keys when setting expectations on objects?](#how-can-i-ignore-undefined-keys-when-setting-expectations-on-objects)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
-## Installation
-
-```
-npm i -D strong-mock
-```
-
-```
-yarn add -D strong-mock
-```
-
-## Requirements
-
-strong-mock requires an environment that supports the [ES6 Proxy object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy). This is necessary to create dynamic mocks from types because TypeScript does not support reflection i.e. exposing the type info at runtime.
-
 ## Features
 
 ### Type safety
@@ -87,34 +73,44 @@ Error messages include the property that has been accessed, any arguments passed
 
 ### Type safe argument matchers
 
-![type safe matchers](./media/type-safe-matchers.png)
+Optional argument matchers allow you to create complex expectations, while still maintaining type safety.
 
-## API
+![type safe matchers](./media/type-safe-matchers.png)
 
-### Setting expectations
+## Installation
 
-Expectations are set by calling the mock inside a `when()` call and finishing it by setting a return value.
+```
+npm i -D strong-mock
+```
 
-```typescript
-when(foo.bar(23)).thenReturn('awesome');
 ```
+yarn add -D strong-mock
+```
+
+## Requirements
+
+strong-mock requires an environment that supports the [ES6 Proxy object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy). This is necessary to create dynamic mocks from types because TypeScript does not support reflection i.e. exposing the type info at runtime.
+
+## API
+
+### Setting expectations
 
-After expectations have been set you need to get an instance of the mock by calling `instance()`.
+Expectations are set by calling the mock inside a `when` callback and finishing it by setting a return value.
 
 ```typescript
-instance(foo)
+when(() => foo.bar(23)).thenReturn('awesome');
 ```
 
 ### Setting multiple expectations
 
-You can set as many expectations as you want by calling `when()` multiple times. If you have multiple expectations with the same arguments they will be consumed in the order they were created.
+You can set as many expectations as you want by calling `when` multiple times. If you have multiple expectations with the same arguments they will be consumed in the order they were created.
 
 ```typescript
-when(foo.bar(23)).thenReturn('awesome');
-when(foo.bar(23)).thenReturn('even more awesome');
+when(() => foo.bar(23)).thenReturn('awesome');
+when(() => foo.bar(23)).thenReturn('even more awesome');
 
-console.log(instance(foo).bar(23)); // awesome
-console.log(instance(foo).bar(23)); // even more awesome
+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.
@@ -126,12 +122,12 @@ You can expect a call to be made multiple times by using the invocation count he
 ```typescript
 const fn = mock<(x: number) => number>();
 
-when(fn(1)).thenReturn(1).between(2, 3);
+when(() => fn(1)).thenReturn(1).between(2, 3);
 
-console.log(instance(fn)(1)); // 1
-console.log(instance(fn)(1)); // 1
-console.log(instance(fn)(1)); // 1
-console.log(instance(fn)(1)); // throws because the expectation is finished
+console.log(fn(1)); // 1
+console.log(fn(1)); // 1
+console.log(fn(1)); // 1
+console.log(fn(1)); // throws because the expectation is finished
 ```
 
 ### Mocking interfaces
@@ -146,11 +142,11 @@ interface Foo {
 
 const foo = mock<Foo>();
 
-when(foo.bar(23)).thenReturn('awesome');
-when(foo.baz).thenReturn(100);
+when(() => foo.bar(23)).thenReturn('awesome');
+when(() => foo.baz).thenReturn(100);
 
-console.log(instance(foo).bar(23)); // 'awesome'
-console.log(instance(foo).baz); // 100
+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.
@@ -164,9 +160,9 @@ type Fn = (x: number) => number;
 
 const fn = mock<Fn>();
 
-when(fn(1)).thenReturn(2);
+when(() => fn(1)).thenReturn(2);
 
-console.log(instance(fn)(1)); // 2
+console.log(fn(1)); // 2
 ```
 
 ### Mocking promises
@@ -178,9 +174,9 @@ type Fn = (x: number) => Promise<number>;
 
 const fn = mock<Fn>();
 
-when(fn(1)).thenResolve(2);
+when(() => fn(1)).thenResolve(2);
 
-console.log(await instance(fn)()); // 2
+console.log(await fn()); // 2
 ```
 
 ### Throwing errors
@@ -192,8 +188,8 @@ type FnWithPromise = (x: number) => Promise<void>;
 const fn = mock<Fn>();
 const fnWithPromise = mock<FnWithPromise>();
 
-when(fn(1)).thenThrow();
-when(fnWithPromise(1)).thenReject();
+when(() => fn(1)).thenThrow();
+when(() => fnWithPromise(1)).thenReject();
 ```
 
 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.
@@ -205,7 +201,7 @@ Calling `verify(mock)` will make sure that all expectations set on `mock` have b
 ```typescript
 const fn = mock<(x: number) => number>();
 
-when(fn(1)).thenReturn(1).between(2, 10);
+when(() => fn(1)).thenReturn(1).between(2, 10);
 
 verify(fn); // throws
 ```
@@ -216,7 +212,7 @@ It will also throw if any unexpected calls happened that were maybe caught in th
 const fn = mock<() => void>();
 
 try {
-  instance(fn)(); // throws because the call is unexpected
+  fn(); // throws because the call is unexpected
 } catch(e) {
   // your code might transition to an error state here
 }
@@ -224,7 +220,7 @@ try {
 verify(fn); // throws
 ```
 
-It is recommended that 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 hasn't silently caught 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 e.g. in an `afterEach` hook.
 
 ![verify error](./media/verify.png)
 
@@ -235,11 +231,11 @@ You can remove all expectations from a mock by using the `reset()` method:
 ```typescript
 const fn = mock<(x: number) => number>();
 
-when(fn(1)).thenReturn(1);
+when(() => fn(1)).thenReturn(1);
 
 reset(fn);
 
-instance(fn)(1); // throws
+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.
@@ -253,12 +249,12 @@ const fn = mock<
   (x: number, data: { values: number[]; labels: string[] }) => string
 >();
 
-when(fn(
+when(() => fn(
   It.isAny(),
   It.isObject({ values: [1, 2, 3] })
 )).thenReturn('matched!');
 
-console.log(instance(fn)(
+console.log(fn(
   123, 
   { values: [1, 2, 3], labels: ['a', 'b', 'c'] })
 ); // 'matched!'
@@ -277,12 +273,12 @@ Available matchers:
 
 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: "bar" }` | `{ foo: "bar" }` | not equal | equal | equal
-`{ }` | `{ foo: undefined }` | not equal | not equal | equal
-`new (class {})()` | `new (class {})()` | not equal | not equal | equal
+| expected           | actual               | `It.is`   | `It.deepEquals` | `It.deepEquals({ strict: false })` |
+|--------------------|----------------------|-----------|-----------------|------------------------------------|
+| `"foo"`            | `"bar"`              | 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                              |
 
 Some matchers, like `isObject` and `isArray` support nesting matchers:
 
@@ -299,9 +295,9 @@ You can create arbitrarily complex and type safe matchers with `It.matches(cb)`:
 ```typescript
 const fn = mock<(x: number, y: number[]) => string>();
 
-when(fn(
+when(() => fn(
   It.matches(x => x > 0),
-  It.matches(y => y.values.includes(42))
+  It.matches(y => y.includes(42))
 )).thenReturn('matched');
 ```
 
@@ -313,9 +309,9 @@ type Cb = (value: number) => number;
 const fn = mock<(cb: Cb) => number>();
 
 const matcher = It.willCapture<Cb>();
-when(fn(matcher)).thenReturn(42);
+when(() => fn(matcher)).thenReturn(42);
 
-console.log(instance(fn)(23, (x) => x + 1)); // 42
+console.log(fn(23, (x) => x + 1)); // 42
 console.log(matcher.value?.(3)); // 4
 ```
 
@@ -324,7 +320,7 @@ console.log(matcher.value?.(3)); // 4
 You can override the default matcher that will be used when setting expectations with non-matcher values e.g. `42` or `{ foo: "bar" }`.
 
 ```ts
-import { mock, when, instance, It, setDefaults } from 'strong-mock';
+import { mock, when, It, setDefaults } from 'strong-mock';
 
 // Use strict equality instead of deep equality.
 setDefaults({
@@ -332,9 +328,9 @@ setDefaults({
 })
 
 const fn = mock<(x: number[]) => boolean>();
-when(fn([1, 2, 3])).thenReturn(true);
+when(() => fn([1, 2, 3])).thenReturn(true);
 
-instance(fn)([1, 2, 3]); // throws because different arrays
+fn([1, 2, 3]); // throws because different arrays
 ```
 
 ## FAQ
@@ -343,7 +339,7 @@ instance(fn)([1, 2, 3]); // throws because different arrays
 
 This library is different from other mocking/spying libraries you might have used before such as [sinon](https://sinonjs.org) or [jest](https://jestjs.io/docs/en/mock-functions). Whereas those libraries are focused on recording calls to the mocks and always returning something, strong-mock requires you to set your expectations upfront. If a call happens that is not expected the mock will throw an error.
 
-This design decision has a few reasons behind it. First of all, 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.
+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.
 
@@ -357,11 +353,11 @@ 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 would have 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?
 
-There is no `thenCall()` method because it can't be safely typed - the type for `thenReturn()` is inferred from the return type in `when()`, meaning that the required type would be the return value for the function, not the function itself. However, we can leverage this by setting an expectation on the function property instead:
+There is no `thenCall()` method because it can't be safely typed - the type for `thenReturn()` is inferred from the return type in `when`, meaning that the required type would be the return value for the function, not the function itself. However, we can leverage this by setting an expectation on the function property instead:
 
 ```typescript
 interface Foo {
@@ -370,12 +366,12 @@ interface Foo {
 
 const foo = mock<Foo>();
 
-when(foo.bar).thenReturn(x => `called ${x}`);
+when(() => foo.bar).thenReturn(x => `called ${x}`);
 
-console.log(instance(foo).bar(23)); // 'called 23'
+console.log(foo.bar(23)); // 'called 23'
 ```
 
-The function in `thenReturn()` will be type checked against the actual interface so you can make sure you're passing in an implementation that makes sense. Moreover, refactoring the interface will also refactor the expectation (in a capable IDE).
+The function in `thenReturn()` will be type checked against the actual interface, so you can make sure you're passing in an implementation that makes sense. Moreover, refactoring the interface will also refactor the expectation (in a capable IDE).
 
 ![call-rename](media/rename-args.gif)
 
@@ -401,10 +397,10 @@ function doFoo(foo: Foo, { callBaz }: { callBaz: boolean }) {
 }
 
 const foo = mock<Foo>();
-when(foo.bar()).thenReturn(42);
+when(() => foo.bar()).thenReturn(42);
 
 // Throws with unexpected access on `baz`.
-doFoo(instance(foo), { callBaz: false });
+doFoo(foo, { callBaz: false });
 ```
 
 To work around this, either change your code to avoid destructuring
@@ -422,20 +418,20 @@ function doFoo(foo: Foo, callBaz: boolean) {
 or set a dummy expectation on the methods you're not interested in during the test.
 
 ```typescript
-when(foo.baz()).thenThrow('should not be called').anyTimes();
+when(() => foo.baz()).thenThrow('should not be called').anyTimes();
 ```
 
-### Can I spread/enumerate a mock instance?
+### Can I spread/enumerate a mock?
 
 Yes, and you will only get the properties that have expectations on them.
 
 ```typescript
 const foo = mock<{ bar: number; baz: number }>();
-when(foo.bar).thenReturn(42);
+when(() => foo.bar).thenReturn(42);
 
-console.log(Object.keys(instance(foo))); // ['bar']
+console.log(Object.keys(foo)); // ['bar']
 
-const foo2 = { ...instance(foo) };
+const foo2 = { ...foo };
 
 console.log(foo2.bar); // 42
 console.log(foo2.baz); // undefined
@@ -449,9 +445,9 @@ Use the `It.deepEquals` matcher explicitly inside `when` and pass `{ strict: fal
 ```ts
 const fn = mock<(x: { foo: string }) => boolean>();
 
-when(fn(It.deepEquals({ foo: "bar" }, { strict: false }))).thenReturn(true);
+when(() => fn(It.deepEquals({ foo: "bar" }, { strict: false }))).thenReturn(true);
 
-instance(fn)({ foo: "bar", baz: undefined }) === true
+fn({ foo: "bar", baz: undefined }) === true
 ```
 
 You can also set this behavior to be the default by using [`setDefaults`](#overriding-default-matcher):

package/dist/errors.d.ts

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

package/dist/expectation/it.d.ts

@@ -22,7 +22,7 @@ export declare const It: {
         containing?: string | undefined;
     }) => TypeMatcher<string>;
     isArray: <T_4 extends any[]>(containing?: T_4 | undefined) => TypeMatcher<T_4>;
-    willCapture: <T_5 = unknown>(name?: string | undefined) => T_5 & Matcher & {
+    willCapture: <T_5 = unknown>(name?: string) => T_5 & Matcher & {
         value: T_5 | undefined;
     };
 };

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

@@ -1,6 +1,6 @@
+import { Property } from '../../proxy';
 import { Expectation, ReturnValue } from '../expectation';
 import { CallMap, ExpectationRepository } from './expectation-repository';
-import { Property } from '../../proxy';
 export declare type CountableExpectation = {
     expectation: Expectation;
     matchCount: number;

package/dist/index.d.ts

@@ -1,6 +1,5 @@
 export { mock } from './mock/mock';
 export { when } from './when/when';
-export { instance } from './instance/instance';
 export { reset, resetAll } from './verify/reset';
 export { verify, verifyAll } from './verify/verify';
 export { It } from './expectation/it';