Use @sinonjs/formatio to format values

sinonjs · Aug 9, 2018 · d3d71a4 · d3d71a4
1 parent f538ce7
commit d3d71a4
Show file tree

Hide file tree

Showing 8 changed files with 139 additions and 196 deletions.
diff --git a/lib/assert-exception-unexpected-exception.test.js b/lib/assert-exception-unexpected-exception.test.js
@@ -17,7 +17,7 @@ describe("assert.exception unexpected exception", function() {
             referee.assert.match(
                 e.message,
                 "[assert.exception] Wow: Expected " +
-                    "[object Object] but threw Error " +
+                    '{ name: "TypeError" } but threw Error ' +
                     "(:()\nError: :(\n"
             );
         }
@@ -37,7 +37,7 @@ describe("assert.exception unexpected exception", function() {
             referee.assert.match(
                 e.message,
                 "[assert.exception] Wow: Expected " +
-                    "[object Object] but threw " +
+                    '{ message: "Aww", name: "Error" } but threw ' +
                     "Error (:()\nError: :(\n"
             );
         }

diff --git a/lib/assertions/contains.js b/lib/assertions/contains.js
@@ -9,9 +9,9 @@ module.exports = function(referee) {
             return includes(haystack, needle);
         },
         assertMessage:
-            "${customMessage}Expected [${actual}] to contain ${expected}",
+            "${customMessage}Expected ${actual} to contain ${expected}",
         refuteMessage:
-            "${customMessage}Expected [${actual}] not to contain ${expected}",
+            "${customMessage}Expected ${actual} not to contain ${expected}",
         expectation: "toContain",
         values: actualAndExpectedMessageValues
     });

diff --git a/lib/assertions/equals.js b/lib/assertions/equals.js
@@ -1,60 +1,19 @@
 "use strict";
 
 var samsam = require("samsam");
-var interpolateProperties = require("../interpolate-properties");
-var actualAndExpectedMessageValues = require("../actual-and-expected-message-values");
 
-// Extract/replace with separate module that does a more detailed
-// visualization of multi-line strings
-function multiLineStringDiff(referee, actual, expected, message) {
-    if (actual === expected) {
-        return true;
+function escapeNewlines(value) {
+    if (typeof value === "string") {
+        return value.replace(/\n/g, "\\n");
     }
-
-    var heading = referee.assert.equals.multiLineStringHeading;
-    var failureText = interpolateProperties(referee, heading, {
-        customMessage: message
-    });
-    var actualLines = actual.split("\n");
-    var expectedLines = expected.split("\n");
-    var lineCount = Math.max(expectedLines.length, actualLines.length);
-    var lines = [];
-
-    for (var i = 0; i < lineCount; ++i) {
-        if (expectedLines[i] !== actualLines[i]) {
-            lines.push(
-                "line " +
-                    (i + 1) +
-                    ": " +
-                    (expectedLines[i] || "") +
-                    "\nwas:    " +
-                    (actualLines[i] || "")
-            );
-        }
-    }
-
-    referee.fail("[assert.equals] " + failureText + lines.join("\n\n"));
-    return false;
+    return value;
 }
 
 module.exports = function(referee) {
     referee.add("equals", {
         // Uses arguments[2] because the function's .length is used to determine
         // the minimum required number of arguments.
         assert: function(actual, expected) {
-            if (
-                typeof actual === "string" &&
-                typeof expected === "string" &&
-                (actual.indexOf("\n") >= 0 || expected.indexOf("\n") >= 0)
-            ) {
-                return multiLineStringDiff(
-                    referee,
-                    actual,
-                    expected,
-                    arguments[2]
-                );
-            }
-
             return samsam.deepEqual(actual, expected);
         },
 
@@ -67,7 +26,13 @@ module.exports = function(referee) {
         refuteMessage:
             "${customMessage}${actual} expected not to be equal to ${expected}",
         expectation: "toEqual",
-        values: actualAndExpectedMessageValues
+        values: function(actual, expected, message) {
+            return {
+                actual: escapeNewlines(actual),
+                expected: escapeNewlines(expected),
+                customMessage: message
+            };
+        }
     });
 
     referee.assert.equals.multiLineStringHeading =

diff --git a/lib/referee.js b/lib/referee.js
@@ -1,12 +1,19 @@
 "use strict";
 
+var formatio = require("@sinonjs/formatio");
 var assertArgNum = require("./assert-arg-num");
 var interpolatePosArg = require("./interpolate-pos-arg");
 var interpolateProperties = require("./interpolate-properties");
 var expect = require("./expect");
 var bane = require("bane");
 var Promise = require("es6-promise").Promise;
 
+// Setup formatter the same way as Sinon does:
+var formatter = formatio.configure({
+    quoteStrings: false,
+    limitChildrenCount: 250
+});
+
 var slice = Array.prototype.slice;
 var referee = bane.createEventEmitter();
 
@@ -198,7 +205,7 @@ referee.fail = function(message) {
 };
 
 referee.format = function(object) {
-    return String(object);
+    return formatter.ascii(object);
 };
 
 referee.prepareMessage = function msg(message) {