refactor(url): Move coreservices.location to router.urlService

Author: christopherthielen

src/common/coreservices.ts

@@ -7,7 +7,7 @@
 /** for typedoc */
 import {IInjectable, Obj} from "./common";
 
-let notImplemented = (fnname: string) => () => {
+export let notImplemented = (fnname: string) => () => {
   throw new Error(`${fnname}(): No coreservices implementation for UI-Router is loaded.`);
 };
 

src/hooks/lazyLoad.ts

@@ -36,15 +36,16 @@ const lazyLoadHook: TransitionHookFn = (transition: Transition) => {
 
   function retryOriginalTransition() {
     if (transitionSource(transition) === 'url') {
-      let $loc = services.location,
+      let $loc = transition.router.urlService,
+          $reg = transition.router.stateRegistry,
           path = $loc.path(),
           search = $loc.search(),
           hash = $loc.hash();
 
       let matchState = state =>
           [state, state.url && state.url.exec(path, search, hash)];
 
-      let matches = transition.router.stateRegistry.get()
+      let matches = $reg.get()
           .map(s => s.$$state())
           .map(matchState)
           .filter(([state, params]) => !!params);

src/router.ts

@@ -13,6 +13,8 @@ import { UIRouterGlobals, Globals } from "./globals";
 import { UIRouterPlugin, Disposable } from "./interface";
 import { values, removeFrom } from "./common/common";
 import { isFunction } from "./common/predicates";
+import { UrlService } from "./url/urlService";
+import { services, LocationServices, LocationConfig } from "./common/coreservices";
 
 /** @hidden */
 let _routerInstance = 0;
@@ -48,6 +50,14 @@ export class UIRouter {
 
   stateService = new StateService(this);
 
+  get urlService(): LocationServices {
+    return services.location;
+  }
+
+  get urlConfig(): LocationConfig {
+    return services.locationConfig;
+  }
+
   private _disposables: Disposable[] = [];
 
   /** Registers an object to be notified when the router is disposed */

src/url/urlRouter.ts

@@ -40,31 +40,6 @@ function appendBasePath(url: string, isHtml5: boolean, absolute: boolean): strin
   return url;
 }
 
-// TODO: Optimize groups of rules with non-empty prefix into some sort of decision tree
-/** @hidden */
-function update(rules: Function[], otherwiseFn: Function, evt?: any) {
-  if (evt && evt.defaultPrevented) return;
-  let $loc = services.location;
-
-  function check(rule: Function) {
-    let handled = rule(services.$injector, $loc);
-
-    if (!handled) return false;
-    if (isString(handled)) {
-      $loc.setUrl(handled, true);
-    }
-    return true;
-  }
-  let n = rules.length;
-
-  for (let i = 0; i < n; i++) {
-    if (check(rules[i])) return;
-  }
-  // always check otherwise last to allow dynamic updates to the set of rules
-  if (otherwiseFn) check(otherwiseFn);
-}
-
-
 /**
  * Manages rules for client-side URL
  *
@@ -346,8 +321,28 @@ export class UrlRouter implements Disposable {
    * });
    * ```
    */
-  sync() {
-    update(this.urlRouterProvider.rules, this.urlRouterProvider.otherwiseFn);
+  sync(evt?) {
+    if (evt && evt.defaultPrevented) return;
+    let $loc = services.location;
+    let rules = this.urlRouterProvider.rules;
+    let otherwiseFn = this.urlRouterProvider.otherwiseFn;
+
+    function check(rule: Function) {
+      let handled = rule(services.$injector, $loc);
+
+      if (!handled) return false;
+      if (isString(handled)) {
+        $loc.setUrl(handled, true);
+      }
+      return true;
+    }
+    let n = rules.length;
+
+    for (let i = 0; i < n; i++) {
+      if (check(rules[i])) return;
+    }
+    // always check otherwise last to allow dynamic updates to the set of rules
+    if (otherwiseFn) check(otherwiseFn);
   }
 
   /**
@@ -357,7 +352,7 @@ export class UrlRouter implements Disposable {
    * This causes [[UrlRouter]] to start listening for changes to the URL, if it wasn't already listening.
    */
   listen(): Function {
-    return this.listener = this.listener || services.location.onChange(evt => update(this.urlRouterProvider.rules, this.urlRouterProvider.otherwiseFn, evt));
+    return this.listener = this.listener || services.location.onChange(evt => this.sync(evt));
   }
 
   /**

src/url/urlService.ts

@@ -0,0 +1,63 @@
+/** @module url */ /** */
+
+import { UIRouter } from "../router";
+import { LocationServices, notImplemented, LocationConfig } from "../common/coreservices";
+import { noop, createProxyFunctions } from "../common/common";
+
+/** @hidden */
+const makeStub = (keys: string[]): any =>
+    keys.reduce((acc, key) => (acc[key] = notImplemented(key), acc), { dispose: noop });
+
+/** @hidden */
+const locationServicesFns = ["setUrl", "path", "search", "hash", "onChange"];
+/** @hidden */
+const locationConfigFns = ["port", "protocol", "host", "baseHref", "html5Mode", "hashPrefix"];
+
+/**
+ * Service methods related to URL management
+ *
+ * This class delegates to other URL services.
+ *
+ * - [[LocationService]]: Framework specific code to interact with the browser URL
+ * - [[LocationConfig]]: Framework specific code to interact with the browser URL
+ * - [[UrlMatcherFactory]]:
+ * - [[UrlRouter]]:
+ */
+export class UrlService implements LocationServices {
+  /** @hidden */
+  static locationServiceStub: LocationServices = makeStub(locationServicesFns);
+  /** @hidden */
+  static locationConfigStub: LocationConfig = makeStub(locationConfigFns);
+
+  /** @inheritdoc */
+  setUrl(newurl: string, replace?: boolean): void { return };
+  /** @inheritdoc */
+  path(): string { return };
+  /** @inheritdoc */
+  search(): { [key: string]: any } { return };
+  /** @inheritdoc */
+  hash(): string { return };
+  /** @inheritdoc */
+  onChange(callback: Function): Function { return };
+
+  dispose() { }
+
+  /**
+   * The [[LocationConfig]] service
+   *
+   * This object returns information about the location (url) configuration.
+   * This information can be used to build absolute URLs, such as
+   * `https://example.com:443/basepath/state/substate?param1=a#hashvalue`;
+   */
+  config: LocationConfig;
+
+  constructor(router: UIRouter) {
+    this.config = {} as any;
+    // proxy function calls from UrlService to the LocationService/LocationConfig
+    const svc = () => router.locationService;
+    createProxyFunctions(svc, this, svc, locationServicesFns);
+
+    const cfg = () => router.locationConfig;
+    createProxyFunctions(cfg, this.config, cfg, locationConfigFns);
+  }
+}