mocha 2.2.5 → 2.3.3

package/lib/reporters/base.js

@@ -2,41 +2,42 @@
  * Module dependencies.
  */
 
-var tty = require('tty')
-  , diff = require('diff')
-  , ms = require('../ms')
-  , utils = require('../utils')
-  , supportsColor = process.env ? require('supports-color') : null;
+var tty = require('tty');
+var diff = require('diff');
+var ms = require('../ms');
+var utils = require('../utils');
+var supportsColor = process.browser ? null : require('supports-color');
 
 /**
- * Save timer references to avoid Sinon interfering (see GH-237).
+ * Expose `Base`.
  */
 
-var Date = global.Date
-  , setTimeout = global.setTimeout
-  , setInterval = global.setInterval
-  , clearTimeout = global.clearTimeout
-  , clearInterval = global.clearInterval;
+exports = module.exports = Base;
 
 /**
- * Check if both stdio streams are associated with a tty.
+ * Save timer references to avoid Sinon interfering.
+ * See: https://github.com/mochajs/mocha/issues/237
  */
 
-var isatty = tty.isatty(1) && tty.isatty(2);
+/* eslint-disable no-unused-vars, no-native-reassign */
+var Date = global.Date;
+var setTimeout = global.setTimeout;
+var setInterval = global.setInterval;
+var clearTimeout = global.clearTimeout;
+var clearInterval = global.clearInterval;
+/* eslint-enable no-unused-vars, no-native-reassign */
 
 /**
- * Expose `Base`.
+ * Check if both stdio streams are associated with a tty.
  */
 
-exports = module.exports = Base;
+var isatty = tty.isatty(1) && tty.isatty(2);
 
 /**
  * Enable coloring by default, except in the browser interface.
  */
 
-exports.useColors = process.env
-  ? (supportsColor || (process.env.MOCHA_COLORS !== undefined))
-  : false;
+exports.useColors = !process.browser && (supportsColor || (process.env.MOCHA_COLORS !== undefined));
 
 /**
  * Inline diffs instead of +/-
@@ -49,25 +50,25 @@ exports.inlineDiffs = false;
  */
 
 exports.colors = {
-    'pass': 90
-  , 'fail': 31
-  , 'bright pass': 92
-  , 'bright fail': 91
-  , 'bright yellow': 93
-  , 'pending': 36
-  , 'suite': 0
-  , 'error title': 0
-  , 'error message': 31
-  , 'error stack': 90
-  , 'checkmark': 32
-  , 'fast': 90
-  , 'medium': 33
-  , 'slow': 31
-  , 'green': 32
-  , 'light': 90
-  , 'diff gutter': 90
-  , 'diff added': 32
-  , 'diff removed': 31
+  pass: 90,
+  fail: 31,
+  'bright pass': 92,
+  'bright fail': 91,
+  'bright yellow': 93,
+  pending: 36,
+  suite: 0,
+  'error title': 0,
+  'error message': 31,
+  'error stack': 90,
+  checkmark: 32,
+  fast: 90,
+  medium: 33,
+  slow: 31,
+  green: 32,
+  light: 90,
+  'diff gutter': 90,
+  'diff added': 32,
+  'diff removed': 31
 };
 
 /**
@@ -81,7 +82,7 @@ exports.symbols = {
 };
 
 // With node.js on Windows: use symbols available in terminal default fonts
-if ('win32' == process.platform) {
+if (process.platform === 'win32') {
   exports.symbols.ok = '\u221A';
   exports.symbols.err = '\u00D7';
   exports.symbols.dot = '.';
@@ -93,53 +94,54 @@ if ('win32' == process.platform) {
  * as well as user-defined color
  * schemes.
  *
- * @param {String} type
- * @param {String} str
- * @return {String}
+ * @param {string} type
+ * @param {string} str
+ * @return {string}
  * @api private
  */
