refactor: 2.0 readiness (#280)

* feat: introduce symbols

* fix: progress on new syntax

* fix: progress on symbols

* feat: symbols for methods

- removed Substitute.disableFor

* refactor: import path alignment

* refactor: symbols only when needed

* refac: use symbols for context handling

* fix: update compatibility assertion

* fix: update test import

* fix: use symbol representation on clear method

* test: add overlapping interface regression

---------

Co-authored-by: Enrique Pöhlmann <sm@notanengineer.com>

Author: ffMathy

ava.config.js

@@ -1,6 +1,6 @@
 
 module.exports = {
-	files: ['spec/**/*.ts'],
+	files: ['spec/**/*.spec.ts'],
 	typescript: {
 		compile: false,
 		rewritePaths: {
@@ -10,4 +10,4 @@ module.exports = {
   cache: false,
   failFast: true,
   failWithoutAssertions: true
-}
+}

compatibility-checks/test/index.ts

@@ -10,7 +10,6 @@ type TestRunner = {
 
 test.describe('Verifies test runner compatibility', () => {
   const failingExec = (command: string): string => {
-    process.env
     const { FORCE_COLOR, ...environment } = { ...process.env, CI: '1', NO_COLOR: '1' } as Partial<Record<string, string>>
     try {
       execSync(command, { env: environment, stdio: 'pipe' })
@@ -43,11 +42,10 @@ test.describe('Verifies test runner compatibility', () => {
           `Could not find the expected failure location in the output. Expected "${testRunner.failureLocationText}"`
         )
         assert.ok(
-          result.includes('SubstituteException: Expected'),
+          result.includes('SubstituteException: Call count mismatch'),
           `Could not find the expected exception message in the output: ${result}`
         )
       })
     })
   })
 })
-

package-lock.json

@@ -46,10 +46,10 @@
     "devDependencies": {
         "@ava/typescript": "^3.0.1",
         "@sinonjs/fake-timers": "^11.2.2",
-        "@types/node": "^18.19.22",
+        "@types/node": "^18.19.122",
         "@types/sinonjs__fake-timers": "^8.1.5",
         "ava": "^4.3.3",
-        "typescript": "^4.8.4"
+        "typescript": "^5.9.2"
     },
     "volta": {
         "node": "18.19.1"

package.json

@@ -2,7 +2,7 @@ import test from 'ava'
 import { inspect } from 'util'
 
 import { Arg } from '../src'
-import { RecordedArguments } from '../src/RecordedArguments'
+import { RecordedArguments } from '../src/internals/RecordedArguments'
 
 const testObject = { 'foo': 'bar' }
 const testArray = ['a', 1, true]
@@ -135,4 +135,4 @@ test('generates custom text representation', t => {
   t.is(inspect(RecordedArguments.from([])), '()')
   t.is(inspect(RecordedArguments.from([undefined])), 'undefined')
   t.is(inspect(RecordedArguments.from([undefined, 1])), '(undefined, 1)')
-})
+})

spec/ClearSubstitute.spec.ts

@@ -1,9 +1,9 @@
 import test from 'ava'
 
-import { Recorder } from '../src/Recorder'
-import { RecordsSet } from '../src/RecordsSet'
-import { Substitute } from '../src/Substitute'
-import { SubstituteNodeBase } from '../src/SubstituteNodeBase'
+import { Recorder } from '../src/internals/Recorder'
+import { RecordsSet } from '../src/internals/RecordsSet'
+import { Substitute } from '../src/api/Substitute'
+import { SubstituteNodeBase } from '../src/internals/SubstituteNodeBase'
 
 const nodeFactory = (key: string) => {
   const node = Substitute.for<SubstituteNodeBase>()

spec/RecordedArguments.spec.ts

@@ -1,6 +1,6 @@
 import test, { ExecutionContext } from 'ava'
 
-import { RecordsSet } from '../src/RecordsSet'
+import { RecordsSet } from '../src/internals/RecordsSet'
 
 const dataArray = [1, 2, 3]
 function* dataArrayGenerator() {
@@ -63,4 +63,4 @@ test('applies and preserves the order of filter and map functions everytime the
   t.deepEqual([...setWithFilter], [1, 3])
   t.deepEqual([...setWithFilterAndMap], ['1', '3'])
   t.deepEqual([...setWithFilterMapAndAnotherFilter], ['3'])
-})
+})

spec/Recorder.spec.ts

@@ -1,6 +1,6 @@
 import test from 'ava'
 import { Arg } from '../../src'
-import { Argument } from '../../src/Arguments'
+import { Argument } from '../../src/shared'
 
 const testObject = { "foo": "bar" }
 const testArray = ["a", 1, true]
@@ -107,4 +107,4 @@ test('should not match the argument with the predicate function using Arg.is.not
 
   t.true(Arg.is.not<string>(x => x === 'foo').matches('bar'))
   t.true(Arg.is.not<number>(x => x % 2 == 0).matches(3))
-})
+})

spec/RecordsSet.spec.ts

@@ -0,0 +1,28 @@
+import test from 'ava'
+
+import { Substitute, SubstituteOf, clearReceivedCalls } from '../../src'
+import { SubstituteNode, instance } from '../../src/internals/SubstituteNode'
+
+interface Calculator {
+  add(a: number, b: number): number
+  subtract(a: number, b: number): number
+  divide(a: number, b: number): number
+  isEnabled: boolean
+}
+
+type InstanceReturningSubstitute<T> = SubstituteOf<T> & {
+  [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]();
+
+  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))
+})