Allow relative pathnames

Fixes #135
remix-run · Sep 29, 2016 · 445ce3e · 445ce3e
1 parent 264d558
commit 445ce3e
Show file tree

Hide file tree

Showing 11 changed files with 85 additions and 14 deletions.
diff --git a/modules/LocationUtils.js b/modules/LocationUtils.js
@@ -1,6 +1,7 @@
+import resolvePathname from 'resolve-pathname'
 import { parsePath } from './PathUtils'
 
-export const createLocation = (path, state, key) => {
+export const createLocation = (path, state, key, currentLocation) => {
   let location
   if (typeof path === 'string') {
     // Two-arg form: push(path, state)
@@ -33,6 +34,15 @@ export const createLocation = (path, state, key) => {
 
   location.key = key
 
+  if (currentLocation) {
+    // Resolve incomplete/relative pathname relative to current location.
+    if (!location.pathname) {
+      location.pathname = currentLocation.pathname
+    } else if (location.pathname.charAt(0) !== '/') {
+      location.pathname = resolvePathname(location.pathname, currentLocation.pathname)
+    }
+  }
+
   return location
 }
 

diff --git a/modules/__tests__/BrowserHistory-test.js b/modules/__tests__/BrowserHistory-test.js
@@ -53,6 +53,12 @@ describeHistory('a browser history', () => {
       })
     })
 
+    describe('push with a relative pathname', () => {
+      it('calls change listeners with the normalized location', (done) => {
+        TestSequences.PushRelativePathname(history, done)
+      })
+    })
+
     describe('replace a new path', () => {
       it('calls change listeners with the new location', (done) => {
         TestSequences.ReplaceNewLocation(history, done)

diff --git a/modules/__tests__/HashHistory-test.js b/modules/__tests__/HashHistory-test.js
@@ -56,6 +56,12 @@ describeHistory('a hash history', () => {
       })
     })
 
+    describe('push with a relative pathname', () => {
+      it('calls change listeners with the normalized location', (done) => {
+        TestSequences.PushRelativePathname(history, done)
+      })
+    })
+
     describe('replace a new path', () => {
       it('calls change listeners with the new location', (done) => {
         TestSequences.ReplaceNewLocation(history, done)

diff --git a/modules/__tests__/MemoryHistory-test.js b/modules/__tests__/MemoryHistory-test.js
@@ -44,6 +44,12 @@ describe('a memory history', () => {
       })
     })
 
+    describe('push with a relative pathname', () => {
+      it('calls change listeners with the normalized location', (done) => {
+        TestSequences.PushRelativePathname(history, done)
+      })
+    })
+
     describe('replace a new path', () => {
       it('calls change listeners with the new location', (done) => {
         TestSequences.ReplaceNewLocation(history, done)

diff --git a/modules/__tests__/TestSequences/PushMissingPathname.js b/modules/__tests__/TestSequences/PushMissingPathname.js
@@ -8,18 +8,25 @@ export default (history, done) => {
         pathname: '/'
       })
 
-      history.push({
-        search: 'the=query',
-        hash: 'the-hash'
-      })
+      history.push('/home?the=query#the-hash')
     },
     (location, action) => {
       expect(action).toBe('PUSH')
       expect(location).toMatch({
-        pathname: '',
+        pathname: '/home',
         search: '?the=query',
         hash: '#the-hash'
       })
+
+      history.push('?another=query#another-hash')
+    },
+    (location, action) => {
+      expect(action).toBe('PUSH')
+      expect(location).toMatch({
+        pathname: '/home',
+        search: '?another=query',
+        hash: '#another-hash'
+      })
     }
   ]
 

diff --git a/modules/__tests__/TestSequences/PushRelativePathname.js b/modules/__tests__/TestSequences/PushRelativePathname.js
@@ -0,0 +1,34 @@
+import expect from 'expect'
+import execSteps from './execSteps'
+
+export default (history, done) => {
+  const steps = [
+    (location) => {
+      expect(location).toMatch({
+        pathname: '/'
+      })
+
+      history.push('/the/path?the=query#the-hash')
+    },
+    (location, action) => {
+      expect(action).toBe('PUSH')
+      expect(location).toMatch({
+        pathname: '/the/path',
+        search: '?the=query',
+        hash: '#the-hash'
+      })
+
+      history.push('../other/path?another=query#another-hash')
+    },
+    (location, action) => {
+      expect(action).toBe('PUSH')
+      expect(location).toMatch({
+        pathname: '/other/path',
+        search: '?another=query',
+        hash: '#another-hash'
+      })
+    }
+  ]
+
+  execSteps(steps, history, done)
+}
diff --git a/modules/__tests__/TestSequences/index.js b/modules/__tests__/TestSequences/index.js
@@ -17,6 +17,7 @@ export PushSamePath from './PushSamePath'
 export PushSamePathWarning from './PushSamePathWarning'
 export PushState from './PushState'
 export PushStateWarning from './PushStateWarning'
+export PushRelativePathname from './PushRelativePathname'
 export ReplaceNewLocation from './ReplaceNewLocation'
 export ReplaceSamePath from './ReplaceSamePath'
 export ReplaceState from './ReplaceState'

diff --git a/modules/createBrowserHistory.js b/modules/createBrowserHistory.js
@@ -146,7 +146,7 @@ const createBrowserHistory = (props = {}) => {
     )
 
     const action = 'PUSH'
-    const location = createLocation(path, state, createKey())
+    const location = createLocation(path, state, createKey(), history.location)
 
     transitionManager.confirmTransitionTo(location, action, getUserConfirmation, (ok) => {
       if (!ok)
@@ -188,7 +188,7 @@ const createBrowserHistory = (props = {}) => {
     )
 
     const action = 'REPLACE'
-    const location = createLocation(path, state, createKey())
+    const location = createLocation(path, state, createKey(), history.location)
 
     transitionManager.confirmTransitionTo(location, action, getUserConfirmation, (ok) => {
       if (!ok)

diff --git a/modules/createHashHistory.js b/modules/createHashHistory.js
@@ -173,7 +173,7 @@ const createHashHistory = (props = {}) => {
     )
 
     const action = 'PUSH'
-    const location = createLocation(path)
+    const location = createLocation(path, undefined, undefined, history.location)
 
     transitionManager.confirmTransitionTo(location, action, getUserConfirmation, (ok) => {
       if (!ok)
@@ -215,7 +215,7 @@ const createHashHistory = (props = {}) => {
     )
 
     const action = 'REPLACE'
-    const location = createLocation(path)
+    const location = createLocation(path, undefined, undefined, history.location)
 
     transitionManager.confirmTransitionTo(location, action, getUserConfirmation, (ok) => {
       if (!ok)

diff --git a/modules/createMemoryHistory.js b/modules/createMemoryHistory.js
@@ -47,7 +47,7 @@ const createMemoryHistory = (props = {}) => {
     )
 
     const action = 'PUSH'
-    const location = createLocation(path, state, createKey())
+    const location = createLocation(path, state, createKey(), history.location)
 
     transitionManager.confirmTransitionTo(location, action, getUserConfirmation, (ok) => {
       if (!ok)
@@ -80,7 +80,7 @@ const createMemoryHistory = (props = {}) => {
     )
 
     const action = 'REPLACE'
-    const location = createLocation(path, state, createKey())
+    const location = createLocation(path, state, createKey(), history.location)
 
     transitionManager.confirmTransitionTo(location, action, getUserConfirmation, (ok) => {
       if (!ok)

diff --git a/package.json b/package.json
@@ -18,8 +18,9 @@
   },
   "dependencies": {
     "invariant": "^2.2.1",
-    "warning": "^3.0.0",
-    "loose-envify": "^1.2.0"
+    "loose-envify": "^1.2.0",
+    "resolve-pathname": "^2.0.0",
+    "warning": "^3.0.0"
   },
   "devDependencies": {
     "babel-cli": "^6.10.1",