Add <History basename>

Fixes #2

Author: mjackson

modules/BrowserHistory.js

@@ -29,6 +29,7 @@ const getHistoryState = () => {
  */
 class BrowserHistory extends React.Component {
   static propTypes = {
+    basename: PropTypes.string,
     children: PropTypes.func.isRequired,
     keyLength: PropTypes.number
   }
@@ -278,11 +279,12 @@ class BrowserHistory extends React.Component {
   }
 
   render() {
-    const { children } = this.props
+    const { basename, children } = this.props
     const { action, location } = this.state
 
     return (
       <HistoryContext
+        basename={basename}
         children={children}
         action={action}
         location={location}

modules/HashHistory.js

@@ -57,6 +57,7 @@ const replaceHashPath = (path) => {
  */
 class HashHistory extends React.Component {
   static propTypes = {
+    basename: PropTypes.string,
     children: PropTypes.func.isRequired,
     hashType: PropTypes.oneOf(Object.keys(HashPathCoders))
   }
@@ -309,11 +310,12 @@ class HashHistory extends React.Component {
   }
 
   render() {
-    const { children } = this.props
+    const { basename, children } = this.props
     const { action, location } = this.state
 
     return (
       <HistoryContext
+        basename={basename}
         children={children}
         action={action}
         location={location}

modules/HistoryContext.js

@@ -6,11 +6,15 @@ import {
   location as locationType
 } from './PropTypes'
 
+const stripPrefix = (prefix, string) =>
+  string.indexOf(prefix) === 0 ? string.substring(prefix.length) : string
+
 /**
  * The common public API for all *History components.
  */
 class HistoryContext extends React.Component {
   static propTypes = {
+    basename: PropTypes.string,
     children: PropTypes.func.isRequired,
     action: actionType.isRequired,
     location: locationType.isRequired,
@@ -20,34 +24,42 @@ class HistoryContext extends React.Component {
     go: PropTypes.func.isRequired
   }
 
+  static defaultProps = {
+    basename: ''
+  }
+
   static childContextTypes = {
     history: historyContextType.isRequired
   }
 
   getChildContext() {
-    const { prompt, push, replace, go } = this.props
-
     return {
       history: {
-        prompt,
-        push,
-        replace,
-        go
+        prompt: this.props.prompt,
+        push: this.push,
+        replace: this.replace,
+        go: this.props.go
       }
     }
   }
 
+  push = (path, state) =>
+    this.props.push(this.props.basename + path, state)
+
+  replace = (path, state) =>
+    this.props.replace(this.props.basename + path, state)
+
   render() {
-    const { action, location } = this.props
+    const { basename, children, action, location } = this.props
 
     const { path, ...everythingElse } = location
     const { pathname, search, hash } = parsePath(path)
 
-    return this.props.children({
+    return children({
       action,
       location: {
         ...everythingElse,
-        pathname,
+        pathname: basename ? stripPrefix(basename, pathname) : pathname,
         search,
         hash
       }

modules/MemoryHistory.js

@@ -12,6 +12,7 @@ const clamp = (n, lowerBound, upperBound) =>
  */
 class MemoryHistory extends React.Component {
   static propTypes = {
+    basename: PropTypes.string,
     children: PropTypes.func.isRequired,
     initialEntries: PropTypes.array,
     initialIndex: PropTypes.number,
@@ -159,12 +160,13 @@ class MemoryHistory extends React.Component {
   }
 
   render() {
-    const { children } = this.props
+    const { basename, children } = this.props
     const { action, index, entries } = this.state
     const location = entries[index]
 
     return (
       <HistoryContext
+        basename={basename}
         children={children}
         action={action}
         location={location}

modules/__tests__/BrowserHistory-test.js

@@ -69,6 +69,29 @@ describe('BrowserHistory', () => {
     })
   })
 
+  describe('with a basename', () => {
+    describe('push', () => {
+      it('emits a new location', (done) => {
+        const children = RenderTestSequences.PushEmitsANewLocation(done)
+        render(<BrowserHistory basename="/base" children={children}/>, node)
+      })
+    })
+
+    describe('replace', () => {
+      it('emits a new location', (done) => {
+        const children = RenderTestSequences.ReplaceEmitsANewLocation(done)
+        render(<BrowserHistory basename="/base" children={children}/>, node)
+      })
+    })
+
+    describe('pop', () => {
+      it('emits a new location', (done) => {
+        const children = RenderTestSequences.PopEmitsANewLocation(done)
+        render(<BrowserHistory basename="/base" children={children}/>, node)
+      })
+    })
+  })
+
   describe('prompt', () => {
     it('blocks a push', (done) => {
       const children = RenderTestSequences.PromptBlocksAPush(done)

modules/__tests__/HashHistory-test.js

@@ -59,6 +59,29 @@ describe('HashHistory', () => {
     })
   })
 
+  describe('with a basename', () => {
+    describe('push', () => {
+      it('emits a new location', (done) => {
+        const children = RenderTestSequences.PushEmitsANewLocation(done)
+        render(<HashHistory basename="/base" children={children}/>, node)
+      })
+    })
+
+    describe('replace', () => {
+      it('emits a new location', (done) => {
+        const children = RenderTestSequences.ReplaceEmitsANewLocation(done)
+        render(<HashHistory basename="/base" children={children}/>, node)
+      })
+    })
+
+    describe('pop', () => {
+      it('emits a new location', (done) => {
+        const children = RenderTestSequences.PopEmitsANewLocation(done)
+        render(<HashHistory basename="/base" children={children}/>, node)
+      })
+    })
+  })
+
   describe('prompt', () => {
     it('blocks a push', (done) => {
       const children = RenderTestSequences.PromptBlocksAPush(done)

modules/__tests__/MemoryHistory-test.js

@@ -53,6 +53,29 @@ describe('MemoryHistory', () => {
     })
   })
 
+  describe('with a basename', () => {
+    describe('push', () => {
+      it('emits a new location', (done) => {
+        const children = RenderTestSequences.PushEmitsANewLocation(done)
+        render(<MemoryHistory basename="/base" children={children}/>, node)
+      })
+    })
+
+    describe('replace', () => {
+      it('emits a new location', (done) => {
+        const children = RenderTestSequences.ReplaceEmitsANewLocation(done)
+        render(<MemoryHistory basename="/base" children={children}/>, node)
+      })
+    })
+
+    describe('pop', () => {
+      it('emits a new location', (done) => {
+        const children = RenderTestSequences.PopEmitsANewLocation(done)
+        render(<MemoryHistory basename="/base" children={children}/>, node)
+      })
+    })
+  })
+
   describe('prompt', () => {
     it('blocks a push', (done) => {
       const children = RenderTestSequences.PromptBlocksAPush(done)