mocha-compat 3.6.4 → 10.8.2

package/lib/reporters/doc.js

@@ -1,11 +1,18 @@
 'use strict';
-
+/**
+ * @module Doc
+ */
 /**
  * Module dependencies.
  */
 
 var Base = require('./base');
 var utils = require('../utils');
+var constants = require('../runner').constants;
+var EVENT_TEST_PASS = constants.EVENT_TEST_PASS;
+var EVENT_TEST_FAIL = constants.EVENT_TEST_FAIL;
+var EVENT_SUITE_BEGIN = constants.EVENT_SUITE_BEGIN;
+var EVENT_SUITE_END = constants.EVENT_SUITE_END;
 
 /**
  * Expose `Doc`.
@@ -14,51 +21,75 @@ var utils = require('../utils');
 exports = module.exports = Doc;
 
 /**
- * Initialize a new `Doc` reporter.
+ * Constructs a new `Doc` reporter instance.
  *
- * @param {Runner} runner
- * @api public
+ * @public
+ * @class
+ * @memberof Mocha.reporters
+ * @extends Mocha.reporters.Base
+ * @param {Runner} runner - Instance triggers reporter actions.
+ * @param {Object} [options] - runner options
  */
-function Doc (runner) {
-  Base.call(this, runner);
+function Doc(runner, options) {
+  Base.call(this, runner, options);
 
   var indents = 2;
 
-  function indent () {
+  function indent() {
     return Array(indents).join('  ');
   }
 
-  runner.on('suite', function (suite) {
+  runner.on(EVENT_SUITE_BEGIN, function (suite) {
     if (suite.root) {
       return;
     }
     ++indents;
-    console.log('%s<section class="suite">', indent());
+    Base.consoleLog('%s<section class="suite">', indent());
     ++indents;
-    console.log('%s<h1>%s</h1>', indent(), utils.escape(suite.title));
-    console.log('%s<dl>', indent());
+    Base.consoleLog('%s<h1>%s</h1>', indent(), utils.escape(suite.title));
+    Base.consoleLog('%s<dl>', indent());
   });
 
-  runner.on('suite end', function (suite) {
+  runner.on(EVENT_SUITE_END, function (suite) {
     if (suite.root) {
       return;
     }
-    console.log('%s</dl>', indent());
+    Base.consoleLog('%s</dl>', indent());
     --indents;
-    console.log('%s</section>', indent());
+    Base.consoleLog('%s</section>', indent());
     --indents;
   });
 
-  runner.on('pass', function (test) {
-    console.log('%s  <dt>%s</dt>', indent(), utils.escape(test.title));
+  runner.on(EVENT_TEST_PASS, function (test) {
+    Base.consoleLog('%s  <dt>%s</dt>', indent(), utils.escape(test.title));
+    Base.consoleLog('%s  <dt>%s</dt>', indent(), utils.escape(test.file));
     var code = utils.escape(utils.clean(test.body));
-    console.log('%s  <dd><pre><code>%s</code></pre></dd>', indent(), code);
+    Base.consoleLog('%s  <dd><pre><code>%s</code></pre></dd>', indent(), code);
   });
 
-  runner.on('fail', function (test, err) {
-    console.log('%s  <dt class="error">%s</dt>', indent(), utils.escape(test.title));
+  runner.on(EVENT_TEST_FAIL, function (test, err) {
+    Base.consoleLog(
+      '%s  <dt class="error">%s</dt>',
+      indent(),
+      utils.escape(test.title)
+    );
+    Base.consoleLog(
+      '%s  <dt class="error">%s</dt>',
+      indent(),
+      utils.escape(test.file)
+    );
     var code = utils.escape(utils.clean(test.body));
-    console.log('%s  <dd class="error"><pre><code>%s</code></pre></dd>', indent(), code);
-    console.log('%s  <dd class="error">%s</dd>', indent(), utils.escape(err));
+    Base.consoleLog(
+      '%s  <dd class="error"><pre><code>%s</code></pre></dd>',
+      indent(),
+      code
+    );
+    Base.consoleLog(
+      '%s  <dd class="error">%s</dd>',
+      indent(),
+      utils.escape(err)
+    );
   });
 }
+
+Doc.description = 'HTML documentation';

package/lib/reporters/dot.js

@@ -1,12 +1,19 @@
 'use strict';
-
+/**
+ * @module Dot
+ */
 /**
  * Module dependencies.
  */
 
 var Base = require('./base');
 var inherits = require('../utils').inherits;
-var color = Base.color;
+var constants = require('../runner').constants;
+var EVENT_TEST_PASS = constants.EVENT_TEST_PASS;
+var EVENT_TEST_FAIL = constants.EVENT_TEST_FAIL;
+var EVENT_RUN_BEGIN = constants.EVENT_RUN_BEGIN;
+var EVENT_TEST_PENDING = constants.EVENT_TEST_PENDING;
+var EVENT_RUN_END = constants.EVENT_RUN_END;
 
 /**
  * Expose `Dot`.
@@ -15,49 +22,53 @@ var color = Base.color;
 exports = module.exports = Dot;
 
 /**
- * Initialize a new `Dot` matrix test reporter.
+ * Constructs a new `Dot` reporter instance.
  *
- * @api public
- * @param {Runner} runner
+ * @public
+ * @class
+ * @memberof Mocha.reporters
+ * @extends Mocha.reporters.Base
+ * @param {Runner} runner - Instance triggers reporter actions.
+ * @param {Object} [options] - runner options
  */
-function Dot (runner) {
-  Base.call(this, runner);
+function Dot(runner, options) {
+  Base.call(this, runner, options);
 
   var self = this;
-  var width = Base.window.width * 0.75 | 0;
+  var width = (Base.window.width * 0.75) | 0;
   var n = -1;
 
-  runner.on('start', function () {
+  runner.on(EVENT_RUN_BEGIN, function () {
     process.stdout.write('\n');
   });
 
-  runner.on('pending', function () {
+  runner.on(EVENT_TEST_PENDING, function () {
     if (++n % width === 0) {
       process.stdout.write('\n  ');
     }
-    process.stdout.write(color('pending', Base.symbols.comma));
+    process.stdout.write(Base.color('pending', Base.symbols.comma));
   });
 
-  runner.on('pass', function (test) {
+  runner.on(EVENT_TEST_PASS, function (test) {
     if (++n % width === 0) {
       process.stdout.write('\n  ');
     }
     if (test.speed === 'slow') {
-      process.stdout.write(color('bright yellow', Base.symbols.dot));
+      process.stdout.write(Base.color('bright yellow', Base.symbols.dot));
     } else {
-      process.stdout.write(color(test.speed, Base.symbols.dot));
+      process.stdout.write(Base.color(test.speed, Base.symbols.dot));
     }
   });
 
-  runner.on('fail', function () {
+  runner.on(EVENT_TEST_FAIL, function () {
     if (++n % width === 0) {
       process.stdout.write('\n  ');
     }
-    process.stdout.write(color('fail', Base.symbols.bang));
+    process.stdout.write(Base.color('fail', Base.symbols.bang));
   });
 
-  runner.on('end', function () {
-    console.log();
+  runner.once(EVENT_RUN_END, function () {
+    process.stdout.write('\n');
     self.epilogue();
   });
 }
@@ -66,3 +77,5 @@ function Dot (runner) {
  * Inherit from `Base.prototype`.
  */
 inherits(Dot, Base);
+
+Dot.description = 'dot matrix representation';

package/lib/reporters/html.js

@@ -1,28 +1,29 @@
 'use strict';
 
 /* eslint-env browser */
-
+/**
+ * @module HTML
+ */
 /**
  * Module dependencies.
  */
 
 var Base = require('./base');
 var utils = require('../utils');
-var Progress = require('../browser/progress');
 var escapeRe = require('escape-string-regexp');
+var constants = require('../runner').constants;
+var EVENT_TEST_PASS = constants.EVENT_TEST_PASS;
+var EVENT_TEST_FAIL = constants.EVENT_TEST_FAIL;
+var EVENT_SUITE_BEGIN = constants.EVENT_SUITE_BEGIN;
+var EVENT_SUITE_END = constants.EVENT_SUITE_END;
+var EVENT_TEST_PENDING = constants.EVENT_TEST_PENDING;
 var escape = utils.escape;
 
 /**
  * Save timer references to avoid Sinon interfering (see GH-237).
  */
 
-/* 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`.
@@ -31,11 +32,13 @@ var clearInterval = global.clearInterval;
 exports = module.exports = HTML;
 
 /**
- * Stats template.
+ * Stats template: Result, progress, passes, failures, and duration.
  */
 
-var statsTemplate = '<ul id="mocha-stats">' +
-  '<li class="progress"><canvas width="40" height="40"></canvas></li>' +
+var statsTemplate =
+  '<ul id="mocha-stats">' +
+  '<li class="result"></li>' +
+  '<li class="progress-contain"><progress class="progress-element" max="100" value="0"></progress><svg class="progress-ring"><circle class="ring-flatlight" stroke-dasharray="100%,0%"/><circle class="ring-highlight" stroke-dasharray="0%,100%"/></svg><div class="progress-text">0%</div></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>' +
@@ -44,41 +47,54 @@ var statsTemplate = '<ul id="mocha-stats">' +
 var playIcon = '&#x2023;';
 
 /**
- * Initialize a new `HTML` reporter.
+ * Constructs a new `HTML` reporter instance.
  *
- * @api public
- * @param {Runner} runner
+ * @public
+ * @class
+ * @memberof Mocha.reporters
+ * @extends Mocha.reporters.Base
+ * @param {Runner} runner - Instance triggers reporter actions.
+ * @param {Object} [options] - runner options
  */
-function HTML (runner) {
-  Base.call(this, runner);
+function HTML(runner, options) {
+  Base.call(this, runner, options);
 
   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];
+  const resultIndex = 0;
+  const progressIndex = 1;
+  const passesIndex = 2;
+  const failuresIndex = 3;
+  const durationIndex = 4;
+  /** Stat item containing the root suite pass or fail indicator (hasFailures ? '✖' : '✓') */
+  var resultIndicator = items[resultIndex];
+  /** Passes text and count */
+  const passesStat = items[passesIndex];
+  /** Stat item containing the pass count (not the word, just the number) */
+  const passesCount = passesStat.getElementsByTagName('em')[0];
+  /** Stat item linking to filter to show only passing tests */
+  const passesLink = passesStat.getElementsByTagName('a')[0];
+  /** Failures text and count */
+  const failuresStat = items[failuresIndex];
+  /** Stat item containing the failure count (not the word, just the number) */
+  const failuresCount = failuresStat.getElementsByTagName('em')[0];
+  /** Stat item linking to filter to show only failing tests */
+  const failuresLink = failuresStat.getElementsByTagName('a')[0];
+  /** Stat item linking to the duration time (not the word or unit, just the number) */
+  var duration = items[durationIndex].getElementsByTagName('em')[0];
   var report = fragment('<ul id="mocha-report"></ul>');
   var stack = [report];
-  var progress;
-  var ctx;
+  var progressText = items[progressIndex].getElementsByTagName('div')[0];
+  var progressBar = items[progressIndex].getElementsByTagName('progress')[0];
+  var progressRing = [
+    items[progressIndex].getElementsByClassName('ring-flatlight')[0],
+    items[progressIndex].getElementsByClassName('ring-highlight')[0]
+  ];
+  var progressRingRadius = null; // computed CSS unavailable now, so set later
   var root = document.getElementById('mocha');
 
-  if (canvas.getContext) {
-    var ratio = window.devicePixelRatio || 1;
-    canvas.style.width = canvas.width;
-    canvas.style.height = canvas.height;
-    canvas.width *= ratio;
-    canvas.height *= ratio;
-    ctx = canvas.getContext('2d');
-    ctx.scale(ratio, ratio);
-    progress = new Progress();
-  }
-
   if (!root) {
     return error('#mocha div missing, add it to your document');
   }
@@ -87,7 +103,7 @@ function HTML (runner) {
   on(passesLink, 'click', function (evt) {
     evt.preventDefault();
     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');
@@ -98,7 +114,7 @@ function HTML (runner) {
   on(failuresLink, 'click', function (evt) {
     evt.preventDefault();
     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');
@@ -108,18 +124,18 @@ function HTML (runner) {
   root.appendChild(stat);
   root.appendChild(report);
 
-  if (progress) {
-    progress.size(40);
-  }
-
-  runner.on('suite', function (suite) {
+  runner.on(EVENT_SUITE_BEGIN, function (suite) {
     if (suite.root) {
       return;
     }
 
     // suite
     var url = self.suiteURL(suite);
-    var el = fragment('<li class="suite"><h1><a href="%s">%s</a></h1></li>', url, escape(suite.title));
+    var el = fragment(
+      '<li class="suite"><h1><a href="%s">%s</a></h1></li>',
+      url,
+      escape(suite.title)
+    );
 
     // container
     stack[0].appendChild(el);
@@ -127,27 +143,43 @@ function HTML (runner) {
     el.appendChild(stack[0]);
   });
 
-  runner.on('suite end', function (suite) {
+  runner.on(EVENT_SUITE_END, function (suite) {
     if (suite.root) {
+      if (stats.failures === 0) {
+        text(resultIndicator, '✓');
+        stat.className += ' pass';
+      }
       updateStats();
       return;
     }
     stack.shift();
   });
 
-  runner.on('pass', function (test) {
+  runner.on(EVENT_TEST_PASS, function (test) {
     var url = self.testURL(test);
-    var markup = '<li class="test pass %e"><h2>%e<span class="duration">%ems</span> ' +
-      '<a href="%s" class="replay">' + playIcon + '</a></h2></li>';
+    var markup =
+      '<li class="test pass %e"><h2>%e<span class="duration">%ems</span> ' +
+      '<a href="%s" class="replay">' +
+      playIcon +
+      '</a></h2></li>';
     var el = fragment(markup, test.speed, test.title, test.duration, url);
     self.addCodeToggle(el, test.body);
     appendToStack(el);
     updateStats();
   });
 
-  runner.on('fail', function (test) {
-    var el = fragment('<li class="test fail"><h2>%e <a href="%e" class="replay">' + playIcon + '</a></h2></li>',
-      test.title, self.testURL(test));
+  runner.on(EVENT_TEST_FAIL, function (test) {
+    // Update stat items
+    text(resultIndicator, '✖');
+    stat.className += ' fail';
+
+    var el = fragment(
+      '<li class="test fail"><h2>%e <a href="%e" class="replay">' +
+        playIcon +
+        '</a></h2></li>',
+      test.title,
+      self.testURL(test)
+    );
     var stackString; // Note: Includes leading newline
     var message = test.err.toString();
 
@@ -162,7 +194,9 @@ function HTML (runner) {
       if (indexOfMessage === -1) {
         stackString = test.err.stack;
       } else {
-        stackString = test.err.stack.substr(test.err.message.length + indexOfMessage);
+        stackString = test.err.stack.slice(
+          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.
@@ -172,12 +206,21 @@ function HTML (runner) {
     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));
+      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));
+      el.appendChild(
+        fragment('<div class="html-error">%s</div>', test.err.htmlMessage)
+      );
     } else {
-      el.appendChild(fragment('<pre class="error">%e%e</pre>', message, stackString));
+      el.appendChild(
+        fragment('<pre class="error">%e%e</pre>', message, stackString)
+      );
     }
 
     self.addCodeToggle(el, test.body);
@@ -185,30 +228,50 @@ function HTML (runner) {
     updateStats();
   });
 
-  runner.on('pending', function (test) {
-    var el = fragment('<li class="test pass pending"><h2>%e</h2></li>', test.title);
+  runner.on(EVENT_TEST_PENDING, function (test) {
+    var el = fragment(
+      '<li class="test pass pending"><h2>%e</h2></li>',
+      test.title
+    );
     appendToStack(el);
     updateStats();
   });
 
-  function appendToStack (el) {
+  function appendToStack(el) {
     // Don't call .appendChild if #mocha-report was already .shift()'ed off the stack.
     if (stack[0]) {
       stack[0].appendChild(el);
     }
   }
 
-  function updateStats () {
-    // TODO: add to stats
-    var percent = stats.tests / runner.total * 100 | 0;
-    if (progress) {
-      progress.update(percent).draw(ctx);
+  function updateStats() {
+    var percent = ((stats.tests / runner.total) * 100) | 0;
+    progressBar.value = percent;
+    if (progressText) {
+      // setting a toFixed that is too low, makes small changes to progress not shown
+      // setting it too high, makes the progress text longer then it needs to
+      // to address this, calculate the toFixed based on the magnitude of total
+      var decimalPlaces = Math.ceil(Math.log10(runner.total / 100));
+      text(
+        progressText,
+        percent.toFixed(Math.min(Math.max(decimalPlaces, 0), 100)) + '%'
+      );
+    }
+    if (progressRing) {
+      var radius = parseFloat(getComputedStyle(progressRing[0]).getPropertyValue('r'));
+      var wholeArc = Math.PI * 2 * radius;
+      var highlightArc = percent * (wholeArc / 100);
+      // The progress ring is in 2 parts, the flatlight color and highlight color.
+      // Rendering both on top of the other, seems to make a 3rd color on the edges.
+      // To create 1 whole ring with 2 colors, both parts are inverse of the other.
+      progressRing[0].style['stroke-dasharray'] = `0,${highlightArc}px,${wholeArc}px`;
+      progressRing[1].style['stroke-dasharray'] = `${highlightArc}px,${wholeArc}px`;
     }
 
     // update stats
     var ms = new Date() - stats.start;
-    text(passes, stats.passes);
-    text(failures, stats.failures);
+    text(passesCount, stats.passes);
+    text(failuresCount, stats.failures);
     text(duration, (ms / 1000).toFixed(2));
   }
 }
@@ -219,15 +282,20 @@ function HTML (runner) {
  * @param {string} s
  * @return {string} A new URL.
  */
-function makeUrl (s) {
+function makeUrl(s) {
   var search = window.location.search;
 
-  // Remove previous grep query parameter if present
+  // Remove previous {grep, fgrep, invert} query parameters if present
   if (search) {
-    search = search.replace(/[?&]grep=[^&\s]*/g, '').replace(/^&/, '?');
+    search = search.replace(/[?&](?:f?grep|invert)=[^&\s]*/g, '').replace(/^&/, '?');
   }
 
-  return window.location.pathname + (search ? search + '&' : '?') + 'grep=' + encodeURIComponent(escapeRe(s));
+  return (
+    window.location.pathname +
+    (search ? search + '&' : '?') +
+    'grep=' +
+    encodeURIComponent(s)
+  );
 }
 
 /**
@@ -236,7 +304,7 @@ function makeUrl (s) {
  * @param {Object} [suite]
  */
 HTML.prototype.suiteURL = function (suite) {
-  return makeUrl(suite.fullTitle());
+  return makeUrl('^' + escapeRe(suite.fullTitle()) + ' ');
 };
 
 /**
@@ -245,7 +313,7 @@ HTML.prototype.suiteURL = function (suite) {
  * @param {Object} [test]
  */
 HTML.prototype.testURL = function (test) {
-  return makeUrl(test.fullTitle());
+  return makeUrl('^' + escapeRe(test.fullTitle()) + '$');
 };
 
 /**
@@ -271,7 +339,7 @@ HTML.prototype.addCodeToggle = function (el, contents) {
  *
  * @param {string} msg
  */
-function error (msg) {
+function error(msg) {
   document.body.appendChild(fragment('<div id="mocha-error">%s</div>', msg));
 }
 
@@ -280,15 +348,17 @@ function error (msg) {
  *
  * @param {string} html
  */
-function fragment (html) {
+function fragment(html) {
   var args = arguments;
   var div = document.createElement('div');
   var i = 1;
 
   div.innerHTML = html.replace(/%([se])/g, function (_, type) {
     switch (type) {
-      case 's': return String(args[i++]);
-      case 'e': return escape(args[i++]);
+      case 's':
+        return String(args[i++]);
+      case 'e':
+        return escape(args[i++]);
       // no default
     }
   });
@@ -302,7 +372,7 @@ function fragment (html) {
  *
  * @param {text} classname
  */
-function hideSuitesWithout (classname) {
+function hideSuitesWithout(classname) {
   var suites = document.getElementsByClassName('suite');
   for (var i = 0; i < suites.length; i++) {
     var els = suites[i].getElementsByClassName(classname);
@@ -315,10 +385,10 @@ function hideSuitesWithout (classname) {
 /**
  * Unhide .hidden suites.
  */
-function unhide () {
+function unhide() {
   var els = document.getElementsByClassName('suite hidden');
-  for (var i = 0; i < els.length; ++i) {
-    els[i].className = els[i].className.replace('suite hidden', 'suite');
+  while (els.length > 0) {
+    els[0].className = els[0].className.replace('suite hidden', 'suite');
   }
 }
 
@@ -328,7 +398,7 @@ function unhide () {
  * @param {HTMLElement} el
  * @param {string} contents
  */
-function text (el, contents) {
+function text(el, contents) {
   if (el.textContent) {
     el.textContent = contents;
   } else {
@@ -339,10 +409,12 @@ function text (el, contents) {
 /**
  * Listen on `event` with callback `fn`.
  */
-function on (el, event, fn) {
+function on(el, event, fn) {
   if (el.addEventListener) {
     el.addEventListener(event, fn, false);
   } else {
     el.attachEvent('on' + event, fn);
   }
 }
+
+HTML.browserOnly = true;