Remove deprecated

* sandbox.stub(obj, 'meth', val)
* sinon.stub(obj, 'meth', fn)
* sinon/util/core

docs/release-source/release/stubs.md

@@ -76,11 +76,13 @@ Replaces `object.method` with a stub function. An exception is thrown if the pro
 
 The original function can be restored by calling `object.method.restore();` (or `stub.restore();`).
 
-#### `var stub = sinon.stub(object, "method", func);`
+#### ~~`var stub = sinon.stub(object, "method", func);`~~
 
-Replaces `object.method` with a `func`, wrapped in a `spy`.
+This has been removed from `v3.0.0`. Instead you should use
 
-As usual, `object.method.restore();` can be used to restore the original method.
+`stub(obj, 'meth').callsFake(fn)`
+
+Codemod available at https://github.com/hurrymaplelad/sinon-codemod
 
 #### `var stub = sinon.stub(obj);`
 

lib/sinon/collection.js

@@ -3,8 +3,8 @@
 var sinonSpy = require("./spy");
 var sinonStub = require("./stub");
 var sinonMock = require("./mock");
-var sandboxStub = require("./sandbox-stub");
 var collectOwnMethods = require("./collect-own-methods");
+var valueToString = require("./util/core/value-to-string");
 
 var push = [].push;
 
@@ -85,9 +85,13 @@ var collection = {
         return this.add(sinonSpy.apply(sinonSpy, arguments));
     },
 
