navigation-stack 0.5.2 → 0.6.0

package/test/{redux/middleware/createProgrammaticNavigationBlockerMiddleware.test.js → NavigationStack.blockProgrammaticNavigationIfRequired.test.js}

@@ -1,42 +1,34 @@
 import delay from 'delay';
 import pDefer from 'p-defer';
-import { applyMiddleware, createStore } from 'redux';
 
-import addNavigationBlockerOriginal from '../../../src/addNavigationBlocker';
-import Actions from '../../../src/redux/Actions';
-import createMiddlewares from '../../../src/redux/createMiddlewares';
-import internalLocationReducer from '../../../src/redux/internalLocationReducer';
-import InMemorySession from '../../../src/session/InMemorySession';
-import { shouldWarn } from '../../testUtil';
+import shouldWarn from './shouldWarn';
+import NavigationStack from '../src/NavigationStack';
+import addNavigationBlockerOriginal from '../src/addNavigationBlocker';
+import InMemoryEnvironment from '../src/environment/InMemoryEnvironment';
 
-describe('createProgrammaticNavigationBlockerMiddleware', () => {
+describe('NavigationStack (blockProgrammaticNavigationIfRequired)', () => {
   // const sandbox = sinon.createSandbox();
 
   let session;
-  let store;
+  let navigationStack;
 
   function addNavigationBlocker(blocker) {
     return addNavigationBlockerOriginal(session, blocker);
   }
 
   beforeEach(() => {
-    session = new InMemorySession();
-
-    store = createStore(
-      internalLocationReducer,
-      applyMiddleware(
-        ...createMiddlewares(session, {
-          _internalLocationReducer: true,
-        }),
-      ),
-    );
-    store.dispatch(Actions.init('/initial'));
-
-    sinon.spy(session.lifecycle, 'addTerminationBlocker');
+    navigationStack = new NavigationStack(InMemoryEnvironment);
+
+    // eslint-disable-next-line no-underscore-dangle
+    session = navigationStack._session;
+
+    navigationStack.init('/initial');
+
+    sinon.spy(session.environment.lifecycle, 'addTerminationBlocker');
   });
 
   afterEach(() => {
-    store.dispatch(Actions.stop());
+    navigationStack.stop();
 
     // sandbox.restore();
   });
@@ -46,8 +38,8 @@ describe('createProgrammaticNavigationBlockerMiddleware', () => {
       const blocker = sinon.stub().returns(true);
       addNavigationBlocker(blocker);
 
-      store.dispatch(Actions.push('/new'));
-      expect(store.getState().pathname).to.equal('/initial');
+      navigationStack.push('/new');
+      expect(navigationStack.current().pathname).to.equal('/initial');
 
       expect(blocker).to.have.been.calledOnce();
 
@@ -60,8 +52,8 @@ describe('createProgrammaticNavigationBlockerMiddleware', () => {
     it('should allow navigation when blocker returns `undefined`', () => {
       addNavigationBlocker(() => undefined);
 
-      store.dispatch(Actions.push('/new'));
-      expect(store.getState().pathname).to.equal('/new');
+      navigationStack.push('/new');
+      expect(navigationStack.current().pathname).to.equal('/new');
     });
 
     it("should fall through when first blocker doesn't return `true`", () => {
@@ -71,8 +63,8 @@ describe('createProgrammaticNavigationBlockerMiddleware', () => {
       addNavigationBlocker(blocker1);
       addNavigationBlocker(blocker2);
 
-      store.dispatch(Actions.push('/new'));
-      expect(store.getState().pathname).to.equal('/initial');
+      navigationStack.push('/new');
+      expect(navigationStack.current().pathname).to.equal('/initial');
 
       expect(blocker1).to.have.been.calledOnce();
       expect(blocker2).to.have.been.calledOnce();
@@ -85,8 +77,8 @@ describe('createProgrammaticNavigationBlockerMiddleware', () => {
       addNavigationBlocker(blocker1);
       addNavigationBlocker(blocker2);
 
-      store.dispatch(Actions.push('/new'));
-      expect(store.getState().pathname).to.equal('/initial');
+      navigationStack.push('/new');
+      expect(navigationStack.current().pathname).to.equal('/initial');
 
       expect(blocker1).to.have.been.calledOnce();
       expect(blocker2).not.to.have.been.called();
@@ -103,8 +95,8 @@ describe('createProgrammaticNavigationBlockerMiddleware', () => {
 
       addNavigationBlocker(syncBlocker);
 
-      store.dispatch(Actions.push('/new'));
-      expect(store.getState().pathname).to.equal('/new');
+      navigationStack.push('/new');
+      expect(navigationStack.current().pathname).to.equal('/new');
     });
 
     // it('should show a confirmation dialog and allow navigation on string', () => {
@@ -112,8 +104,8 @@ describe('createProgrammaticNavigationBlockerMiddleware', () => {
     //
     //   addNavigationBlocker(({ pathname }) => pathname);
     //
-    //   store.dispatch(Actions.push('/new'));
-    //   expect(store.getState().pathname).to.equal('/new');
+    //   navigationStack.push('/new'));
+    //   expect(navigationStack.current().pathname).to.equal('/new');
     //
     //   expect(window.confirm)
     //     .to.have.been.calledOnce()
@@ -125,8 +117,8 @@ describe('createProgrammaticNavigationBlockerMiddleware', () => {
     //
     //   addNavigationBlocker(({ pathname }) => pathname);
     //
-    //   store.dispatch(Actions.push('/new'));
-    //   expect(store.getState().pathname).to.equal('/initial');
+    //   navigationStack.push('/new'));
+    //   expect(navigationStack.current().pathname).to.equal('/initial');
     //
     //   expect(window.confirm)
     //     .to.have.been.calledOnce()
@@ -137,26 +129,26 @@ describe('createProgrammaticNavigationBlockerMiddleware', () => {
       const navigationBlockerDeferred = pDefer();
       addNavigationBlocker(() => navigationBlockerDeferred.promise);
 
-      store.dispatch(Actions.push('/new'));
-      expect(store.getState().pathname).to.equal('/initial');
+      navigationStack.push('/new');
+      expect(navigationStack.current().pathname).to.equal('/initial');
 
       navigationBlockerDeferred.resolve(undefined);
       await delay(10);
 
-      expect(store.getState().pathname).to.equal('/new');
+      expect(navigationStack.current().pathname).to.equal('/new');
     });
 
     it('should block navigation when blocker returns `true` (async)', async () => {
       const navigationBlockerDeferred = pDefer();
       addNavigationBlocker(() => navigationBlockerDeferred.promise);
 
-      store.dispatch(Actions.push('/new'));
-      expect(store.getState().pathname).to.equal('/initial');
+      navigationStack.push('/new');
+      expect(navigationStack.current().pathname).to.equal('/initial');
 
       navigationBlockerDeferred.resolve(true);
       await delay(10);
 
-      expect(store.getState().pathname).to.equal('/initial');
+      expect(navigationStack.current().pathname).to.equal('/initial');
     });
 
     it('should allow chaining async blockers', async () => {
@@ -166,18 +158,18 @@ describe('createProgrammaticNavigationBlockerMiddleware', () => {
       addNavigationBlocker(() => navigationBlockerDeferred1.promise);
       addNavigationBlocker(() => navigationBlockerDeferred2.promise);
 
-      store.dispatch(Actions.push('/new'));
-      expect(store.getState().pathname).to.equal('/initial');
+      navigationStack.push('/new');
+      expect(navigationStack.current().pathname).to.equal('/initial');
 
       navigationBlockerDeferred1.resolve(undefined);
       await delay(10);
 
-      expect(store.getState().pathname).to.equal('/initial');
+      expect(navigationStack.current().pathname).to.equal('/initial');
 
       navigationBlockerDeferred2.resolve(undefined);
       await delay(10);
 
-      expect(store.getState().pathname).to.equal('/new');
+      expect(navigationStack.current().pathname).to.equal('/new');
     });
 
     it('should warn on and ignore async blockers that throw an error', async () => {
@@ -192,24 +184,24 @@ describe('createProgrammaticNavigationBlockerMiddleware', () => {
 
       addNavigationBlocker(asyncBlocker);
 
-      store.dispatch(Actions.push('/new'));
-      expect(store.getState().pathname).to.equal('/initial');
+      navigationStack.push('/new');
+      expect(navigationStack.current().pathname).to.equal('/initial');
 
       await delay(10);
 
-      expect(store.getState().pathname).to.equal('/new');
+      expect(navigationStack.current().pathname).to.equal('/new');
     });
 
     it('should allow removing blockers', () => {
       const removeNavigationBlocker = addNavigationBlocker(() => true);
 
-      store.dispatch(Actions.push('/new'));
-      expect(store.getState().pathname).to.equal('/initial');
+      navigationStack.push('/new');
+      expect(navigationStack.current().pathname).to.equal('/initial');
 
       removeNavigationBlocker();
 
-      store.dispatch(Actions.push('/new'));
-      expect(store.getState().pathname).to.equal('/new');
+      navigationStack.push('/new');
+      expect(navigationStack.current().pathname).to.equal('/new');
     });
   });
 });
@@ -218,43 +210,46 @@ describe('addTerminationBlocker', () => {
   // const sandbox = sinon.createSandbox();
 
   let session;
-  let store;
+  let navigationStack;
 
   function addNavigationBlocker(blocker) {
     return addNavigationBlockerOriginal(session, blocker);
   }
 
   beforeEach(() => {
-    session = new InMemorySession();
+    navigationStack = new NavigationStack(InMemoryEnvironment);
+
+    // eslint-disable-next-line no-underscore-dangle
+    session = navigationStack._session;
 
-    store = createStore(
-      internalLocationReducer,
-      applyMiddleware(...createMiddlewares(session)),
-    );
-    store.dispatch(Actions.init('/initial'));
+    navigationStack.init('/initial');
 
-    sinon.spy(session.lifecycle, 'addTerminationBlocker');
+    sinon.spy(session.environment.lifecycle, 'addTerminationBlocker');
 
     // sandbox.stub(window, 'addEventListener');
     // sandbox.stub(window, 'removeEventListener');
   });
 
   afterEach(() => {
-    if (store) {
-      store.dispatch(Actions.stop());
+    if (navigationStack) {
+      navigationStack.stop();
     }
 
     // sandbox.restore();
   });
 
   it('should add/remove event blocker', () => {
-    expect(session.lifecycle.addTerminationBlocker).not.to.have.been.called();
+    expect(
+      session.environment.lifecycle.addTerminationBlocker,
+    ).not.to.have.been.called();
     // expect(window.addEventListener).not.to.have.been.called();
 
     const removeNavigationBlocker1 = addNavigationBlocker(() => null, {
       beforeUnload: true,
     });
-    expect(session.lifecycle.addTerminationBlocker).to.have.been.calledOnce();
+    expect(
+      session.environment.lifecycle.addTerminationBlocker,
+    ).to.have.been.calledOnce();
     // expect(window.addEventListener)
     //   .to.have.been.calledOnce()
     //   .and.to.have.been.called.with('beforeunload');
@@ -262,7 +257,9 @@ describe('addTerminationBlocker', () => {
     const removeNavigationBlocker2 = addNavigationBlocker(() => null, {
       beforeUnload: true,
     });
-    expect(session.lifecycle.addTerminationBlocker).to.have.been.calledOnce();
+    expect(
+      session.environment.lifecycle.addTerminationBlocker,
+    ).to.have.been.calledOnce();
     // expect(window.addEventListener)
     //   .to.have.been.calledOnce()
     //   .and.to.have.been.called.with('beforeunload');
@@ -282,6 +279,39 @@ describe('addTerminationBlocker', () => {
     expect(removeTerminationBlocker).to.have.been.calledOnce();
   });
 
+  // it('should not add a global "before destroy" listener when no `beforeTermination` blocker has been added', () => {
+  //   const removeNavigationBlocker = addNavigationBlocker(() => null);
+  //   expect(window.addEventListener).not.to.have.been.called();
+  //
+  //   removeNavigationBlocker();
+  //   expect(window.removeEventListener).not.to.have.been.called();
+  // });
+});
+
+describe('NavigationStack (blockProgrammaticNavigationIfRequired) (stop)', () => {
+  let session;
+  let navigationStack;
+
+  function addNavigationBlocker(blocker) {
+    return addNavigationBlockerOriginal(session, blocker);
+  }
+
+  beforeEach(() => {
+    navigationStack = new NavigationStack(InMemoryEnvironment);
+
+    // eslint-disable-next-line no-underscore-dangle
+    session = navigationStack._session;
+
+    navigationStack.init('/initial');
+
+    sinon.spy(session.environment.lifecycle, 'addTerminationBlocker');
+  });
+
+  afterEach(() => {
+    // Don't call `navigationStack.stop()` here because it was already stopped in the test case.
+    // navigationStack.stop();
+  });
+
   it('should remove event blocker on stop', () => {
     addNavigationBlocker(() => null);
 
@@ -292,21 +322,11 @@ describe('addTerminationBlocker', () => {
     // expect(window.removeEventListener).not.to.have.been.called();
     expect(removeTerminationBlocker).not.to.have.been.called();
 
-    store.dispatch(Actions.stop());
-    // Prevent `store.dispatch(Actions.stop())` in `afterEach()`.
-    store = undefined;
+    navigationStack.stop();
 
     // expect(window.removeEventListener)
     //   .to.have.been.calledOnce()
     //   .and.to.have.been.called.with('beforeunload');
     expect(removeTerminationBlocker).to.have.been.calledOnce();
   });
-
-  // it('should not add a global "before destroy" listener when no `beforeTermination` blocker has been added', () => {
-  //   const removeNavigationBlocker = addNavigationBlocker(() => null);
-  //   expect(window.addEventListener).not.to.have.been.called();
-  //
-  //   removeNavigationBlocker();
-  //   expect(window.removeEventListener).not.to.have.been.called();
-  // });
 });

package/test/NavigationStack.general.test.js

@@ -0,0 +1,68 @@
+import NavigationStack from '../src/NavigationStack';
+import InMemoryEnvironment from '../src/environment/InMemoryEnvironment';
+
+describe('NavigationStack (general)', () => {
+  let navigationStack;
+
+  beforeEach(() => {
+    navigationStack = new NavigationStack(InMemoryEnvironment);
+    navigationStack.init('/initial');
+  });
+
+  afterEach(() => {
+    navigationStack.stop();
+  });
+
+  it('should support `push` and `shift` navigation actions', () => {
+    navigationStack.push('/new');
+    expect(navigationStack.current()).to.include({
+      pathname: '/new',
+      index: 1,
+    });
+
+    navigationStack.shift(-1);
+    expect(navigationStack.current()).to.include({
+      pathname: '/initial',
+      index: 0,
+    });
+
+    navigationStack.shift(+1);
+    expect(navigationStack.current()).to.include({
+      pathname: '/new',
+      index: 1,
+    });
+  });
+
+  it('should support `replace` navigation action', () => {
+    navigationStack.replace('/new');
+    expect(navigationStack.current()).to.include({
+      pathname: '/new',
+      index: 0,
+    });
+  });
+});
+
+describe('NavigationStack (basePath)', () => {
+  it('should support `basePath` option', () => {
+    const navigationStack = new NavigationStack(InMemoryEnvironment, {
+      basePath: '/base',
+    });
+
+    // eslint-disable-next-line no-underscore-dangle
+    const session = navigationStack._session;
+
+    navigationStack.init('/initial');
+
+    navigationStack.push('/new');
+
+    // eslint-disable-next-line no-underscore-dangle
+    expect(session._subscription._latest.pathname).to.equal('/base/new');
+
+    expect(navigationStack.current()).to.include({
+      pathname: '/new',
+      index: 1,
+    });
+
+    navigationStack.stop();
+  });
+});

package/test/NavigationStack.parseInputLocation.test.js

@@ -0,0 +1,52 @@
+import NavigationStack from '../src/NavigationStack';
+import InMemoryEnvironment from '../src/environment/InMemoryEnvironment';
+
+describe('NavigationStack (parseInputLocation)', () => {
+  let navigationStack;
+
+  beforeEach(() => {
+    navigationStack = new NavigationStack(InMemoryEnvironment);
+
+    // should transform input location of `.init()` method (`string` to `object`)
+    navigationStack.init('/foo?bar=baz#qux');
+
+    expect(navigationStack.current()).to.deep.include({
+      pathname: '/foo',
+      search: '?bar=baz',
+      query: {
+        bar: 'baz',
+      },
+      hash: '#qux',
+    });
+  });
+
+  afterEach(() => {
+    navigationStack.stop();
+  });
+
+  it('should transform input location of `.push()` method (`string` to `object`)', () => {
+    navigationStack.push('/foo?bar=baz#qux');
+
+    expect(navigationStack.current()).to.deep.include({
+      pathname: '/foo',
+      search: '?bar=baz',
+      query: {
+        bar: 'baz',
+      },
+      hash: '#qux',
+    });
+  });
+
+  it('should transform input location of `.replace()` method (`string` to `object`)', () => {
+    navigationStack.replace('/foo?bar=baz#qux');
+
+    expect(navigationStack.current()).to.deep.include({
+      pathname: '/foo',
+      search: '?bar=baz',
+      query: {
+        bar: 'baz',
+      },
+      hash: '#qux',
+    });
+  });
+});

package/test/NavigationStack.removeBasePath.test.js

@@ -0,0 +1,69 @@
+import NavigationStack from '../src/NavigationStack';
+import InMemoryEnvironment from '../src/environment/InMemoryEnvironment';
+import parseInputLocation from '../src/parseInputLocation';
+
+describe('NavigationStack (removeBasePath)', () => {
+  it('should strip `basePath` from `location.pathname`', () => {
+    const navigationStack = new NavigationStack(InMemoryEnvironment, {
+      basePath: '/base',
+    });
+    // eslint-disable-next-line no-underscore-dangle
+    const session = navigationStack._session;
+    session.start(parseInputLocation('/base/path'));
+    expect(navigationStack.current().pathname).to.equal('/path');
+    navigationStack.stop();
+  });
+
+  it('should strip `basePath` (with a trailing slash) from `location.pathname`', () => {
+    const navigationStack = new NavigationStack(InMemoryEnvironment, {
+      basePath: '/base/',
+    });
+    // eslint-disable-next-line no-underscore-dangle
+    const session = navigationStack._session;
+    session.start(parseInputLocation('/base/path'));
+    expect(navigationStack.current().pathname).to.equal('/path');
+    navigationStack.stop();
+  });
+
+  it('should not strip `basePath` from `location.pathname` when it does not contain the `basePath`', () => {
+    const navigationStack = new NavigationStack(InMemoryEnvironment, {
+      basePath: '/base',
+    });
+    // eslint-disable-next-line no-underscore-dangle
+    const session = navigationStack._session;
+    session.start(parseInputLocation('/path'));
+    expect(navigationStack.current().pathname).to.equal('/path');
+    navigationStack.stop();
+  });
+
+  it('should not strip `basePath` (with a trailing slash) from `location.pathname` when it does not contain the `basePath`', () => {
+    const navigationStack = new NavigationStack(InMemoryEnvironment, {
+      basePath: '/base/',
+    });
+    // eslint-disable-next-line no-underscore-dangle
+    const session = navigationStack._session;
+    session.start(parseInputLocation('/path'));
+    expect(navigationStack.current().pathname).to.equal('/path');
+    navigationStack.stop();
+  });
+
+  it('should not modify `location.pathname` when no `basePath` was specified', () => {
+    const navigationStack = new NavigationStack(InMemoryEnvironment);
+    // eslint-disable-next-line no-underscore-dangle
+    const session = navigationStack._session;
+    session.start(parseInputLocation('/path'));
+    expect(navigationStack.current().pathname).to.equal('/path');
+    navigationStack.stop();
+  });
+
+  it('should not modify `location.pathname` when `basePath: "/"` was specified', () => {
+    const navigationStack = new NavigationStack(InMemoryEnvironment, {
+      basePath: '/',
+    });
+    // eslint-disable-next-line no-underscore-dangle
+    const session = navigationStack._session;
+    session.start(parseInputLocation('/path'));
+    expect(navigationStack.current().pathname).to.equal('/path');
+    navigationStack.stop();
+  });
+});