Refactored tests to use Bower

Author: JamesMessinger

.bowerrc

@@ -0,0 +1,3 @@
+{
+  "directory": "www/bower_components"
+}

bower.json

@@ -1,11 +1,20 @@
 {
   "name": "ono",
   "description": "Throw better errors.",
-  "keywords": [],
+  "keywords": [
+    "throw",
+    "error",
+    "errors",
+    "exception",
+    "printf",
+    "format",
+    "wrap",
+    "inner"
+  ],
   "authors": [
     {
       "name": "James Messinger",
-      "homepage": "https://github.com/BigstickCarpet"
+      "homepage": "http://jamesmessinger.com"
     }
   ],
   "license": "MIT",
@@ -21,5 +30,11 @@
     "/lib",
     "/.*"
   ],
-  "dependencies": {}
+  "dependencies": {},
+  "devDependencies": {
+    "chai": "*",
+    "mocha": "*",
+    "sinon-js": "*",
+    "useragent-parser": "*"
+  }
 }

tests/_config.js

@@ -0,0 +1,45 @@
+/**
+ * This script configures Mocha, Chai, Sinon, etc.
+ * It also exposes everything as globals, to allow tests to run in Node and in browsers.
+ * 
+ * Why not use Browserify instead of globals?
+ *  - To make sure Ono works properly when Node and CommonJS are not available
+ *  - Some of our devDependencies have separate packages packages for Node vs. Browser (e.g. Mocha, Sinon)
+ *  - This reduces redundant boilerplate code in the .spec files
+ */
+(function() {
+  'use strict';
+
+  if (typeof(window) === 'object') {
+    // Configure Mocha
+    mocha.setup('bdd');
+    mocha.fullTrace();
+    mocha.checkLeaks();
+    mocha.globals([]);
+
+    // Expose Browser globals
+    window.global = window;
+    window.expect = chai.expect;
+    window.userAgent = userAgentParser.parse(navigator.userAgent);
+    window.userAgent.isNode = false;
+    window.userAgent.isBrowser = true;
+  }
+  else {
+    // Expose Node globals
+    global.ono = require('../');
+    global.expect = require('chai').expect;
+    global.sinon = require('sinon');
+
+    global.userAgent = {
+      isNode: true,
+      isBrowser: false
+    }
+  }
+
+  // Set global settings for all tests
+  beforeEach(function() {
+    this.currentTest.timeout(2000);
+    this.currentTest.slow(100);
+  });
+
+})();

tests/_utils.js

@@ -0,0 +1,70 @@
+(function() {
+  'use strict';
+
+  /**
+   * Utility methods for use in tests
+   */
+  global.utils = {
+    forEachMethod: forEachMethod,
+    matchesJSON: matchesJSON
+  };
+
+  /**
+   * Invokes the given function for each {@link Ono} method
+   *
+   * @param {function} fn - The function that's invoked for each method
+   */
+  function forEachMethod(fn) {
+    var names = ['', 'error', 'eval', 'range', 'reference', 'syntax', 'type', 'uri'];
+    var types = ['Error', 'Error', 'EvalError', 'RangeError', 'ReferenceError', 'SyntaxError', 'TypeError', 'URIError'];
+
+    for (var i = 0; i < names.length; i++) {
+      var name, method;
+
+      if (i === 0) {
+        name = 'ono()';
+        method = ono;
+      }
+      else {
+        name = 'ono.' + names[i] + '()';
+        method = ono[names[i]];
+      }
+
+      var type = types[i];
+      fn(name, method, global[type], type);
+    }
+  }
+
+  /**
+   * Asserts that a JSON-serialized Error has the expected properties & values.
+   *
+   * @param {object} expected - The expected properties & values
+   * @returns {function}
+   */
+  function matchesJSON(expected) {
+    return function(json) {
+      if (userAgent.isFirefox) {
+        expect(json.fileName).to.be.a('string').and.not.empty;
+        expect(json.lineNumber).to.be.a('number').above(0);
+        expect(json.columnNumber).to.be.a('number').above(0);
+        expected.fileName = json.fileName;
+        expected.lineNumber = json.lineNumber;
+        expected.columnNumber = json.columnNumber;
+      }
+
+      if (userAgent.isIE && 'description' in json) {
+        expect(json.description).to.be.a('string');
+        expected.description = json.description;
+      }
+
+      if (!('stack' in json)) {
+        // Some browsers don't support the "stack" property
+        delete expected.stack;
+      }
+
+      expect(json).to.deep.equal(expected);
+      return true;
+    }
+  }
+})();
+

tests/formatter.spec.js

@@ -1,13 +1,11 @@
-'use strict';
-
-var helper = require('./helper'),
-    expect = require('chai').expect,
-    ono    = require('../');
-
 describe('ono.formatter', function() {
-  var originalFormatter = ono.formatter;
+  'use strict';
+
+  var originalFormatter;
 
   before(function() {
+    originalFormatter = ono.formatter;
+
     // A simple formatter that replaces $0, $1, $2, etc. with the corresponding param
     ono.formatter = function(message) {
       var params = Array.prototype.slice.call(arguments, 1);
@@ -30,7 +28,7 @@ describe('ono.formatter', function() {
       expect(err.message).to.equal('4 must be greater than 10');
 
       var json = JSON.parse(JSON.stringify(err));
-      expect(json).to.satisfy(helper.matchesJSON({
+      expect(json).to.satisfy(utils.matchesJSON({
         name: err.name,
         message: err.message,
         stack: err.stack
@@ -47,7 +45,7 @@ describe('ono.formatter', function() {
       expect(err.message).to.equal('4 must be greater than 10');
 
       var json = JSON.parse(JSON.stringify(err));
-      expect(json).to.satisfy(helper.matchesJSON({
+      expect(json).to.satisfy(utils.matchesJSON({
         name: err.name,
         message: err.message,
         stack: err.stack

tests/helper.js

@@ -1,32 +1,33 @@
 <!DOCTYPE html>
 <html>
   <head lang="en">
-    <meta charset="UTF-8">
-    <link rel="stylesheet" href="../node_modules/mocha/mocha.css"/>
+    <meta charset='utf-8'>
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
 
     <title>Ono Tests</title>
+
+    <link rel="stylesheet" href="../www/bower_components/mocha/mocha.css"/>
   </head>
   <body>
     <div id="mocha"></div>
 
-    <!-- Unit Testing Frameworks -->
-    <script src="../node_modules/mocha/mocha.js"></script>
-    <script src="../node_modules/chai/chai.js"></script>
-    <script src="../node_modules/sinon/pkg/sinon.js"></script>
-    <script>mocha.setup('bdd')</script>
+    <!-- Third-Party Libraries -->
+    <script src="../www/bower_components/mocha/mocha.js"></script>
+    <script src="../www/bower_components/chai/chai.js"></script>
+    <script src="../www/bower_components/sinon-js/sinon.js"></script>
+    <script src="../www/bower_components/useragent-parser/src/useragent-parser.js"></script>
 
     <!-- Ono -->
     <script src="../dist/ono.js"></script>
 
     <!-- Unit Tests -->
-    <script src="helper.js"></script>
+    <script src="_config.js"></script>
+    <script src="_utils.js"></script>
     <script src="ono.spec.js"></script>
     <script src="formatter.spec.js"></script>
 
     <script>
-      expect = chai.expect;
-      mocha.checkLeaks();
-      mocha.globals([]);
       mocha.run();
     </script>
   </body>