mocha 2.2.5 → 2.3.3

package/lib/suite.js

@@ -2,11 +2,12 @@
  * Module dependencies.
  */
 
-var EventEmitter = require('events').EventEmitter
-  , debug = require('debug')('mocha:suite')
-  , milliseconds = require('./ms')
-  , utils = require('./utils')
-  , Hook = require('./hook');
+var EventEmitter = require('events').EventEmitter;
+var Hook = require('./hook');
+var utils = require('./utils');
+var inherits = utils.inherits;
+var debug = require('debug')('mocha:suite');
+var milliseconds = require('./ms');
 
 /**
  * Expose `Suite`.
@@ -15,41 +16,38 @@ var EventEmitter = require('events').EventEmitter
 exports = module.exports = Suite;
 
 /**
- * Create a new `Suite` with the given `title`
- * and parent `Suite`. When a suite with the
- * same title is already present, that suite
- * is returned to provide nicer reporter
- * and more flexible meta-testing.
+ * Create a new `Suite` with the given `title` and parent `Suite`. When a suite
+ * with the same title is already present, that suite is returned to provide
+ * nicer reporter and more flexible meta-testing.
  *
+ * @api public
  * @param {Suite} parent
- * @param {String} title
+ * @param {string} title
  * @return {Suite}
- * @api public
  */
