Update README

- add documentation of APIs

Author: jedirandy

.travis.yml

@@ -1,7 +1,10 @@
 language: node_js
 node_js:
   - "5"
+  - "6"
+  - "7"
 script:
   - npm run lint
+  - npm run test -- --single-run
   - npm run flow
-  - npm run build
+  - npm run build

LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2017 Sheng Ran
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,17 +1,27 @@
-# Redux simple router
-[![Build Status](https://travis-ci.org/jedirandy/redux-simple-router.svg?branch=master)](https://travis-ci.org/jedirandy/redux-simple-router)
+# redux-url
 
-A redux middleware that does one simple job: matches a route and dispatch an action.
+[![Build Status](https://travis-ci.org/jedirandy/redux-url.svg?branch=master)](https://travis-ci.org/jedirandy/redux-url)
+[![npm module](https://badge.fury.io/js/redux-url.svg)](https://www.npmjs.org/package/redux-url)
+
+A redux middleware that does one simple job: matches a url pattern and dispatch an action.
+
+## Install
+
+```
+npm install redux-url
+```
+
+[`history`](https://github.com/ReactTraining/history) is needed for it to work correctly.
 
 ## Usage
 
 ```javascript
 import createHistory from 'history/createBrowserHistory'; // choose a history implementation
 import { createStore, applyMiddleware } from 'redux';
-import { createRouter, navigate } from 'redux-simple-router';
+import { createRouter, navigate } from 'redux-url';
 
 const routes = {
-    '/': 'HOME', // when url is matched, will dispatch an action of type home, payload is the matched result
+    '/': 'HOME', // when url is matched, will dispatch an action of type 'HOME', the payload is the matched result
     '/todos/:id': ({ id }) => ({ type: 'CHANGE_TODO', payload: id }), // you can also pass a function to custom the action, the matched result will be passed in
     '*': 'NOT_FOUND'
 };
@@ -24,5 +34,39 @@ const store = createStore(
 
 store.dispatch(navigate(location.pathname, false)); // for state to be restored from URL when refreshed
 
-store.dispatch(navigate('/todos/123')); // change route
+store.dispatch(navigate('/todos/123')); // navigate to '/todos/123'
 ```
+
+## API
+
+* `createRouter(routes, history)`:
+
+  creates the middleware
+  - arguments
+    * routes (*object*) : URL patterns to be mapped, where values can be:
+      * string: when matched, an action will be dispatched of which the is the given string, the payload will be the matched result
+
+      * function: a function that takes the matched result and returns a
+
+    * history: the history object created from lib [`history`](https://github.com/ReactTraining/history),
+    such as `createBrowserHistory`
+
+  - returns
+
+    the middleware
+
+* `navigate(path: string, replace: *boolean* = false)`:
+
+  creates an action for going to the path, `replace` indicates whether it should modify the current history entry rather than push a new one
+
+* `goBack()`:
+
+  creates an action for going back
+
+* `goForward()`:
+
+  creates an action for going forward
+
+* `go(n)`:
+
+  creates an action for going n (can be negative) steps

karma.conf.js

@@ -0,0 +1,56 @@
+module.exports = function(config) {
+    config.set({
+        basePath: '.',
+        singleRun: false,
+        browsers: ['PhantomJS'],
+        frameworks: ['mocha', 'chai'],
+        files: [
+            'node_modules/babel-polyfill/dist/polyfill.js',
+            {
+                pattern: 'tests/*.spec.js',
+                watched: false,
+                served: true,
+                included: true
+            }
+        ],
+        preprocessors: {
+            'tests/*.js': ['webpack'],
+            'src/*.js': ['webpack']
+        },
+        webpack: {
+            module: {
+                loaders: [
+                    {
+                        test: /\.js$/,
+                        loader: 'babel-loader',
+                        query: {
+                            presets: ['es2015'],
+                            plugins: [
+                                'transform-object-rest-spread',
+                                'transform-class-properties',
+                                'transform-flow-strip-types'
+                            ]
+                        }
+                    }
+                ]
+            },
+            externals: {
+                'react/addons': true,
+                'react/lib/ExecutionEnvironment': true,
+                'react/lib/ReactContext': true
+            }
+        },
+        webpackMiddleware: {
+            noInfo: false,
+            stats: {
+                chunks: false
+            }
+        },
+        plugins: [
+            'karma-webpack',
+            'karma-mocha',
+            'karma-chai',
+            'karma-phantomjs-launcher'
+        ]
+    });
+};

package.json

@@ -1,13 +1,27 @@
 {
-  "name": "redux-simple-router",
+  "name": "redux-url",
   "version": "1.0.0",
   "main": "dist/index.js",
   "repository": {},
   "license": "MIT",
   "scripts": {
     "flow": "flow check src",
     "lint": "eslint src",
-    "build": "webpack"
+    "build": "webpack",
+    "test": "karma start"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jedirandy/redux-url.git"
+  },
+  "keywords": [
+    "redux",
+    "redux-middleware",
+    "middleware",
+    "url"
+  ],
+  "dependencies": {
+    "url-pattern": "^1.0.3"
   },
   "devDependencies": {
     "babel-core": "^6.23.1",
@@ -16,11 +30,24 @@
     "babel-plugin-transform-class-properties": "^6.23.0",
     "babel-plugin-transform-flow-strip-types": "^6.22.0",
     "babel-plugin-transform-object-rest-spread": "^6.23.0",
+    "babel-polyfill": "^6.23.0",
     "babel-preset-es2015": "^6.22.0",
+    "chai": "^3.5.0",
     "eslint": "^3.16.0",
     "eslint-plugin-react": "^6.10.0",
     "flow-bin": "^0.39.0",
-    "url-pattern": "^1.0.3",
+    "history": "^4.5.1",
+    "karma": "^1.5.0",
+    "karma-chai": "^0.1.0",
+    "karma-mocha": "^1.3.0",
+    "karma-phantomjs-launcher": "^1.0.2",
+    "karma-webpack": "^2.0.2",
+    "mocha": "^3.2.0",
+    "phantomjs-prebuilt": "^2.1.14",
+    "redux": "^3.6.0",
     "webpack": "^2.2.1"
+  },
+  "peerDependencies": {
+    "history": "^4.0.0"
   }
 }

src/index.js

@@ -1,5 +1,6 @@
 // @flow
 import UrlPattern from 'url-pattern';
+
 import type {
     Store,
     Routes,
@@ -8,7 +9,7 @@ import type {
     Action
 } from './types';
 
-const routerType = '@@redux-simple-router';
+const routerType = '@@redux-url';
 
 const createRouter = (routes: Routes, history: any) => {
     const patterns = Object.keys(routes).reduce((result, route) => ({
@@ -76,5 +77,6 @@ export {
     navigate,
     goBack,
     go,
-    goForward
+    goForward,
+    routerType
 };

tests/index.spec.js

@@ -0,0 +1,82 @@
+import { createRouter, navigate, goBack, goForward, go } from '../src/';
+import { createMemoryHistory } from 'history';
+import { createStore, applyMiddleware } from 'redux';
+
+describe('tests', () => {
+    const routes = {
+        '/': 'HOME',
+        '/todos/:id': ({ id }) => ({ type: 'CHANGE_TODO', payload: parseInt(id) }),
+        '*': 'NOT_FOUND'
+    }
+
+    const reducer = (state = {}, action) => {
+        switch (action.type) {
+            case 'HOME': 
+                return {
+                    page: 'HOME'
+                };
+            case 'CHANGE_TODO':
+                return {
+                    page: 'TODO',
+                    id: action.payload
+                };
+            case 'NOT_FOUND':
+                return {
+                    page: 'NOT_FOUND',
+                    url: action.payload._
+                }
+            default:
+                return state;
+        }
+    }
+
+    let store;
+    let history;
+    beforeEach(() => {
+        history = createMemoryHistory();
+        const router = createRouter(routes, history);
+        store = createStore(
+            reducer,
+            applyMiddleware(router)
+        );
+    });
+
+    it('navigate()', () => {
+        store.dispatch(navigate('/todos/123'));
+        expect(store.getState()).to.deep.equal({
+            page: 'TODO',
+            id: 123
+        });
+    });
+
+    it('navigate() with replace option on does not push a new state', () => {
+        expect(history.entries).to.have.length(1);
+        store.dispatch(navigate('/todos/123', true));
+        expect(history.entries).to.have.length(1);
+    });
+
+    it('goBack()', () => {
+        history.push('/1');
+        expect(history.index).to.equal(1);
+        store.dispatch(goBack());
+        expect(history.index).to.equal(0);
+    });
+
+    it('goForward()', () => {
+        history.push('/1');
+        expect(history.index).to.equal(1);
+        history.go(-1);
+        store.dispatch(goForward());
+        expect(history.index).to.equal(1);
+    });
+
+    it('go()', () => {
+        history.push('/1');
+        history.push('/2');
+        history.push('/3');
+        store.dispatch(go(-3));
+        expect(history.index).to.equal(0);
+        store.dispatch(go(2));
+        expect(history.index).to.equal(2);
+    });
+});

webpack.config.js

@@ -9,7 +9,7 @@ module.exports = {
     output: {
         path: path.resolve(__dirname, 'dist'),
         filename: '[name].js',
-        library: 'ReduxSimpleRouter',
+        library: 'ReduxURL',
         libraryTarget: 'umd'
     },
     module: {