refactor: symbols only when needed

Author: ffMathy

package-lock.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"
     }
 }

package.json

@@ -1,7 +1,7 @@
 import test from 'ava'
 
 import { Substitute, SubstituteOf, clearReceivedCalls, received, returns } from '../src'
-import { SubstituteNode } from '../src/SubstituteNode'
+import { SubstituteNode, instance } from '../src/SubstituteNode'
 
 interface Calculator {
   add(a: number, b: number): number
@@ -11,18 +11,18 @@ interface Calculator {
 }
 
 type InstanceReturningSubstitute<T> = SubstituteOf<T> & {
-  [SubstituteNode.instance]: SubstituteNode
+  [instance]: SubstituteNode
 }
 
 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[clearReceivedCalls]();
+  calculator.add(1, 1).returns(2)
+  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.throws(() => calculator.received().add(1, 1))
   t.is(2, calculator.add(1, 1))
 })

spec/ClearSubstitute.spec.ts

@@ -8,7 +8,7 @@ import { returns } from '../src'
 
 const nodeFactory = (key: string) => {
   const node = Substitute.for<SubstituteNodeBase>()
-  node.key[returns](key)
+  node.key.returns(key)
   return node
 }
 

spec/Recorder.spec.ts

@@ -12,41 +12,41 @@ interface Calculator {
 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]().add(1, 1), { instanceOf: SubstituteException })
-  t.throws(() => calculator[received]().add(Arg.all()), { instanceOf: SubstituteException })
+  calculator.didNotReceive().add(1, 1)
+  t.throws(() => calculator.received().add(1, 1), { instanceOf: SubstituteException })
+  t.throws(() => calculator.received().add(Arg.all()), { instanceOf: SubstituteException })
 })
 
 test('not getting a property correctly asserts the call count', t => {
   const calculator = Substitute.for<Calculator>()
 
-  calculator[didNotReceive]().isEnabled
-  t.throws(() => calculator[received](1).isEnabled, { instanceOf: SubstituteException })
-  t.throws(() => calculator[received]().isEnabled, { instanceOf: SubstituteException })
+  calculator.didNotReceive().isEnabled
+  t.throws(() => calculator.received(1).isEnabled, { instanceOf: SubstituteException })
+  t.throws(() => calculator.received().isEnabled, { instanceOf: SubstituteException })
 })
 
 test('not setting a property correctly asserts the call count', t => {
   const calculator = Substitute.for<Calculator>()
 
-  calculator[didNotReceive]().isEnabled = true
-  t.throws(() => calculator[received](1).isEnabled = true, { instanceOf: SubstituteException })
-  t.throws(() => calculator[received]().isEnabled = true, { instanceOf: SubstituteException })
+  calculator.didNotReceive().isEnabled = true
+  t.throws(() => calculator.received(1).isEnabled = true, { instanceOf: SubstituteException })
+  t.throws(() => calculator.received().isEnabled = true, { instanceOf: SubstituteException })
 })
 
 test('not calling a method with mock correctly asserts the call count', t => {
   const calculator = Substitute.for<Calculator>()
-  calculator.add(1, 1)[returns](2)
+  calculator.add(1, 1).returns(2)
 
-  calculator[didNotReceive]().add(1, 1)
-  t.throws(() => calculator[received](1).add(1, 1), { instanceOf: SubstituteException })
-  t.throws(() => calculator[received]().add(Arg.all()), { instanceOf: SubstituteException })
+  calculator.didNotReceive().add(1, 1)
+  t.throws(() => calculator.received(1).add(1, 1), { instanceOf: SubstituteException })
+  t.throws(() => calculator.received().add(Arg.all()), { instanceOf: SubstituteException })
 })
 
 test('not getting a property with mock correctly asserts the call count', t => {
   const calculator = Substitute.for<Calculator>()
-  calculator.isEnabled[returns](true)
+  calculator.isEnabled.returns(true)
 
-  calculator[didNotReceive]().isEnabled
-  t.throws(() => calculator[received](1).isEnabled, { instanceOf: SubstituteException })
-  t.throws(() => calculator[received]().isEnabled, { instanceOf: SubstituteException })
+  calculator.didNotReceive().isEnabled
+  t.throws(() => calculator.received(1).isEnabled, { instanceOf: SubstituteException })
+  t.throws(() => calculator.received().isEnabled, { instanceOf: SubstituteException })
 })

spec/regression/didNotReceive.spec.ts

@@ -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'
 	}
 
