feat: better JSON Expected/Actual output

Now displays trivial Objects as indented and sorted by property
groupon · Jul 12, 2017 · dc15426 · dc15426
1 parent 25d8d5f
commit dc15426
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 15 deletions.
diff --git a/lib/assertive.js b/lib/assertive.js
@@ -31,7 +31,7 @@ LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
-var _, abbreviate, asRegExp, assert, assertSync, clear, error, fn, fn1, getNameOfType, getTypeName, global, green, handleArgs, i, implodeNicely, includes, isArray, isEqual, isFunction, isNumber, isPromiseAlike, isRegExp, isString, isType, len, map, name, nameNegative, positiveAssertions, red, ref, ref1, ref2, stringify, toString, type, types,
+var _, abbreviate, asRegExp, assert, assertSync, clear, error, fn, fn1, getNameOfType, getTypeName, global, green, handleArgs, i, implodeNicely, includes, isArray, isEqual, isFunction, isNumber, isPromiseAlike, isRegExp, isString, isType, len, map, name, nameNegative, positiveAssertions, red, ref, ref1, ref2, stringify, stringifyReplacer, toString, type, types,
   indexOf = [].indexOf || function(item) { for (var i = 0, l = this.length; i < l; i++) { if (i in this && this[i] === item) return i; } return -1; },
   slice = [].slice,
   hasProp = {}.hasOwnProperty;
@@ -399,6 +399,19 @@ asRegExp = function(re) {
 
 toString = Object.prototype.toString;
 
+stringifyReplacer = function(key, val) {
+  if (typeof val === 'function') {
+    return toString(val);
+  }
+  if (isRegExp(val)) {
+    return asRegExp(val);
+  }
+  if (_.isObject(val) && !_.isArray(val)) {
+    return _(val).toPairs().sortBy(0).fromPairs().value();
+  }
+  return val;
+};
+
 stringify = function(x) {
   var className, e, json;
   if (x == null) {
@@ -413,15 +426,7 @@ stringify = function(x) {
   if (typeof x === 'symbol') {
     return x.toString();
   }
-  json = JSON.stringify(x, function(key, val) {
-    if (typeof val === 'function') {
-      return toString(val);
-    }
-    if (isRegExp(val)) {
-      return asRegExp(val);
-    }
-    return val;
-  });
+  json = JSON.stringify(x, stringifyReplacer, 2);
   if (typeof x !== 'object' || includes(['Object', 'Array'], className = x.constructor.name)) {
     return json;
   }

diff --git a/package.json b/package.json
@@ -34,7 +34,6 @@
     "lodash": "^4.6.1"
   },
   "devDependencies": {
-    "assertive": "^2.1.0",
     "bluebird": "^3.3.4",
     "coffee-script": "^1.10.0",
     "coffeelint": "^1.10.1",

diff --git a/src/assertive.coffee b/src/assertive.coffee
@@ -311,15 +311,19 @@ asRegExp = (re) ->
 
 toString = Object::toString
 
+stringifyReplacer = (key, val) ->
+  return toString val  if typeof val is 'function'
+  return asRegExp val  if isRegExp val
+  if _.isObject(val) and not _.isArray(val)
+    return _(val).toPairs().sortBy(0).fromPairs().value()
+  val
+
 stringify = (x) ->
   return "#{x}"  unless x?
   return 'NaN'  if _.isNaN x
   return asRegExp x  if isRegExp x
   return x.toString()  if typeof x is 'symbol'
-  json = JSON.stringify x, (key, val) ->
-    return toString val  if typeof val is 'function'
-    return asRegExp val  if isRegExp val
-    return val
+  json = JSON.stringify x, stringifyReplacer, 2
   if typeof x isnt 'object' \
   or includes ['Object', 'Array'], className = x.constructor.name
     return json