mocha 2.2.5 → 2.3.3

package/lib/reporters/html-cov.js

@@ -2,8 +2,9 @@
  * Module dependencies.
  */
 
-var JSONCov = require('./json-cov')
-  , fs = require('fs');
+var JSONCov = require('./json-cov');
+var readFileSync = require('fs').readFileSync;
+var join = require('path').join;
 
 /**
  * Expose `HTMLCov`.
@@ -14,37 +15,42 @@ exports = module.exports = HTMLCov;
 /**
  * Initialize a new `JsCoverage` reporter.
  *
- * @param {Runner} runner
  * @api public
+ * @param {Runner} runner
  */
-
 function HTMLCov(runner) {
-  var jade = require('jade')
-    , file = __dirname + '/templates/coverage.jade'
-    , str = fs.readFileSync(file, 'utf8')
-    , fn = jade.compile(str, { filename: file })
-    , self = this;
+  var jade = require('jade');
+  var file = join(__dirname, '/templates/coverage.jade');
+  var str = readFileSync(file, 'utf8');
+  var fn = jade.compile(str, { filename: file });
+  var self = this;
 
   JSONCov.call(this, runner, false);
 
-  runner.on('end', function(){
+  runner.on('end', function() {
     process.stdout.write(fn({
-        cov: self.cov
-      , coverageClass: coverageClass
+      cov: self.cov,
+      coverageClass: coverageClass
     }));
   });
 }
 
 /**
- * Return coverage class for `n`.
+ * Return coverage class for a given coverage percentage.
  *
- * @return {String}
  * @api private
+ * @param {number} coveragePctg
+ * @return {string}
  */
-
-function coverageClass(n) {
-  if (n >= 75) return 'high';
-  if (n >= 50) return 'medium';
-  if (n >= 25) return 'low';
+function coverageClass(coveragePctg) {
+  if (coveragePctg >= 75) {
+    return 'high';
+  }
+  if (coveragePctg >= 50) {
+    return 'medium';
+  }
+  if (coveragePctg >= 25) {
+    return 'low';
+  }
   return 'terrible';
 }

package/lib/reporters/html.js

@@ -1,21 +1,26 @@
+/* eslint-env browser */
+
 /**
  * Module dependencies.
  */
 
-var Base = require('./base')
-  , utils = require('../utils')
-  , Progress = require('../browser/progress')
-  , escape = utils.escape;
+var Base = require('./base');
+var utils = require('../utils');
+var Progress = require('../browser/progress');
+var escapeRe = require('escape-string-regexp');
+var escape = utils.escape;
 
 /**
  * Save timer references to avoid Sinon interfering (see GH-237).
  */
 
-var Date = global.Date
-  , setTimeout = global.setTimeout
-  , setInterval = global.setInterval
-  , clearTimeout = global.clearTimeout
-  , clearInterval = global.clearInterval;
+/* 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 `HTML`.
@@ -29,37 +34,35 @@ exports = module.exports = HTML;
 
 var statsTemplate = '<ul id="mocha-stats">'
   + '<li class="progress"><canvas width="40" height="40"></canvas></li>'
-  + '<li class="passes"><a href="#">passes:</a> <em>0</em></li>'
-  + '<li class="failures"><a href="#">failures:</a> <em>0</em></li>'
+  + '<li class="passes"><a href="javascript:void(0);">passes:</a> <em>0</em></li>'
+  + '<li class="failures"><a href="javascript:void(0);">failures:</a> <em>0</em></li>'
   + '<li class="duration">duration: <em>0</em>s</li>'
   + '</ul>';
 
 /**
  * Initialize a new `HTML` reporter.
  *
- * @param {Runner} runner
  * @api public
+ * @param {Runner} runner
  */
-
 function HTML(runner) {
   Base.call(this, runner);
 
-  var self = this
-    , stats = this.stats
-    , total = runner.total
-    , stat = fragment(statsTemplate)
-    , items = stat.getElementsByTagName('li')
-    , passes = items[1].getElementsByTagName('em')[0]
-    , passesLink = items[1].getElementsByTagName('a')[0]
-    , failures = items[2].getElementsByTagName('em')[0]
-    , failuresLink = items[2].getElementsByTagName('a')[0]
-    , duration = items[3].getElementsByTagName('em')[0]
-    , canvas = stat.getElementsByTagName('canvas')[0]
-    , report = fragment('<ul id="mocha-report"></ul>')
-    , stack = [report]
-    , progress
-    , ctx
-    , root = document.getElementById('mocha');
+  var self = this;
+  var stats = this.stats;
+  var stat = fragment(statsTemplate);
+  var items = stat.getElementsByTagName('li');
+  var passes = items[1].getElementsByTagName('em')[0];
+  var passesLink = items[1].getElementsByTagName('a')[0];
+  var failures = items[2].getElementsByTagName('em')[0];
+  var failuresLink = items[2].getElementsByTagName('a')[0];
+  var duration = items[3].getElementsByTagName('em')[0];
+  var canvas = stat.getElementsByTagName('canvas')[0];
+  var report = fragment('<ul id="mocha-report"></ul>');
+  var stack = [report];
+  var progress;
+  var ctx;
+  var root = document.getElementById('mocha');
 
   if (canvas.getContext) {
     var ratio = window.devicePixelRatio || 1;
@@ -69,34 +72,44 @@ function HTML(runner) {
     canvas.height *= ratio;
     ctx = canvas.getContext('2d');
     ctx.scale(ratio, ratio);
-    progress = new Progress;
+    progress = new Progress();
   }
 
-  if (!root) return error('#mocha div missing, add it to your document');
+  if (!root) {
+    return error('#mocha div missing, add it to your document');
+  }
 
   // pass toggle
-  on(passesLink, 'click', function(){
+  on(passesLink, 'click', function() {
     unhide();
-    var name = /pass/.test(report.className) ? '' : ' pass';
+    var name = (/pass/).test(report.className) ? '' : ' pass';
     report.className = report.className.replace(/fail|pass/g, '') + name;
-    if (report.className.trim()) hideSuitesWithout('test pass');
+    if (report.className.trim()) {
+      hideSuitesWithout('test pass');
+    }
   });
 
   // failure toggle
-  on(failuresLink, 'click', function(){
+  on(failuresLink, 'click', function() {
     unhide();
-    var name = /fail/.test(report.className) ? '' : ' fail';
+    var name = (/fail/).test(report.className) ? '' : ' fail';
     report.className = report.className.replace(/fail|pass/g, '') + name;
-    if (report.className.trim()) hideSuitesWithout('test fail');
+    if (report.className.trim()) {
+      hideSuitesWithout('test fail');
+    }
   });
 
   root.appendChild(stat);
   root.appendChild(report);
 
-  if (progress) progress.size(40);
+  if (progress) {
+    progress.size(40);
+  }
 
-  runner.on('suite', function(suite){
-    if (suite.root) return;
+  runner.on('suite', function(suite) {
+    if (suite.root) {
+      return;
+    }
 
     // suite
     var url = self.suiteURL(suite);
@@ -108,51 +121,71 @@ function HTML(runner) {
     el.appendChild(stack[0]);
   });
 
-  runner.on('suite end', function(suite){
-    if (suite.root) return;
+  runner.on('suite end', function(suite) {
+    if (suite.root) {
+      return;
+    }
     stack.shift();
   });
 
-  runner.on('fail', function(test, err){
-    if ('hook' == test.type) runner.emit('test end', test);
+  runner.on('fail', function(test) {
+    if (test.type === 'hook') {
+      runner.emit('test end', test);
+    }
   });
 
-  runner.on('test end', function(test){
+  runner.on('test end', function(test) {
     // TODO: add to stats
     var percent = stats.tests / this.total * 100 | 0;
-    if (progress) progress.update(percent).draw(ctx);
+    if (progress) {
+      progress.update(percent).draw(ctx);
+    }
 
     // update stats
-    var ms = new Date - stats.start;
+    var ms = new Date() - stats.start;
     text(passes, stats.passes);
     text(failures, stats.failures);
     text(duration, (ms / 1000).toFixed(2));
 
     // test
-    if ('passed' == test.state) {
+    var el;
+    if (test.state === 'passed') {
       var url = self.testURL(test);
-      var el = fragment('<li class="test pass %e"><h2>%e<span class="duration">%ems</span> <a href="%s" class="replay">‣</a></h2></li>', test.speed, test.title, test.duration, url);
+      el = fragment('<li class="test pass %e"><h2>%e<span class="duration">%ems</span> <a href="%s" class="replay">‣</a></h2></li>', test.speed, test.title, test.duration, url);
     } else if (test.pending) {
-      var el = fragment('<li class="test pass pending"><h2>%e</h2></li>', test.title);
+      el = fragment('<li class="test pass pending"><h2>%e</h2></li>', test.title);
     } else {
-      var el = fragment('<li class="test fail"><h2>%e <a href="%e" class="replay">‣</a></h2></li>', test.title, self.testURL(test));
-      var str = test.err.stack || test.err.toString();
-
-      // FF / Opera do not add the message
-      if (!~str.indexOf(test.err.message)) {
-        str = test.err.message + '\n' + str;
-      }
+      el = fragment('<li class="test fail"><h2>%e <a href="%e" class="replay">‣</a></h2></li>', test.title, self.testURL(test));
+      var stackString; // Note: Includes leading newline
+      var message = test.err.toString();
 
       // <=IE7 stringifies to [Object Error]. Since it can be overloaded, we
       // check for the result of the stringifying.
-      if ('[object Error]' == str) str = test.err.message;
+      if (message === '[object Error]') {
+        message = test.err.message;
+      }
 
-      // Safari doesn't give you a stack. Let's at least provide a source line.
-      if (!test.err.stack && test.err.sourceURL && test.err.line !== undefined) {
-        str += "\n(" + test.err.sourceURL + ":" + test.err.line + ")";
+      if (test.err.stack) {
+        var indexOfMessage = test.err.stack.indexOf(test.err.message);
+        if (indexOfMessage === -1) {
+          stackString = test.err.stack;
+        } else {
+          stackString = test.err.stack.substr(test.err.message.length + indexOfMessage);
+        }
+      } else if (test.err.sourceURL && test.err.line !== undefined) {
+        // Safari doesn't give you a stack. Let's at least provide a source line.
+        stackString = '\n(' + test.err.sourceURL + ':' + test.err.line + ')';
       }
 
-      el.appendChild(fragment('<pre class="error">%e</pre>', str));
+      stackString = stackString || '';
+
+      if (test.err.htmlMessage && stackString) {
+        el.appendChild(fragment('<div class="html-error">%s\n<pre class="error">%e</pre></div>', test.err.htmlMessage, stackString));
+      } else if (test.err.htmlMessage) {
+        el.appendChild(fragment('<div class="html-error">%s</div>', test.err.htmlMessage));
+      } else {
+        el.appendChild(fragment('<pre class="error">%e%e</pre>', message, stackString));
+      }
     }
 
     // toggle code
@@ -160,10 +193,8 @@ function HTML(runner) {
     if (!test.pending) {
       var h2 = el.getElementsByTagName('h2')[0];
 
-      on(h2, 'click', function(){
-        pre.style.display = 'none' == pre.style.display
-          ? 'block'
-          : 'none';
+      on(h2, 'click', function() {
+        pre.style.display = pre.style.display === 'none' ? 'block' : 'none';
       });
 
       var pre = fragment('<pre><code>%e</code></pre>', utils.clean(test.fn.toString()));
@@ -172,16 +203,19 @@ function HTML(runner) {
     }
 
     // Don't call .appendChild if #mocha-report was already .shift()'ed off the stack.
-    if (stack[0]) stack[0].appendChild(el);
+    if (stack[0]) {
+      stack[0].appendChild(el);
+    }
   });
 }
 
 /**
  * Makes a URL, preserving querystring ("search") parameters.
+ *
  * @param {string} s
- * @returns {string} your new URL
+ * @return {string} A new URL.
  */
-var makeUrl = function makeUrl(s) {
+function makeUrl(s) {
   var search = window.location.search;
 
   // Remove previous grep query parameter if present
@@ -189,49 +223,51 @@ var makeUrl = function makeUrl(s) {
     search = search.replace(/[?&]grep=[^&\s]*/g, '').replace(/^&/, '?');
   }
 
-  return window.location.pathname + (search ? search + '&' : '?' ) + 'grep=' + encodeURIComponent(s);
-};
+  return window.location.pathname + (search ? search + '&' : '?') + 'grep=' + encodeURIComponent(escapeRe(s));
+}
 
 /**
- * Provide suite URL
+ * Provide suite URL.
  *
  * @param {Object} [suite]
  */
-HTML.prototype.suiteURL = function(suite){
+HTML.prototype.suiteURL = function(suite) {
   return makeUrl(suite.fullTitle());
 };
 
 /**
- * Provide test URL
+ * Provide test URL.
  *
  * @param {Object} [test]
  */
-
-HTML.prototype.testURL = function(test){
+HTML.prototype.testURL = function(test) {
   return makeUrl(test.fullTitle());
 };
 
 /**
  * Display error `msg`.
+ *
+ * @param {string} msg
  */
-
 function error(msg) {
   document.body.appendChild(fragment('<div id="mocha-error">%s</div>', msg));
 }
 
 /**
  * Return a DOM fragment from `html`.
+ *
+ * @param {string} html
  */
-
 function fragment(html) {
-  var args = arguments
-    , div = document.createElement('div')
-    , i = 1;
+  var args = arguments;
+  var div = document.createElement('div');
+  var i = 1;
 
-  div.innerHTML = html.replace(/%([se])/g, function(_, type){
+  div.innerHTML = html.replace(/%([se])/g, function(_, type) {
     switch (type) {
       case 's': return String(args[i++]);
       case 'e': return escape(args[i++]);
+      // no default
     }
   });
 
@@ -241,20 +277,22 @@ function fragment(html) {
 /**
  * Check for suites that do not have elements
  * with `classname`, and hide them.
+ *
+ * @param {text} classname
  */
-
 function hideSuitesWithout(classname) {
   var suites = document.getElementsByClassName('suite');
   for (var i = 0; i < suites.length; i++) {
     var els = suites[i].getElementsByClassName(classname);
-    if (0 == els.length) suites[i].className += ' hidden';
+    if (!els.length) {
+      suites[i].className += ' hidden';
+    }
   }
 }
 
 /**
  * Unhide .hidden suites.
  */
-
 function unhide() {
   var els = document.getElementsByClassName('suite hidden');
   for (var i = 0; i < els.length; ++i) {
@@ -263,21 +301,22 @@ function unhide() {
 }
 
 /**
- * Set `el` text to `str`.
+ * Set an element's text contents.
+ *
+ * @param {HTMLElement} el
+ * @param {string} contents
  */
-
-function text(el, str) {
+function text(el, contents) {
   if (el.textContent) {
-    el.textContent = str;
+    el.textContent = contents;
   } else {
-    el.innerText = str;
+    el.innerText = contents;
   }
 }
 
 /**
  * Listen on `event` with callback `fn`.
  */
-
 function on(el, event, fn) {
   if (el.addEventListener) {
     el.addEventListener(event, fn, false);

package/lib/reporters/index.js

@@ -1,17 +1,19 @@
-exports.Base = require('./base');
-exports.Dot = require('./dot');
-exports.Doc = require('./doc');
-exports.TAP = require('./tap');
-exports.JSON = require('./json');
-exports.HTML = require('./html');
-exports.List = require('./list');
-exports.Min = require('./min');
-exports.Spec = require('./spec');
-exports.Nyan = require('./nyan');
-exports.XUnit = require('./xunit');
-exports.Markdown = require('./markdown');
-exports.Progress = require('./progress');
-exports.Landing = require('./landing');
-exports.JSONCov = require('./json-cov');
-exports.HTMLCov = require('./html-cov');
-exports.JSONStream = require('./json-stream');
+// Alias exports to a their normalized format Mocha#reporter to prevent a need
+// for dynamic (try/catch) requires, which Browserify doesn't handle.
+exports.Base = exports.base = require('./base');
+exports.Dot = exports.dot = require('./dot');
+exports.Doc = exports.doc = require('./doc');
+exports.TAP = exports.tap = require('./tap');
+exports.JSON = exports.json = require('./json');
+exports.HTML = exports.html = require('./html');
+exports.List = exports.list = require('./list');
+exports.Min = exports.min = require('./min');
+exports.Spec = exports.spec = require('./spec');
+exports.Nyan = exports.nyan = require('./nyan');
+exports.XUnit = exports.xunit = require('./xunit');
+exports.Markdown = exports.markdown = require('./markdown');
+exports.Progress = exports.progress = require('./progress');
+exports.Landing = exports.landing = require('./landing');
+exports.JSONCov = exports['json-cov'] = require('./json-cov');
+exports.HTMLCov = exports['html-cov'] = require('./html-cov');
+exports.JSONStream = exports['json-stream'] = require('./json-stream');

package/lib/reporters/json-cov.js

@@ -13,42 +13,42 @@ exports = module.exports = JSONCov;
 /**
  * Initialize a new `JsCoverage` reporter.
  *
- * @param {Runner} runner
- * @param {Boolean} output
  * @api public
+ * @param {Runner} runner
+ * @param {boolean} output
  */
-
 function JSONCov(runner, output) {
-  var self = this
-    , output = 1 == arguments.length ? true : output;
-
   Base.call(this, runner);
 
-  var tests = []
-    , failures = []
-    , passes = [];
+  output = arguments.length === 1 || output;
+  var self = this;
+  var tests = [];
+  var failures = [];
+  var passes = [];
 
-  runner.on('test end', function(test){
+  runner.on('test end', function(test) {
     tests.push(test);
   });
 
-  runner.on('pass', function(test){
+  runner.on('pass', function(test) {
     passes.push(test);
   });
 
-  runner.on('fail', function(test){
+  runner.on('fail', function(test) {
     failures.push(test);
   });
 
-  runner.on('end', function(){
+  runner.on('end', function() {
     var cov = global._$jscoverage || {};
     var result = self.cov = map(cov);
     result.stats = self.stats;
     result.tests = tests.map(clean);
     result.failures = failures.map(clean);
     result.passes = passes.map(clean);
-    if (!output) return;
-    process.stdout.write(JSON.stringify(result, null, 2 ));
+    if (!output) {
+      return;
+    }
+    process.stdout.write(JSON.stringify(result, null, 2));
   });
 }
 
@@ -56,27 +56,29 @@ function JSONCov(runner, output) {
  * Map jscoverage data to a JSON structure
  * suitable for reporting.
  *
+ * @api private
  * @param {Object} cov
  * @return {Object}
- * @api private
  */
 
 function map(cov) {
   var ret = {
-      instrumentation: 'node-jscoverage'
-    , sloc: 0
-    , hits: 0
-    , misses: 0
-    , coverage: 0
-    , files: []
+    instrumentation: 'node-jscoverage',
+    sloc: 0,
+    hits: 0,
+    misses: 0,
+    coverage: 0,
+    files: []
   };
 
   for (var filename in cov) {
-    var data = coverage(filename, cov[filename]);
-    ret.files.push(data);
-    ret.hits += data.hits;
-    ret.misses += data.misses;
-    ret.sloc += data.sloc;
+    if (Object.prototype.hasOwnProperty.call(cov, filename)) {
+      var data = coverage(filename, cov[filename]);
+      ret.files.push(data);
+      ret.hits += data.hits;
+      ret.misses += data.misses;
+      ret.sloc += data.sloc;
+    }
   }
 
   ret.files.sort(function(a, b) {
@@ -94,12 +96,11 @@ function map(cov) {
  * Map jscoverage data for a single source file
  * to a JSON structure suitable for reporting.
  *
- * @param {String} filename name of the source file
+ * @api private
+ * @param {string} filename name of the source file
  * @param {Object} data jscoverage coverage data
  * @return {Object}
- * @api private
  */
-
 function coverage(filename, data) {
   var ret = {
     filename: filename,
@@ -110,7 +111,7 @@ function coverage(filename, data) {
     source: {}
   };
 
-  data.source.forEach(function(line, num){
+  data.source.forEach(function(line, num) {
     num++;
 
     if (data[num] === 0) {
@@ -122,10 +123,8 @@ function coverage(filename, data) {
     }
 
     ret.source[num] = {
-        source: line
-      , coverage: data[num] === undefined
-        ? ''
-        : data[num]
+      source: line,
+      coverage: data[num] === undefined ? '' : data[num]
     };
   });
 
@@ -138,15 +137,14 @@ function coverage(filename, data) {
  * Return a plain-object representation of `test`
  * free of cyclic properties etc.
  *
+ * @api private
  * @param {Object} test
  * @return {Object}
- * @api private
  */
-
 function clean(test) {
   return {
-      title: test.title
-    , fullTitle: test.fullTitle()
-    , duration: test.duration
-  }
+    duration: test.duration,
+    fullTitle: test.fullTitle(),
+    title: test.title
+  };
 }