navigation-stack 0.1.3 → 0.2.0

package/src/environment/MemoryEnvironment.js

@@ -1,151 +0,0 @@
-import normalizeInputLocation from '../normalizeInputLocation';
-
-export default class MemoryEnvironment {
-  constructor(initialLocation, { save, load } = {}) {
-    this._save = save;
-    this._load = load;
-
-    const initialState = load ? this._loadState() : null;
-    if (initialState) {
-      this._stack = initialState.stack;
-      this._index = initialState.index;
-      this._state = initialState.state;
-    } else {
-      this._stack = [normalizeInputLocation(initialLocation)];
-      this._index = 0;
-      this._state = {};
-    }
-
-    this._keyPrefix = Math.random().toString(36).slice(2, 8);
-    this._keyIndex = 0;
-
-    this._listener = null;
-  }
-
-  _loadState() {
-    try {
-      const { stack, index, state } = JSON.parse(this._load());
-
-      // Check that the stack and index at least seem reasonable before using
-      // them as state. This isn't foolproof, but it might prevent mistakes.
-      // Also perform a basic validation of `state`.
-      if (
-        Array.isArray(stack) &&
-        typeof index === 'number' &&
-        stack[index] &&
-        typeof state === 'object' &&
-        state !== null
-      ) {
-        return { stack, index, state };
-      }
-    } catch (error) {} // eslint-disable-line no-empty
-
-    return null;
-  }
-
-  init(delta = 0) {
-    return {
-      ...this._stack[this._index],
-      action: 'POP',
-      index: this._index,
-      delta,
-    };
-  }
-
-  subscribe(listener) {
-    this._listener = listener;
-
-    return () => {
-      this._listener = null;
-    };
-  }
-
-  navigate(location) {
-    const { action, pathname, search, query, hash, state } = location;
-
-    const push = action === 'PUSH';
-
-    if (!push && action !== 'REPLACE')
-      throw Error(`Unrecognized browser environment action: ${action}`);
-
-    const delta = push ? 1 : 0;
-    this._index += delta;
-
-    const keyIndex = this._keyIndex++;
-    const key = `${this._keyPrefix}:${keyIndex.toString(36)}`;
-
-    this._stack[this._index] = { pathname, search, query, hash, state, key };
-    if (push) {
-      this._stack.length = this._index + 1;
-    }
-
-    if (this._save) {
-      this._saveState();
-    }
-
-    return { ...location, key, index: this._index, delta };
-  }
-
-  shift(delta) {
-    const prevIndex = this._index;
-
-    this._index = Math.min(
-      Math.max(this._index + delta, 0),
-      this._stack.length - 1,
-    );
-
-    if (this._index === prevIndex) {
-      return;
-    }
-
-    if (this._save) {
-      this._saveState();
-    }
-
-    if (this._listener) {
-      this._listener(this.init(this._index - prevIndex));
-    }
-  }
-
-  // "Before destroy" listeners are currently ignored.
-  // If required, one could implement a `_destroy()` method
-  // and there check that the listeners actually do get called.
-  addBeforeDestroyListener(listener) {
-    return () => {
-      this._removeBeforeDestroyListener(listener);
-    };
-  }
-
-  // This method is used in tests.
-  _removeBeforeDestroyListener() {}
-
-  _saveState() {
-    try {
-      this._save(
-        JSON.stringify({
-          stack: this._stack,
-          index: this._index,
-          state: this._state,
-        }),
-      );
-    } catch (error) {} // eslint-disable-line no-empty
-  }
-
-  // Returns either a `string` value or `null` if the key doesn't exist.
-  getState(key) {
-    if (key in this._state) {
-      return this._state[key];
-    }
-    return null;
-  }
-
-  removeState(key) {
-    if (key in this._state) {
-      delete this._state[key];
-    }
-  }
-
-  setState(key, value) {
-    this._state[key] = value;
-  }
-}

package/test/environment/MemoryEnvironment.test.js

