Accept objects in push and replace

remix-run · Nov 19, 2015 · 563b9eb · 563b9eb
1 parent 4125bff
commit 563b9eb
Show file tree

Hide file tree

Showing 8 changed files with 383 additions and 64 deletions.
diff --git a/modules/__tests__/describeBasename.js b/modules/__tests__/describeBasename.js
@@ -48,7 +48,7 @@ function describeBasename(createHistory) {
     })
 
     describe('in push', function () {
-      it('works', function (done) {
+      it('works with string', function (done) {
         let steps = [
           function (location) {
             expect(location.pathname).toEqual('/')
@@ -70,6 +70,32 @@ function describeBasename(createHistory) {
 
         unlisten = history.listen(execSteps(steps, done))
       })
+
+      it('works with object', function (done) {
+        let steps = [
+          function (location) {
+            expect(location.pathname).toEqual('/')
+            expect(location.search).toEqual('')
+            expect(location.state).toEqual(null)
+            expect(location.action).toEqual(POP)
+            expect(location.basename).toEqual('')
+
+            history.push({
+              pathname: '/home',
+              state: { the: 'state' }
+            })
+          },
+          function (location) {
+            expect(location.pathname).toEqual('/home')
+            expect(location.search).toEqual('')
+            expect(location.state).toEqual({ the: 'state' })
+            expect(location.action).toEqual(PUSH)
+            expect(location.basename).toEqual('/base/url')
+          }
+        ]
+
+        unlisten = history.listen(execSteps(steps, done))
+      })
     })
 
     describe('in replaceState', function () {
@@ -98,7 +124,7 @@ function describeBasename(createHistory) {
     })
 
     describe('in replace', function () {
-      it('works', function (done) {
+      it('works with string', function (done) {
         let steps = [
           function (location) {
             expect(location.pathname).toEqual('/')
@@ -120,6 +146,32 @@ function describeBasename(createHistory) {
 
         unlisten = history.listen(execSteps(steps, done))
       })
+
+      it('works with object', function (done) {
+        let steps = [
+          function (location) {
+            expect(location.pathname).toEqual('/')
+            expect(location.search).toEqual('')
+            expect(location.state).toEqual(null)
+            expect(location.action).toEqual(POP)
+            expect(location.basename).toEqual('')
+
+            history.replace({
+              pathname: '/home',
+              state: { the: 'state' }
+            })
+          },
+          function (location) {
+            expect(location.pathname).toEqual('/home')
+            expect(location.search).toEqual('')
+            expect(location.state).toEqual({ the: 'state' })
+            expect(location.action).toEqual(REPLACE)
+            expect(location.basename).toEqual('/base/url')
+          }
+        ]
+
+        unlisten = history.listen(execSteps(steps, done))
+      })
     })
 
     describe('in createPath', function () {

diff --git a/modules/__tests__/describePush.js b/modules/__tests__/describePush.js
@@ -15,25 +15,84 @@ function describePush(createHistory) {
         unlisten()
     })
 
-    it('calls change listeners with the new location', function (done) {
-      let steps = [
-        function (location) {
-          expect(location.pathname).toEqual('/')
-          expect(location.search).toEqual('')
-          expect(location.state).toEqual(null)
-          expect(location.action).toEqual(POP)
-
-          history.push('/home?the=query')
-        },
-        function (location) {
-          expect(location.pathname).toEqual('/home')
-          expect(location.search).toEqual('?the=query')
-          expect(location.state).toEqual(null)
-          expect(location.action).toEqual(PUSH)
-        }
-      ]
-
-      unlisten = history.listen(execSteps(steps, done))
+    describe('with a path string', function () {
+      it('calls change listeners with the new location', function (done) {
+        let steps = [
+          function (location) {
+            expect(location.pathname).toEqual('/')
+            expect(location.search).toEqual('')
+            expect(location.state).toEqual(null)
+            expect(location.action).toEqual(POP)
+
+            history.push('/home?the=query')
+          },
+          function (location) {
+            expect(location.pathname).toEqual('/home')
+            expect(location.search).toEqual('?the=query')
+            expect(location.state).toEqual(null)
+            expect(location.action).toEqual(PUSH)
+          }
+        ]
+
+        unlisten = history.listen(execSteps(steps, done))
+      })
+    })
+
+    describe('with a path object', function () {
+      it('calls change listeners with the new location', function (done) {
+        let steps = [
+          function (location) {
+            expect(location.pathname).toEqual('/')
+            expect(location.search).toEqual('')
+            expect(location.state).toEqual(null)
+            expect(location.action).toEqual(POP)
+
+            history.push({
+              pathname: '/home',
+              search: '?the=query',
+              state: { the: 'state' }
+            })
+          },
+          function (location) {
+            expect(location.pathname).toEqual('/home')
+            expect(location.search).toEqual('?the=query')
+            expect(location.state).toEqual({ the: 'state' })
+            expect(location.action).toEqual(PUSH)
+          }
+        ]
+
+        unlisten = history.listen(execSteps(steps, done))
+      })
+
+      it('correctly merges with old location', function (done) {
+        let oldLocation
+
+        let steps = [
+          function (location) {
+            expect(location.pathname).toEqual('/')
+            expect(location.search).toEqual('')
+            expect(location.state).toEqual(null)
+            expect(location.action).toEqual(POP)
+
+            oldLocation = location
+
+            history.push({
+              ...location,
+              search: '?the=query',
+              state: { the: 'state' }
+            })
+          },
+          function (location) {
+            expect(location.pathname).toEqual(oldLocation.pathname)
+            expect(location.search).toEqual('?the=query')
+            expect(location.state).toEqual({ the: 'state' })
+            expect(location.action).toEqual(PUSH)
+            expect(location.key).toNotEqual(oldLocation.key)
+          }
+        ]
+
+        unlisten = history.listen(execSteps(steps, done))
+      })
     })
   })
 }

diff --git a/modules/__tests__/describeQueries.js b/modules/__tests__/describeQueries.js
@@ -45,6 +45,35 @@ function describeQueries(createHistory) {
       })
     })
 
+    describe('in push', function () {
+      it('works', function (done) {
+        let steps = [
+          function (location) {
+            expect(location.pathname).toEqual('/')
+            expect(location.search).toEqual('')
+            expect(location.query).toEqual({})
+            expect(location.state).toEqual(null)
+            expect(location.action).toEqual(POP)
+
+            history.push({
+              pathname: '/home',
+              query: { the: 'query value' },
+              state: { the: 'state' }
+            })
+          },
+          function (location) {
+            expect(location.pathname).toEqual('/home')
+            expect(location.search).toEqual('?the=query+value')
+            expect(location.query).toEqual({ the: 'query value' })
+            expect(location.state).toEqual({ the: 'state' })
+            expect(location.action).toEqual(PUSH)
+          }
+        ]
+
+        unlisten = history.listen(execSteps(steps, done))
+      })
+    })
+
     describe('in replaceState', function () {
       it('works', function (done) {
         let steps = [
@@ -70,6 +99,35 @@ function describeQueries(createHistory) {
       })
     })
 
+    describe('in replace', function () {
+      it('works', function (done) {
+        let steps = [
+          function (location) {
+            expect(location.pathname).toEqual('/')
+            expect(location.search).toEqual('')
+            expect(location.query).toEqual({})
+            expect(location.state).toEqual(null)
+            expect(location.action).toEqual(POP)
+
+            history.replace({
+              pathname: '/home',
+              query: { the: 'query value' },
+              state: { the: 'state' }
+            })
+          },
+          function (location) {
+            expect(location.pathname).toEqual('/home')
+            expect(location.search).toEqual('?the=query+value')
+            expect(location.query).toEqual({ the: 'query value' })
+            expect(location.state).toEqual({ the: 'state' })
+            expect(location.action).toEqual(REPLACE)
+          }
+        ]
+
+        unlisten = history.listen(execSteps(steps, done))
+      })
+    })
+
     describe('in createPath', function () {
       it('works', function () {
         expect(
@@ -152,6 +210,35 @@ function describeQueries(createHistory) {
       })
     })
 
+    describe('in push', function () {
+      it('works', function (done) {
+        let steps = [
+          function (location) {
+            expect(location.pathname).toEqual('/')
+            expect(location.search).toEqual('')
+            expect(location.query).toEqual('PARSE_QUERY_STRING')
+            expect(location.state).toEqual(null)
+            expect(location.action).toEqual(POP)
+
+            history.push({
+              pathname: '/home',
+              query: { the: 'query' },
+              state: { the: 'state' }
+            })
+          },
+          function (location) {
+            expect(location.pathname).toEqual('/home')
+            expect(location.search).toEqual('?STRINGIFY_QUERY')
+            expect(location.query).toEqual('PARSE_QUERY_STRING')
+            expect(location.state).toEqual({ the: 'state' })
+            expect(location.action).toEqual(PUSH)
+          }
+        ]
+
+        unlisten = history.listen(execSteps(steps, done))
+      })
+    })
+
     describe('in replaceState', function () {
       it('works', function (done) {
         let steps = [
@@ -177,6 +264,35 @@ function describeQueries(createHistory) {
       })
     })
 
+    describe('in replace', function () {
+      it('works', function (done) {
+        let steps = [
+          function (location) {
+            expect(location.pathname).toEqual('/')
+            expect(location.search).toEqual('')
+            expect(location.query).toEqual('PARSE_QUERY_STRING')
+            expect(location.state).toEqual(null)
+            expect(location.action).toEqual(POP)
+
+            history.replace({
+              pathname: '/home',
+              query: { the: 'query' },
+              state: { the: 'state' }
+            })
+          },
+          function (location) {
+            expect(location.pathname).toEqual('/home')
+            expect(location.search).toEqual('?STRINGIFY_QUERY')
+            expect(location.query).toEqual('PARSE_QUERY_STRING')
+            expect(location.state).toEqual({ the: 'state' })
+            expect(location.action).toEqual(REPLACE)
+          }
+        ]
+
+        unlisten = history.listen(execSteps(steps, done))
+      })
+    })
+
     describe('in createPath', function () {
       it('works', function () {
         expect(