Add support for passing a function to stub.throws(...).

Author: George Schneeloch

docs/release-source/release/stubs.md

@@ -271,6 +271,11 @@ Causes the stub to throw an exception of the provided type.
 Causes the stub to throw the provided exception object.
 
 
+#### `stub.throws(function() { return new Error(); });`
+
+Causes the stub to throw the exception returned by the function.
+
+
 #### `stub.rejects();`
 
 Causes the stub to return a Promise which rejects with an exception (`Error`).

lib/sinon/behavior.js

@@ -127,6 +127,10 @@ var proto = {
 
         if (this.exception) {
             throw this.exception;
+        } else if (this.exceptionCreator) {
+            this.exception = this.exceptionCreator();
+            this.exceptionCreator = undefined;
+            throw this.exception;
         } else if (typeof this.returnArgAt === "number") {
             return args[this.returnArgAt];
         } else if (this.returnThis) {

lib/sinon/default-behaviors.js

@@ -7,11 +7,18 @@ var useLeftMostCallback = -1;
 var useRightMostCallback = -2;
 
 function throwsException(fake, error, message) {
-    if (typeof error === "string") {
-        fake.exception = new Error(message || "");
-        fake.exception.name = error;
+    if (typeof error === "function") {
+        fake.exceptionCreator = error;
+    } else if (typeof error === "string") {
+        fake.exceptionCreator = function () {
+            var newException = new Error(message || "");
+            newException.name = error;
+            return newException;
+        };
     } else if (!error) {
-        fake.exception = new Error("Error");
+        fake.exceptionCreator = function () {
+            return new Error("Error");
+        };
     } else {
         fake.exception = error;
     }
@@ -129,6 +136,7 @@ module.exports = {
         fake.reject = false;
         fake.returnValueDefined = true;
         fake.exception = undefined;
+        fake.exceptionCreator = undefined;
         fake.fakeFn = undefined;
     },
 
@@ -158,6 +166,7 @@ module.exports = {
         fake.reject = false;
         fake.returnValueDefined = true;
         fake.exception = undefined;
+        fake.exceptionCreator = undefined;
         fake.fakeFn = undefined;
     },
 
@@ -176,6 +185,7 @@ module.exports = {
         fake.reject = true;
         fake.returnValueDefined = true;
         fake.exception = undefined;
+        fake.exceptionCreator = undefined;
         fake.fakeFn = undefined;
 
         return fake;

test/stub-test.js

@@ -513,6 +513,43 @@ describe("stub", function () {
             assert.exception(stub, "Error");
         });
 
+        it("uses a lazily created exception for the generic error", function () {
+            var stub = createStub.create();
+            stub.throws();
+
+            assert.isFunction(stub.defaultBehavior.exceptionCreator);
+            assert(stub.defaultBehavior.exception === undefined);
+            assert.exception(stub, "Error");
+            assert(stub.defaultBehavior.exceptionCreator === undefined);
+            assert.same(stub.firstCall.exception.name, "Error");
+        });
+
+        it("uses a lazily created exception for the named error", function () {
+            var stub = createStub.create();
+            stub.throws("TypeError", "typeerror message");
+
+            assert.isFunction(stub.defaultBehavior.exceptionCreator);
+            assert(stub.defaultBehavior.exception === undefined);
+            assert.exception(stub, {
+                name: "TypeError",
+                message: "typeerror message"
+            });
+            assert(stub.defaultBehavior.exceptionCreator === undefined);
+            assert.same(stub.firstCall.exception.name, "TypeError");
+        });
+
+        it("does not use a lazily created exception if the error object is provided", function () {
+            var stub = createStub.create();
+            var exception = new Error();
+            stub.throws(exception);
+
+            assert(stub.defaultBehavior.exceptionCreator === undefined);
+            assert(stub.defaultBehavior.exception === exception);
+            assert.exception(stub, exception);
+            assert(stub.defaultBehavior.exceptionCreator === undefined);
+            assert(stub.defaultBehavior.exception === exception);
+        });
+
         it("resets 'invoking' flag", function () {
             var stub = createStub.create();
             stub.throws();
@@ -521,6 +558,23 @@ describe("stub", function () {
 
             refute.defined(stub.invoking);
         });
+
+        it("throws an exception created using a function", function () {
+            var stub = createStub.create();
+
+            stub.throws(function () {
+                return new Error("not implemented");
+            });
+
+            assert.isFunction(stub.defaultBehavior.exceptionCreator);
+            assert(stub.defaultBehavior.exception === undefined);
+            assert.exception(stub, {
+                message: "not implemented"
+            });
+            assert(stub.defaultBehavior.exceptionCreator === undefined);
+            assert.same(stub.firstCall.exception.message, "not implemented");
+            assert.contains(stub.firstCall.toString(), "not implemented");
+        });
     });
 
     describe(".callsArg", function () {
@@ -872,6 +926,17 @@ describe("stub", function () {
             assert(stub.threw("TypeError"));
         });
 
+        it("handles threw properly for lazily instantiated Errors", function () {
+            var stub = createStub(this.object, "method");
+            stub.throws(function () {
+                return new TypeError();
+            });
+
+            assert.exception(this.object.method);
+
+            assert(stub.threw("TypeError"));
+        });
+
         it("returns standalone stub without arguments", function () {
             var stub = createStub();