fixes issue sinonjs#1368 by adding stub#resolvesThis

HugoMuller · Aug 7, 2017 · 62a2a80 · 62a2a80
1 parent 112af55
commit 62a2a80
Show file tree

Hide file tree

Showing 4 changed files with 81 additions and 0 deletions.
diff --git a/lib/sinon/behavior.js b/lib/sinon/behavior.js
@@ -117,6 +117,7 @@ var proto = {
                 this.exception ||
                 typeof this.returnArgAt === "number" ||
                 this.returnThis ||
+                this.resolveThis ||
                 typeof this.throwArgAt === "number" ||
                 this.fakeFn ||
                 this.returnValueDefined);
@@ -142,6 +143,8 @@ var proto = {
             throw args[this.throwArgAt];
         } else if (this.fakeFn) {
             return this.fakeFn.apply(context, args);
+        } else if (this.resolveThis) {
+            return (this.promiseLibrary || Promise).resolve(context);
         } else if (this.resolve) {
             return (this.promiseLibrary || Promise).resolve(this.returnValue);
         } else if (this.reject) {

diff --git a/lib/sinon/default-behaviors.js b/lib/sinon/default-behaviors.js
@@ -155,6 +155,7 @@ module.exports = {
     resolves: function resolves(fake, value) {
         fake.returnValue = value;
         fake.resolve = true;
+        fake.resolveThis = false;
         fake.reject = false;
         fake.returnValueDefined = true;
         fake.exception = undefined;
@@ -173,6 +174,7 @@ module.exports = {
         }
         fake.returnValue = reason;
         fake.resolve = false;
+        fake.resolveThis = false;
         fake.reject = true;
         fake.returnValueDefined = true;
         fake.exception = undefined;
@@ -181,6 +183,12 @@ module.exports = {
         return fake;
     },
 
+    resolvesThis: function resolvesThis(fake) {
+        fake.resolveThis = true;
+        fake.resolve = false;
+        fake.reject = false;
+    },
+
     callThrough: function callThrough(fake) {
         fake.callsThrough = true;
     },

diff --git a/lib/sinon/stub.js b/lib/sinon/stub.js
@@ -123,6 +123,7 @@ var proto = {
         delete this.throwArgAt;
         delete this.fakeFn;
         this.returnThis = false;
+        this.resolveThis = false;
 
         fakes.forEach(function (fake) {
             fake.resetBehavior();

diff --git a/test/stub-test.js b/test/stub-test.js
@@ -285,6 +285,65 @@ describe("stub", function () {
         });
     });
 
+    describe(".resolvesThis", function () {
+        afterEach(function () {
+            if (Promise.resolve.restore) {
+                Promise.resolve.restore();
+            }
+        });
+
+        it("returns a promise resolves with this", function () {
+            var instance = {};
+            instance.stub = createStub.create();
+            instance.stub.resolvesThis();
+
+            return instance.stub().then(function (actual) {
+                assert.same(actual, instance);
+            });
+        });
+
+        var strictMode = (function () {
+            return this;
+        }()) === undefined;
+        if (strictMode) {
+            it("returns a promise resolves with undefined when detached", function () {
+                var stub = createStub.create();
+                stub.resolvesThis();
+
+                // Due to strict mode, would be `global` otherwise
+                return stub().then(function (actual) {
+                    assert.same(actual, undefined);
+                });
+            });
+        }
+
+        it("stub respects call", function () {
+            var stub = createStub.create();
+            stub.resolvesThis();
+            var object = {};
+
+            return stub.call(object).then(function (actual) {
+                assert.same(actual, object);
+            });
+        });
+
+        it("stub respects apply", function () {
+            var stub = createStub.create();
+            stub.resolvesThis();
+            var object = {};
+
+            return stub.apply(object).then(function (actual) {
+                assert.same(actual, object);
+            });
+        });
+
+        it("returns stub", function () {
+            var stub = createStub.create();
+
+            assert.same(stub.resolvesThis(), stub);
+        });
+    });
+
     describe(".returnsArg", function () {
         it("returns argument at specified index", function () {
             var stub = createStub.create();
@@ -2171,6 +2230,16 @@ describe("stub", function () {
             refute.defined(instance.stub());
         });
 
+        it("cleans 'resolvesThis' behavior", function () {
+            var instance = {};
+            instance.stub = createStub.create();
+            instance.stub.resolvesThis();
+
+            instance.stub.resetBehavior();
+
+            refute.defined(instance.stub());
+        });
+
         describe("does not touch properties that are reset by 'reset'", function () {
             it(".calledOnce", function () {
                 var stub = createStub();