-    stub: function stub(object, property/*, value*/) {
+    stub: function stub(object, property) {
         if (arguments.length > 2) {
-            return sandboxStub.apply(this, arguments);
+            throw new TypeError("stub(obj, 'meth', fn) has been removed, see documentation");
+        }
+
+        if (object && typeof property !== "undefined" && !Object.prototype.hasOwnProperty.call(object, property)) {
+            throw new TypeError("Cannot stub non-existent own property " + valueToString(property));
         }
 
         var stubbed = sinonStub.apply(null, arguments);

lib/sinon/sandbox-stub.js

@@ -1,21 +1,15 @@
 "use strict";
 
 var collectOwnMethods = require("./collect-own-methods");
-var deprecated = require("./util/core/deprecated");
 var getPropertyDescriptor = require("./util/core/get-property-descriptor");
 var stubNonFunctionProperty = require("./stub-non-function-property");
 var sinonStub = require("./stub");
 var throwOnFalsyObject = require("./throw-on-falsy-object");
 
-// This is deprecated and will be removed in a future version of sinon.
-// We will only consider pull requests that fix serious bugs in the implementation
-function sandboxStub(object, property/*, value*/) {
-    deprecated.printWarning(
-      "sandbox.stub(obj, 'meth', val) is deprecated and will be removed from " +
-      "the public API in a future version of sinon." +
-      "\n Use sandbox.stub(obj, 'meth').callsFake(fn) instead in order to stub a function." +
-      "\n Use sandbox.stub(obj, 'meth').value(fn) instead in order to stub a non-function value."
-    );
+function sandboxStub(object, property) {
+    if (arguments.length > 2) {
+        throw new TypeError("stub(obj, 'meth', fn) has been removed, see documentation");
+    }
 
     throwOnFalsyObject.apply(null, arguments);
 
@@ -25,9 +19,6 @@ function sandboxStub(object, property/*, value*/) {
                                     && typeof property !== "undefined"
                                     && (typeof actualDescriptor === "undefined"
                                     || typeof actualDescriptor.value !== "function");
-
-
-    // When passing a value as third argument it will be applied to stubNonFunctionProperty
     var stubbed = isStubbingNonFuncProperty ?
                     stubNonFunctionProperty.apply(null, arguments) :
                     sinonStub.apply(null, arguments);

lib/sinon/stub-non-function-property.js

@@ -3,15 +3,13 @@
 var valueToString = require("./util/core/value-to-string");
 var hasOwnProperty = Object.prototype.hasOwnProperty;
 
-function stubNonFunctionProperty(object, property, value) {
+function stubNonFunctionProperty(object, property) {
     var original = object[property];
 
     if (!hasOwnProperty.call(object, property)) {
         throw new TypeError("Cannot stub non-existent own property " + valueToString(property));
     }
 
-    object[property] = value;
-
     return {
         restore: function restore() {
             object[property] = original;

lib/sinon/stub.js

@@ -8,25 +8,26 @@ var functionToString = require("./util/core/function-to-string");
 var getPropertyDescriptor = require("./util/core/get-property-descriptor");
 var wrapMethod = require("./util/core/wrap-method");
 var stubEntireObject = require("./stub-entire-object");
-var stubDescriptor = require("./stub-descriptor");
 var throwOnFalsyObject = require("./throw-on-falsy-object");
 
 var slice = Array.prototype.slice;
 
-function stub(object, property, descriptor) {
+function stub(object, property) {
+    if (arguments.length > 2) {
+        throw new TypeError("stub(obj, 'meth', fn) has been removed, see documentation");
+    }
+
     throwOnFalsyObject.apply(null, arguments);
 
     var actualDescriptor = getPropertyDescriptor(object, property);
     var isStubbingEntireObject = typeof property === "undefined" && typeof object === "object";
     var isCreatingNewStub = !object && typeof property === "undefined";
-    var isStubbingDescriptor = object && property && Boolean(descriptor);
     var isStubbingNonFuncProperty = (typeof object === "object" || typeof object === "function")
                                     && typeof property !== "undefined"
                                     && (typeof actualDescriptor === "undefined"
                                     || typeof actualDescriptor.value !== "function")
                                     && typeof descriptor === "undefined";
-    var isStubbingExistingMethod = !isStubbingDescriptor
-                                    && typeof object === "object"
+    var isStubbingExistingMethod = typeof object === "object"
                                     && typeof actualDescriptor !== "undefined"
                                     && typeof actualDescriptor.value === "function";
     var arity = isStubbingExistingMethod ? object[property].length : 0;
@@ -35,10 +36,6 @@ function stub(object, property, descriptor) {
         return stubEntireObject(stub, object);
     }
 
-    if (isStubbingDescriptor) {
-        return stubDescriptor.apply(null, arguments);
-    }
-
     if (isCreatingNewStub) {
         return stub.create();
     }

test/collection-test.js

@@ -113,7 +113,7 @@ describe("collection", function () {
                     var originalPrintWarning = deprecated.printWarning;
                     deprecated.printWarning = function () {};
 
-                    this.collection.stub(process.env, "HELL", "froze over");
+                    this.collection.stub(process.env, "HELL").value("froze over");
                     assert.equals(process.env.HELL, "froze over");
 
                     deprecated.printWarning = originalPrintWarning;
@@ -132,7 +132,7 @@ describe("collection", function () {
             var originalPrintWarning = deprecated.printWarning;
             deprecated.printWarning = function () {};
 
-            this.collection.stub(this.object, "property", 1);
+            this.collection.stub(this.object, "property").value(1);
 
             assert.equals(this.object.property, 1);
 
@@ -143,7 +143,7 @@ describe("collection", function () {
             var originalPrintWarning = deprecated.printWarning;
             deprecated.printWarning = function () {};
 
-            this.collection.stub(this.object, "property", 1);
+            this.collection.stub(this.object, "property").value(1);
             this.collection.restore();
 
             assert.equals(this.object.property, 42);
@@ -174,10 +174,8 @@ describe("collection", function () {
                 deprecated.printWarning = function () {};
 
                 assert.exception(function () {
-                    collection.stub(object, Symbol(), 1);
-                }, function (err) {
-                    return err.message === "Cannot stub non-existent own property Symbol()";
-                });
+                    collection.stub(object, Symbol());
+                }, {message: "Cannot stub non-existent own property Symbol()"}, TypeError);
 
                 deprecated.printWarning = originalPrintWarning;
             }

test/sandbox-test.js

@@ -597,6 +597,7 @@ describe("sinonSandbox", function () {
 
         it("allows stubbing setters", function () {
             var object = {
+                foo: undefined,
                 prop: "bar"
             };
 

test/stub-test.js

@@ -42,22 +42,6 @@ describe("stub", function () {
         );
     });
 
-    it("fails if called with an empty property descriptor", function () {
-        var propertyKey = "ea762c6d-16ab-4ded-8bc2-3bc6f2de2925";
-        var object = {};
-
-        object[propertyKey] = "257b38d8-3c02-4353-82ab-b1b588be6990";
-
-        assert.exception(
-            function () {
-                createStub(object, propertyKey, {});
-            },
-            {
-                message: "Expected property descriptor to have at least one key"
-            }
-        );
-    });
-
     it("throws a readable error if stubbing Symbol on null", function () {
         if (typeof Symbol === "function") {
             assert.exception(
@@ -856,27 +840,12 @@ describe("stub", function () {
             }
         });
 
-        it("warns provided function as stub, recommending callsFake instead", function () {
-            deprecated.printWarning.restore();
-
-            var called = false;
-            var infoStub = createStub(console, "info");
-            var stub = createStub(this.object, "method", function () {
-                called = true;
-            });
-
-            stub();
-
-            assert(called);
-            assert(infoStub.called);
-        });
-
-        it("throws if third argument is provided but not a proprety descriptor", function () {
+        it("throws when third argument is provided", function () {
             var object = this.object;
 
             assert.exception(function () {
                 createStub(object, "method", 1);
-            }, "TypeError");
+            }, {message: "stub(obj, 'meth', fn) has been removed, see documentation"}, "TypeError");
         });
 
         it("stubbed method should be proper stub", function () {
@@ -1027,10 +996,10 @@ describe("stub", function () {
                     fail("should not call getter");
                 }
             };
-            var stub = createStub(obj, "prop", {get: function () {
-                return 43;
-            }});
 
+            var stub = createStub(obj, "prop").get(function () {
+                return 43;
+            });
             assert.equals(obj.prop, 43);
 
             stub.restore();