Add mockObject.reset (#293)

* feat(mocks): Allow MockObjects to be resetted Fixes #292 * test: Fix test naming * Export resetMockObject and update implementation * Add changeset * Change api to mockObject.reset --------- Co-authored-by: Piotr Szlachciak <[email protected]>
l2beat · Apr 21, 2024 · e5ce81a · e5ce81a
1 parent ce60bac
commit e5ce81a
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 0 deletions.
diff --git a/.changeset/proud-queens-invite.md b/.changeset/proud-queens-invite.md
@@ -0,0 +1,5 @@
+---
+"earl": minor
+---
+
+Add mockObject.reset which resets all functions on MockObject
diff --git a/packages/earl/src/mocks/mockObject.test.ts b/packages/earl/src/mocks/mockObject.test.ts
@@ -36,4 +36,12 @@ describe(mockObject.name, () => {
       'Cannot access .run - no mock value provided.',
     )
   })
+
+  it('can be reset using mockObject.reset', () => {
+    const instance = mockObject<Jogger>({ run: () => 10 })
+    instance.run.returnsOnce(20)
+    mockObject.reset(instance)
+
+    expect(instance.run()).to.equal(10)
+  })
 })
diff --git a/packages/earl/src/mocks/mockObject.ts b/packages/earl/src/mocks/mockObject.ts
@@ -62,3 +62,16 @@ function replaceFunctionsWithMocks<T extends object>(object: T) {
   }
   return clone
 }
+
+/**
+ * Resets every `mockFn` of the given `MockObject`.
+ *
+ * @param mockObject - The `MockObject` to reset
+ */
+mockObject.reset = function reset(mockObject: MockObject<unknown>): void {
+  for (const value of Object.values(mockObject)) {
+    if (isMockFn(value)) {
+      value.reset()
+    }
+  }
+}