a_mock 2.0.3 → 2.0.5

package/README.md

@@ -13,15 +13,6 @@ npm install a_mock
 ```
 
 
-
-__If you want the test framework, install it globally too:__
-
-```
-npm install a_mock -g
-```
-
-
-
 _Mocking_
 ===================
 
@@ -103,24 +94,26 @@ mock(['a','b']); //throws unexpected arguments
 mock(['foo', 'bar']); //throws unexpected arguments
 ```
 
-__Expecting struct__
-
-```js
-var mock = require('a_mock').mock();
-var obj = {};
+__Expecting struct__
+
+```js
+var mock = require('a_mock').mock();
+var obj = {};
 mock.expect({a : 1}).return('fake1');
 mock.expect({a : 2}).return('fake2');
 mock.expect({a : 2, b : {c : 'foo', d : ['me', 'too']}}).return('fake3');
 mock.expect(obj).return('fake4');
 mock.expect({}).return('will never happen');
 
-mock({a : 'x'}); //throws unexpected arguments
-mock({a : 1}); //returns 'fake1'
-mock({a : 2}); //returns 'fake2'
-mock({a : 2, b : {c : 'foo', d : ['me', 'too']}}); //returns 'fake3'
-mock(obj);  //returns 'fake4'
-mock({});  //throws unexpected arguments
-```
+mock({a : 'x'}); //throws unexpected arguments
+mock({a : 1}); //returns 'fake1'
+mock({a : 2}); //returns 'fake2'
+mock({a : 2, b : {c : 'foo', d : ['me', 'too']}}); //returns 'fake3'
+mock(obj);  //returns 'fake4'
+mock({});  //throws unexpected arguments cause leaf properties are not equal
+```
+
+Note: Struct matching is strict on leaf properties. All leaf property values must be equal to match, and an empty object does not match a non-empty expected struct.
 
 __Repeats__
 
