Add release documentation for v11.1.0

Author: fatso83

docs/_releases/latest.md

@@ -2,7 +2,7 @@
 layout: page
 title: API documentation - Sinon.JS
 skip_ad: true
-release_id: v11.0.0
+release_id: v11.1.0
 ---
 
 # {{page.title}} - `{{page.release_id}}`
@@ -15,6 +15,7 @@ This page contains the entire Sinon.JS API documentation along with brief introd
 - [Stubs](./stubs)
 - [Mocks](./mocks)
 - [Spy calls](./spy-call)
+- [Promises](./promises)
 - [Fake timers](./fake-timers)
 - [Fake <code>XHR</code> and server](./fake-xhr-and-server)
 - [JSON-P](./json-p)

docs/_releases/latest/examples/fakes-1-using-fakes-instead-of-spies.test.js

@@ -0,0 +1,17 @@
+require("@fatso83/mini-mocha").install();
+const sinon = require("sinon");
+const referee = require("@sinonjs/referee");
+const assert = referee.assert;
+
+describe("FakeTest", function () {
+    it("should be able to be used instead of spies", function () {
+        const foo = {
+            bar: () => "baz",
+        };
+        // wrap existing method without changing its behaviour
+        const fake = sinon.replace(foo, "bar", sinon.fake(foo.bar));
+
+        assert.equals(fake(), "baz"); // behaviour is the same
+        assert.equals(fake.callCount, 1); // calling information is saved
+    });
+});

docs/_releases/latest/examples/fakes-10-firstArg.test.js

@@ -0,0 +1,17 @@
+require("@fatso83/mini-mocha").install();
+const sinon = require("sinon");
+const referee = require("@sinonjs/referee");
+const assert = referee.assert;
+
+describe("FakeTest", function () {
+    it("should have working firstArg property", function () {
+        const f = sinon.fake();
+        const date1 = new Date();
+        const date2 = new Date();
+
+        f(date1, 1, 2);
+        f(date2, 1, 2);
+
+        assert.isTrue(f.firstArg === date2);
+    });
+});

docs/_releases/latest/examples/fakes-11-lastArg.test.js

@@ -0,0 +1,21 @@
+require("@fatso83/mini-mocha").install();
+const sinon = require("sinon");
+const referee = require("@sinonjs/referee");
+const assert = referee.assert;
+
+describe("FakeTest", function () {
+    it("should have working lastArg property", function () {
+        const f = sinon.fake();
+        const date1 = new Date();
+        const date2 = new Date();
+
+        f(1, 2, date1);
+        f(1, 2, date2);
+
+        assert.isTrue(f.lastArg === date2);
+        // spy call methods:
+        assert.isTrue(f.getCall(0).lastArg === date1);
+        assert.isTrue(f.getCall(1).lastArg === date2);
+        assert.isTrue(f.lastCall.lastArg === date2);
+    });
+});

docs/_releases/latest/examples/fakes-12-adding-fake-to-system-under-test.test.js

@@ -0,0 +1,20 @@
+require("@fatso83/mini-mocha").install();
+const sinon = require("sinon");
+const referee = require("@sinonjs/referee");
+const assert = referee.assert;
+
+describe("FakeTest", function () {
+    it("should have working lastArg property", function () {
+        const fake = sinon.fake.returns("42");
+
+        sinon.replace(console, "log", fake);
+
+        assert.equals(console.log("apple pie"), 42);
+
+        // restores all replaced properties set by sinon methods (replace, spy, stub)
+        sinon.restore();
+
+        assert.equals(console.log("apple pie"), undefined);
+        assert.equals(fake.callCount, 1);
+    });
+});

docs/_releases/latest/examples/fakes-2-using-fakes-instead-of-stubs.test.js

@@ -0,0 +1,21 @@
+require("@fatso83/mini-mocha").install();
+const sinon = require("sinon");
+const referee = require("@sinonjs/referee");
+const assert = referee.assert;
+
+describe("FakeTest", function () {
+    it("should be able to be used instead of stubs", function () {
+        const foo = {
+            bar: () => "baz",
+        };
+        // replace method with a fake one
+        const fake = sinon.replace(
+            foo,
+            "bar",
+            sinon.fake.returns("fake value")
+        );
+
+        assert.equals(fake(), "fake value"); // returns fake value
+        assert.equals(fake.callCount, 1); // saves calling information
+    });
+});

docs/_releases/latest/examples/fakes-3-creating-without-behaviour.test.js

@@ -0,0 +1,14 @@
+require("@fatso83/mini-mocha").install();
+const sinon = require("sinon");
+const referee = require("@sinonjs/referee");
+const assert = referee.assert;
+
+describe("FakeTest", function () {
+    it("should create fake without behaviour", function () {
+        // create a basic fake, with no behavior
+        const fake = sinon.fake();
+
+        assert.isUndefined(fake()); // by default returns undefined
+        assert.equals(fake.callCount, 1); // saves call information
+    });
+});

