a_mock 2.0.2 → 2.0.4

package/eventEmitterSpec/test.js

@@ -1,5 +1,5 @@
 var assert = require('assert');
-var test = require('../test')
+var test = require('node:test')
 var newRequireMock = require('../partialMock/simple/newRequireMock');
 var newMock = require('../partialMock/simple/newMock');
 
@@ -13,13 +13,11 @@ var tryRemove = newRequireMock('./eventEmitter/tryRemove');
 var newSut = require('../eventEmitter');
 
 (function(){
-	console.log('newEventEmitter');
 	var context = {};
 	newEmitterContext.expect().return(context);
 	var sut = newSut();
 
 	(function() {
-		console.log('add');
 		var callback = {};
 		var didAdd;
 		add.expect(context).expect(callback).whenCalled(onAdd).return();
@@ -40,7 +38,6 @@ var newSut = require('../eventEmitter');
 	})();
 
 	(function() {
-		console.log('tryAdd');
 		var callback = {};
 		var didAdd;
 		tryAdd.expect(context).expect(callback).whenCalled(onAdd).return();
@@ -61,7 +58,6 @@ var newSut = require('../eventEmitter');
 	})();
 
 	(function() {
-		console.log('remove');
 		var callback = {};
 		var didRemove;
 		remove.expect(context).expect(callback).whenCalled(onRemove).return();
@@ -82,7 +78,6 @@ var newSut = require('../eventEmitter');
 	})();
 
 	(function() {
-		console.log('tryRemove');
 		var callback = {};
 		var didtryRemove;
 		tryRemove.expect(context).expect(callback).whenCalled(ontryRemove).return();
@@ -103,7 +98,6 @@ var newSut = require('../eventEmitter');
 	})();
 
 	(function() {
-		console.log('emit');
 		var callback = {};
 		var didemit;
 		var callback = newMock();

package/expectRequireSpec/test.js

@@ -1,5 +1,5 @@
 var sut = require('../expectRequire');
-var test = require('../test');
+var test = require('node:test');
 var assert = require('assert');
 
 var fooFake = {};
@@ -7,10 +7,8 @@ var bazFake = {};
 	
 
 (function(){
-	console.log('expectRequire');
 	
 	(function() {		
-		console.log('require');
 		sut('./foo').return(fooFake);
 			sut('./baz').return(bazFake);
 
@@ -42,10 +40,8 @@ var bazFake = {};
 })();
 
 (function(){
-	console.log('expectRequire reset');
 	
 	(function() {		
-		console.log('require');
 		sut('./foo').return(fooFake);
 		sut.reset();
 		var returned = require('./foo');

package/index.d.ts

@@ -1,109 +1,138 @@
-type AnyFunction = (...args: any[]) => any;
-type Tail<T extends any[]> = T extends [any, ...infer R] ? R : [];
-type FunctionProps<T> = T extends (...args: any[]) => any
-  ? { [K in Exclude<keyof T, keyof Function>]: Mocked<T[K]> }
-  : {};
-type MockedFunction<T extends AnyFunction> = MockFunction<
-  Parameters<T>,
-  ReturnType<T>
-> &
-  T &
-  FunctionProps<T>;
-
-interface RepeatControl {
-  repeat(times: number): RepeatControl;
-  repeatAny(): RepeatControl;
-}
-
-interface ExpectationTerminal<R, TArgs extends any[]> {
-  return(value?: R): RepeatControl;
-  whenCalled(callback: (...args: TArgs) => void): ExpectationTerminal<R, TArgs>;
-  repeat(times: number): RepeatControl;
-  repeatAny(): RepeatControl;
-  throw(error: unknown): ExpectationTerminal<R, TArgs>;
-  resolve(value: any): RepeatControl;
-  reject(value: any): RepeatControl;
-}
-
-interface ExpectationChain<TArgs extends any[], R>
-  extends ExpectationTerminal<R, TArgs> {
-  expect(arg: TArgs[0]): ExpectationChain<Tail<TArgs>, R>;
-  expectAnything(): ExpectationChain<Tail<TArgs>, R>;
-  ignore(): ExpectationChain<Tail<TArgs>, R>;
+import type { AxiosInstance, AxiosResponse } from 'axios';
+
+type AnyFunction = (...args: any[]) => any;
+type Tail<T extends any[]> = T extends [any, ...infer R] ? R : [];
+type OverloadedParameters<T> = T extends {
+  (...args: infer A): any;
+  (...args: infer B): any;
+}
+  ? A | B
+  : T extends (...args: infer A) => any
+  ? A
+  : never;
+type OverloadedReturnType<T> = T extends {
+  (...args: any[]): infer A;
+  (...args: any[]): infer B;
+}
+  ? A | B
+  : T extends (...args: any[]) => infer A
+  ? A
+  : never;
+type OptionalTuple<T extends any[]> = { [K in keyof T]?: T[K] };
+type UnwrapPromise<T> = T extends Promise<infer U> ? U : T;
+type CallbackFor<TArgs> = TArgs extends any[] ? (...args: TArgs) => void : never;
+type FunctionProps<T> = T extends (...args: any[]) => any
+  ? { [K in Exclude<keyof T, keyof Function>]: Mocked<T[K]> }
+  : {};
+type MockedFunction<T extends AnyFunction> = MockFunction<
+  OverloadedParameters<T>,
+  T extends AxiosInstance
+    ? Promise<AxiosResponse<any, any, {}>>
+    : OverloadedReturnType<T>
+> &
+  T &
+  FunctionProps<T>;
+
+interface RepeatControl {
+  repeat(times: number): RepeatControl;
+  repeatAny(): RepeatControl;
+}
+
+interface ExpectationTerminal<R, TArgs extends any[], TOrigArgs extends any[] = TArgs> {
+  return(value: R): RepeatControl;
+  returnLoose(value?: any): RepeatControl;
+  whenCalled(callback: CallbackFor<TOrigArgs>): ExpectationTerminal<R, TArgs, TOrigArgs>;
+  repeat(times: number): RepeatControl;
+  repeatAny(): RepeatControl;
+  throw(error: any): ExpectationTerminal<R, TArgs, TOrigArgs>;
+  resolve(value: UnwrapPromise<R>): RepeatControl;
+  resolveLoose(value?: any): RepeatControl;
+  reject(error: Error): RepeatControl;
+}
+
+interface ExpectationChain<TArgs extends any[], R, TOrigArgs extends any[] = TArgs>
+  extends ExpectationTerminal<R, TArgs, TOrigArgs> {
+  expect(arg?: TArgs[0]): ExpectationChain<Tail<TArgs>, R, TOrigArgs>;
+  /** @deprecated Use ignoreAll() instead. */
+  expectAnything(): ExpectationChain<any[], R, TOrigArgs>;
+  ignoreAll(): ExpectationChain<any[], R, TOrigArgs>;
+  expectLoose(...args: any[]): ExpectationChain<any[], any, TOrigArgs>;
+  ignore(): ExpectationChain<Tail<TArgs>, R, TOrigArgs>;
+  /** @deprecated Use expect() instead. */
   expectArray(
-    value: TArgs[0] extends any[] ? TArgs[0] : any[]
-  ): ExpectationChain<Tail<TArgs>, R>;
-}
-
-interface MockFunction<TArgs extends any[], R> {
-  (...args: TArgs): R;
+    value?: TArgs[0] extends any[] ? TArgs[0] : any[]
+  ): ExpectationChain<Tail<TArgs>, R, TOrigArgs>;
+}
+
+interface MockFunction<TArgs extends any[], R> {
+  (...args: TArgs): R;
   // Allow any-args calls in addition to the original signature.
   (...args: any[]): any;
-  expect(): ExpectationTerminal<R, TArgs>;
-  expect(...args: TArgs): ExpectationTerminal<R, TArgs>;
-  expect(arg: TArgs[0]): ExpectationChain<Tail<TArgs>, R>;
-  expectAnything(): ExpectationChain<Tail<TArgs>, R>;
-  ignore(): ExpectationChain<Tail<TArgs>, R>;
+  expect(...args: OptionalTuple<TArgs>): ExpectationChain<Tail<TArgs>, R, TArgs>;
+  ignore(): ExpectationChain<Tail<TArgs>, R, TArgs>;
+  /** @deprecated Use expect() instead. */
   expectArray(
-    value: TArgs[0] extends any[] ? TArgs[0] : any[]
-  ): ExpectationChain<Tail<TArgs>, R>;
-  // Allow any-args expectations in addition to typed expectations.
-  expect(...args: any[]): ExpectationTerminal<any, any[]>;
-  verify(): true;
-  reset(): void;
-}
-
-type Mocked<T> = T extends AnyFunction
-  ? MockedFunction<T>
-  : T extends object
-  ? { [K in keyof T]: Mocked<T[K]> } & { verify: () => true }
-  : T;
-
-interface RequireExpectation {
-  return(value: any): RequireExpectation;
-  repeat(times: number): RequireExpectation;
-  repeatAny(): RequireExpectation;
-  whenCalled(callback: (...args: any[]) => void): RequireExpectation;
-}
-
-interface ThenableMock<T = any> {
-  (valueToResolveWith?: T | null, errorToFailWith?: any): ThenableMock<T>;
-  then<U = T>(
-    success?: (value: T) => U | ThenableMock<U> | PromiseLike<U>,
-    fail?: (error: any) => U | ThenableMock<U> | PromiseLike<U>
-  ): ThenableMock<U>;
-  resolve(value?: T): ThenableMock<T>;
-  reject(error: any): ThenableMock<never>;
-}
-
-declare function mock<TArgs extends any[] = any[], R = any>(): MockFunction<
-  TArgs,
-  R
->;
-declare function mock<T extends AnyFunction>(
-  original: T
-): MockedFunction<T>;
-declare function mock<T extends object>(subject: T): Mocked<T>;
-
-declare function expectRequire(moduleName: string): RequireExpectation;
-declare namespace expectRequire {
-  function reset(): void;
-}
-
-declare function requireMock<TArgs extends any[] = any[], R = any>(
-  moduleName: string
-): MockFunction<TArgs, R>;
-declare namespace requireMock {
-  function reset(): void;
-}
-
-declare function promise<T = any>(): ThenableMock<T>;
-
-declare const aMock: {
-  mock: typeof mock;
-  expectRequire: typeof expectRequire;
-  requireMock: typeof requireMock;
-  promise: typeof promise;
-};
-
-export = aMock;
+    value?: TArgs[0] extends any[] ? TArgs[0] : any[]
+  ): ExpectationChain<Tail<TArgs>, R, TArgs>;
+  /** @deprecated Use ignoreAll() instead. */
+  expectAnything(): ExpectationChain<any[], R, TArgs>;
+  ignoreAll(): ExpectationChain<any[], R, TArgs>;
+  // Explicit loose expectations.
+  expectLoose(...args: any[]): ExpectationChain<any[], any, TArgs>;
+  verify(): true;
+  reset(): void;
+}
+
+type Mocked<T> = T extends AnyFunction
+  ? MockedFunction<T>
+  : T extends object
+  ? { [K in keyof T]: Mocked<T[K]> } & { verify: () => true }
+  : T;
+
+interface RequireExpectation {
+  return(value: any): RequireExpectation;
+  repeat(times: number): RequireExpectation;
+  repeatAny(): RequireExpectation;
+  whenCalled(callback: (...args: any[]) => void): RequireExpectation;
+}
+
+interface ThenableMock<T = any> {
+  (valueToResolveWith?: T | null, errorToFailWith?: any): ThenableMock<T>;
+  then<U = T>(
+    success?: (value: T) => U | ThenableMock<U> | PromiseLike<U>,
+    fail?: (error: any) => U | ThenableMock<U> | PromiseLike<U>
+  ): ThenableMock<U>;
+  resolve(value?: T): ThenableMock<T>;
+  reject(error: any): ThenableMock<never>;
+}
+
+declare function mock<T = any[], R = any>(): T extends any[]
+  ? MockFunction<T, R>
+  : Mocked<T>;
+declare function mock<T extends AnyFunction>(
+  original: T
+): MockedFunction<T>;
+declare function mock<T extends object>(subject: T): Mocked<T>;
+
+declare function expectRequire(moduleName: string): RequireExpectation;
+declare namespace expectRequire {
+  function reset(): void;
+}
+
+declare function requireMock<TArgs extends any[] = any[], R = any>(
+  moduleName: string
+): MockFunction<TArgs, R>;
+declare namespace requireMock {
+  function reset(): void;
+}
+
+declare function promise<T = any>(): ThenableMock<T>;
+
+declare const aMock: {
+  mock: typeof mock;
+  expectRequire: typeof expectRequire;
+  requireMock: typeof requireMock;
+  promise: typeof promise;
+};
+
+export = aMock;

package/mock/mockContextSpec/test.js

@@ -1,14 +1,12 @@
 var assert = require('assert');
-var test = require('../../test');
+var test = require('node:test');
 var newRequireMock = require('../../partialMock/simple/newRequireMock');
 
 (function(){
-	console.log('mockContext');
 	var newVerify = newRequireMock('../newMutableAnd');
 	var sut = require('../mockContext');
 
 	(function() {
-		console.log('empty input.new');
 		var verify = {};
 		newVerify.expect().return(verify);	
 		var returned = sut();
@@ -19,7 +17,6 @@ var newRequireMock = require('../../partialMock/simple/newRequireMock');
 	})();
 
 	(function() {		
-		console.log('nonEmpty input.new');
 		var input = {};		
 		var returned = sut(input);
 
@@ -27,4 +24,4 @@ var newRequireMock = require('../../partialMock/simple/newRequireMock');
 			assert.equal(returned,input);
     	});
 	})();
-})();
+})();

package/mock/mockFuncProperties.js

@@ -1,39 +1,39 @@
-var propertyMock = require('./propertyMock');
-
-function collectPropertyNames(subject) {
-	var names = {};
-	for (var name in subject) {
-		names[name] = true;
-	}
-	var proto = Object.getPrototypeOf(subject);
-	while (proto && proto !== Object.prototype && proto !== Function.prototype) {
-		var props = Object.getOwnPropertyNames(proto);
-		for (var i = 0; i < props.length; i++) {
-			var prop = props[i];
-			if (prop === 'constructor' || names[prop])
-				continue;
-			var desc = Object.getOwnPropertyDescriptor(proto, prop);
-			if (desc && typeof desc.value === 'function')
-				names[prop] = true;
-		}
-		proto = Object.getPrototypeOf(proto);
-	}
-	return Object.keys(names);
-}
-
-function execute(subject,mockObject) {
-	if (!(subject instanceof Object))
-		return;
-	var mockFuncProperties = require('./mockFuncProperties');
-	var propertyNames = collectPropertyNames(subject);
-	for(var i = 0; i < propertyNames.length; i++) {
-		var propertyName = propertyNames[i];
-		var property = subject[propertyName];
-		var mockProperty = mockObject[propertyName];
-		if (property instanceof Function)
-			subject[propertyName] = propertyMock(subject,propertyName,mockProperty);
-		mockFuncProperties(property,mockProperty);
-	}
-}
+var propertyMock = require('./propertyMock');
+
+function collectPropertyNames(subject) {
+	var names = {};
+	for (var name in subject) {
+		names[name] = true;
+	}
+	var proto = Object.getPrototypeOf(subject);
+	while (proto && proto !== Object.prototype && proto !== Function.prototype) {
+		var props = Object.getOwnPropertyNames(proto);
+		for (var i = 0; i < props.length; i++) {
+			var prop = props[i];
+			if (prop === 'constructor' || names[prop])
+				continue;
+			var desc = Object.getOwnPropertyDescriptor(proto, prop);
+			if (desc && typeof desc.value === 'function')
+				names[prop] = true;
+		}
+		proto = Object.getPrototypeOf(proto);
+	}
+	return Object.keys(names);
+}
+
+function execute(subject,mockObject) {
+	if (!(subject instanceof Object))
+		return;
+	var mockFuncProperties = require('./mockFuncProperties');
+	var propertyNames = collectPropertyNames(subject);
+	for(var i = 0; i < propertyNames.length; i++) {
+		var propertyName = propertyNames[i];
+		var property = subject[propertyName];
+		var mockProperty = mockObject[propertyName];
+		if (property instanceof Function)
+			subject[propertyName] = propertyMock(subject,propertyName,mockProperty);
+		mockFuncProperties(property,mockProperty);
+	}
+}
 
 module.exports  = execute;

package/mock/mockFuncPropertiesSpec/test.js

@@ -1,16 +1,14 @@
 var assert = require('assert');
-var test = require('../../test');
+var test = require('node:test');
 var newRequireMock = require('../../partialMock/simple/newRequireMock');
 var newMock = require('../../partialMock/simple/newMock');
 
 (function(){
-	console.log('mockFuncProperties');
 	var newPropertyMock = newRequireMock('./propertyMock');
 	var mockFuncProperties = newRequireMock('./mockFuncProperties');
 	var sut = require('../mockFuncProperties');
 
 	(function() {
-		console.log('subject is non-primitive');
 		var subject = {};
 		var a2 = {};
 		var a = function() {};
@@ -54,7 +52,6 @@ var newMock = require('../../partialMock/simple/newMock');
 	})();
 
 	(function() {
-		console.log('subject is primitive');
 		var subject = 'a';
 		var mockObject = 'a';
 
@@ -64,4 +61,4 @@ var newMock = require('../../partialMock/simple/newMock');
 			assert(true);
 		});	
 	})();
-})();
+})();

