refactor(vanilla): Rename from history to location

Author: christopherthielen

src/vanilla/hashHistory.ts renamed to src/vanilla/hashLocation.ts

@@ -1,12 +1,11 @@
 import {services, isDefined} from '../common/module';
 import {LocationConfig, LocationServices} from '../common/coreservices';
-import {HistoryImplementation} from './interface';
 import {splitHash, splitQuery, trimHashVal, getParams} from './utils';
 
 let hashPrefix: string = '';
 let baseHref: string = '';
 
-const locationServiceConfig: LocationConfig = {
+export const hashLocationConfig: LocationConfig = {
   port: () =>
     parseInt(location.port),
   protocol: () =>
@@ -23,9 +22,9 @@ const locationServiceConfig: LocationConfig = {
     }
     return hashPrefix;
   }
-}
+};
 
-const locationService: LocationServices = {
+export const hashLocationService: LocationServices = {
   hash: () =>
       splitHash(trimHashVal(location.hash))[1],
   path: () =>
@@ -36,9 +35,4 @@ const locationService: LocationServices = {
     if (url) location.hash = url;
   },
   onChange: (cb: EventListener) => window.addEventListener("hashchange", cb, false) as any
-}
-
-export const hashHistory: HistoryImplementation = {
-  service: locationService,
-  configuration: locationServiceConfig
-}
+};

src/vanilla/index.ts

@@ -1,38 +1,37 @@
 /**
  * Naive, pure JS implementation of core ui-router services
  *
- * @module vanilla
+ * @internalapi @module vanilla
  */ /** */
 import { UIRouter } from "../router";
 
-import { services as coreservices } from "../common/coreservices";
+import { services, LocationServices, LocationConfig } from "../common/coreservices";
+import { LocationPlugin, ServicesPlugin } from "./interface";
+import { extend } from "../common/common";
+import { hashLocationService, hashLocationConfig } from "./hashLocation";
+import { pushStateLocationService, pushStateLocationConfig } from "./pushStateLocation";
 import { $q } from "./$q";
 import { $injector } from "./$injector";
-import { hashHistory } from "./hashHistory";
-import { browserHistory } from "./browserHistory";
-import { HistoryImplementationPlugin, ServicesPlugin, HistoryImplementation } from "./interface";
-import { extend } from "../common/common";
 
-export { $q, $injector, hashHistory, browserHistory };
+export { $q, $injector };
 