@@ -1,218 +0,0 @@
-import MemoryEnvironment from '../../src/environment/MemoryEnvironment';
-
-const STATE_KEY = '@@navigation-stack/environment-state';
-
-function save(state) {
-  window.sessionStorage.setItem(STATE_KEY, state);
-}
-
-function load() {
-  return window.sessionStorage.getItem(STATE_KEY);
-}
-
-describe('MemoryEnvironment', () => {
-  it('should parse the initial location', () => {
-    const environment = new MemoryEnvironment('/foo?bar=baz#qux');
-
-    expect(environment.init()).to.eql({
-      action: 'POP',
-      pathname: '/foo',
-      search: '?bar=baz',
-      query: {
-        bar: 'baz',
-      },
-      hash: '#qux',
-      index: 0,
-      delta: 0,
-    });
-  });
-
-  it('should support basic navigation', () => {
-    const environment = new MemoryEnvironment('/foo');
-
-    const listener = sinon.spy();
-    environment.subscribe(listener);
-
-    const barLocation = environment.navigate({
-      action: 'PUSH',
-      pathname: '/bar',
-      state: { the: 'state' },
-    });
-
-    expect(barLocation).to.deep.include({
-      action: 'PUSH',
-      pathname: '/bar',
-      index: 1,
-      delta: 1,
-      state: { the: 'state' },
-    });
-    expect(barLocation.key).not.to.be.empty();
-
-    expect(
-      environment.navigate({ action: 'PUSH', pathname: '/baz' }),
-    ).to.include({
-      action: 'PUSH',
-      pathname: '/baz',
-      index: 2,
-      delta: 1,
-    });
-
-    expect(
-      environment.navigate({ action: 'REPLACE', pathname: '/qux' }),
-    ).to.include({
-      action: 'REPLACE',
-      pathname: '/qux',
-      index: 2,
-      delta: 0,
-    });
-
-    expect(listener).not.to.have.been.called();
-
-    environment.shift(-1);
-
-    expect(listener).to.have.been.calledOnce();
-    expect(listener.firstCall.args[0]).to.deep.include({
-      action: 'POP',
-      pathname: '/bar',
-      key: barLocation.key,
-      index: 1,
-      delta: -1,
-      state: { the: 'state' },
-    });
-  });
-
-  it('should support subscribing and unsubscribing', () => {
-    const environment = new MemoryEnvironment('/foo');
-    environment.navigate({ action: 'PUSH', pathname: '/bar' });
-    environment.navigate({ action: 'PUSH', pathname: '/baz' });
-
-    const listener = sinon.spy();
-    const unsubscribe = environment.subscribe(listener);
-
-    environment.shift(-1);
-
-    expect(listener).to.have.been.calledOnce();
-    expect(listener.firstCall.args[0]).to.include({
-      action: 'POP',
-      pathname: '/bar',
-    });
-    listener.resetHistory();
-
-    unsubscribe();
-
-    environment.shift(-1);
-
-    expect(listener).not.to.have.been.called();
-  });
-
-  it('should respect stack bounds', () => {
-    const environment = new MemoryEnvironment('/foo');
-    environment.navigate({ action: 'PUSH', pathname: '/bar' });
-    environment.navigate({ action: 'PUSH', pathname: '/baz' });
-
-    const listener = sinon.spy();
-    environment.subscribe(listener);
-
-    environment.shift(-390);
-
-    expect(listener).to.have.been.calledOnce();
-    expect(listener.firstCall.args[0]).to.include({
-      action: 'POP',
-      pathname: '/foo',
-      delta: -2,
-    });
-    listener.resetHistory();
-
-    environment.shift(-1);
-
-    expect(listener).not.to.have.been.called();
-
-    environment.shift(+22);
-
-    expect(listener).to.have.been.calledOnce();
-    expect(listener.firstCall.args[0]).to.include({
-      action: 'POP',
-      pathname: '/baz',
-      delta: 2,
-    });
-    listener.resetHistory();
-
-    environment.shift(+1);
-
-    expect(listener).not.to.have.been.called();
-  });
-
-  it('should reset forward entries on push', () => {
-    const environment = new MemoryEnvironment('/foo');
-    environment.navigate({ action: 'PUSH', pathname: '/bar' });
-    environment.navigate({ action: 'PUSH', pathname: '/baz' });
-    environment.shift(-2);
-    environment.navigate({ action: 'REPLACE', pathname: '/qux' });
-
-    const listener = sinon.spy();
-    environment.subscribe(listener);
-
-    environment.shift(+1);
-
-    expect(listener).to.have.been.calledOnce();
-    expect(listener.firstCall.args[0]).to.include({
-      action: 'POP',
-      pathname: '/bar',
-      delta: 1,
-    });
-  });
-
-  it('should not reset forward entries on replace', () => {
-    const environment = new MemoryEnvironment('/foo');
-    environment.navigate({ action: 'PUSH', pathname: '/bar' });
-    environment.navigate({ action: 'PUSH', pathname: '/baz' });
-    environment.shift(-2);
-    environment.navigate({ action: 'PUSH', pathname: '/qux' });
-
-    const listener = sinon.spy();
-    environment.subscribe(listener);
-
-    environment.shift(+1);
-
-    expect(listener).not.to.have.been.called();
-  });
-
-  describe('persistence', () => {
-    beforeEach(() => {
-      window.sessionStorage.clear();
-    });
-
-    it('should support persistence', () => {
-      const environment1 = new MemoryEnvironment('/foo', { save, load });
-      expect(environment1.init()).to.include({
-        pathname: '/foo',
-      });
-
-      environment1.navigate({ action: 'PUSH', pathname: '/bar' });
-      environment1.navigate({ action: 'PUSH', pathname: '/baz' });
-      environment1.shift(-1);
-
-      const environment2 = new MemoryEnvironment('/foo', { save, load });
-      expect(environment2.init()).to.include({
-        pathname: '/bar',
-      });
-
-      environment2.shift(+1);
-      expect(environment2.init()).to.include({
-        pathname: '/baz',
-      });
-    });
-
-    it('should ignore broken session storage entry', () => {
-      sessionStorage.setItem(
-        '@@navigation-stack/state',
-        JSON.stringify({ stack: [], index: 2 }),
-      );
-
-      const environment = new MemoryEnvironment('/foo', { save, load });
-      expect(environment.init()).to.include({
-        pathname: '/foo',
-      });
-    });
-  });
-});

package/test/environment/ServerEnvironment.test.js

@@ -1,23 +0,0 @@
-import ServerEnvironment from '../../src/environment/ServerEnvironment';
-
-describe('ServerEnvironment', () => {
-  it('should parse the initial location', () => {
-    const environment = new ServerEnvironment('/foo?bar=baz#qux');
-
-    expect(environment.init()).to.eql({
-      action: 'POP',
-      pathname: '/foo',
-      search: '?bar=baz',
-      query: {
-        bar: 'baz',
-      },
-      hash: '#qux',
-    });
-  });
-
-  it('should have dummy support for subscriptions', () => {
-    const environment = new ServerEnvironment('/foo?bar=baz#qux');
-    const unsubscribe = environment.subscribe();
-    expect(unsubscribe).to.not.throw();
-  });
-});