tests and refactoring for AngularRouteBuilder

.dockerignore

@@ -18,4 +18,5 @@ htmlcov
 .coverage
 coverage
 .cache
+.npm-debug.log
 test/__pycache__

.gitignore

@@ -21,3 +21,4 @@ coverage
 htmlcov
 .tox
 .cache
+.npm-debug.log

karma.conf.js

@@ -8,7 +8,6 @@ module.exports = function (config) {
       'node_modules/angular/angular.js',
       'node_modules/angular-animate/angular-animate.js',
       'node_modules/angular-cookies/angular-cookies.js',
-      'node_modules/angular-md5/angular-md5.js',
       'node_modules/angular-mocks/angular-mocks.js',
       'node_modules/angular-route/angular-route.js',
       'node_modules/angular-sanitize/angular-sanitize.js',

static/js/angular-route-builder.js

@@ -1,38 +0,0 @@
-var AngularRouteBuilder = function(routeProvider, pages, profiles, currentProfile) {
-  this.routeProvider = routeProvider;
-  this.pages = pages;
-  this.profiles = profiles;
-
-  for (var i = 0; i < profiles.length; ++i) {
-    var current = profiles[i];
-    if (current.id == currentProfile) {
-      this.profiles = this.profiles.slice(i);
-      break;
-    }
-  }
-};
-
-AngularRouteBuilder.prototype.otherwise = function(options) {
-  this.routeProvider.otherwise(options);
-};
-
-AngularRouteBuilder.prototype.route = function(path, pagename) {
-  // Lookup the page, matching our lists of profiles.
-  var pair = this.pages.get(pagename, this.profiles);
-  if (!pair) {
-    throw Error('Unknown page: ' + pagename);
-  }
-
-  // Create the route.
-  var foundProfile = pair[0];
-  var page = pair[1];
-  var templateUrl = foundProfile.templatePath + page.templateName;
-
-  var options = jQuery.extend({}, page.flags || {});
-  options['templateUrl'] = templateUrl;
-  options['reloadOnSearch'] = false;
-  options['controller'] = page.controller;
-
-  this.routeProvider.when(path, options);
-  return this;
-};

static/js/app.js

@@ -90,7 +90,8 @@ quayApp.config(['$compileProvider', function ($compileProvider) {
 }]);
 
 // Configure the routes.
-quayApp.config(['$routeProvider', '$locationProvider', 'pages', function($routeProvider, $locationProvider, pages) {
+quayApp.config(['$routeProvider', '$locationProvider', 'pages', 'RouteBuilderProvider',
+  function($routeProvider, $locationProvider, pages, RouteBuilderProvider) {
   $locationProvider.html5Mode(true);
 
   // WARNING WARNING WARNING
@@ -101,7 +102,7 @@ quayApp.config(['$routeProvider', '$locationProvider', 'pages', function($routeP
   var layoutProfile = 'layout';
   window.console.log('Using layout profile: ' + layoutProfile);
 
-  var routeBuilder = new AngularRouteBuilder($routeProvider, pages, [
+  var routeBuilder = new RouteBuilderProvider.$get()($routeProvider, pages, [
     // Start with the old pages (if we asked for it).
     {id: 'old-layout', templatePath: '/static/partials/'},
 

static/js/route-builder/route-builder.js

@@ -0,0 +1,57 @@
+(function() {
+  'use strict';
+
+  angular
+    .module("quay")
+    .factory('RouteBuilder', factory);
+
+  factory.$inject = [
+
+  ];
+
+  function factory() {
+    function RouteBuilder(routeProvider, pages, profiles, currentProfile) {
+      this.routeProvider = routeProvider;
+      this.pages = pages;
+      this.profiles = profiles;
+
+      for (var i = 0; i < profiles.length; ++i) {
+        if (profiles[i].id == currentProfile) {
+          this.profiles = this.profiles.slice(i);
+          break;
+        }
+      }
+    }
+
+    RouteBuilder.prototype.otherwise = function(options) {
+      this.routeProvider.otherwise(options);
+    };
+
+    RouteBuilder.prototype.route = function(path, pagename) {
+      // Lookup the page, matching our lists of profiles.
+      var pair = this.pages.get(pagename, this.profiles);
+      if (!pair) {
+        throw Error('Unknown page: ' + pagename);
+      }
+
+      // Create the route.
+      var foundProfile = pair[0];
+      var page = pair[1];
+      var templateUrl = foundProfile.templatePath + page.templateName;
+
+      var options = jQuery.extend({}, page.flags || {});
+      options['templateUrl'] = templateUrl;
+      options['reloadOnSearch'] = false;
+      options['controller'] = page.controller;
+
+      this.routeProvider.when(path, options);
+
+      return this;
+    };
+
+    return function(routeProvider, pages, profiles, currentProfile) {
+      return new RouteBuilder(routeProvider, pages, profiles, currentProfile);
+    }
+  }
+
+})();

static/js/route-builder/route-builder.spec.js

@@ -0,0 +1,120 @@
+describe("Service: RouteBuilder", function() {
+  var RouteBuilder;
+  var routeProviderMock;
+  var pagesMock;
+  var profiles;
+  var currentProfile;
+
+  beforeEach(module('quay'));
+
+  beforeEach(inject(function($injector) {
+    profiles = [
+      {id: 'old-layout', templatePath: '/static/partials/'},
+      {id: 'layout', templatePath: '/static/partials/'}
+    ];
+    currentProfile = 'layout';
+    routeProviderMock = jasmine.createSpyObj('routeProvider', ['otherwise', 'when']);
+    pagesMock = jasmine.createSpyObj('pagesMock', ['get', 'create']);
+    RouteBuilder = $injector.get('RouteBuilder');
+  }));
+
+  describe("constructor", function() {
+
+    it("returns a RouteBuilder object", function() {
+      var routeBuilder = new RouteBuilder(routeProviderMock, pagesMock, profiles, currentProfile);
+
+      expect(routeBuilder).toBeDefined();
+    });
+
+    it("initializes dependencies", function() {
+      var routeBuilder = new RouteBuilder(routeProviderMock, pagesMock, profiles, currentProfile);
+
+      expect(routeBuilder.routeProvider).toEqual(routeProviderMock);
+      expect(routeBuilder.pages).toEqual(pagesMock);
+      expect(routeBuilder.profiles).toBeDefined();
+    });
+
+    it("sets 'profiles' to all given profiles if given current profile does not match any of the given profiles' id", function() {
+      var routeBuilder = new RouteBuilder(routeProviderMock, pagesMock, profiles, 'fake-profile');
+
+      expect(routeBuilder.profiles).toEqual(profiles);
+    });
+
+    it("sets 'profiles' to the first given profile with id matching given current profile", function() {
+      var routeBuilder = new RouteBuilder(routeProviderMock, pagesMock, profiles, currentProfile);
+
+      expect(routeBuilder.profiles).toEqual([profiles[1]]);
+    });
+  });
+
+  describe("otherwise", function() {
+    var routeBuilder;
+
+    beforeEach(function() {
+      routeBuilder = new RouteBuilder(routeProviderMock, pagesMock, profiles, currentProfile);
+    });
+
+    it("calls routeProvider to set fallback route with given options", function() {
+      var options = {1: "option"};
+      routeBuilder.otherwise(options);
+
+      expect(routeProviderMock.otherwise.calls.argsFor(0)[0]).toEqual(options);
+    });
+  });
+
+  describe("route", function() {
+    var routeBuilder;
+    var path;
+    var pagename;
+    var page;
+
+    beforeEach(function() {
+      path = '/repository/:namespace/:name';
+      pagename = 'repo-view';
+      page = {
+        templateName: 'repository.html',
+        reloadOnSearch: false,
+        controller: jasmine.createSpy('pageController'),
+        flags: {},
+      };
+      routeBuilder = new RouteBuilder(routeProviderMock, pagesMock, profiles, currentProfile);
+    });
+
+    it("calls pages with given pagename and 'profiles' to get matching page and profile pair", function() {
+      pagesMock.get.and.returnValue([profiles[1], page]);
+      routeBuilder.route(path, pagename);
+
+      expect(pagesMock.get.calls.argsFor(0)[0]).toEqual(pagename);
+      expect(pagesMock.get.calls.argsFor(0)[1]).toEqual(routeBuilder.profiles);
+    });
+
+    it("throws error if no matching page/profile pair found", function() {
+      pagesMock.get.and.returnValue();
+      try {
+        routeBuilder.route(path, pagename);
+        fail();
+      } catch (error) {
+        expect(error.message).toEqual('Unknown page: ' + pagename);
+      }
+    });
+
+    it("calls routeProvider to set route for given path and options", function() {
+      pagesMock.get.and.returnValue([profiles[1], page]);
+      var expectedOptions = {
+        templateUrl: profiles[1].templatePath + page.templateName,
+        reloadOnSearch: false,
+        controller: page.controller,
+      };
+      routeBuilder.route(path, pagename);
+
+      expect(routeProviderMock.when.calls.argsFor(0)[0]).toEqual(path);
+      expect(routeProviderMock.when.calls.argsFor(0)[1]).toEqual(expectedOptions);
+    });
+
+    it("returns itself (the RouteBuilder instance)", function() {
+      pagesMock.get.and.returnValue([profiles[1], page]);
+
+      expect(routeBuilder.route(path, pagename)).toEqual(routeBuilder);
+    });
+  });
+});