@@ -456,160 +449,4 @@ function success(arg) {
 function error(e) {
 	console.log(e.stack);//will happen
 }
-```
-
-_A test framework_
-===================
-<b>From version 3.0.0 this is in a separate package: [npmjs.com/package/a_test](https://npmjs.com/package/a_test)</b>  
-_A_ test framework is a simplistic, magic-free library providing unit-testing facilities with a compact, bdd-style syntax.
-
-In contrast to other bdd-style test frameworks, it doesn't allow nesting suites in each other in order to test the SUT(subject under test) in different states. Instead, the framework relies on folder structure to describe the state. The SUT currently has that folder structure. Suite names are generated based on their filenames. As a result, there will be many small test files without nested test suites instead of a few big test files with nested test suites.
-
-Test setup, the "Arrange-Act" part of suites, is separated from the "Assert" part. This way the same setup can be used across different suites. Test setups can be chained.
-
-
-Examples below can be found here: https://github.com/alfateam/a_demo
-
-Example
----------
-The test runner ( _a_ ) will search for all files named 'when*.js' in the current and sub-directories.
-
-Given the following file structure
-
-- demo/
-	- counter.js
-	- counter_specs/
-		- new/
-			- increment.js
-			- when_incremented.js
-		- new.js
-		- when_new.js
-
-__counter.js__
-
-```js
-module.exports = function () {
-	var counter = {
-		value: 0,
-		increment: function() { value++; }
-	};
-
-	return counter;
-}
-```
-
-__counter_specs/new.js__
-
-```js
-function act(c) {
-	var createCounter = require('../counter');
-	c.sut = createCounter();
-}
-module.exports = act;
-```
-
-__counter_specs/when_new.js__
-
-```js
-var c = {}; //test context object
-var when = require('a_mock').when;
-
-when('./new', c). //set up
-	it('should be an object').
-		assertEqual('object', typeof c.sut)
-	it('should have value equal to zero').
-		assertEqual(0, c.sut.value).
-	it('should fail just for fun').
-		assertFail('error message');
-
-```
-
-__counter_specs/new/increment.js__
-
-```js
-function act(c) {
-	c.sut.increment();
-}
-act.base = '../new';
-module.exports = act;
-```
-
-__counter_specs/new/when_incremented.js__
-
-```js
-var c = {};
-var when = require('a_mock').when;
-
-when('./increment', c).
-	it('should have value equal to 1').
-		assertEqual(1, c.sut.value);
-
-```
-
-__In demo directory, run _a_ __
-
-	user@localhost:~/a_demo $ a
-
-	 » counter_specs » new
-
-	  ✓ should be an object
-	  ✓ should have value equal to zero
-	  ✘ should fail just for fun
-
-	 » counter_specs » new » increment
-
-	  ✓ should have value equal to 1
-
-	========== Summary =============
-
-	counter_specs » new
-	  ✘ should fail just for fun
-
-	AssertionError: error message
-    	at retval.assertFail (/home/user/a_demo/node_modules/a/when/it.js:14:11)
-    	at Object.test (/home/user/a_demo/node_modules/a/when/test_invoker.js:5:3)
-    	at Object.retval.assertFail (/home/user/a_demo/node_modules/a/when/it.js:13:5)
-    	at Object.<anonymous> (/home/user/a_demo/counter_specs/when_new.js:11:3)
-    	at Module._compile (module.js:449:26)
-    	at Object.Module._extensions..js (module.js:467:10)
-    	at Module.load (module.js:356:32)
-    	at Function.Module._load (module.js:312:12)
-    	at Module.require (module.js:362:17)
-    	at require (module.js:378:17)
-	------------
-
-	suites: 2, passed: 3, failed: 1
-
-Async test support
-------------------
-Modified act files should look like this:
-
-```js
-
-function act(c) {
-	...
-	return c.sut(c.arguments); //returns promise
-}
-
-```
-
-or
-
-```js
-
-async function act(c) {
-	...
-	await c.sut(c.arguments);
-}
-
-```
-Test file should look like this:
-```js
-var when = require('a_mock').when;
-var c = {};
-
-when(c).then(it => {
-	it('....').assertXXXX();
-});
-
-```
+```

package/index.d.ts

@@ -1,5 +1,3 @@
-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 {
@@ -26,9 +24,7 @@ type FunctionProps<T> = T extends (...args: any[]) => any
   : {};
 type MockedFunction<T extends AnyFunction> = MockFunction<
   OverloadedParameters<T>,
-  T extends AxiosInstance
-    ? Promise<AxiosResponse<any, any, {}>>
-    : OverloadedReturnType<T>
+  OverloadedReturnType<T>
 > &
   T &
   FunctionProps<T>;
@@ -40,7 +36,7 @@ interface RepeatControl {
 
 interface ExpectationTerminal<R, TArgs extends any[], TOrigArgs extends any[] = TArgs> {
   return(value: R): RepeatControl;
-  returnAny(value?: any): RepeatControl;
+  returnLoose(value?: any): RepeatControl;
   whenCalled(callback: CallbackFor<TOrigArgs>): ExpectationTerminal<R, TArgs, TOrigArgs>;
   repeat(times: number): RepeatControl;
   repeatAny(): RepeatControl;
@@ -55,25 +51,25 @@ interface ExpectationChain<TArgs extends any[], R, TOrigArgs extends any[] = TAr
   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, 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, TOrigArgs>;
 }
 
 interface MockFunction<TArgs extends any[], R> {
   (...args: TArgs): R;
-  // Allow any-args calls in addition to the original signature.
-  (...args: any[]): any;
-  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, TArgs>;
+  // Allow any-args calls in addition to the original signature.
+  (...args: any[]): any;
+  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, TArgs>;
   /** @deprecated Use ignoreAll() instead. */
   expectAnything(): ExpectationChain<any[], R, TArgs>;
   ignoreAll(): ExpectationChain<any[], R, TArgs>;

package/package.json

@@ -1,18 +1,29 @@
 {
   "name": "a_mock",
-  "version": "2.0.3",
+  "version": "2.0.5",
   "main": "index.js",
   "types": "index.d.ts",
   "title": "a_mock",
   "description": "Sub package of a. Mocking framework",
-  "keywords": ["mock","mocking","partial mock","strict mock","tdd","stub","stubbing","mock require","verify"],
+  "keywords": [
+    "mock",
+    "mocking",
+    "partial mock",
+    "strict mock",
+    "tdd",
+    "stub",
+    "stubbing",
+    "mock require",
+    "verify"
+  ],
   "scripts": {
     "test": "node --test **/*Spec/test*.js"
-    
   },
-  "dependencies": {  },
-  "repository" : {
-    "type" : "git",
-    "url"  : "git@github.com:alfateam/a_mock.git"
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:alfateam/a_mock.git"
+  },
+  "devDependencies": {
+    "axios": "^1.13.2"
   }
 }

package/partialMock/expectAnything.js

@@ -26,9 +26,10 @@ function expectAnything(index,mockContext) {
 
 	c.ignoreAll = c.expectAnything;
 
-	c.return = function(arg) {
-		return _return(arg,index+1,mockContext);
-	};
+	c.return = function(arg) {
+		return _return(arg,index+1,mockContext);
+	};
+	c.returnLoose = c.return;
 
 	c.whenCalled = function(callback) {
 		mockContext.whenCalledEmitter.add(callback);

package/partialMock/expectCore.js

@@ -35,9 +35,10 @@ function expect(hasCorrectArgument,index,mockContext) {
 		return expectArray(index+1,mockContext,array);
 	}
 
-	c.return = function(arg) {
-		return _return(arg,index+1,mockContext);
-	};
+	c.return = function(arg) {
+		return _return(arg,index+1,mockContext);
+	};
+	c.returnLoose = c.return;
 
 	c.whenCalled = function(callback) {
 		mockContext.whenCalledEmitter.add(callback);
@@ -57,10 +58,10 @@ function expect(hasCorrectArgument,index,mockContext) {
 		return _return(undefined,index+1,mockContext).repeatAny();
 	};
 
-	c.resolve = function(value) {
-		var promise = newThen.resolve(value);
-		return c.return(promise);
-	};
+	c.resolve = function(value) {
+		var promise = newThen.resolve(value);
+		return c.return(promise);
+	};
 
 	c.reject = function(value) {
 		var promise = newThen.reject(value);

package/partialMock/expectEmpty.js

@@ -10,9 +10,10 @@ function expectEmpty(mockContext) {
 	mockContext.compositeAreCorrectArguments.add(hasCorrectArgument);
 	mockContext.numberOfArgs = 0;
 
-	c.return = function(arg) {
-		return _return(arg,0,mockContext);
-	};
+	c.return = function(arg) {
+		return _return(arg,0,mockContext);
+	};
+	c.returnLoose = c.return;
 
 	c.whenCalled = function(callback) {
 		mockContext.whenCalledEmitter.add(callback);
@@ -45,4 +46,4 @@ function expectEmpty(mockContext) {
 	return c;
 }
 
-module.exports = expectEmpty;
+module.exports = expectEmpty;