Fix browser tests and make them easier to use

Author: SpaceK33z

CONTRIBUTING.md

@@ -0,0 +1,27 @@
+Contributions are very appreciated!
+
+If you re-implement a PR from [Director](https://github.com/flatiron/director), please refer to that PR.
+
+## Running tests
+
+For now you need to run three commands to execute all tests.
+
+Test the Node.js version:
+
+```
+npm test
+```
+
+Test the browser version with HTML5 routing:
+
+```
+npm run test-html5
+```
+
+Test the browser version with hash routing:
+
+```
+npm run test-hash
+```
+
+Note that the browser tests don't run automatically via Travis yet, they must be done manually.

package.json

@@ -22,6 +22,8 @@
   "devDependencies": {
     "api-easy": "^0.4.0",
     "colors": "^1.1.2",
+    "opn": "^4.0.2",
+    "opn-cli": "^3.1.0",
     "qunitjs": "^2.0.1",
     "request": "^2.79.0",
     "rollup": "^0.36.4",
@@ -42,6 +44,8 @@
   "scripts": {
     "test": "vows test/server/*/*-test.js --spec",
     "build": "rm -f build/** && rollup -c && rollup -c rollup.minify.config.js",
+    "test-html5": "node ./test/browser/backend/backend.js",
+    "test-hash": "opn ./test/browser/routes-harness.html",
     "preversion": "npm run -s build",
     "version": "git add -A build"
   }

test/browser/backend/backend.js

@@ -1,7 +1,8 @@
 var http     = require('http'),
   fs       = require('fs'),
   path     = require('path'),
-  director = require('../../../lib/tarantino'),
+  tarantino = require('../../../lib/tarantino'),
+  opn = require('opn'),
   index;
 
 fs.readFile(path.join(__dirname, '..', 'html5-routes-harness.html'), function (err, data) {
@@ -52,7 +53,7 @@ function fileServer(folder, file) {
   });
 }
 
-var router = new director.http.Router({
+var router = new tarantino.http.Router({
   '/files': {
     '/:folder': {
       '/(.+)': {
@@ -74,4 +75,8 @@ var server = http.createServer(function (req, res) {
   });
 });
 
-server.listen(8080);
+server.listen(8080, function () {
+  var url = 'http://localhost:8080/';
+  console.log('Open your browser on ' + url);
+  opn(url);
+});

test/browser/browserify-harness.html

@@ -1,5 +1,5 @@
-module("Director.js", {
-  setup: function() {
+QUnit.module("Director.js", {
+  beforeEach: function() {
     window.location.hash = "";
     shared = {};
     // Init needed keys earlier because of in HTML5 mode the route handler
@@ -10,7 +10,7 @@ module("Director.js", {
       shared.fired_count = 0;
     }
   },
-  teardown: function() {
+  afterEach: function() {
     window.location.hash = "";
     shared = {};
   }
@@ -21,28 +21,30 @@ var shared;
 function createTest(name, config, use, test, initialRoute) {
   // We rename to `RouterAlias` for the browserify tests, since we want to be
   // sure that no code is depending on `window.Router` being available.
-  var Router = window.Router || window.RouterAlias;
+  var Router = window.tarantino.Router;
 
   if (typeof use === 'function') {
     test = use;
     use = undefined;
   }
 
+  if (use === undefined) {
+    use = {};
+  }
   if (HTML5TEST) {
-    if (use === undefined) {
-      use = {};
-    }
 
     if (use.run_handler_in_init === undefined) {
       use.run_handler_in_init = false;
     }
-    use.html5history        = true;
+  } else {
+    use.html5history = false;
   }
 
   // Because of the use of setTimeout when defining onpopstate
   var innerTimeout = HTML5TEST === true ? 500 : 0;
 
-  asyncTest(name, function() {
+  QUnit.test(name, function(assert) {
+    var done = assert.async();
     setTimeout(function() {
       var router = new Router(config),
           context;
@@ -68,9 +70,9 @@ function createTest(name, config, use, test, initialRoute) {
           },
           finish: function() {
             router.destroy();
-            start();
+            done();
           }
-        })
+        }, assert)
       }, innerTimeout);
     }, 14);
   });