mocha 2.2.5 → 2.3.3

package/lib/runnable.js

@@ -2,21 +2,24 @@
  * Module dependencies.
  */
 
-var EventEmitter = require('events').EventEmitter
-  , debug = require('debug')('mocha:runnable')
-  , Pending = require('./pending')
-  , milliseconds = require('./ms')
-  , utils = require('./utils');
+var EventEmitter = require('events').EventEmitter;
+var Pending = require('./pending');
+var debug = require('debug')('mocha:runnable');
+var milliseconds = require('./ms');
+var utils = require('./utils');
+var inherits = utils.inherits;
 
 /**
  * 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 */
 
 /**
  * Object#toString().
@@ -36,70 +39,81 @@ module.exports = Runnable;
  * @param {String} title
  * @param {Function} fn
  * @api private
+ * @param {string} title
+ * @param {Function} fn
  */
-
 function Runnable(title, fn) {
   this.title = title;
   this.fn = fn;
   this.async = fn && fn.length;
-  this.sync = ! this.async;
+  this.sync = !this.async;
   this._timeout = 2000;
   this._slow = 75;
   this._enableTimeouts = true;
   this.timedOut = false;
-  this._trace = new Error('done() called multiple times')
+  this._trace = new Error('done() called multiple times');
 }
 
 /**
  * Inherit from `EventEmitter.prototype`.
  */
-
-Runnable.prototype.__proto__ = EventEmitter.prototype;
+inherits(Runnable, EventEmitter);
 
 /**
  * Set & get timeout `ms`.
  *
- * @param {Number|String} ms
- * @return {Runnable|Number} ms or self
  * @api private
+ * @param {number|string} ms
+ * @return {Runnable|number} ms or Runnable instance.
  */
