refactor(UrlRule): Change match and handler params from (path, search, query) to (urlService)

Author: christopherthielen

package.json

@@ -9,6 +9,7 @@
     "test": "karma start",
     "watch": "run-p watch:*",
     "watch:buildjs": "tsc -w",
+    "watch:buildesm": "tsc -w -m es6 --outDir lib-esm",
     "watch:test": "karma start --singleRun=false --autoWatch=true --autoWatchInterval=1",
     "debug": "karma start --singleRun=false --autoWatch=true --autoWatchInterval=1 --browsers=Chrome"
   },

src/url/interface.ts

@@ -2,6 +2,8 @@ import { LocationConfig } from "../common/coreservices";
 import { Obj } from "../common/common";
 import { ParamType } from "../params/type";
 import { Param } from "../params/param";
+import { UrlService } from "./urlService";
+import { UIRouter } from "../router";
 
 export interface ParamFactory {
   /** Creates a new [[Param]] from a CONFIG block */
@@ -21,14 +23,26 @@ export interface UrlMatcherConfig {
   paramType(name, type?)
 }
 
-/** @return truthy or falsey */
+/**
+ * A function that matches the URL for a [[UrlRule]]
+ *
+ * Implementations should match against the current
+ * [[UrlService.path]], [[UrlService.search]], and [[UrlService.hash]]
+ *
+ * @return truthy or falsey
+ */
 export interface UrlRuleMatchFn {
-  (path: string, search: Obj, hash: string): any;
+  (urlService?: UrlService, router?: UIRouter): any;
 }
 
-/** Handler invoked when a rule is matched */
+/**
+ * Handler invoked when a rule is matched
+ *
+ * The matched value from the rule's [[UrlRuleMatchFn]] is passed as the first argument
+ * The handler should return a string (to redirect), or void
+ */
 export interface UrlRuleHandlerFn {
-  (matchObject: any, path?: string, search?: Obj, hash?: string): (string|boolean|void);
+  (matchValue?: any, urlService?: UrlService, router?: UIRouter): (string|void);
 }
 
 export type UrlRuleType = "STATE" | "URLMATCHER" | "STRING" | "REGEXP" | "RAW" | "OTHER";

src/url/urlRouter.ts

@@ -72,16 +72,14 @@ export class UrlRouter implements Disposable {
   sync(evt?) {
     if (evt && evt.defaultPrevented) return;
 
-    let $url = this._router.urlService;
-    let path = $url.path(),
-        search = $url.search(),
-        hash = $url.hash();
+    let router = this._router;
+    let $url = router.urlService;
 
     function check(rule: UrlRule) {
-      let match = rule && rule.match(path, search, hash);
+      let match = rule && rule.match($url, router);
       if (!match) return false;
 
-      let result = rule.handler(match, path, search, hash);
+      let result = rule.handler(match, $url, router);
       if (isString(result)) $url.url(result, true);
       return true;
     }

src/url/urlRule.ts

@@ -8,6 +8,7 @@ import { RawParams } from "../params/interface";
 import { UrlRule, UrlRuleMatchFn, UrlRuleHandlerFn, UrlRuleType } from "./interface";
 import { StateService } from "../state/stateService";
 import { UIRouterGlobals } from "../globals";
+import { UrlService } from "./urlService";
 
 /**
  * Creates a [[UrlRule]]
@@ -113,8 +114,8 @@ export class RegExpRule implements UrlRule {
           newurl.replace(/\$(\$|\d{1,2})/, (m, what) =>
               match[what === '$' ? 0 : Number(what)]);
 
-  match(path: string): RegExpExecArray {
-    return this.regexp.exec(path);
+  match($url: UrlService): RegExpExecArray {
+    return this.regexp.exec($url.path());
   }
 }
 
@@ -168,8 +169,8 @@ export class UrlMatcherRule implements UrlRule {
       (match: RawParams) =>
           newurl.format(match);
 
-  match = (path: string, search: any, hash: string) =>
-      this.urlMatcher.exec(path, search, hash);
+  match = ($url: UrlService) =>
+      this.urlMatcher.exec($url.path(), $url.search(), $url.hash());
 }
 
 /**
@@ -193,8 +194,8 @@ export class StateUrlRule implements UrlRule {
     this.$state = router.stateService;
   }
 
-  match = (path: string, search: any, hash: string) =>
-      this.state.url.exec(path, search, hash);
+  match = ($url: UrlService) =>
+      this.state.url.exec($url.path(), $url.search(), $url.hash());
 
   /**
    * Checks if the router should start a new transition.
@@ -210,7 +211,6 @@ export class StateUrlRule implements UrlRule {
     if (this.shouldTransition(match)) {
       this.$state.transitionTo(this.state, match, { inherit: true, source: "url" });
     }
-    return true;
   };
 }
 

test/urlRouterSpec.ts

@@ -26,7 +26,7 @@ describe("UrlRouter", function () {
 
   beforeEach(function () {
     let rule1 = $ur.urlRuleFactory.fromRegExp(/\/baz/, "/b4z");
-    let rule1b = $ur.urlRuleFactory.fromMatchFn(path => /baz/.test(path) && path.replace('baz', 'b4z'));
+    // let rule1 = $ur.urlRuleFactory.fromMatchFn($url => /baz/.test($url.path()) && $url.path().replace('baz', 'b4z'));
     $ur.addRule(rule1);
 
     $ur.when('/foo/:param', function ($match) {