package/mock/objectMock.js

@@ -1,48 +1,61 @@
-var newMockContext = require('./mockContext');
-var newPartialMock = require('../partialMock');
-
-function collectPropertyNames(subject) {
-	var names = {};
-	for (var name in subject) {
-		names[name] = true;
-	}
-	var proto = Object.getPrototypeOf(subject);
-	while (proto && proto !== Object.prototype && proto !== Function.prototype) {
-		var props = Object.getOwnPropertyNames(proto);
-		for (var i = 0; i < props.length; i++) {
-			var prop = props[i];
-			if (prop === 'constructor' || names[prop])
-				continue;
-			var desc = Object.getOwnPropertyDescriptor(proto, prop);
-			if (desc && typeof desc.value === 'function')
-				names[prop] = true;
-		}
-		proto = Object.getPrototypeOf(proto);
-	}
-	return Object.keys(names);
-}
-
-function _new(subject,mockContext,parent) {
-	var newObjectMock = require('./objectMock');
-
-	var mockContext = newMockContext(mockContext);
-	var mock = {};
-	mock.verify = mockContext.verify;
-	if (subject instanceof Function) {
-		mock = newPartialMock(subject, parent);		
-		mockContext.verify.add(mock.verify);
-	}
-	if (!(subject instanceof Object))
-		return mock;
-	var propertyNames = collectPropertyNames(subject);
-	for(var i = 0; i < propertyNames.length; i++) {
-		var propertyName = propertyNames[i];
-		if (Object.prototype.hasOwnProperty.call(mock, propertyName))
-			continue;
-		var property = subject[propertyName];
-		mock[propertyName] = newObjectMock(property,mockContext,subject);
-	}
-	return mock;
-}
+var newMockContext = require('./mockContext');
+var newPartialMock = require('../partialMock');
+
+function collectPropertyNames(subject) {
+	var names = {};
+	for (var name in subject) {
+		names[name] = true;
+	}
+	var proto = Object.getPrototypeOf(subject);
+	while (proto && proto !== Object.prototype && proto !== Function.prototype) {
+		var props = Object.getOwnPropertyNames(proto);
+		for (var i = 0; i < props.length; i++) {
+			var prop = props[i];
+			if (prop === 'constructor' || names[prop])
+				continue;
+			var desc = Object.getOwnPropertyDescriptor(proto, prop);
+			if (desc && typeof desc.value === 'function')
+				names[prop] = true;
+		}
+		proto = Object.getPrototypeOf(proto);
+	}
+	return Object.keys(names);
+}
+
+function _new(subject,mockContext,parent) {
+	var newObjectMock = require('./objectMock');
+
+	var mockContext = newMockContext(mockContext);
+	var mock = {};
+	if (subject && typeof subject === 'function' && typeof subject.expectAnything === 'function' && typeof subject.expect === 'function')
+		return subject;
+	var mockedMap = mockContext._mockedMap;
+	if (!mockedMap) {
+		mockedMap = new WeakMap();
+		mockContext._mockedMap = mockedMap;
+	}
+	if (subject && (typeof subject === 'object' || typeof subject === 'function')) {
+		var existingMock = mockedMap.get(subject);
+		if (existingMock)
+			return existingMock;
+	}
+	mock.verify = mockContext.verify;
+	if (subject instanceof Function) {
+		mock = newPartialMock(subject, parent);		
+		mockContext.verify.add(mock.verify);
+	}
+	if (!(subject instanceof Object))
+		return mock;
+	mockedMap.set(subject, mock);
+	var propertyNames = collectPropertyNames(subject);
+	for(var i = 0; i < propertyNames.length; i++) {
+		var propertyName = propertyNames[i];
+		if (Object.prototype.hasOwnProperty.call(mock, propertyName))
+			continue;
+		var property = subject[propertyName];
+		mock[propertyName] = newObjectMock(property,mockContext,subject);
+	}
+	return mock;
+}
 
 module.exports  = _new

