mocha 2.2.5 → 2.3.3

package/lib/interfaces/bdd.js

@@ -2,33 +2,31 @@
  * Module dependencies.
  */
 
-var Suite = require('../suite')
-  , Test = require('../test')
-  , utils = require('../utils')
-  , escapeRe = require('escape-string-regexp');
+var Suite = require('../suite');
+var Test = require('../test');
+var escapeRe = require('escape-string-regexp');
 
 /**
  * BDD-style interface:
  *
- *      describe('Array', function(){
- *        describe('#indexOf()', function(){
- *          it('should return -1 when not present', function(){
- *
+ *      describe('Array', function() {
+ *        describe('#indexOf()', function() {
+ *          it('should return -1 when not present', function() {
+ *            // ...
  *          });
  *
- *          it('should return the index when present', function(){
- *
+ *          it('should return the index when present', function() {
+ *            // ...
  *          });
  *        });
  *      });
  *
+ * @param {Suite} suite Root suite.
  */
-
-module.exports = function(suite){
+module.exports = function(suite) {
   var suites = [suite];
 
-  suite.on('pre-require', function(context, file, mocha){
-
+  suite.on('pre-require', function(context, file, mocha) {
     var common = require('./common')(suites, context);
 
     context.before = common.before;
@@ -42,7 +40,7 @@ module.exports = function(suite){
      * and/or tests.
      */
 
-    context.describe = context.context = function(title, fn){
+    context.describe = context.context = function(title, fn) {
       var suite = Suite.create(suites[0], title);
       suite.file = file;
       suites.unshift(suite);
@@ -55,9 +53,7 @@ module.exports = function(suite){
      * Pending describe.
      */
 
-    context.xdescribe =
-    context.xcontext =
-    context.describe.skip = function(title, fn){
+    context.xdescribe = context.xcontext = context.describe.skip = function(title, fn) {
       var suite = Suite.create(suites[0], title);
       suite.pending = true;
       suites.unshift(suite);
@@ -69,7 +65,7 @@ module.exports = function(suite){
      * Exclusive suite.
      */
 
-    context.describe.only = function(title, fn){
+    context.describe.only = function(title, fn) {
       var suite = context.describe(title, fn);
       mocha.grep(suite.fullTitle());
       return suite;
@@ -81,9 +77,11 @@ module.exports = function(suite){
      * acting as a thunk.
      */
 
-    context.it = context.specify = function(title, fn){
+    context.it = context.specify = function(title, fn) {
       var suite = suites[0];
-      if (suite.pending) fn = null;
+      if (suite.pending) {
+        fn = null;
+      }
       var test = new Test(title, fn);
       test.file = file;
       suite.addTest(test);
@@ -94,7 +92,7 @@ module.exports = function(suite){
      * Exclusive test-case.
      */
 
-    context.it.only = function(title, fn){
+    context.it.only = function(title, fn) {
       var test = context.it(title, fn);
       var reString = '^' + escapeRe(test.fullTitle()) + '$';
       mocha.grep(new RegExp(reString));
@@ -105,11 +103,8 @@ module.exports = function(suite){
      * Pending test case.
      */
 
-    context.xit =
-    context.xspecify =
-    context.it.skip = function(title){
+    context.xit = context.xspecify = context.it.skip = function(title) {
       context.it(title);
     };
-
   });
 };

package/lib/interfaces/common.js

@@ -1,16 +1,20 @@
-/**
- * Functions common to more than one interface
- * @module lib/interfaces/common
- */
-
 'use strict';
 
-module.exports = function (suites, context) {
-
+/**
+ * Functions common to more than one interface.
+ *
+ * @param {Suite[]} suites
+ * @param {Context} context
+ * @return {Object} An object containing common functions.
+ */
+module.exports = function(suites, context) {
   return {
     /**
-     * This is only present if flag --delay is passed into Mocha.  It triggers
-     * root suite execution.  Returns a function which runs the root suite.
+     * This is only present if flag --delay is passed into Mocha. It triggers
+     * root suite execution.
+     *
+     * @param {Suite} suite The root wuite.
+     * @return {Function} A function which runs the root suite
      */
     runWithSuite: function runWithSuite(suite) {
       return function run() {
@@ -20,39 +24,53 @@ module.exports = function (suites, context) {
 
     /**
      * Execute before running tests.
+     *
+     * @param {string} name
+     * @param {Function} fn
      */
-    before: function (name, fn) {
+    before: function(name, fn) {
       suites[0].beforeAll(name, fn);
     },
 
     /**
      * Execute after running tests.
+     *
+     * @param {string} name
+     * @param {Function} fn
      */
-    after: function (name, fn) {
+    after: function(name, fn) {
       suites[0].afterAll(name, fn);
     },
 
     /**
      * Execute before each test case.
+     *
+     * @param {string} name
+     * @param {Function} fn
      */
-    beforeEach: function (name, fn) {
+    beforeEach: function(name, fn) {
       suites[0].beforeEach(name, fn);
     },
 
     /**
      * Execute after each test case.
+     *
+     * @param {string} name
+     * @param {Function} fn
      */
-    afterEach: function (name, fn) {
+    afterEach: function(name, fn) {
       suites[0].afterEach(name, fn);
     },
 
     test: {
       /**
        * Pending test case.
+       *
+       * @param {string} title
        */
-      skip: function (title) {
+      skip: function(title) {
         context.test(title);
       }
     }
-  }
+  };
 };

package/lib/interfaces/exports.js

@@ -2,27 +2,27 @@
  * Module dependencies.
  */
 
-var Suite = require('../suite')
-  , Test = require('../test');
+var Suite = require('../suite');
+var Test = require('../test');
 
 /**
  * TDD-style interface:
  *
  *     exports.Array = {
  *       '#indexOf()': {
- *         'should return -1 when the value is not present': function(){
+ *         'should return -1 when the value is not present': function() {
  *
  *         },
  *
- *         'should return the correct index when the value is present': function(){
+ *         'should return the correct index when the value is present': function() {
  *
  *         }
  *       }
  *     };
  *
+ * @param {Suite} suite Root suite.
  */
-
-module.exports = function(suite){
+module.exports = function(suite) {
   var suites = [suite];
 
   suite.on('require', visit);
@@ -30,7 +30,7 @@ module.exports = function(suite){
   function visit(obj, file) {
     var suite;
     for (var key in obj) {
-      if ('function' == typeof obj[key]) {
+      if (typeof obj[key] === 'function') {
         var fn = obj[key];
         switch (key) {
           case 'before':

package/lib/interfaces/qunit.js

@@ -2,22 +2,21 @@
  * Module dependencies.
  */
 
-var Suite = require('../suite')
-  , Test = require('../test')
-  , escapeRe = require('escape-string-regexp')
-  , utils = require('../utils');
+var Suite = require('../suite');
+var Test = require('../test');
+var escapeRe = require('escape-string-regexp');
 
 /**
  * QUnit-style interface:
  *
  *     suite('Array');
  *
- *     test('#length', function(){
+ *     test('#length', function() {
  *       var arr = [1,2,3];
  *       ok(arr.length == 3);
  *     });
  *
- *     test('#indexOf()', function(){
+ *     test('#indexOf()', function() {
  *       var arr = [1,2,3];
  *       ok(arr.indexOf(1) == 0);
  *       ok(arr.indexOf(2) == 1);
@@ -26,17 +25,16 @@ var Suite = require('../suite')
  *
  *     suite('String');
  *
- *     test('#length', function(){
+ *     test('#length', function() {
  *       ok('foo'.length == 3);
  *     });
  *
+ * @param {Suite} suite Root suite.
  */
-
-module.exports = function(suite){
+module.exports = function(suite) {
   var suites = [suite];
 
-  suite.on('pre-require', function(context, file, mocha){
-
+  suite.on('pre-require', function(context, file, mocha) {
     var common = require('./common')(suites, context);
 
     context.before = common.before;
@@ -48,8 +46,10 @@ module.exports = function(suite){
      * Describe a "suite" with the given `title`.
      */
 
-    context.suite = function(title){
-      if (suites.length > 1) suites.shift();
+    context.suite = function(title) {
+      if (suites.length > 1) {
+        suites.shift();
+      }
       var suite = Suite.create(suites[0], title);
       suite.file = file;
       suites.unshift(suite);
@@ -60,7 +60,7 @@ module.exports = function(suite){
      * Exclusive test-case.
      */
 
-    context.suite.only = function(title, fn){
+    context.suite.only = function(title, fn) {
       var suite = context.suite(title, fn);
       mocha.grep(suite.fullTitle());
     };
@@ -71,7 +71,7 @@ module.exports = function(suite){
      * acting as a thunk.
      */
 
-    context.test = function(title, fn){
+    context.test = function(title, fn) {
       var test = new Test(title, fn);
       test.file = file;
       suites[0].addTest(test);
@@ -82,13 +82,12 @@ module.exports = function(suite){
      * Exclusive test-case.
      */
 
-    context.test.only = function(title, fn){
+    context.test.only = function(title, fn) {
       var test = context.test(title, fn);
       var reString = '^' + escapeRe(test.fullTitle()) + '$';
       mocha.grep(new RegExp(reString));
     };
 
     context.test.skip = common.test.skip;
-
   });
 };

package/lib/interfaces/tdd.js

@@ -2,41 +2,39 @@
  * Module dependencies.
  */
 
-var Suite = require('../suite')
-  , Test = require('../test')
-  , escapeRe = require('escape-string-regexp')
-  , utils = require('../utils');
+var Suite = require('../suite');
+var Test = require('../test');
+var escapeRe = require('escape-string-regexp');
 
 /**
  * TDD-style interface:
  *
- *      suite('Array', function(){
- *        suite('#indexOf()', function(){
- *          suiteSetup(function(){
+ *      suite('Array', function() {
+ *        suite('#indexOf()', function() {
+ *          suiteSetup(function() {
  *
  *          });
  *
- *          test('should return -1 when not present', function(){
+ *          test('should return -1 when not present', function() {
  *
  *          });
  *
- *          test('should return the index when present', function(){
+ *          test('should return the index when present', function() {
  *
  *          });
  *
- *          suiteTeardown(function(){
+ *          suiteTeardown(function() {
  *
  *          });
  *        });
  *      });
  *
+ * @param {Suite} suite Root suite.
  */
-
-module.exports = function(suite){
+module.exports = function(suite) {
   var suites = [suite];
 
-  suite.on('pre-require', function(context, file, mocha){
-
+  suite.on('pre-require', function(context, file, mocha) {
     var common = require('./common')(suites, context);
 
     context.setup = common.beforeEach;
@@ -44,13 +42,12 @@ module.exports = function(suite){
     context.suiteSetup = common.before;
     context.suiteTeardown = common.after;
     context.run = mocha.options.delay && common.runWithSuite(suite);
+
     /**
-     * Describe a "suite" with the given `title`
-     * and callback `fn` containing nested suites
-     * and/or tests.
+     * Describe a "suite" with the given `title` and callback `fn` containing
+     * nested suites and/or tests.
      */
-
-    context.suite = function(title, fn){
+    context.suite = function(title, fn) {
       var suite = Suite.create(suites[0], title);
       suite.file = file;
       suites.unshift(suite);
@@ -73,21 +70,20 @@ module.exports = function(suite){
     /**
      * Exclusive test-case.
      */
-
-    context.suite.only = function(title, fn){
+    context.suite.only = function(title, fn) {
       var suite = context.suite(title, fn);
       mocha.grep(suite.fullTitle());
     };
 
     /**
-     * Describe a specification or test-case
-     * with the given `title` and callback `fn`
-     * acting as a thunk.
+     * Describe a specification or test-case with the given `title` and
+     * callback `fn` acting as a thunk.
      */
-
-    context.test = function(title, fn){
+    context.test = function(title, fn) {
       var suite = suites[0];
-      if (suite.pending) fn = null;
+      if (suite.pending) {
+        fn = null;
+      }
       var test = new Test(title, fn);
       test.file = file;
       suite.addTest(test);
@@ -98,7 +94,7 @@ module.exports = function(suite){
      * Exclusive test-case.
      */
 
-    context.test.only = function(title, fn){
+    context.test.only = function(title, fn) {
       var test = context.test(title, fn);
       var reString = '^' + escapeRe(test.fullTitle()) + '$';
       mocha.grep(new RegExp(reString));