docs/_releases/latest/examples/fakes-4-creating-with-custom-behaviour.test.js

@@ -0,0 +1,13 @@
+require("@fatso83/mini-mocha").install();
+const sinon = require("sinon");
+const referee = require("@sinonjs/referee");
+const assert = referee.assert;
+
+describe("FakeTest", function () {
+    it("should create fake with custom behaviour", function () {
+        // create a fake that returns the text "foo"
+        const fake = sinon.fake.returns("foo");
+
+        assert.equals(fake(), "foo");
+    });
+});

docs/_releases/latest/examples/fakes-5-returns.test.js

@@ -0,0 +1,12 @@
+require("@fatso83/mini-mocha").install();
+const sinon = require("sinon");
+const referee = require("@sinonjs/referee");
+const assert = referee.assert;
+
+describe("FakeTest", function () {
+    it("should create a fake that 'returns' a value", function () {
+        const fake = sinon.fake.returns("apple pie");
+
+        assert.equals(fake(), "apple pie");
+    });
+});

docs/_releases/latest/examples/fakes-6-throws.test.js

@@ -0,0 +1,13 @@
+require("@fatso83/mini-mocha").install();
+const sinon = require("sinon");
+const referee = require("@sinonjs/referee");
+const assert = referee.assert;
+
+describe("FakeTest", function () {
+    it("should create a fake that 'throws' an Error", function () {
+        const fake = sinon.fake.throws(new Error("not apple pie"));
+
+        // Expected to throw an error with message 'not apple pie'
+        assert.exception(fake, { name: "Error", message: "not apple pie" });
+    });
+});

docs/_releases/latest/examples/fakes-7-yields.test.js

@@ -0,0 +1,23 @@
+require("@fatso83/mini-mocha").install();
+const sinon = require("sinon");
+const referee = require("@sinonjs/referee");
+const assert = referee.assert;
+const fs = require("fs");
+
+describe("FakeTest", function () {
+    it("should create a fake that 'yields'", function () {
+        const fake = sinon.fake.yields(null, "file content");
+        const anotherFake = sinon.fake();
+
+        sinon.replace(fs, "readFile", fake);
+        fs.readFile("somefile", (err, data) => {
+            // called with fake values given to yields as arguments
+            assert.isNull(err);
+            assert.equals(data, "file content");
+            // since yields is synchronous, anotherFake is not called yet
+            assert.isFalse(anotherFake.called);
+        });
+
+        anotherFake();
+    });
+});

docs/_releases/latest/examples/fakes-8-yields-async.test.js

@@ -0,0 +1,23 @@
+require("@fatso83/mini-mocha").install();
+const sinon = require("sinon");
+const referee = require("@sinonjs/referee");
+const assert = referee.assert;
+const fs = require("fs");
+
+describe("FakeTest", function () {
+    it("should create a fake that 'yields asynchronously'", function () {
+        const fake = sinon.fake.yieldsAsync(null, "file content");
+        const anotherFake = sinon.fake();
+
+        sinon.replace(fs, "readFile", fake);
+        fs.readFile("somefile", (err, data) => {
+            // called with fake values given to yields as arguments
+            assert.isNull(err);
+            assert.equals(data, "file content");
+            // since yields is asynchronous, anotherFake is called first
+            assert.isTrue(anotherFake.called);
+        });
+
+        anotherFake();
+    });
+});

docs/_releases/latest/examples/fakes-9-callback.test.js

@@ -0,0 +1,20 @@
+require("@fatso83/mini-mocha").install();
+const sinon = require("sinon");
+const referee = require("@sinonjs/referee");
+const assert = referee.assert;
+
+describe("FakeTest", function () {
+    it("should have working callback property", function () {
+        const f = sinon.fake();
+        const cb1 = function () {};
+        const cb2 = function () {};
+
+        f(1, 2, 3, cb1);
+        f(1, 2, 3, cb2);
+
+        assert.isTrue(f.callback === cb2);
+        // spy call methods:
+        assert.isTrue(f.getCall(1).callback === cb2);
+        assert.isTrue(f.lastCall.callback === cb2);
+    });
+});

docs/_releases/latest/examples/run-test.sh

@@ -1,12 +1,14 @@
 #!/bin/bash
-
 # Link 'sinon' to local development dir
 SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
-cd "$SCRIPT_DIR/.."
+SINON_ROOT="$SCRIPT_DIR/../../../.."
+
+cd "$SINON_ROOT"
 npm link
 
 # Install examples project and link to local sinon folder
 cd "$SCRIPT_DIR"
+rm -r node_modules 2>/dev/null
 npm install --ignore-scripts
 npm link sinon