Merge pull request #1503 from cypress-io/set-formatter

Add method to set custom formatter

lib/sinon.js

@@ -54,3 +54,6 @@ var behavior = require("./sinon/behavior");
 exports.addBehavior = function (name, fn) {
     behavior.addBehavior(exports.stub, name, fn);
 };
+
+var format = require("./sinon/util/core/format");
+exports.setFormatter = format.setFormatter;

lib/sinon/util/core/format.js

@@ -7,6 +7,22 @@ var formatter = formatio.configure({
     limitChildrenCount: 250
 });
 
-module.exports = function format() {
+var customFormatter;
+
+function format() {
+    if (customFormatter) {
+        return customFormatter.apply(null, arguments);
+    }
+
     return formatter.ascii.apply(formatter, arguments);
+}
+
+format.setFormatter = function (aCustomFormatter) {
+    if (typeof aCustomFormatter !== "function") {
+        throw new Error("format.setFormatter must be called with a function");
+    }
+
+    customFormatter = aCustomFormatter;
 };
+
+module.exports = format;

test/util/core/format-test.js

@@ -1,6 +1,7 @@
 "use strict";
 
 var referee = require("referee");
+var sinon = require("../../../lib/sinon");
 var format = require("../../../lib/sinon/util/core/format");
 var assert = referee.assert;
 
@@ -20,4 +21,23 @@ describe("util/core/format", function () {
     it("formats strings without quotes", function () {
         assert.equals(format("Hey"), "Hey");
     });
+
+    describe("format.setFormatter", function () {
+        it("sets custom formatter", function () {
+            format.setFormatter(function () { return "formatted"; });
+            assert.equals(format("Hey"), "formatted");
+        });
+
+        it("throws if custom formatter is not a function", function () {
+            assert.exception(function () {
+                format.setFormatter("foo");
+            }, {
+                message: "format.setFormatter must be called with a function"
+            });
+        });
+
+        it("exposes method on sinon", function () {
+            assert.equals(sinon.setFormatter, format.setFormatter);
+        });
+    });
 });