feat(config): add register state provider api

in order to allow other libraries to register custom providers

Author: Xiphe

Diff for: config/config.js

@@ -1,5 +1,9 @@
+const path = require('path');
 const transformStateOptions = require('./transformStateOptions');
 const getDirectiveSource = require('./getDirectiveSource');
+const { registerProvider } = require('./providers');
+
+registerProvider('session', path.resolve(__dirname, '../src/runtimes/session'));
 
 module.exports = [
   {
@@ -14,3 +18,5 @@ module.exports = [
     transformOptions: transformStateOptions,
   },
 ];
+
+module.exports.register = registerProvider;

Diff for: config/getDirectiveSource.js

@@ -1,21 +1,25 @@
+const { getProviders } = require('./providers');
+
 function isScopeProp(property) {
   return property.key.name === 'scope';
 }
 
 module.exports = function getDirectiveSource(optionsNode, bootstrap) {
+  const providers = getProviders();
   const scope = optionsNode.expression.properties.find(isScopeProp).value.value;
   const scopeDefinition = bootstrap[scope];
 
   if (!scopeDefinition) {
     throw new Error(`State scope "${scope}" is not defined.`);
   }
 
-  switch (scopeDefinition.type) {
-    case 'session':
-      return './src/runtimes/session';
-    default:
-      throw new Error(
-        `Unexpected use of unknown scope type "${scopeDefinition.type}"`,
-      );
+  if (!providers[scopeDefinition.type]) {
+    throw new Error(
+      `There is no registered provider for scope of type "${
+        scopeDefinition.type
+      }"`,
+    );
   }
+
+  return providers[scopeDefinition.type];
 };

Diff for: config/providers.js

@@ -0,0 +1,18 @@
+let providers = {};
+
+exports.registerProvider = function registerProvider(name, entry) {
+  if (providers[name]) {
+    throw new Error(`state provider "${name}" is already registered`);
+  }
+
+  providers[name] = entry;
+};
+
+exports.getProviders = function getProviders() {
+  return providers;
+};
+
+// eslint-disable-next-line no-underscore-dangle
+exports.__reset = () => {
+  providers = {};
+};

Diff for: src/runtimes/helpers/createBootstrap.js renamed to src/createBootstrap.js

@@ -1,4 +1,6 @@
-export default function createBootstrap(providerKey, bootstrapFn) {
+import { registerProvider } from './StateProviderDirective';
+
+export default function createBootstrap(providerKey, bootstrapFn, Provider) {
   return options => {
     const typeOptions = Object.keys(options).reduce((memo, key) => {
       const definition = options[key];
@@ -11,6 +13,7 @@ export default function createBootstrap(providerKey, bootstrapFn) {
       return memo;
     }, {});
 
+    registerProvider(Provider);
     bootstrapFn(typeOptions);
   };
 }

Diff for: src/index.js

@@ -0,0 +1 @@
+export { default } from './createBootstrap';

Diff for: src/runtimes/helpers/index.js

@@ -1,13 +1,19 @@
 import { createStore } from 'redux';
 import { devToolsEnhancer } from 'redux-devtools-extension';
 import createReducers from './createReducers';
+import Provider from './Provider';
+import createBootstrap from '../../';
 
 let store = null;
 
 export function getStore() {
   return store;
 }
 
-export default function bootstrap(options) {
-  store = createStore(createReducers(options), devToolsEnhancer());
-}
+export default createBootstrap(
+  'session',
+  options => {
+    store = createStore(createReducers(options), devToolsEnhancer());
+  },
+  Provider,
+);

Diff for: src/runtimes/session.js

@@ -1,3 +1,2 @@
 export { default } from './SessionDirective';
-export { default as Provider } from './Provider';
 export { default as bootstrap } from './bootstrap';

Diff for: src/stateProviders/session/bootstrap.js

@@ -2,4 +2,4 @@
 
 exports[`getDirectiveSource throws when a undefined scope is being used 1`] = `"State scope \\"foo\\" is not defined."`;
 
-exports[`getDirectiveSource throws when a undefined scope type is being used 1`] = `"Unexpected use of unknown scope type \\"bar\\""`;
+exports[`getDirectiveSource throws when a undefined scope type is being used 1`] = `"There is no registered provider for scope of type \\"bar\\""`;

Diff for: src/stateProviders/session/index.js

@@ -0,0 +1,3 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`providers does not support overwrites of providers 1`] = `"state provider \\"foo\\" is already registered"`;

Diff for: test/config/__snapshots__/getDirectiveSouce.spec.js.snap

@@ -1,4 +1,5 @@
 const getDirectiveSource = require('../../config/getDirectiveSource');
+const { registerProvider, __reset } = require('../../config/providers');
 
 function createNode(properties) {
   return {
@@ -16,11 +17,15 @@ function createProperty(name, value) {
 }
 
 describe('getDirectiveSource', () => {
+  afterEach(() => {
+    __reset();
+  });
+
   it('throws when a undefined scope is being used', () => {
     const fakeNode = createNode([createProperty('scope', 'foo')]);
 
     expect(() => {
-      getDirectiveSource(fakeNode, { bar: {} });
+      getDirectiveSource(fakeNode, {});
     }).toThrowErrorMatchingSnapshot();
   });
 
@@ -32,11 +37,12 @@ describe('getDirectiveSource', () => {
     }).toThrowErrorMatchingSnapshot();
   });
 
-  it('supports a session scope type', () => {
+  it('supports a registered scope type', () => {
+    registerProvider('bar', '/bar.js');
     const fakeNode = createNode([createProperty('scope', 'foo')]);
 
-    const source = getDirectiveSource(fakeNode, { foo: { type: 'session' } });
+    const source = getDirectiveSource(fakeNode, { foo: { type: 'bar' } });
 
-    expect(source).toBe('./src/runtimes/session');
+    expect(source).toBe('/bar.js');
   });
 });

Diff for: test/config/__snapshots__/providers.spec.js.snap

@@ -0,0 +1,28 @@
+const {
+  registerProvider,
+  __reset,
+  getProviders,
+} = require('../../config/providers');
+
+describe('providers', () => {
+  afterEach(() => {
+    __reset();
+  });
+
+  it('has no registered providers by default', () => {
+    expect(getProviders()).toEqual({});
+  });
+
+  it('provides registered providers', () => {
+    registerProvider('foo', 'bar');
+
+    expect(getProviders()).toEqual({ foo: 'bar' });
+  });
+
+  it('does not support overwrites of providers', () => {
+    registerProvider('foo', 'bar');
+    expect(() => {
+      registerProvider('foo', 'bar');
+    }).toThrowErrorMatchingSnapshot();
+  });
+});

Diff for: test/config/getDirectiveSouce.spec.js

@@ -1,8 +1,10 @@
+/* eslint-disable no-console */
+
 import React from 'react';
 import Enzyme, { mount } from 'enzyme';
 import Adapter from 'enzyme-adapter-react-16';
 import renderer from 'react-test-renderer';
-import SessionDirective, { bootstrap } from '../../src/runtimes/session';
+import SessionDirective, { bootstrap } from '../../src/stateProviders/session';
 import StateProviderDirective from '../../src/StateProviderDirective';
 
 Enzyme.configure({ adapter: new Adapter() });
@@ -31,7 +33,15 @@ function withState({ options, as }) {
   };
 }
 
+const originalConsoleError = console.error;
+
+function noop() {}
+
 describe('session runtime', () => {
+  afterEach(() => {
+    console.error = originalConsoleError;
+  });
+
   it('renders without error', () => {
     const SimpleDiv = withState({})('div');
 
@@ -176,6 +186,7 @@ describe('session runtime', () => {
 
     bootstrap({ bar: { type: 'session', initialState: { bar: 'baf' } } });
 
+    console.error = noop;
     expect(() => {
       renderer
         .create(
@@ -215,6 +226,7 @@ describe('session runtime', () => {
       as: 'children',
     })('div');
 
+    console.error = noop;
     expect(() => {
       renderer
         .create(