refactor: 2.0 readiness

package.json

@@ -49,6 +49,6 @@
         "@types/node": "^12.20.55",
         "@types/sinonjs__fake-timers": "^8.1.5",
         "ava": "^4.3.3",
-        "typescript": "^4.8.4"
+        "typescript": "^5.4.2"
     }
 }

spec/ClearSubstitute.spec.ts

@@ -1,7 +1,7 @@
 import test from 'ava'
 
-import { Substitute, SubstituteOf } from '../src'
-import { SubstituteNode } from '../src/SubstituteNode'
+import { Substitute, SubstituteOf, clearReceivedCalls, received, returns } from '../src'
+import { SubstituteNode, instance } from '../src/SubstituteNode'
 
 interface Calculator {
   add(a: number, b: number): number
@@ -11,54 +11,18 @@ interface Calculator {
 }
 
 type InstanceReturningSubstitute<T> = SubstituteOf<T> & {
-  [SubstituteNode.instance]: SubstituteNode
+  [instance]: SubstituteNode
 }
 
-test('clears everything on a substitute', t => {
-  const calculator = Substitute.for<Calculator>() as InstanceReturningSubstitute<Calculator>
-  calculator.add(1, 1)
-  calculator.received().add(1, 1)
-  calculator.clearSubstitute()
-
-  t.is(calculator[SubstituteNode.instance].recorder.records.size, 0)
-  t.is(calculator[SubstituteNode.instance].recorder.indexedRecords.size, 0)
-
-  t.throws(() => calculator.received().add(1, 1))
-
-  // explicitly using 'all'
-  calculator.add(1, 1)
-  calculator.received().add(1, 1)
-  calculator.clearSubstitute('all')
-
-  t.is(calculator[SubstituteNode.instance].recorder.records.size, 0)
-  t.is(calculator[SubstituteNode.instance].recorder.indexedRecords.size, 0)
-
-  t.throws(() => calculator.received().add(1, 1))
-})
-
 test('clears received calls on a substitute', t => {
   const calculator = Substitute.for<Calculator>() as InstanceReturningSubstitute<Calculator>
   calculator.add(1, 1)
   calculator.add(1, 1).returns(2)
-  calculator.clearSubstitute('receivedCalls')
+  calculator.clearReceivedCalls();
 
-  t.is(calculator[SubstituteNode.instance].recorder.records.size, 2)
-  t.is(calculator[SubstituteNode.instance].recorder.indexedRecords.size, 2)
+  t.is(calculator[instance].recorder.records.size, 2)
+  t.is(calculator[instance].recorder.indexedRecords.size, 2)
 
   t.throws(() => calculator.received().add(1, 1))
   t.is(2, calculator.add(1, 1))
-})
-
-test('clears return values on a substitute', t => {
-  const calculator = Substitute.for<Calculator>() as InstanceReturningSubstitute<Calculator>
-  calculator.add(1, 1)
-  calculator.add(1, 1).returns(2)
-  calculator.clearSubstitute('substituteValues')
-
-  t.is(calculator[SubstituteNode.instance].recorder.records.size, 2)
-  t.is(calculator[SubstituteNode.instance].recorder.indexedRecords.size, 2)
-
-  t.notThrows(() => calculator.received().add(1, 1))
-  // @ts-expect-error
-  t.true(calculator.add(1, 1)[SubstituteNode.instance] instanceof SubstituteNode)
 })

spec/Recorder.spec.ts

@@ -4,6 +4,7 @@ import { Recorder } from '../src/Recorder'
 import { RecordsSet } from '../src/RecordsSet'
 import { Substitute } from '../src/Substitute'
 import { SubstituteNodeBase } from '../src/SubstituteNodeBase'
+import { returns } from '../src'
 
 const nodeFactory = (key: string) => {
   const node = Substitute.for<SubstituteNodeBase>()

spec/regression/didNotReceive.spec.ts

@@ -1,5 +1,5 @@
 import test from 'ava'
-import { Substitute, Arg } from '../../src'
+import { Substitute, Arg, didNotReceive, received, returns } from '../../src'
 import { SubstituteException } from '../../src/SubstituteException'
 
 interface Calculator {
@@ -13,7 +13,7 @@ test('not calling a method correctly asserts the call count', t => {
   const calculator = Substitute.for<Calculator>()
 
   calculator.didNotReceive().add(1, 1)
-  t.throws(() => calculator.received(1).add(1, 1), { instanceOf: SubstituteException })
+  t.throws(() => calculator.received().add(1, 1), { instanceOf: SubstituteException })
   t.throws(() => calculator.received().add(Arg.all()), { instanceOf: SubstituteException })
 })
 

spec/regression/index.test.ts

@@ -1,6 +1,6 @@
 import test from 'ava'
 
-import { Substitute, Arg, SubstituteOf } from '../../src'
+import { Substitute, Arg, SubstituteOf, received, mimicks, resolves, returns } from '../../src'
 
 class Dummy {
 
@@ -20,15 +20,15 @@ export class Example {
 	set v(x: string | null | undefined) {
 	}
 
-	received(stuff: number | string) {
+	received(_stuff: string) {
 
 	}
 
 	returnPromise() {
 		return Promise.resolve(new Dummy())
 	}
 
-	foo(): string | undefined | null {
+	foo(_arg?: string): string | undefined | null {
 		return 'stuff'
 	}
 
@@ -47,22 +47,13 @@ function initialize() {
 
 const textModifierRegex = /\x1b\[\d+m/g
 
-test('class with method called \'received\' can be used for call count verification when proxies are suspended', t => {
-	initialize()
-
-	Substitute.disableFor(substitute).received(2)
-
-	t.throws(() => substitute.received(2).received(2))
-	t.notThrows(() => substitute.received(1).received(2))
-})
-
-test('class with method called \'received\' can be used for call count verification', t => {
-	initialize()
+test('class with method called \'received\' can be used for call count verification when using symbols', t => {
+	const substitute = Substitute.for<Example>()
 
-	Substitute.disableFor(substitute).received('foo')
+	substitute.received("foo")
 
-	t.notThrows(() => substitute.received(1).received('foo'))
-	t.throws(() => substitute.received(2).received('foo'))
+	t.notThrows(() => substitute[received](1).received("foo"))
+	t.throws(() => substitute[received](2).received("foo"))
 })
 
 test('class string field set received', t => {
@@ -79,16 +70,16 @@ test('class string field set received', t => {
 	runLogic(substitute)
 
 
-	t.notThrows(() => substitute.received().v = 'hello')
-	t.notThrows(() => substitute.received(5).v = Arg.any())
-	t.notThrows(() => substitute.received().v = Arg.any())
-	t.notThrows(() => substitute.received(2).v = 'hello')
-	t.notThrows(() => substitute.received(2).v = Arg.is(x => typeof x === 'string' && x.indexOf('ll') > -1))
+	t.notThrows(() => substitute[received]().v = 'hello')
+	t.notThrows(() => substitute[received](5).v = Arg.any())
+	t.notThrows(() => substitute[received]().v = Arg.any())
+	t.notThrows(() => substitute[received](2).v = 'hello')
+	t.notThrows(() => substitute[received](2).v = Arg.is(x => typeof x === 'string' && x.indexOf('ll') > -1))
 
-	t.throws(() => substitute.received(2).v = Arg.any())
-	t.throws(() => substitute.received(1).v = Arg.any())
-	t.throws(() => substitute.received(1).v = Arg.is(x => typeof x === 'string' && x.indexOf('ll') > -1))
-	t.throws(() => substitute.received(3).v = 'hello')
+	t.throws(() => substitute[received](2).v = Arg.any())
+	t.throws(() => substitute[received](1).v = Arg.any())
+	t.throws(() => substitute[received](1).v = Arg.is(x => typeof x === 'string' && x.indexOf('ll') > -1))
+	t.throws(() => substitute[received](3).v = 'hello')
 })
 
 test('resolving promises works', async t => {
@@ -117,9 +108,9 @@ test('class method received', t => {
 	void substitute.c('hi', 'there')
 	void substitute.c('hi', 'there')
 
-	t.notThrows(() => substitute.received(4).c('hi', 'there'))
-	t.notThrows(() => substitute.received(1).c('hi', 'the1re'))
-	t.notThrows(() => substitute.received().c('hi', 'there'))
+	t.notThrows(() => substitute[received](4).c('hi', 'there'))
+	t.notThrows(() => substitute[received](1).c('hi', 'the1re'))
+	t.notThrows(() => substitute[received]().c('hi', 'there'))
 
 	const expectedMessage = 'Expected 7 calls to the method c with arguments [\'hi\', \'there\'], but received 4 of such calls.\n' +
 		'All calls received to method c:\n' +
@@ -128,7 +119,7 @@ test('class method received', t => {
 		'-> call with arguments [\'hi\', \'there\']\n' +
 		'-> call with arguments [\'hi\', \'there\']\n' +
 		'-> call with arguments [\'hi\', \'there\']'
-	const { message } = t.throws(() => { substitute.received(7).c('hi', 'there') })
+	const { message } = t.throws(() => { substitute[received](7).c('hi', 'there') })
 	t.is(message.replace(textModifierRegex, ''), expectedMessage)
 })
 
@@ -138,14 +129,14 @@ test('received call matches after partial mocks using property instance mimicks'
 	substitute.d.mimicks(() => instance.d)
 	substitute.c('lala', 'bar')
 
-	substitute.received(1).c('lala', 'bar')
-	substitute.received(1).c('lala', 'bar')
+	substitute[received](1).c('lala', 'bar')
+	substitute[received](1).c('lala', 'bar')
 
-	t.notThrows(() => substitute.received(1).c('lala', 'bar'))
+	t.notThrows(() => substitute[received](1).c('lala', 'bar'))
 	const expectedMessage = 'Expected 2 calls to the method c with arguments [\'lala\', \'bar\'], but received 1 of such calls.\n' +
 		'All calls received to method c:\n' +
 		'-> call with arguments [\'lala\', \'bar\']'
-	const { message } = t.throws(() => substitute.received(2).c('lala', 'bar'))
+	const { message } = t.throws(() => substitute[received](2).c('lala', 'bar'))
 	t.is(message.replace(textModifierRegex, ''), expectedMessage)
 	t.deepEqual(substitute.d, 1337)
 })

spec/regression/issues/11.test.ts

@@ -1,5 +1,5 @@
 import test from 'ava'
-import { Substitute, Arg } from '../../../src'
+import { Substitute, Arg, received, returns } from '../../../src'
 
 type Addands = {
     op1: number

spec/regression/issues/178.test.ts

@@ -2,7 +2,7 @@ import test, { ExecutionContext, ThrowsExpectation } from 'ava'
 import * as fakeTimers from '@sinonjs/fake-timers'
 import { types } from 'util'
 
-import { Substitute } from '../../../src'
+import { Substitute, didNotReceive, received, returns } from '../../../src'
 import { SubstituteException } from '../../../src/SubstituteException'
 
 interface Library {

spec/regression/issues/23.test.ts

@@ -1,6 +1,6 @@
 import test from 'ava'
 
-import { Substitute, Arg } from '../../../src'
+import { Substitute, Arg, received, mimicks } from '../../../src'
 
 interface CalculatorInterface {
   add(a: number, b: number): number

spec/regression/issues/36.test.ts

@@ -1,6 +1,6 @@
 import test from 'ava'
 
-import { Substitute, Arg } from '../../../src'
+import { Substitute, Arg, received, returns } from '../../../src'
 
 class Key {
     private constructor(private _value: string) { }

spec/regression/issues/45.test.ts

@@ -1,6 +1,6 @@
 import test from 'ava'
 
-import { Substitute, Arg } from '../../../src'
+import { Substitute, Arg, received } from '../../../src'
 
 class DependencyClass {
     public methodOne() { }

spec/regression/issues/59.test.ts

@@ -1,6 +1,6 @@
 import test from 'ava'
 
-import { Substitute } from '../../../src'
+import { Substitute, received, returns } from '../../../src'
 
 interface IEcho {
   echo(a: string): string

spec/regression/mimicks.spec.ts

@@ -1,5 +1,5 @@
 import test from 'ava'
-import { Substitute, Arg } from '../../src'
+import { Substitute, Arg, mimicks } from '../../src'
 
 interface Calculator {
   add(a: number, b: number): number

spec/regression/received.spec.ts

@@ -1,5 +1,5 @@
 import test from 'ava'
-import { Substitute, Arg } from '../../src'
+import { Substitute, Arg, received, returns } from '../../src'
 import { SubstituteException } from '../../src/SubstituteException'
 
 interface Calculator {

spec/regression/rejects.spec.ts

@@ -1,6 +1,6 @@
 import test from 'ava'
 
-import { Substitute, Arg } from '../../src'
+import { Substitute, Arg, rejects } from '../../src'
 
 interface Calculator {
   getMemory(): Promise<number>

spec/regression/resolves.spec.ts

@@ -1,6 +1,6 @@
 import test from 'ava'
 
-import { Substitute, Arg } from '../../src'
+import { Substitute, Arg, resolves } from '../../src'
 
 interface Calculator {
   getMemory(): Promise<number>

spec/regression/returns.spec.ts

@@ -1,7 +1,7 @@
 import test from 'ava'
 import { types } from 'util'
 
-import { Substitute, Arg } from '../../src'
+import { Substitute, Arg, returns } from '../../src'
 
 interface Calculator {
   add(a: number, b: number): number
@@ -19,9 +19,6 @@ interface Calculator {
 test('returns a primitive value for method with no arguments', t => {
   const calculator = Substitute.for<Calculator>()
   calculator.clear().returns()
-  // calculator.add(1, 2).toExponential()
-  // calculator.isEnabled2.viewResult().returns(3)
-  // calculator.other().viewResult().returns(2)
 
   t.is(void 0 as void, calculator.clear())
 })

spec/regression/throws.spec.ts

@@ -1,6 +1,6 @@
 import test from 'ava'
 
-import { Substitute, Arg } from '../../src'
+import { Substitute, Arg, returns, throws } from '../../src'
 
 interface Calculator {
   add(a: number, b: number): number