-export function services(router: UIRouter): ServicesPlugin {
-  coreservices.$injector = $injector;
-  coreservices.$q = $q;
+export function servicesPlugin(router: UIRouter): ServicesPlugin {
+  services.$injector = $injector;
+  services.$q = $q;
 
   return { name: "vanilla.services", $q, $injector };
 }
 
-const HistoryImplementationPluginFactory = (name: string, historyImpl: HistoryImplementation) =>
+const locationPluginFactory = (name: string, service: LocationServices, configuration: LocationConfig) =>
     (router: UIRouter) => {
-      const { service, configuration } = historyImpl;
-      extend(coreservices.location, service);
-      extend(coreservices.locationConfig, configuration);
-
+      extend(services.location, service);
+      extend(services.locationConfig, configuration);
       return { name, service, configuration };
     };
 
-export const hashLocation: (router: UIRouter) => HistoryImplementationPlugin =
-    HistoryImplementationPluginFactory("vanilla.hashBangLocation", hashHistory);
-export const pushStateLocation: (router: UIRouter) => HistoryImplementationPlugin =
-    HistoryImplementationPluginFactory("vanilla.pushStateLocation", browserHistory);
+export const hashLocationPlugin: (router: UIRouter) => LocationPlugin =
+    locationPluginFactory("vanilla.hashBangLocation", hashLocationService, hashLocationConfig);
+
+export const pushStateLocationPlugin: (router: UIRouter) => LocationPlugin =
+    locationPluginFactory("vanilla.pushStateLocation", pushStateLocationService, pushStateLocationConfig);
 

src/vanilla/interface.ts

@@ -2,15 +2,11 @@ import { LocationConfig, LocationServices } from '../common/coreservices';
 import { UIRouterPlugin } from "../interface";
 import { $InjectorLike, $QLike } from "../common/module";
 
-export interface HistoryImplementation {
+export interface LocationPlugin extends UIRouterPlugin {
   service: LocationServices;
   configuration: LocationConfig;
 }
 
-export interface HistoryImplementationPlugin extends UIRouterPlugin, HistoryImplementation {
-
-}
-
 export interface ServicesPlugin extends UIRouterPlugin {
   $q: $QLike,
   $injector: $InjectorLike

src/vanilla/browserHistory.ts renamed to src/vanilla/pushStateLocation.ts

@@ -1,12 +1,11 @@
 import { services, isDefined } from '../common/module';
 import { LocationConfig, LocationServices } from '../common/coreservices';
-import { HistoryImplementation } from './interface';
 import { splitQuery, trimHashVal, getParams } from './utils';
 
 let hashPrefix: string = '';
 let baseHref: string = '';
 
-const locationServiceConfig: LocationConfig = {
+export const pushStateLocationConfig: LocationConfig = {
   port: () =>
       parseInt(location.port),
   protocol: () =>
@@ -25,7 +24,7 @@ const locationServiceConfig: LocationConfig = {
   }
 };
 
-const locationService: LocationServices = {
+export const pushStateLocationService: LocationServices = {
   hash: () =>
       trimHashVal(location.hash),
   path: () => {
@@ -45,8 +44,3 @@ const locationService: LocationServices = {
   },
   onChange: (cb: EventListener) => window.addEventListener("popstate", cb, false) as any
 };
-
-export const browserHistory: HistoryImplementation = {
-  service: locationService,
-  configuration: locationServiceConfig
-};

test/hookBuilderSpec.ts

@@ -16,8 +16,8 @@ describe('HookBuilder:', function() {
   beforeEach(() => {
     log = "";
     uiRouter = new UIRouter();
-    uiRouter.plugin(vanilla.services);
-    uiRouter.plugin(vanilla.hashLocation);
+    uiRouter.plugin(vanilla.servicesPlugin);
+    uiRouter.plugin(vanilla.hashLocationPlugin);
 
     $trans = uiRouter.transitionService;
     $state = uiRouter.stateService;

test/lazyLoadSpec.ts

@@ -20,8 +20,8 @@ describe('future state', function () {
 
   beforeEach(() => {
     router = new UIRouter();
-    router.plugin(vanilla.services);
-    router.plugin(vanilla.hashLocation);
+    router.plugin(vanilla.servicesPlugin);
+    router.plugin(vanilla.hashLocationPlugin);
     $registry = router.stateRegistry;
     $state = router.stateService;
     $transitions = router.transitionService;

test/pluginSpec.ts

@@ -14,8 +14,8 @@ describe('plugin api', function () {
 
   beforeEach(() => {
     router = new UIRouter();
-    router.plugin(vanilla.services);
-    router.plugin(vanilla.hashLocation);
+    router.plugin(vanilla.servicesPlugin);
+    router.plugin(vanilla.hashLocationPlugin);
     $registry = router.stateRegistry;
     $state = router.stateService;
     $transitions = router.transitionService;

test/resolveSpec.ts

@@ -63,8 +63,8 @@ function getStates() {
 
 beforeEach(function () {
   router = new UIRouter();
-  router.plugin(vanilla.services);
-  router.plugin(vanilla.hashLocation);
+  router.plugin(vanilla.servicesPlugin);
+  router.plugin(vanilla.hashLocationPlugin);
   router.stateRegistry.stateQueue.autoFlush(router.stateService);
 
   counts = { _J: 0, _J2: 0, _K: 0, _L: 0, _M: 0, _Q: 0 };

test/stateServiceSpec.ts

@@ -28,8 +28,8 @@ describe('stateService', function () {
 
   beforeEach(() => {
     router = new UIRouter();
-    router.plugin(vanilla.services);
-    router.plugin(vanilla.hashLocation);
+    router.plugin(vanilla.servicesPlugin);
+    router.plugin(vanilla.hashLocationPlugin);
     $loc = services.location;
     $state = router.stateService;
     $registry = router.stateRegistry;

test/transitionSpec.ts

@@ -30,8 +30,8 @@ describe('transition', function () {
 
   beforeEach(() => {
     router = new UIRouter();
-    router.plugin(vanilla.services);
-    router.plugin(vanilla.hashLocation);
+    router.plugin(vanilla.servicesPlugin);
+    router.plugin(vanilla.hashLocationPlugin);
     $state = router.stateService;
     $transitions = router.transitionService;
     router.stateRegistry.stateQueue.autoFlush($state);

test/vanilla.browserHistorySpec.ts

@@ -19,8 +19,8 @@ describe('browserHistory implementation', () => {
 
   beforeEach(() => {
     router = new UIRouter();
-    router.plugin(vanilla.services);
-    router.plugin(vanilla.pushStateLocation);
+    router.plugin(vanilla.servicesPlugin);
+    router.plugin(vanilla.pushStateLocationPlugin);
     router.stateRegistry.stateQueue.autoFlush(router.stateService);
     makeMatcher = (url, config?) => {
       return new UrlMatcher(url, router.urlMatcherFactory.paramTypes, config)

test/vanilla.hashHistorySpec.ts

@@ -10,8 +10,8 @@ describe('hashHistory implementation', () => {
 
   beforeEach(() => {
     router = new UIRouter();
-    router.plugin(vanilla.services);
-    router.plugin(vanilla.hashLocation);
+    router.plugin(vanilla.servicesPlugin);
+    router.plugin(vanilla.hashLocationPlugin);
     $state = router.stateService;
     router.stateRegistry.stateQueue.autoFlush($state);