-
-Runnable.prototype.timeout = function(ms){
-  if (0 == arguments.length) return this._timeout;
-  if (ms === 0) this._enableTimeouts = false;
-  if ('string' == typeof ms) ms = milliseconds(ms);
+Runnable.prototype.timeout = function(ms) {
+  if (!arguments.length) {
+    return this._timeout;
+  }
+  if (ms === 0) {
+    this._enableTimeouts = false;
+  }
+  if (typeof ms === 'string') {
+    ms = milliseconds(ms);
+  }
   debug('timeout %d', ms);
   this._timeout = ms;
-  if (this.timer) this.resetTimeout();
+  if (this.timer) {
+    this.resetTimeout();
+  }
   return this;
 };
 
 /**
  * Set & get slow `ms`.
  *
- * @param {Number|String} ms
- * @return {Runnable|Number} ms or self
  * @api private
+ * @param {number|string} ms
+ * @return {Runnable|number} ms or Runnable instance.
  */
-
-Runnable.prototype.slow = function(ms){
-  if (0 === arguments.length) return this._slow;
-  if ('string' == typeof ms) ms = milliseconds(ms);
+Runnable.prototype.slow = function(ms) {
+  if (!arguments.length) {
+    return this._slow;
+  }
+  if (typeof ms === 'string') {
+    ms = milliseconds(ms);
+  }
   debug('timeout %d', ms);
   this._slow = ms;
   return this;
 };
 
 /**
- * Set and & get timeout `enabled`.
+ * Set and get whether timeout is `enabled`.
  *
- * @param {Boolean} enabled
- * @return {Runnable|Boolean} enabled or self
  * @api private
+ * @param {boolean} enabled
+ * @return {Runnable|boolean} enabled or Runnable instance.
  */
-
-Runnable.prototype.enableTimeouts = function(enabled){
-  if (arguments.length === 0) return this._enableTimeouts;
+Runnable.prototype.enableTimeouts = function(enabled) {
+  if (!arguments.length) {
+    return this._enableTimeouts;
+  }
   debug('enableTimeouts %s', enabled);
   this._enableTimeouts = enabled;
   return this;
@@ -110,20 +124,18 @@ Runnable.prototype.enableTimeouts = function(enabled){
  *
  * @api private
  */
-
-Runnable.prototype.skip = function(){
-    throw new Pending();
+Runnable.prototype.skip = function() {
+  throw new Pending();
 };
 
 /**
- * Return the full title generated by recursively
- * concatenating the parent's full title.
+ * Return the full title generated by recursively concatenating the parent's
+ * full title.
  *
- * @return {String}
  * @api public
+ * @return {string}
  */
-
-Runnable.prototype.fullTitle = function(){
+Runnable.prototype.fullTitle = function() {
   return this.parent.fullTitle() + ' ' + this.title;
 };
 
@@ -132,23 +144,27 @@ Runnable.prototype.fullTitle = function(){
  *
  * @api private
  */
-
-Runnable.prototype.clearTimeout = function(){
+Runnable.prototype.clearTimeout = function() {
   clearTimeout(this.timer);
 };
 
 /**
  * Inspect the runnable void of private properties.
  *
- * @return {String}
  * @api private
+ * @return {string}
  */
-
-Runnable.prototype.inspect = function(){
-  return JSON.stringify(this, function(key, val){
-    if ('_' == key[0]) return;
-    if ('parent' == key) return '#<Suite>';
-    if ('ctx' == key) return '#<Context>';
+Runnable.prototype.inspect = function() {
+  return JSON.stringify(this, function(key, val) {
+    if (key[0] === '_') {
+      return;
+    }
+    if (key === 'parent') {
+      return '#<Suite>';
+    }
+    if (key === 'ctx') {
+      return '#<Context>';
+    }
     return val;
   }, 2);
 };
@@ -158,28 +174,31 @@ Runnable.prototype.inspect = function(){
  *
  * @api private
  */
-
-Runnable.prototype.resetTimeout = function(){
+Runnable.prototype.resetTimeout = function() {
   var self = this;
   var ms = this.timeout() || 1e9;
 
-  if (!this._enableTimeouts) return;
+  if (!this._enableTimeouts) {
+    return;
+  }
   this.clearTimeout();
-  this.timer = setTimeout(function(){
-    if (!self._enableTimeouts) return;
+  this.timer = setTimeout(function() {
+    if (!self._enableTimeouts) {
+      return;
+    }
     self.callback(new Error('timeout of ' + ms + 'ms exceeded. Ensure the done() callback is being called in this test.'));
     self.timedOut = true;
   }, ms);
 };
 
 /**
- * Whitelist these globals for this test run
+ * Whitelist a list of globals for this test run.
  *
  * @api private
+ * @param {string[]} globals
  */
-Runnable.prototype.globals = function(arr){
-  var self = this;
-  this._allowedGlobals = arr;
+Runnable.prototype.globals = function(globals) {
+  this._allowedGlobals = globals;
 };
 
 /**
@@ -188,20 +207,23 @@ Runnable.prototype.globals = function(arr){
  * @param {Function} fn
  * @api private
  */
-
-Runnable.prototype.run = function(fn){
-  var self = this
-    , start = new Date
-    , ctx = this.ctx
-    , finished
-    , emitted;
-
-  // Some times the ctx exists but it is not runnable
-  if (ctx && ctx.runnable) ctx.runnable(this);
+Runnable.prototype.run = function(fn) {
+  var self = this;
+  var start = new Date();
+  var ctx = this.ctx;
+  var finished;
+  var emitted;
+
+  // Sometimes the ctx exists, but it is not runnable
+  if (ctx && ctx.runnable) {
+    ctx.runnable(this);
+  }
 
   // called multiple times
   function multiple(err) {
-    if (emitted) return;
+    if (emitted) {
+      return;
+    }
     emitted = true;
     self.emit('error', err || new Error('done() called multiple times; stacktrace may be inaccurate'));
   }
@@ -209,16 +231,19 @@ Runnable.prototype.run = function(fn){
   // finished
   function done(err) {
     var ms = self.timeout();
-    if (self.timedOut) return;
-    if (finished) return multiple(err || self._trace);
-
-    // Discard the resolution if this test has already failed asynchronously
-    if (self.state) return;
+    if (self.timedOut) {
+      return;
+    }
+    if (finished) {
+      return multiple(err || self._trace);
+    }
 
     self.clearTimeout();
-    self.duration = new Date - start;
+    self.duration = new Date() - start;
     finished = true;
-    if (!err && self.duration > ms && self._enableTimeouts) err = new Error('timeout of ' + ms + 'ms exceeded. Ensure the done() callback is being called in this test.');
+    if (!err && self.duration > ms && self._enableTimeouts) {
+      err = new Error('timeout of ' + ms + 'ms exceeded. Ensure the done() callback is being called in this test.');
+    }
     fn(err);
   }
 
@@ -229,26 +254,21 @@ Runnable.prototype.run = function(fn){
   if (this.async) {
     this.resetTimeout();
 
+    if (this.allowUncaught) {
+      return callFnAsync(this.fn);
+    }
     try {
-      this.fn.call(ctx, function(err){
-        if (err instanceof Error || toString.call(err) === "[object Error]") return done(err);
-        if (null != err) {
-          if (Object.prototype.toString.call(err) === '[object Object]') {
-            return done(new Error('done() invoked with non-Error: ' + JSON.stringify(err)));
-          } else {
-            return done(new Error('done() invoked with non-Error: ' + err));
-          }
-        }
-        done();
-      });
+      callFnAsync(this.fn);
     } catch (err) {
       done(utils.getError(err));
     }
     return;
   }
 
-  if (this.asyncOnly) {
-    return done(new Error('--async-only option in use without declaring `done()`'));
+  if (this.allowUncaught) {
+    callFn(this.fn);
+    done();
+    return;
   }
 
   // sync or promise-returning
@@ -268,13 +288,33 @@ Runnable.prototype.run = function(fn){
       self.resetTimeout();
       result
         .then(function() {
-          done()
+          done();
         },
         function(reason) {
-          done(reason || new Error('Promise rejected with no or falsy reason'))
+          done(reason || new Error('Promise rejected with no or falsy reason'));
         });
     } else {
+      if (self.asyncOnly) {
+        return done(new Error('--async-only option in use without declaring `done()` or returning a promise'));
+      }
+
       done();
     }
   }
+
+  function callFnAsync(fn) {
+    fn.call(ctx, function(err) {
+      if (err instanceof Error || toString.call(err) === '[object Error]') {
+        return done(err);
+      }
+      if (err) {
+        if (Object.prototype.toString.call(err) === '[object Object]') {
+          return done(new Error('done() invoked with non-Error: '
+            + JSON.stringify(err)));
+        }
+        return done(new Error('done() invoked with non-Error: ' + err));
+      }
+      done();
+    });
+  }
 };