-
 var color = exports.color = function(type, str) {
-  if (!exports.useColors) return String(str);
+  if (!exports.useColors) {
+    return String(str);
+  }
   return '\u001b[' + exports.colors[type] + 'm' + str + '\u001b[0m';
 };
 
 /**
- * Expose term window size, with some
- * defaults for when stderr is not a tty.
+ * Expose term window size, with some defaults for when stderr is not a tty.
  */
 
 exports.window = {
-  width: isatty
-    ? process.stdout.getWindowSize
-      ? process.stdout.getWindowSize(1)[0]
-      : tty.getWindowSize()[1]
-    : 75
+  width: 75
 };
 
+if (isatty) {
+  exports.window.width = process.stdout.getWindowSize
+      ? process.stdout.getWindowSize(1)[0]
+      : tty.getWindowSize()[1];
+}
+
 /**
- * Expose some basic cursor interactions
- * that are common among reporters.
+ * Expose some basic cursor interactions that are common among reporters.
  */
 
 exports.cursor = {
-  hide: function(){
+  hide: function() {
     isatty && process.stdout.write('\u001b[?25l');
   },
 
-  show: function(){
+  show: function() {
     isatty && process.stdout.write('\u001b[?25h');
   },
 
-  deleteLine: function(){
+  deleteLine: function() {
     isatty && process.stdout.write('\u001b[2K');
   },
 
-  beginningOfLine: function(){
+  beginningOfLine: function() {
     isatty && process.stdout.write('\u001b[0G');
   },
 
-  CR: function(){
+  CR: function() {
     if (isatty) {
       exports.cursor.deleteLine();
       exports.cursor.beginningOfLine();
@@ -156,22 +158,31 @@ exports.cursor = {
  * @api public
  */
 
-exports.list = function(failures){
+exports.list = function(failures) {
   console.log();
-  failures.forEach(function(test, i){
+  failures.forEach(function(test, i) {
     // format
     var fmt = color('error title', '  %s) %s:\n')
       + color('error message', '     %s')
       + color('error stack', '\n%s\n');
 
     // msg
-    var err = test.err
-      , message = err.message || ''
-      , stack = err.stack || message
-      , index = stack.indexOf(message)
-      , actual = err.actual
-      , expected = err.expected
-      , escape = true;
+    var msg;
+    var err = test.err;
+    var message;
+    if (err.message) {
+      message = err.message;
+    } else if (typeof err.inspect === 'function') {
+      message = err.inspect() + '';
+    } else {
+      message = '';
+    }
+    var stack = err.stack || message;
+    var index = stack.indexOf(message);
+    var actual = err.actual;
+    var expected = err.expected;
+    var escape = true;
+
     if (index === -1) {
       msg = message;
     } else {
@@ -186,9 +197,7 @@ exports.list = function(failures){
       msg = 'Uncaught ' + msg;
     }
     // explicitly show diff
-    if (err.showDiff !== false && sameType(actual, expected)
-        && expected !== undefined) {
-
+    if (err.showDiff !== false && sameType(actual, expected) && expected !== undefined) {
       escape = false;
       if (!(utils.isString(actual) && utils.isString(expected))) {
         err.actual = actual = utils.stringify(actual);
@@ -226,55 +235,57 @@ exports.list = function(failures){
  */
 
 function Base(runner) {
-  var self = this
-    , stats = this.stats = { suites: 0, tests: 0, passes: 0, pending: 0, failures: 0 }
-    , failures = this.failures = [];
+  var stats = this.stats = { suites: 0, tests: 0, passes: 0, pending: 0, failures: 0 };
+  var failures = this.failures = [];
 
-  if (!runner) return;
+  if (!runner) {
+    return;
+  }
   this.runner = runner;
 
   runner.stats = stats;
 
-  runner.on('start', function(){
-    stats.start = new Date;
+  runner.on('start', function() {
+    stats.start = new Date();
   });
 
-  runner.on('suite', function(suite){
+  runner.on('suite', function(suite) {
     stats.suites = stats.suites || 0;
     suite.root || stats.suites++;
   });
 
-  runner.on('test end', function(test){
+  runner.on('test end', function() {
     stats.tests = stats.tests || 0;
     stats.tests++;
   });
 
-  runner.on('pass', function(test){
+  runner.on('pass', function(test) {
     stats.passes = stats.passes || 0;
 
-    var medium = test.slow() / 2;
-    test.speed = test.duration > test.slow()
-      ? 'slow'
-      : test.duration > medium
-        ? 'medium'
-        : 'fast';
+    if (test.duration > test.slow()) {
+      test.speed = 'slow';
+    } else if (test.duration > test.slow() / 2) {
+      test.speed = 'medium';
+    } else {
+      test.speed = 'fast';
+    }
 
     stats.passes++;
   });
 
-  runner.on('fail', function(test, err){
+  runner.on('fail', function(test, err) {
     stats.failures = stats.failures || 0;
     stats.failures++;
     test.err = err;
     failures.push(test);
   });
 
-  runner.on('end', function(){
-    stats.end = new Date;
-    stats.duration = new Date - stats.start;
+  runner.on('end', function() {
+    stats.end = new Date();
+    stats.duration = new Date() - stats.start;
   });
 
-  runner.on('pending', function(){
+  runner.on('pending', function() {
     stats.pending++;
   });
 }
@@ -285,10 +296,8 @@ function Base(runner) {
  *
  * @api public
  */
-
-Base.prototype.epilogue = function(){
+Base.prototype.epilogue = function() {
   var stats = this.stats;
-  var tests;
   var fmt;
 
   console.log();
@@ -326,26 +335,24 @@ Base.prototype.epilogue = function(){
 /**
  * Pad the given `str` to `len`.
  *
- * @param {String} str
- * @param {String} len
- * @return {String}
  * @api private
+ * @param {string} str
+ * @param {string} len
+ * @return {string}
  */
-
 function pad(str, len) {
   str = String(str);
   return Array(len - str.length + 1).join(' ') + str;
 }
 
-
 /**
  * Returns an inline diff between 2 strings with coloured ANSI output
  *
- * @param {Error} Error with actual/expected
- * @return {String} Diff
  * @api private
+ * @param {Error} err with actual/expected
+ * @param {boolean} escape
+ * @return {string} Diff
  */
-
 function inlineDiff(err, escape) {
   var msg = errorDiff(err, 'WordsWithSpace', escape);
 
@@ -353,7 +360,7 @@ function inlineDiff(err, escape) {
   var lines = msg.split('\n');
   if (lines.length > 4) {
     var width = String(lines.length).length;
-    msg = lines.map(function(str, i){
+    msg = lines.map(function(str, i) {
       return pad(++i, width) + ' |' + ' ' + str;
     }).join('\n');
   }
@@ -373,51 +380,64 @@ function inlineDiff(err, escape) {
 }
 
 /**
- * Returns a unified diff between 2 strings
+ * Returns a unified diff between two strings.
  *
- * @param {Error} Error with actual/expected
- * @return {String} Diff
  * @api private
+ * @param {Error} err with actual/expected
+ * @param {boolean} escape
+ * @return {string} The diff.
  */
-
 function unifiedDiff(err, escape) {
   var indent = '      ';
   function cleanUp(line) {
     if (escape) {
       line = escapeInvisibles(line);
     }
-    if (line[0] === '+') return indent + colorLines('diff added', line);
-    if (line[0] === '-') return indent + colorLines('diff removed', line);
-    if (line.match(/\@\@/)) return null;
-    if (line.match(/\\ No newline/)) return null;
-    else return indent + line;
+    if (line[0] === '+') {
+      return indent + colorLines('diff added', line);
+    }
+    if (line[0] === '-') {
+      return indent + colorLines('diff removed', line);
+    }
+    if (line.match(/\@\@/)) {
+      return null;
+    }
+    if (line.match(/\\ No newline/)) {
+      return null;
+    }
+    return indent + line;
   }
   function notBlank(line) {
-    return line != null;
+    return typeof line !== 'undefined' && line !== null;
   }
   var msg = diff.createPatch('string', err.actual, err.expected);
   var lines = msg.split('\n').splice(4);
   return '\n      '
-         + colorLines('diff added',   '+ expected') + ' '
-         + colorLines('diff removed', '- actual')
-         + '\n\n'
-         + lines.map(cleanUp).filter(notBlank).join('\n');
+    + colorLines('diff added', '+ expected') + ' '
+    + colorLines('diff removed', '- actual')
+    + '\n\n'
+    + lines.map(cleanUp).filter(notBlank).join('\n');
 }
 
 /**
  * Return a character diff for `err`.
  *
- * @param {Error} err
- * @return {String}
  * @api private
+ * @param {Error} err
+ * @param {string} type
+ * @param {boolean} escape
+ * @return {string}
  */
-
 function errorDiff(err, type, escape) {
-  var actual   = escape ? escapeInvisibles(err.actual)   : err.actual;
+  var actual = escape ? escapeInvisibles(err.actual) : err.actual;
   var expected = escape ? escapeInvisibles(err.expected) : err.expected;
-  return diff['diff' + type](actual, expected).map(function(str){
-    if (str.added) return colorLines('diff added', str.value);
-    if (str.removed) return colorLines('diff removed', str.value);
+  return diff['diff' + type](actual, expected).map(function(str) {
+    if (str.added) {
+      return colorLines('diff added', str.value);
+    }
+    if (str.removed) {
+      return colorLines('diff removed', str.value);
+    }
     return str.value;
   }).join('');
 }
@@ -425,42 +445,43 @@ function errorDiff(err, type, escape) {
 /**
  * Returns a string with all invisible characters in plain text
  *
- * @param {String} line
- * @return {String}
  * @api private
+ * @param {string} line
+ * @return {string}
  */
 function escapeInvisibles(line) {
-    return line.replace(/\t/g, '<tab>')
-               .replace(/\r/g, '<CR>')
-               .replace(/\n/g, '<LF>\n');
+  return line.replace(/\t/g, '<tab>')
+    .replace(/\r/g, '<CR>')
+    .replace(/\n/g, '<LF>\n');
 }
 
 /**
  * Color lines for `str`, using the color `name`.
  *
- * @param {String} name
- * @param {String} str
- * @return {String}
  * @api private
+ * @param {string} name
+ * @param {string} str
+ * @return {string}
  */
-
 function colorLines(name, str) {
-  return str.split('\n').map(function(str){
+  return str.split('\n').map(function(str) {
     return color(name, str);
   }).join('\n');
 }
 
+/**
+ * Object#toString reference.
+ */
+var objToString = Object.prototype.toString;
+
 /**
  * Check that a / b have the same type.
  *
+ * @api private
  * @param {Object} a
  * @param {Object} b
- * @return {Boolean}
- * @api private
+ * @return {boolean}
  */
-
 function sameType(a, b) {
-  a = Object.prototype.toString.call(a);
-  b = Object.prototype.toString.call(b);
-  return a == b;
+  return objToString.call(a) === objToString.call(b);
 }

package/lib/reporters/doc.js

@@ -2,8 +2,8 @@
  * Module dependencies.
  */
 
-var Base = require('./base')
-  , utils = require('../utils');
+var Base = require('./base');
+var utils = require('../utils');
 
 /**
  * Expose `Doc`.
@@ -17,21 +17,19 @@ exports = module.exports = Doc;
  * @param {Runner} runner
  * @api public
  */
-
 function Doc(runner) {
   Base.call(this, runner);
 
-  var self = this
-    , stats = this.stats
-    , total = runner.total
-    , indents = 2;
+  var indents = 2;
 
   function indent() {
     return Array(indents).join('  ');
   }
 
-  runner.on('suite', function(suite){
-    if (suite.root) return;
+  runner.on('suite', function(suite) {
+    if (suite.root) {
+      return;
+    }
     ++indents;
     console.log('%s<section class="suite">', indent());
     ++indents;
@@ -39,21 +37,23 @@ function Doc(runner) {
     console.log('%s<dl>', indent());
   });
 
-  runner.on('suite end', function(suite){
-    if (suite.root) return;
+  runner.on('suite end', function(suite) {
+    if (suite.root) {
+      return;
+    }
     console.log('%s</dl>', indent());
     --indents;
     console.log('%s</section>', indent());
     --indents;
   });
 
-  runner.on('pass', function(test){
+  runner.on('pass', function(test) {
     console.log('%s  <dt>%s</dt>', indent(), utils.escape(test.title));
     var code = utils.escape(utils.clean(test.fn.toString()));
     console.log('%s  <dd><pre><code>%s</code></pre></dd>', indent(), code);
   });
 
-  runner.on('fail', function(test, err){
+  runner.on('fail', function(test, err) {
     console.log('%s  <dt class="error">%s</dt>', indent(), utils.escape(test.title));
     var code = utils.escape(utils.clean(test.fn.toString()));
     console.log('%s  <dd class="error"><pre><code>%s</code></pre></dd>', indent(), code);

package/lib/reporters/dot.js

@@ -2,8 +2,9 @@
  * Module dependencies.
  */
 
-var Base = require('./base')
-  , color = Base.color;
+var Base = require('./base');
+var inherits = require('../utils').inherits;
+var color = Base.color;
 
 /**
  * Expose `Dot`.
@@ -14,42 +15,46 @@ exports = module.exports = Dot;
 /**
  * Initialize a new `Dot` matrix test reporter.
  *
- * @param {Runner} runner
  * @api public
+ * @param {Runner} runner
  */
-
 function Dot(runner) {
   Base.call(this, runner);
 
-  var self = this
-    , stats = this.stats
-    , width = Base.window.width * .75 | 0
-    , n = -1;
+  var self = this;
+  var width = Base.window.width * .75 | 0;
+  var n = -1;
 
-  runner.on('start', function(){
+  runner.on('start', function() {
     process.stdout.write('\n');
   });
 
-  runner.on('pending', function(test){
-    if (++n % width == 0) process.stdout.write('\n  ');
+  runner.on('pending', function() {
+    if (++n % width === 0) {
+      process.stdout.write('\n  ');
+    }
     process.stdout.write(color('pending', Base.symbols.dot));
   });
 
-  runner.on('pass', function(test){
-    if (++n % width == 0) process.stdout.write('\n  ');
-    if ('slow' == test.speed) {
+  runner.on('pass', function(test) {
+    if (++n % width === 0) {
+      process.stdout.write('\n  ');
+    }
+    if (test.speed === 'slow') {
       process.stdout.write(color('bright yellow', Base.symbols.dot));
     } else {
       process.stdout.write(color(test.speed, Base.symbols.dot));
     }
   });
 
-  runner.on('fail', function(test, err){
-    if (++n % width == 0) process.stdout.write('\n  ');
+  runner.on('fail', function() {
+    if (++n % width === 0) {
+      process.stdout.write('\n  ');
+    }
     process.stdout.write(color('fail', Base.symbols.dot));
   });
 
-  runner.on('end', function(){
+  runner.on('end', function() {
     console.log();
     self.epilogue();
   });
@@ -58,5 +63,4 @@ function Dot(runner) {
 /**
  * Inherit from `Base.prototype`.
  */
-
-Dot.prototype.__proto__ = Base.prototype;
+inherits(Dot, Base);