refactor(StateQueueManager): convert to ES6 class

Author: christopherthielen

src/state/interface.ts

@@ -386,7 +386,7 @@ export interface StateDeclaration extends ViewDeclaration {
   /**
    * @deprecated define individual parameters as [[ParamDeclaration.dynamic]]
    */
-  reloadOnSearch: boolean;
+  reloadOnSearch?: boolean;
 }
 
 export interface StateParams {

src/state/state.ts

@@ -390,16 +390,14 @@ function $StateProvider(   $urlRouterProvider,   $urlMatcherFactoryProvider) {
 
     let $transitions: ITransitionService = <any> _$transition;
     // Implicit root state that is always active
-    let rootStateDef = {
+    let rootStateDef: StateDeclaration = {
       name: '',
       url: '^',
       views: null,
       params: {
         '#': { value: null, type: 'hash' }
       },
-      // params: [Param.fromPath('#', <Type> paramTypes.types.hash, { value: null })],
-      path: [],
-      'abstract': true
+      abstract: true
     };
     root = stateQueue.register(rootStateDef, true);
 

src/state/stateQueueManager.ts

@@ -2,73 +2,84 @@
 import {extend, inherit, isString, pluck, equalForKeys, abstractKey} from "../common/common";
 import {StateDeclaration} from "./interface";
 import {State} from "./module";
+import {StateBuilder} from "./stateBuilder";
+import {StateService} from "./interface";
 
-export function StateQueueManager(states, builder, $urlRouterProvider, $state) {
-  let queue = [];
+export class StateQueueManager {
+  queue: State[];
 
-  let queueManager = extend(this, {
-    register: function(config: StateDeclaration, pre?: boolean) {
-      // Wrap a new object around the state so we can store our private details easily.
-      // @TODO: state = new State(extend({}, config, { ... }))
-      let state = inherit(new State(), extend({}, config, {
-        self: config,
-        resolve: config.resolve || {},
-        toString: () => config.name
-      }));
+  constructor(
+      public states: { [key: string]: State; },
+      public builder: StateBuilder,
+      public $urlRouterProvider,
+      public $state: StateService) {
+    this.queue = [];
+  }
 
-      if (!isString(state.name)) throw new Error("State must have a valid name");
-      if (states.hasOwnProperty(state.name) || pluck(queue, 'name').indexOf(state.name) !== -1)
-        throw new Error(`State '${state.name}' is already defined`);
+  register(config: StateDeclaration, pre?: boolean) {
+    let {states, queue, $state} = this;
+    // Wrap a new object around the state so we can store our private details easily.
+    // @TODO: state = new State(extend({}, config, { ... }))
+    let state = inherit(new State(), extend({}, config, {
+      self: config,
+      resolve: config.resolve || {},
+      toString: () => config.name
+    }));
 
-      queue[pre ? "unshift" : "push"](state);
+    if (!isString(state.name)) throw new Error("State must have a valid name");
+    if (states.hasOwnProperty(state.name) || pluck(queue, 'name').indexOf(state.name) !== -1)
+      throw new Error(`State '${state.name}' is already defined`);
 
-      if (queueManager.autoFlush) {
-        queueManager.flush($state);
-      }
-      return state;
-    },
+    queue[pre ? "unshift" : "push"](state);
 
-    flush: function($state) {
-      let result, state, orphans = [], orphanIdx, previousQueueLength = {};
+    if (this.autoFlush) {
+      this.flush($state);
+    }
+    return state;
+  }
 
-      while (queue.length > 0) {
-        state = queue.shift();
-        result = builder.build(state);
-        orphanIdx = orphans.indexOf(state);
+  flush($state) {
+    let {queue, states, builder} = this;
+    let result, state, orphans = [], orphanIdx, previousQueueLength = {};
 
-        if (result) {
-          if (states.hasOwnProperty(state.name))
-            throw new Error(`State '${name}' is already defined`);
-          states[state.name] = state;
-          this.attachRoute($state, state);
-          if (orphanIdx >= 0) orphans.splice(orphanIdx, 1);
-          continue;
-        }
+    while (queue.length > 0) {
+      state = queue.shift();
+      result = builder.build(state);
+      orphanIdx = orphans.indexOf(state);
 
-        let prev = previousQueueLength[state.name];
-        previousQueueLength[state.name] = queue.length;
-        if (orphanIdx >= 0 && prev === queue.length) {
-          // Wait until two consecutive iterations where no additional states were dequeued successfully.
-          throw new Error(`Cannot register orphaned state '${state.name}'`);
-        } else if (orphanIdx < 0) {
-          orphans.push(state);
-        }
+      if (result) {
+        if (states.hasOwnProperty(state.name))
+          throw new Error(`State '${name}' is already defined`);
+        states[state.name] = state;
+        this.attachRoute($state, state);
+        if (orphanIdx >= 0) orphans.splice(orphanIdx, 1);
+        continue;
+      }
 
-        queue.push(state);
+      let prev = previousQueueLength[state.name];
+      previousQueueLength[state.name] = queue.length;
+      if (orphanIdx >= 0 && prev === queue.length) {
+        // Wait until two consecutive iterations where no additional states were dequeued successfully.
+        throw new Error(`Cannot register orphaned state '${state.name}'`);
+      } else if (orphanIdx < 0) {
+        orphans.push(state);
       }
-      return states;
-    },
 
-    autoFlush: false,
+      queue.push(state);
+    }
+    return states;
+  }
 
-    attachRoute: function($state, state) {
-      if (state[abstractKey] || !state.url) return;
+  autoFlush: boolean = false;
 
-      $urlRouterProvider.when(state.url, ['$match', '$stateParams', function ($match, $stateParams) {
-        if ($state.$current.navigable !== state || !equalForKeys($match, $stateParams)) {
-          $state.transitionTo(state, $match, { inherit: true, location: false });
-        }
-      }]);
-    }
-  });
+  attachRoute($state, state) {
+    let {$urlRouterProvider} = this;
+    if (state[abstractKey] || !state.url) return;
+
+    $urlRouterProvider.when(state.url, ['$match', '$stateParams', function ($match, $stateParams) {
+      if ($state.$current.navigable !== state || !equalForKeys($match, $stateParams)) {
+        $state.transitionTo(state, $match, { inherit: true, location: false });
+      }
+    }]);
+  }
 }