Merge pull request #104 from AthennaIO/develop

feat(mock): add new match methods

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/test",
-  "version": "4.8.0",
+  "version": "4.9.0",
   "description": "The Athenna test runner. Built on top of Japa.",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",
@@ -58,7 +58,7 @@
     "sinon": "^15.1.0"
   },
   "devDependencies": {
-    "@athenna/common": "^4.14.0",
+    "@athenna/common": "^4.15.5",
     "@typescript-eslint/eslint-plugin": "^5.56.0",
     "@typescript-eslint/parser": "^5.56.0",
     "c8": "^8.0.0",

src/globals/Assert.ts

@@ -44,6 +44,16 @@ Assert.macro(
   }
 )
 
+Assert.macro('calledWithMatch', function (mock: SinonSpy, ...args: any[]) {
+  const hasCalledWithMatch = mock.calledWithMatch(...args)
+
+  if (!hasCalledWithMatch) {
+    return this.deepEqual(mock.args[0], args)
+  }
+
+  return this.isTrue(hasCalledWithMatch)
+})
+
 Assert.macro('calledBefore', function (mock: SinonSpy, beforeMock: SinonSpy) {
   return this.isTrue(mock.calledBefore(beforeMock))
 })
@@ -66,6 +76,16 @@ Assert.macro('notCalledWith', function (mock: SinonSpy, ...args: any[]) {
   return this.isFalse(hasCalledWith)
 })
 
+Assert.macro('notCalledWithMatch', function (mock: SinonSpy, ...args: any[]) {
+  const hasCalledWithMatch = mock.calledWithMatch(...args)
+
+  if (hasCalledWithMatch) {
+    return this.notDeepEqual(mock.args[0], args)
+  }
+
+  return this.isFalse(hasCalledWithMatch)
+})
+
 Assert.macro('calledOnceWith', function (mock: SinonSpy, ...args: any[]) {
   return this.isTrue(mock.calledOnceWith(...args))
 })
@@ -140,6 +160,32 @@ declare module '@japa/assert' {
      * determined arguments.
      */
     notCalledWith(mock: SinonSpy, ...args: any[]): void
+    /**
+     * Assert that the given mock was called with the
+     * arguments matching some of the given arguments.
+     * This is the same of doing:
+     * `assert.calledWith(mock, Mock.match(arg1), Mock.match(arg2))`
+     *
+     * @example
+     * ```ts
+     * console.log('hello', 'world', '!')
+     * assert.calledWithMatch(console.log, 'hello', 'world') // passes
+     * ```
+     */
+    calledWithMatch(mock: SinonSpy, ...args: any[]): void
+    /**
+     * Assert that the given mock was not called with the
+     * arguments matching some of the given arguments.
+     * This is the same of doing:
+     * `assert.notCalledWith(mock, Mock.match(arg1), Mock.match(arg2))`
+     *
+     * @example
+     * ```ts
+     * console.log('hello', 'world', '!')
+     * assert.notCalledWithMatch(console.log, 'hello', 'world') // fails
+     * ```
+     */
+    notCalledWithMatch(mock: SinonSpy, ...args: any[]): void
     /**
      * Assert that the given mock was called only once
      * with the determined arguments.

src/mocks/Mock.ts

@@ -7,15 +7,16 @@
  * file that was distributed with this source code.
  */
 
-import { createSandbox } from 'sinon'
-import { MockBuilder } from '#src/mocks/MockBuilder'
 import type {
   Spy,
+  Match,
   SpyMethod,
   StubMethod,
   SpyInstance,
   StubInstance
 } from '#src'
+import { createSandbox } from 'sinon'
+import { MockBuilder } from '#src/mocks/MockBuilder'
 
 export class Mock {
   /**
@@ -69,6 +70,18 @@ export class Mock {
     return Mock.sandbox.fake()
   }
 
+  /**
+   * Create a matcher for the given value.
+   *
+   * @example
+   * ```ts
+   * assert.isTrue({ hello: 'world', name: 'João' }, Mock.match({ hello: 'world' }))
+   * ```
+   */
+  public static match(value: any): Match {
+    return Mock.sandbox.match(value)
+  }
+
   /**
    * Restore all mocks to default.
    */

src/types/Match.ts

@@ -0,0 +1,12 @@
+/**
+ * @athenna/test
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { SinonMatcher } from 'sinon'
+
+export type Match = SinonMatcher

src/types/index.ts

@@ -10,6 +10,7 @@
 export type { Config, PluginFn } from '@japa/runner'
 
 export * from './Spy.js'
+export * from './Match.js'
 export * from './SpyMethod.js'
 export * from './SpyInstance.js'
 export * from './Stub.js'