package/mock/objectMockSpec/test.js

@@ -1,17 +1,15 @@
 var assert = require('assert');
-var test = require('../../test');
+var test = require('node:test');
 var newRequireMock = require('../../partialMock/simple/newRequireMock');
 var newMock = require('../../partialMock/simple/newMock');
 
 (function(){
-	console.log('objectMock');
 	var newMockContext = newRequireMock('./mockContext');
 	var newPartialMock = newRequireMock('../partialMock');
 	var newSut =  require('../objectMock');
 	
 
 	(function() {
-		console.log('subject is object.new');
 		var newObjectMock = newRequireMock('./objectMock');
 		var initialMockContext = {}
 		var mockContext = {};
@@ -26,9 +24,11 @@ var newMock = require('../../partialMock/simple/newMock');
 		var bMock = {};
 
 		newMockContext.expect(initialMockContext).return(mockContext);
-		newObjectMock.expect(a).expect(mockContext).return(aMock);
-		newObjectMock.expect(b).expect(mockContext).return(bMock);
+		// parent is optional metadata; behavior should not require callers to pass it.
+		newObjectMock.expect(a).expect(mockContext).expect(subject).return(aMock);
+		newObjectMock.expect(b).expect(mockContext).expect(subject).return(bMock);
 
+		//todo
 		var returned = newSut(subject,initialMockContext);
 
 		test('it should not return subject', function(){
@@ -49,7 +49,6 @@ var newMock = require('../../partialMock/simple/newMock');
 	})();
 
 	(function() {
-		console.log('subject is func.new');
 		var newObjectMock = newRequireMock('./objectMock');
 		var initialMockContext = {}
 		var mockContext = {};
@@ -69,9 +68,10 @@ var newMock = require('../../partialMock/simple/newMock');
 		var didAddVerifyToComposite;
 
 		newMockContext.expect(initialMockContext).return(mockContext);
-		newObjectMock.expect(a).expect(mockContext).return(aMock);
-		newObjectMock.expect(b).expect(mockContext).return(bMock);
-		newPartialMock.expect(subject).return(partialMock);
+		// parent is optional metadata; behavior should not require callers to pass it.
+		newObjectMock.expect(a).expect(mockContext).expect(subject).return(aMock);
+		newObjectMock.expect(b).expect(mockContext).expect(subject).return(bMock);
+		newPartialMock.expect(subject).expectAnything().return(partialMock);
 		compositeVerify.add.expect(verify).whenCalled(onAddVerify).return(null);
 
 		function onAddVerify() {
@@ -99,7 +99,6 @@ var newMock = require('../../partialMock/simple/newMock');
 	})();
 
 	(function() {
-		console.log('subject is primitive');
 		var newObjectMock = newRequireMock('./objectMock');
 		var initialMockContext = {}
 		var mockContext = {};
@@ -120,4 +119,4 @@ var newMock = require('../../partialMock/simple/newMock');
 	    	assert.equal(returned.verify,verify);
 	    });
 	})();
-})();
+})();

package/mock/propertyMockSpec/test.js

@@ -1,9 +1,8 @@
 var assert = require('assert');
-var test = require('../../test');
+var test = require('node:test');
 var newMock = require('../../partialMock/simple/newMock');
 
 (function(){
-	console.log('propertyMock.new');
 	newSut = require('../propertyMock');
 
 	var subject = {};
@@ -22,7 +21,6 @@ var newMock = require('../../partialMock/simple/newMock');
 	});
 
 	(function() {
-		console.log('execute mocked property');
 		var mockedValue = {};
 		var arg = {};
 		mock.expect(arg).return(mockedValue);
@@ -33,4 +31,4 @@ var newMock = require('../../partialMock/simple/newMock');
 		});
 	})();
 	
-})();
+})();