-
-exports.create = function(parent, title){
+exports.create = function(parent, title) {
   var suite = new Suite(title, parent.ctx);
   suite.parent = parent;
-  if (parent.pending) suite.pending = true;
+  if (parent.pending) {
+    suite.pending = true;
+  }
   title = suite.fullTitle();
   parent.addSuite(suite);
   return suite;
 };
 
 /**
- * Initialize a new `Suite` with the given
- * `title` and `ctx`.
+ * Initialize a new `Suite` with the given `title` and `ctx`.
  *
- * @param {String} title
- * @param {Context} ctx
  * @api private
+ * @param {string} title
+ * @param {Context} parentContext
  */
-
 function Suite(title, parentContext) {
   this.title = title;
-  var context = function() {};
-  context.prototype = parentContext;
-  this.ctx = new context();
+  function Context() {}
+  Context.prototype = parentContext;
+  this.ctx = new Context();
   this.suites = [];
   this.tests = [];
   this.pending = false;
@@ -68,17 +66,15 @@ function Suite(title, parentContext) {
 /**
  * Inherit from `EventEmitter.prototype`.
  */
-
-Suite.prototype.__proto__ = EventEmitter.prototype;
+inherits(Suite, EventEmitter);
 
 /**
  * Return a clone of this `Suite`.
  *
- * @return {Suite}
  * @api private
+ * @return {Suite}
  */
-
-Suite.prototype.clone = function(){
+Suite.prototype.clone = function() {
   var suite = new Suite(this.title);
   debug('clone');
   suite.ctx = this.ctx;
@@ -92,30 +88,36 @@ Suite.prototype.clone = function(){
 /**
  * Set timeout `ms` or short-hand such as "2s".
  *
- * @param {Number|String} ms
- * @return {Suite|Number} for chaining
  * @api private
+ * @param {number|string} ms
+ * @return {Suite|number} for chaining
  */
-
-Suite.prototype.timeout = function(ms){
-  if (0 == arguments.length) return this._timeout;
-  if (ms.toString() === '0') this._enableTimeouts = false;
-  if ('string' == typeof ms) ms = milliseconds(ms);
+Suite.prototype.timeout = function(ms) {
+  if (!arguments.length) {
+    return this._timeout;
+  }
+  if (ms.toString() === '0') {
+    this._enableTimeouts = false;
+  }
+  if (typeof ms === 'string') {
+    ms = milliseconds(ms);
+  }
   debug('timeout %d', ms);
   this._timeout = parseInt(ms, 10);
   return this;
 };
 
 /**
-  * Set timeout `enabled`.
+  * Set timeout to `enabled`.
   *
-  * @param {Boolean} enabled
-  * @return {Suite|Boolean} self or enabled
   * @api private
+  * @param {boolean} enabled
+  * @return {Suite|boolean} self or enabled
   */
-
-Suite.prototype.enableTimeouts = function(enabled){
-  if (arguments.length === 0) return this._enableTimeouts;
+Suite.prototype.enableTimeouts = function(enabled) {
+  if (!arguments.length) {
+    return this._enableTimeouts;
+  }
   debug('enableTimeouts %s', enabled);
   this._enableTimeouts = enabled;
   return this;
@@ -124,14 +126,17 @@ Suite.prototype.enableTimeouts = function(enabled){
 /**
  * Set slow `ms` or short-hand such as "2s".
  *
- * @param {Number|String} ms
- * @return {Suite|Number} for chaining
  * @api private
+ * @param {number|string} ms
+ * @return {Suite|number} for chaining
  */
-
-Suite.prototype.slow = function(ms){
-  if (0 === arguments.length) return this._slow;
-  if ('string' == typeof ms) ms = milliseconds(ms);
+Suite.prototype.slow = function(ms) {
+  if (!arguments.length) {
+    return this._slow;
+  }
+  if (typeof ms === 'string') {
+    ms = milliseconds(ms);
+  }
   debug('slow %d', ms);
   this._slow = ms;
   return this;
@@ -140,13 +145,14 @@ Suite.prototype.slow = function(ms){
 /**
  * Sets whether to bail after first error.
  *
- * @param {Boolean} bail
- * @return {Suite|Number} for chaining
  * @api private
+ * @param {boolean} bail
+ * @return {Suite|number} for chaining
  */
-
-Suite.prototype.bail = function(bail){
-  if (0 == arguments.length) return this._bail;
+Suite.prototype.bail = function(bail) {
+  if (!arguments.length) {
+    return this._bail;
+  }
   debug('bail %s', bail);
   this._bail = bail;
   return this;
@@ -155,14 +161,16 @@ Suite.prototype.bail = function(bail){
 /**
  * Run `fn(test[, done])` before running tests.
  *
+ * @api private
+ * @param {string} title
  * @param {Function} fn
  * @return {Suite} for chaining
- * @api private
  */
-
-Suite.prototype.beforeAll = function(title, fn){
-  if (this.pending) return this;
-  if ('function' === typeof title) {
+Suite.prototype.beforeAll = function(title, fn) {
+  if (this.pending) {
+    return this;
+  }
+  if (typeof title === 'function') {
     fn = title;
     title = fn.name;
   }
@@ -182,14 +190,16 @@ Suite.prototype.beforeAll = function(title, fn){
 /**
  * Run `fn(test[, done])` after running tests.
  *
+ * @api private
+ * @param {string} title
  * @param {Function} fn
  * @return {Suite} for chaining
- * @api private
  */
-
-Suite.prototype.afterAll = function(title, fn){
-  if (this.pending) return this;
-  if ('function' === typeof title) {
+Suite.prototype.afterAll = function(title, fn) {
+  if (this.pending) {
+    return this;
+  }
+  if (typeof title === 'function') {
     fn = title;
     title = fn.name;
   }
@@ -209,14 +219,16 @@ Suite.prototype.afterAll = function(title, fn){
 /**
  * Run `fn(test[, done])` before each test case.
  *
+ * @api private
+ * @param {string} title
  * @param {Function} fn
  * @return {Suite} for chaining
- * @api private
  */
-
-Suite.prototype.beforeEach = function(title, fn){
-  if (this.pending) return this;
-  if ('function' === typeof title) {
+Suite.prototype.beforeEach = function(title, fn) {
+  if (this.pending) {
+    return this;
+  }
+  if (typeof title === 'function') {
     fn = title;
     title = fn.name;
   }
@@ -236,14 +248,16 @@ Suite.prototype.beforeEach = function(title, fn){
 /**
  * Run `fn(test[, done])` after each test case.
  *
+ * @api private
+ * @param {string} title
  * @param {Function} fn
  * @return {Suite} for chaining
- * @api private
  */
-
-Suite.prototype.afterEach = function(title, fn){
-  if (this.pending) return this;
-  if ('function' === typeof title) {
+Suite.prototype.afterEach = function(title, fn) {
+  if (this.pending) {
+    return this;
+  }
+  if (typeof title === 'function') {
     fn = title;
     title = fn.name;
   }
@@ -263,12 +277,11 @@ Suite.prototype.afterEach = function(title, fn){
 /**
  * Add a test `suite`.
  *
+ * @api private
  * @param {Suite} suite
  * @return {Suite} for chaining
- * @api private
  */
-
-Suite.prototype.addSuite = function(suite){
+Suite.prototype.addSuite = function(suite) {
   suite.parent = this;
   suite.timeout(this.timeout());
   suite.enableTimeouts(this.enableTimeouts());
@@ -282,12 +295,11 @@ Suite.prototype.addSuite = function(suite){
 /**
  * Add a `test` to this suite.
  *
+ * @api private
  * @param {Test} test
  * @return {Suite} for chaining
- * @api private
  */
-
-Suite.prototype.addTest = function(test){
+Suite.prototype.addTest = function(test) {
   test.parent = this;
   test.timeout(this.timeout());
   test.enableTimeouts(this.enableTimeouts());
@@ -299,17 +311,18 @@ Suite.prototype.addTest = function(test){
 };
 
 /**
- * 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}
  */
-
-Suite.prototype.fullTitle = function(){
+Suite.prototype.fullTitle = function() {
   if (this.parent) {
     var full = this.parent.fullTitle();
-    if (full) return full + ' ' + this.title;
+    if (full) {
+      return full + ' ' + this.title;
+    }
   }
   return this.title;
 };
@@ -317,29 +330,26 @@ Suite.prototype.fullTitle = function(){
 /**
  * Return the total number of tests.
  *
- * @return {Number}
  * @api public
+ * @return {number}
  */
-
-Suite.prototype.total = function(){
-  return utils.reduce(this.suites, function(sum, suite){
+Suite.prototype.total = function() {
+  return utils.reduce(this.suites, function(sum, suite) {
     return sum + suite.total();
   }, 0) + this.tests.length;
 };
 
 /**
- * Iterates through each suite recursively to find
- * all tests. Applies a function in the format
- * `fn(test)`.
+ * Iterates through each suite recursively to find all tests. Applies a
+ * function in the format `fn(test)`.
  *
+ * @api private
  * @param {Function} fn
  * @return {Suite}
- * @api private
  */
-
-Suite.prototype.eachTest = function(fn){
+Suite.prototype.eachTest = function(fn) {
   utils.forEach(this.tests, fn);
-  utils.forEach(this.suites, function(suite){
+  utils.forEach(this.suites, function(suite) {
     suite.eachTest(fn);
   });
   return this;

package/lib/template.html

@@ -9,7 +9,7 @@
   <body>
     <div id="mocha"></div>
     <script src="mocha.js"></script>
-    <script>mocha.setup('bdd')</script>
+    <script>mocha.setup('bdd');</script>
     <script src="tests.js"></script>
     <script>
       mocha.run();

package/lib/test.js

@@ -3,6 +3,7 @@
  */
 
 var Runnable = require('./runnable');
+var inherits = require('./utils').inherits;
 
 /**
  * Expose `Test`.
@@ -13,11 +14,10 @@ module.exports = Test;
 /**
  * Initialize a new `Test` with the given `title` and callback `fn`.
  *
+ * @api private
  * @param {String} title
  * @param {Function} fn
- * @api private
  */
-
 function Test(title, fn) {
   Runnable.call(this, title, fn);
   this.pending = !fn;
@@ -27,5 +27,4 @@ function Test(title, fn) {
 /**
  * Inherit from `Runnable.prototype`.
  */
-
-Test.prototype.__proto__ = Runnable.prototype;
+inherits(Test, Runnable);