@johanblumenberg/ts-mockito - npm Package Compare versions

Comparing version 1.0.39 to 1.0.40

lib/MethodStubVerificator.d.ts

 import { MethodToStub } from "./MethodToStub";
 export declare class MethodStubVerificator<T> {
     private methodToVerify;
-    private methodCallToStringConverter;
     private actualCalls;
@@ -6,0 +5,0 @@ constructor(methodToVerify: MethodToStub);

lib/MethodStubVerificator.js

@@ -9,3 +9,2 @@ "use strict";
         this.methodToVerify = methodToVerify;
-        this.methodCallToStringConverter = new MethodCallToStringConverter_1.MethodCallToStringConverter();
         methodToVerify.watcher.invoked();
@@ -15,3 +14,3 @@ }
         var calls = this.methodToVerify.mocker.getActionsByName(this.methodToVerify.methodName);
-        return 'Actual calls:\n  ' + this.methodCallToStringConverter.convertActualCalls(calls).join('\n  ');
+        return 'Actual calls:\n  ' + MethodCallToStringConverter_1.MethodCallToStringConverter.convertActualCalls(calls).join('\n  ');
     };
@@ -36,3 +35,3 @@ MethodStubVerificator.prototype.called = function () {
         if (value !== allMatchingActions.length) {
-            var methodToVerifyAsString = this.methodCallToStringConverter.convert(this.methodToVerify);
+            var methodToVerifyAsString = MethodCallToStringConverter_1.MethodCallToStringConverter.convert(this.methodToVerify);
             var msg = "Expected \"" + methodToVerifyAsString + "to be called " + value + " time(s). But has been called " + allMatchingActions.length + " time(s).";
@@ -45,3 +44,3 @@ throw new Error(msg + '\n' + this.actualCalls());
         if (value > allMatchingActions.length) {
-            var methodToVerifyAsString = this.methodCallToStringConverter.convert(this.methodToVerify);
+            var methodToVerifyAsString = MethodCallToStringConverter_1.MethodCallToStringConverter.convert(this.methodToVerify);
             var msg = "Expected \"" + methodToVerifyAsString + "to be called at least " + value + " time(s). But has been called " + allMatchingActions.length + " time(s).";
@@ -54,3 +53,3 @@ throw new Error(msg + '\n' + this.actualCalls());
         if (value < allMatchingActions.length) {
-            var methodToVerifyAsString = this.methodCallToStringConverter.convert(this.methodToVerify);
+            var methodToVerifyAsString = MethodCallToStringConverter_1.MethodCallToStringConverter.convert(this.methodToVerify);
             var msg = "Expected \"" + methodToVerifyAsString + "to be called at most " + value + " time(s). But has been called " + allMatchingActions.length + " time(s).";
@@ -64,4 +63,4 @@ throw new Error(msg + '\n' + this.actualCalls());
         var secondMethodAction = method.mocker.getFirstMatchingAction(method.methodName, method.matchers);
-        var mainMethodToVerifyAsString = this.methodCallToStringConverter.convert(this.methodToVerify);
-        var secondMethodAsString = this.methodCallToStringConverter.convert(method);
+        var mainMethodToVerifyAsString = MethodCallToStringConverter_1.MethodCallToStringConverter.convert(this.methodToVerify);
+        var secondMethodAsString = MethodCallToStringConverter_1.MethodCallToStringConverter.convert(method);
         var errorBeginning = "Expected \"" + mainMethodToVerifyAsString + " to be called before " + secondMethodAsString;
@@ -87,4 +86,4 @@ if (firstMethodAction && secondMethodAction) {
         var secondMethodAction = method.mocker.getFirstMatchingAction(method.methodName, method.matchers);
-        var mainMethodToVerifyAsString = this.methodCallToStringConverter.convert(this.methodToVerify);
-        var secondMethodAsString = this.methodCallToStringConverter.convert(method);
+        var mainMethodToVerifyAsString = MethodCallToStringConverter_1.MethodCallToStringConverter.convert(this.methodToVerify);
+        var secondMethodAsString = MethodCallToStringConverter_1.MethodCallToStringConverter.convert(method);
         var errorBeginning = "Expected \"" + mainMethodToVerifyAsString + "to be called after " + secondMethodAsString;
@@ -116,3 +115,3 @@ if (firstMethodAction && secondMethodAction) {
                 else if (Date.now() >= expired) {
-                    var methodToVerifyAsString = _this.methodCallToStringConverter.convert(_this.methodToVerify);
+                    var methodToVerifyAsString = MethodCallToStringConverter_1.MethodCallToStringConverter.convert(_this.methodToVerify);
                     reject(new Error("Expected \"" + methodToVerifyAsString + "to be called within " + ms + " ms."));
@@ -119,0 +118,0 @@ }

lib/Mock.d.ts

@@ -10,2 +10,6 @@ import { Matcher } from "./matcher/type/Matcher";
 }
+export interface MockOptions {
+    propertyPolicy?: MockPropertyPolicy;
+    logInvocations?: Boolean;
+}
 export declare class Mocker {
@@ -21,3 +25,3 @@ private clazz;
     private excludedPropertyNames;
-    constructor(clazz: any, policy: MockPropertyPolicy, instance?: any);
+    constructor(clazz: any, options: MockOptions, instance?: any);
     getMock(): any;
@@ -24,0 +28,0 @@ createCatchAllHandlerForRemainingPropertiesWithoutGetters(origin: "instance" | "expectation"): any;

lib/Mock.js

@@ -14,2 +14,3 @@ "use strict";
 var ObjectPropertyCodeRetriever_1 = require("./utils/ObjectPropertyCodeRetriever");
+var MethodCallToStringConverter_1 = require("./utils/MethodCallToStringConverter");
 var MockPropertyPolicy;
@@ -22,4 +23,5 @@ (function (MockPropertyPolicy) {
 var Mocker = (function () {
-    function Mocker(clazz, policy, instance) {
+    function Mocker(clazz, options, instance) {
         if (instance === void 0) { instance = {}; }
+        var _a, _b;
         this.clazz = clazz;
@@ -34,3 +36,4 @@ this.instance = instance;
         this.excludedPropertyNames = ["hasOwnProperty"];
-        this.mock.__policy = policy;
+        this.mock.__policy = (_a = options.propertyPolicy) !== null && _a !== void 0 ? _a : MockPropertyPolicy.StubAsMethod;
+        this.mock.__logInvocations = (_b = options.logInvocations) !== null && _b !== void 0 ? _b : false;
         this.mock.__tsmockitoInstance = this.instance;
@@ -157,2 +160,5 @@ this.mock.__tsmockitoMocker = this;
             _this.methodActions.push(action);
+            if (_this.mock.__logInvocations) {
+                console.log("call: " + MethodCallToStringConverter_1.MethodCallToStringConverter.convertActualCalls([action])[0]);
+            }
             var methodStub = _this.getMethodStub(key, args);
@@ -159,0 +165,0 @@ methodStub.execute(args, thisArg);

lib/Spy.js

@@ -24,3 +24,3 @@ "use strict";
     function Spy(instance) {
-        var _this = _super.call(this, instance.constructor, Mock_1.MockPropertyPolicy.StubAsProperty, instance) || this;
+        var _this = _super.call(this, instance.constructor, { propertyPolicy: Mock_1.MockPropertyPolicy.StubAsProperty }, instance) || this;
         if (_.isObject(instance)) {
@@ -27,0 +27,0 @@ _this.processProperties(instance);

lib/ts-mockito.d.ts

@@ -5,4 +5,4 @@ import { ArgCaptor1, ArgCaptor10, ArgCaptor2, ArgCaptor3, ArgCaptor4, ArgCaptor5, ArgCaptor6, ArgCaptor7, ArgCaptor8, ArgCaptor9 } from "./capture/ArgCaptor";
 import { MethodStubVerificator } from "./MethodStubVerificator";
-import { MockPropertyPolicy } from "./Mock";
-export { MockPropertyPolicy } from "./Mock";
+import { MockPropertyPolicy, MockOptions } from "./Mock";
+export { MockPropertyPolicy, MockOptions } from "./Mock";
 export declare function spy<T>(instanceToSpy: T): T;
@@ -13,2 +13,3 @@ export declare function mock<T>(clazz: (new (...args: any[]) => T) | (Function & {
 export declare function imock<T>(policy?: MockPropertyPolicy): NonNullable<T> extends object ? T : unknown;
+export declare function imock<T>(options?: MockOptions): NonNullable<T> extends object ? T : unknown;
 export declare function fnmock<T extends (...args: any[]) => void>(): T;
@@ -15,0 +16,0 @@ export declare function cmock<R, T extends any[]>(): new (...args: T) => R;

lib/ts-mockito.js

@@ -77,7 +77,12 @@ "use strict";
     if (policy === void 0) { policy = Mock_1.MockPropertyPolicy.StubAsProperty; }
-    return new Mock_1.Mocker(clazz, policy).getMock();
+    return new Mock_1.Mocker(clazz, { propertyPolicy: policy }).getMock();
 }
 exports.mock = mock;
-function imock(policy) {
-    if (policy === void 0) { policy = Mock_1.MockPropertyPolicy.StubAsMethod; }
+function imock(optionsOrPolicy) {
+    var options = typeof optionsOrPolicy === 'object' ?
+        optionsOrPolicy :
+        {
+            propertyPolicy: optionsOrPolicy,
+            logInvocations: false,
+        };
     var Empty = (function () {
@@ -88,3 +93,3 @@ function Empty() {
     }());
-    var mockedValue = new Mock_1.Mocker(Empty, policy).getMock();
+    var mockedValue = new Mock_1.Mocker(Empty, options).getMock();
     if (typeof Proxy === "undefined") {
@@ -91,0 +96,0 @@ throw new Error("Mocking of interfaces requires support for Proxy objects");

lib/utils/MethodCallToStringConverter.d.ts

 import { MethodToStub } from "../MethodToStub";
 import { MethodAction } from "../MethodAction";
 export declare class MethodCallToStringConverter {
-    convert(method: MethodToStub): string;
-    convertActualCalls(calls: MethodAction[]): string[];
+    static convert(method: MethodToStub): string;
+    static convertActualCalls(calls: MethodAction[]): string[];
 }

lib/utils/MethodCallToStringConverter.js

@@ -7,3 +7,3 @@ "use strict";
     if (type === "string") {
-        return arg;
+        return "\"" + arg + "\"";
     }
@@ -20,3 +20,3 @@ else if (!arg || type === "number") {
     }
-    MethodCallToStringConverter.prototype.convert = function (method) {
+    MethodCallToStringConverter.convert = function (method) {
         method.watcher.invoked();
@@ -26,3 +26,3 @@ var stringifiedMatchers = method.matchers.map(function (matcher) { return matcher.toString(); }).join(", ");
     };
-    MethodCallToStringConverter.prototype.convertActualCalls = function (calls) {
+    MethodCallToStringConverter.convertActualCalls = function (calls) {
         return calls.map(function (call) { return call.methodName + "(" + call.args.map(argToString).join(", ") + ")"; });
@@ -29,0 +29,0 @@ };

package.json

 {
   "name": "@johanblumenberg/ts-mockito",
-  "version": "1.0.39",
+  "version": "1.0.40",
   "description": "Mocking library for TypeScript",
@@ -5,0 +5,0 @@ "main": "lib/ts-mockito.js",

README.md

@@ -32,2 +32,6 @@ # @johanblumenberg/ts-mockito
 
+### 1.0.40
+
+- [Log mock invocations`](#log-mock-invocations)
+
 ## Installation
@@ -514,2 +518,17 @@
 
+### Log mock invocations
+
+Sometimes it is useful to be able to see all invocations on a mocked object,
+for example if you are testing a component which you are not sure exactly
+how it works.
+
+``` typescript
+let mockedFoo:Foo = imock({logInvocations: true});
+let foo:Foo = instance(mockedFoo);
+
+foo.bar("hello world");
+// This will log:
+//   call: bar("hello world")
+```
+
 ### Thanks
@@ -516,0 +535,0 @@

No alert changes

Improved metrics

Total package byte prevSize

185248

0.91%

Lines of code

2758

0.51%

Number of lines in readme file

544

3.62%

No dependency changes