@@ -48,12 +48,12 @@ function initialize() {
 const textModifierRegex = /\x1b\[\d+m/g
 
 test('class with method called \'received\' can be used for call count verification when using symbols', t => {
-	initialize()
+	const substitute = Substitute.for<Example>()
 
-	substitute.received(2)
+	substitute.received("foo")
 
-	t.throws(() => substitute[received](2).received(2))
-	t.notThrows(() => substitute[received](1).received(2))
+	t.notThrows(() => substitute[received](1).received("foo"))
+	t.throws(() => substitute[received](2).received("foo"))
 })
 
 test('class string field set received', t => {
@@ -85,15 +85,15 @@ test('class string field set received', t => {
 test('resolving promises works', async t => {
 	initialize()
 
-	substitute.returnPromise()[resolves](1338)
+	substitute.returnPromise().resolves(1338)
 
 	t.is(1338, await substitute.returnPromise() as number)
 })
 
 test('class void returns', t => {
 	initialize()
 
-	substitute.foo()[returns](void 0, null)
+	substitute.foo().returns(void 0, null)
 
 	t.is(substitute.foo(), void 0)
 	t.is(substitute.foo(), null)
@@ -126,7 +126,7 @@ test('class method received', t => {
 test('received call matches after partial mocks using property instance mimicks', t => {
 	initialize()
 
-	substitute.d[mimicks](() => instance.d)
+	substitute.d.mimicks(() => instance.d)
 	substitute.c('lala', 'bar')
 
 	substitute[received](1).c('lala', 'bar')
@@ -144,7 +144,7 @@ test('received call matches after partial mocks using property instance mimicks'
 test('partial mocks using property instance mimicks', t => {
 	initialize()
 
-	substitute.d[mimicks](() => instance.d)
+	substitute.d.mimicks(() => instance.d)
 
 	t.deepEqual(substitute.d, 1337)
 })

spec/regression/index.test.ts

@@ -14,12 +14,12 @@ class RealCalculator {
 
 test('issue 11: arg.is is only called once', async t => {
     let mockedCalculator = Substitute.for<RealCalculator>()
-    mockedCalculator.add(Arg.any())[returns](4)
+    mockedCalculator.add(Arg.any()).returns(4)
 
     let count = 0
     mockedCalculator.add({ op1: 1, op2: 2 })
 
-    mockedCalculator[received](1).add(Arg.is(a => {
+    mockedCalculator.received(1).add(Arg.is(a => {
         count++
         return a.op1 === 1 && a.op2 === 2
     }))

spec/regression/issues/11.test.ts

@@ -24,17 +24,17 @@ const throwsUncaughtException = (cb: () => any, t: ExecutionContext, expectation
 
 test('can substitute callable interfaces', async t => {
   const lib = Substitute.for<Library>()
-  lib.subSection()[returns]('subSection as method')
-  lib.subSection[returns]({ subMethod: () => 'subSection as property' } as Subsection)
+  lib.subSection().returns('subSection as method')
+  lib.subSection.returns({ subMethod: () => 'subSection as property' } as Subsection)
 
   t.is('subSection as method', lib.subSection())
   t.true(types.isProxy(lib.subSection), 'Expected proxy: given the context, it\'s not possible to determine the property type')
   t.is('subSection as property', lib.subSection.subMethod())
 
-  lib[received]().subSection()
-  lib[received](1).subSection()
-  lib[received](2).subSection
-  t.throws(() => lib[didNotReceive]().subSection(), { instanceOf: SubstituteException })
-  t.throws(() => lib[received](2).subSection(), { instanceOf: SubstituteException })
-  throwsUncaughtException(() => lib[received](3).subSection, t, { instanceOf: SubstituteException })
+  lib.received().subSection()
+  lib.received(1).subSection()
+  lib.received(2).subSection
+  t.throws(() => lib.didNotReceive().subSection(), { instanceOf: SubstituteException })
+  t.throws(() => lib.received(2).subSection(), { instanceOf: SubstituteException })
+  throwsUncaughtException(() => lib.received(3).subSection, t, { instanceOf: SubstituteException })
 })

spec/regression/issues/178.test.ts

@@ -14,12 +14,12 @@ test('issue 23: mimick received should not call method', t => {
 
   let calls = 0
 
-  mockedCalculator.add(Arg.all())[mimicks]((a, b) => {
+  mockedCalculator.add(Arg.all()).mimicks((a, b) => {
     t.deepEqual(++calls, 1, 'mimick called twice')
     return a + b
   })
 
   mockedCalculator.add(1, 1) // ok
 
-  mockedCalculator[received](1).add(1, 1) // not ok, calls mimick func
+  mockedCalculator.received(1).add(1, 1) // not ok, calls mimick func
 })

spec/regression/issues/23.test.ts

@@ -49,7 +49,7 @@ class Service {
 
 test('issue 36 - promises returning object with properties', async t => {
     const emptyFetch = Substitute.for<IFetch>()
-    emptyFetch.getUpdates(Key.create())[returns](Promise.resolve<IData>(IData.create()))
+    emptyFetch.getUpdates(Key.create()).returns(Promise.resolve<IData>(IData.create()))
     const result = await emptyFetch.getUpdates(Key.create())
     t.true(result.serverCheck instanceof Date, 'given date is instanceof Date')
     t.deepEqual(result.data, [1], 'arrays are deep equal')
@@ -58,12 +58,12 @@ test('issue 36 - promises returning object with properties', async t => {
 test('using objects or classes as arguments should be able to match mock', async t => {
     const db = Substitute.for<IFetch>()
     const data = IData.create()
-    db.getUpdates(Key.create())[returns](Promise.resolve(data))
+    db.getUpdates(Key.create()).returns(Promise.resolve(data))
     const service = new Service(db)
 
     await service.handle(Key.create())
 
-    db[received](1).storeUpdates(Arg.is((arg: IData) =>
+    db.received(1).storeUpdates(Arg.is((arg: IData) =>
         arg.serverCheck instanceof Date &&
         arg instanceof IData &&
         arg.data[0] === 100