refactor(update): Update to Cycle Unified

Author: ntilwalli

README.md

@@ -1,7 +1,7 @@
 # cyclic-router
 cyclic-router is a Router Driver built for Cycle.js
 
-**Disclaimer** v2.x.x and v3 are for Cycle Diversity!
+**Disclaimer** Use v4 for Cycle Unified. v2.x.x is for Cycle and v3 is for Cycle Diversity.  
 If you are still using @cycle/core please continue to use v1.x.x
 
 ## Installation
@@ -10,7 +10,7 @@ Using [npm](https://www.npmjs.com/):
 
     $ npm install --save cyclic-router
 
-Version 3 requires users to inject the route matcher.  We'll use `switch-path` for our examples but other
+Versions 3 and 4 requires users to inject the route matcher.  We'll use `switch-path` for our examples but other
 matching libraries could be adapted to be used here:
 
     $ npm install --save switch-path

package.json

@@ -18,14 +18,13 @@
   },
   "homepage": "https://github.com/TylorS/cyclic-router#readme",
   "dependencies": {
-    "@cycle/history": "^4.0.0",
-    "history": "^3.0.0"
+    "@cycle/history": "^6.1.0",
+    "@types/history": "^4.5.0",
+    "history": "^4.5.0",
+    "@cycle/run": "^3.0.0"
   },
   "devDependencies": {
-    "@cycle/base": "^4.0.0",
-    "@cycle/rx-adapter": "^3.0.0",
-    "@cycle/rxjs-adapter": "^3.0.0",
-    "@cycle/xstream-adapter": "^3.0.1",
+    "@cycle/rxjs-run": "^6.1.0",
     "assert": "^1.4.1",
     "babel-preset-es2015": "^6.16.0",
     "babel-register": "^6.18.0",
@@ -35,15 +34,14 @@
     "ghooks": "^1.2.1",
     "mkdirp": "^0.5.1",
     "mocha": "^2.5.3",
-    "rx": "^4.1.0",
-    "rxjs": "^5.0.0-beta.8",
+    "rxjs": "^5.2.0",
     "testem": "^1.10.4",
     "tslint": "^3.10.2",
     "typescript": "^2.0.7",
     "typings": "^0.8.1",
     "uglify-js": "^2.7.1",
     "validate-commit-message": "^3.0.1",
-    "xstream": "^7.0.0",
+    "xstream": "^10.3.0",
     "switch-path": "^1.1.8"
   },
   "config": {

src/RouterSource.ts

@@ -1,7 +1,8 @@
-import {StreamAdapter} from '@cycle/base';
-import {Location, Pathname} from '@cycle/history/lib/interfaces';
+import {Location, Pathname} from '@cycle/history';
+import {LocationDescriptorObject} from 'history';
 import {RouteDefinitionsMap, RouteDefinitionsArray, RouteMatcher} from './interfaces';
 import * as util from './util';
+import {adapt} from '@cycle/run/lib/adapt';
 
 function isStrictlyInScope(namespace: Pathname[], path: Pathname): boolean {
   const pathParts = util.splitPath(path);
@@ -16,36 +17,40 @@ function getFilteredPath(namespace: Pathname[], path: Pathname): Pathname {
 }
 
 export class RouterSource {
-  constructor(public history$: any,
+  constructor(private _history$: any,
               private _namespace: Pathname[],
-              private _createHref: (path: Pathname) => Pathname,
-              private _runSA: StreamAdapter,
+              private _createHref: (path: LocationDescriptorObject) => Pathname,
               private _routeMatcher: RouteMatcher) {}
 
+  history$ = adapt(this._history$);
+
   path(pathname: Pathname): RouterSource {
     const scopedNamespace = this._namespace.concat(util.splitPath(pathname));
-    const scopedHistory$ = this._runSA.remember(this.history$
-      .filter(({pathname: _path}: Location) => isStrictlyInScope(scopedNamespace, _path)));
+    const scopedHistory$ = this._history$
+      .filter(({pathname: _path}: Location) => isStrictlyInScope(scopedNamespace, _path))
+      .remember();
 
     const createHref = this._createHref;
-    return new RouterSource(scopedHistory$, scopedNamespace, createHref, this._runSA, this._routeMatcher);
+    return new RouterSource(scopedHistory$, scopedNamespace, createHref, this._routeMatcher);
   }
 
   define(routes: RouteDefinitionsMap | RouteDefinitionsArray, routeMatcher?: RouteMatcher): any {
     const namespace = this._namespace;
     const _createHref = this._createHref;
     const createHref = util.makeCreateHref(namespace, _createHref);
 
-    let match$ = this._runSA.remember(this.history$
+    let match$ = this._history$
       .map((location: Location) => {
         const matcher = routeMatcher || this._routeMatcher;
         const filteredPath = getFilteredPath(namespace, location.pathname);
         const {path, value} = matcher(filteredPath, routes);
         return {path, value, location, createHref};
-      }));
+      })
+      .remember();
 
-    match$.createHref = createHref;
-    return match$;
+    const out$ = adapt(match$);
+    out$.createHref = createHref;
+    return out$;
   }
 
   createHref(path: Pathname): Pathname {

src/index.ts

@@ -1,6 +1 @@
 export {makeRouterDriver} from './makeRouterDriver';
-export {
-  supportsHistory,
-  createLocation,
-  createServerHistory,
-} from '@cycle/history'

src/makeRouterDriver.ts

@@ -1,8 +1,7 @@
-import {StreamAdapter} from '@cycle/base';
 import {makeHistoryDriver} from '@cycle/history';
-import {History, HistoryDriverOptions} from '@cycle/history/lib/interfaces';
 import {RouteMatcher} from './interfaces';
 import {RouterSource} from './RouterSource';
+import {History} from '@types/history';
 
 /**
  * Instantiates an new router driver function using the same arguments required
@@ -11,8 +10,11 @@ import {RouterSource} from './RouterSource';
  * @method makeRouterDriver
  * @return {routerDriver} The router driver function
  */
-function makeRouterDriver(history: History, routeMatcher: RouteMatcher, options?: HistoryDriverOptions) {
-  const historyDriver = makeHistoryDriver(history, options);
+function makeRouterDriver(history: History, routeMatcher: RouteMatcher) {
+  if (!history) {
+    throw new Error('Cyclic router must be given a history object');
+  }
+  const historyDriver = makeHistoryDriver(history);
   /**
    * The actual router driver.
    * @public
@@ -23,9 +25,9 @@ function makeRouterDriver(history: History, routeMatcher: RouteMatcher, options?
    * history driver would expect.
    * @return {routerAPI}
    */
-  return function routerDriver(sink$: any, runSA: StreamAdapter) {
-    const history$ = runSA.remember(historyDriver(sink$, runSA));
-    return new RouterSource(history$, [], history.createHref, runSA, routeMatcher);
+  return function routerDriver(sink$: any) {
+    const history$ = historyDriver(sink$).remember();
+    return new RouterSource(history$, [], history.createHref, routeMatcher);
   };
 }
 

src/util.ts

@@ -1,4 +1,5 @@
-import {Pathname} from '@cycle/history/lib/interfaces';
+import {Pathname} from '@cycle/history';
+import {LocationDescriptorObject} from 'history';
 
 function splitPath(path: Pathname): Pathname[] {
   return path.split('/').filter(p => p.length > 0);
@@ -13,7 +14,7 @@ const startsWith = (param: string, value: string) => param[0] === value;
 const startsWith2 = (param: string, value1: string, value2: string) =>
   param[0] === value1 && param[1] === value2;
 
-function makeCreateHref(namespace: Pathname[], _createHref: (pathname: Pathname) => Pathname) {
+function makeCreateHref(namespace: Pathname[], _createHref: (pathname: LocationDescriptorObject) => Pathname) {
   /**
    * Function used to create HREFs that are properly namespaced
    * @typedef {createHref}
@@ -24,11 +25,28 @@ function makeCreateHref(namespace: Pathname[], _createHref: (pathname: Pathname)
    * @return {string} a fully qualified HREF composed from the current
    * namespace and the path provided
    */
-  return function createHref(path: Pathname): Pathname {
-    const fullPath = `${namespace.join('/')}${path}`;
-    return startsWith(fullPath, '/') || startsWith2(fullPath, '#', '/')
-      ? _createHref(fullPath)
-      : _createHref('/' + fullPath);
+  return function createHref(location: Pathname | LocationDescriptorObject): Pathname {
+    if (typeof location === 'object' && location !== null) {
+      const fullPath = `${namespace.join('/')}${location.pathname}`;
+      return startsWith(fullPath, '/') || startsWith2(fullPath, '#', '/')
+        ? _createHref({
+            ...location,
+            pathname: fullPath,
+          })
+        : _createHref({
+            ...location,
+            pathname: '/' + fullPath
+          });
+    } else if (typeof location === 'string') {
+      const fullPath = `${namespace.join('/')}${location}`;
+      return startsWith(fullPath, '/') || startsWith2(fullPath, '#', '/')
+        ? _createHref({
+            pathname: fullPath
+          })
+        : _createHref({
+            pathname: '/' + fullPath
+          });
+    }
   };
 }
 

test/index.js

@@ -1,3 +1,2 @@
-import './rx';
 import './rxjs';
 import './xstream';