Implement initial default adapter for upcoming adapter pattern

README.md

@@ -423,3 +423,10 @@ collectionActions.fetch('posts', {
 ## Local Development
 
 In order to develop against a local checkout, run `yarn link` in `brainstem-redux`, then `yarn link brainstem-redux` in the project you want to use it in and restart webpack. Also, make sure to `yarn compile` when making changes in `brainstem-redux`.
+
+## Running example
+
+1. run `yarn start`
+2. navigate to `http://localhost:8080/webpack-dev-server/`
+3. click on `example`
+4. view example app and type an approved string into the search bar 

lib/actions/collection.js

@@ -1,4 +1,4 @@
-const { StorageManager } = require('brainstem-js');
+const defaultAdapter = require('../adapters/default');
 
 const xhrs = {};
 
@@ -9,24 +9,30 @@ module.exports = {
       postFetchAction,
       preFetchAction,
       trackKey,
+      adapter = defaultAdapter,
     } = options;
 
-    const storageManager = StorageManager.get();
-
     if (xhrs[trackKey] && xhrs[trackKey].state() === 'pending') xhrs[trackKey].abort();
 
-    return (dispatch) => {
+    return (dispatch, getState) => {
       if (preFetchAction) dispatch(preFetchAction);
 
-      const xhr = storageManager.storage(brainstemKey)
-        .fetch(Object.assign(fetchOptions, { remove: false }));
+      const xhr = adapter.fetchCollection(brainstemKey, {
+        dispatch,
+        getState,
+        fetchOptions,
+      });
 
-      if (postFetchAction) xhr.done(collection => dispatch(postFetchAction(collection.pluck('id'))));
+      if (postFetchAction) {
+        xhr.done(collection =>
+          dispatch(postFetchAction(adapter.collectionToIds(collection)))
+        );
+      }
 
       if (trackKey) xhrs[trackKey] = xhr;
 
       return new Promise((resolve, reject) => xhr
-        .done(collection => resolve(collection.map(model => model.attributes)))
+        .done(collection => resolve(adapter.collectionToArray(collection)))
         .fail(reject)
       );
     };

lib/actions/model.js

@@ -1,5 +1,5 @@
-const { StorageManager } = require('brainstem-js');
 const $ = require('jquery');
+const defaultAdapter = require('../adapters/default');
 
 const xhrs = {};
 
@@ -10,20 +10,21 @@ module.exports = {
       postFetchAction,
       preFetchAction,
       trackKey,
+      adapter = defaultAdapter,
     } = options;
 
-    const storageManager = StorageManager.get();
-
     if (xhrs[trackKey] && xhrs[trackKey].state() === 'pending') xhrs[trackKey].abort();
 
-    return (dispatch) => {
+    return (dispatch, getState) => {
       if (preFetchAction) dispatch(preFetchAction);
 
-      const Model = storageManager.storage(brainstemKey).model;
-      const xhr = new Model({ id: modelId })
-        .fetch(Object.assign(fetchOptions, { remove: false }));
+      const xhr = adapter.fetchModel(brainstemKey, modelId, {
+        dispatch,
+        getState,
+        fetchOptions,
+      });
 
-      if (postFetchAction) xhr.done(model => dispatch(postFetchAction(model.get('id'))));
+      if (postFetchAction) xhr.done(model => dispatch(postFetchAction(adapter.modelToId(model))));
 
       if (trackKey) xhrs[trackKey] = xhr;
 
@@ -37,18 +38,19 @@ module.exports = {
       preSaveAction,
       postSaveAction,
       trackKey,
+      adapter = defaultAdapter,
     } = options;
 
-    const storageManager = StorageManager.get();
-
     if (xhrs[trackKey] && xhrs[trackKey].state() === 'pending') xhrs[trackKey].abort();
 
-    return (dispatch) => {
+    return (dispatch, getState) => {
       if (preSaveAction) dispatch(preSaveAction);
 
-      const Model = storageManager.storage(brainstemKey).model;
-      let xhr = new Model({ id: modelId })
-        .save(attributes, saveOptions);
+      let xhr = adapter.saveModel(brainstemKey, modelId, attributes, {
+        dispatch,
+        getState,
+        saveOptions,
+      });
 
       // backbone returns false when the model is invalid
       if (!xhr.then) {
@@ -71,17 +73,21 @@ module.exports = {
   },
 
   destroy(brainstemKey, modelId, options = {}) {
-    const storageManager = StorageManager.get();
     const {
       deleteOptions = {},
       trackKey,
+      adapter = defaultAdapter,
     } = options;
 
     if (xhrs[trackKey] && xhrs[trackKey].state() === 'pending') xhrs[trackKey].abort();
 
-    return () => {
-      const Model = storageManager.storage(brainstemKey).model;
-      const xhr = new Model({ id: modelId }).destroy(deleteOptions);
+    return (dispatch, getState) => {
+      const xhr = adapter.destroyModel(brainstemKey, modelId, {
+        dispatch,
+        getState,
+        deleteOptions,
+      });
+
       if (trackKey) xhrs[trackKey] = xhr;
 
       return xhr;
@@ -93,15 +99,17 @@ module.exports = {
       validateOptions = {},
       preValidateAction,
       postValidateAction,
+      adapter = defaultAdapter,
     } = options;
 
-    const storageManager = StorageManager.get();
-
-    return (dispatch) => {
+    return (dispatch, getState) => {
       if (preValidateAction) dispatch(preValidateAction);
 
-      const Model = storageManager.storage(brainstemKey).model;
-      const validationErrors = new Model().validate(attributes, validateOptions);
+      const validationErrors = adapter.validateModel(brainstemKey, attributes, {
+        dispatch,
+        getState,
+        validateOptions,
+      });
 
       if (postValidateAction) { dispatch(postValidateAction(validationErrors)); }
 

lib/adapters/default.js

@@ -0,0 +1,34 @@
+const { StorageManager } = require('brainstem-js');
+
+module.exports = {
+  fetchCollection: (brainstemKey, options) => {
+    const storageManager = StorageManager.get();
+    return storageManager.storage(brainstemKey)
+      .fetch(Object.assign({}, options.fetchOptions, { remove: false }));
+  },
+  fetchModel: (brainstemKey, modelId, options) => {
+    const storageManager = StorageManager.get();
+    const Model = storageManager.storage(brainstemKey).model;
+    return new Model({ id: modelId })
+      .fetch(Object.assign({}, options.fetchOptions, { remove: false }));
+  },
+  saveModel: (brainstemKey, modelId, attributes, options) => {
+    const storageManager = StorageManager.get();
+    const Model = storageManager.storage(brainstemKey).model;
+    return new Model({ id: modelId })
+      .save(attributes, options.saveOptions);
+  },
+  destroyModel: (brainstemKey, modelId, options) => {
+    const storageManager = StorageManager.get();
+    const Model = storageManager.storage(brainstemKey).model;
+    return new Model({ id: modelId }).destroy(options.deleteOptions);
+  },
+  validateModel: (brainstemKey, attributes, options) => {
+    const storageManager = StorageManager.get();
+    const Model = storageManager.storage(brainstemKey).model;
+    return new Model().validate(attributes, options.validateOptions);
+  },
+  collectionToIds: collection => collection.pluck('id'),
+  collectionToArray: collection => collection.map(model => model.attributes),
+  modelToId: model => model.get('id'),
+};

lib/reducers/index.js

@@ -14,6 +14,7 @@
 */
 
 const updateModel = require('./update-model');
+const syncCollections = require('./sync-collections');
 const removeModel = require('./remove-model');
 const initialState = require('./initial-state');
 
@@ -24,6 +25,8 @@ module.exports = (state = initialState(), action) => {
       return updateModel(state, action);
     case 'REMOVE_MODEL':
       return removeModel(state, action);
+    case 'SYNC_COLLECTIONS':
+      return syncCollections(state, action);
     default:
       return state;
   }

lib/reducers/sync-collections.js

@@ -0,0 +1,15 @@
+module.exports = (state, action) => {
+  const mergedCollections = {};
+  const { collections } = action.payload;
+  const collectionNames = Object.keys(collections);
+
+  collectionNames.forEach((collectionName) => {
+    mergedCollections[collectionName] = Object.assign(
+      {},
+      state[collectionName],
+      collections[collectionName],
+    );
+  });
+
+  return Object.assign({}, state, mergedCollections);
+};

lib/types/make-brainstem-type.js

@@ -7,9 +7,16 @@ const defaultTypeOptions = {
 };
 
 module.exports = function makeBrainstemType(brainstemKey, typeOptions = defaultTypeOptions) {
+  const mergedOptions = { ...defaultTypeOptions, ...typeOptions };
+
+  const buildActionOptions = (options) => {
+    const { adapter } = mergedOptions;
+    return adapter ? { ...options, adapter } : options;
+  };
+
   function all(state) {
     return Object.keys(state.brainstem[brainstemKey])
-      .filter(id => typeOptions.filterPredicate(state.brainstem[brainstemKey][id]))
+      .filter(id => mergedOptions.filterPredicate(state.brainstem[brainstemKey][id]))
       .reduce((memo, id) => {
         memo[id] = state.brainstem[brainstemKey][id]; // eslint-disable-line no-param-reassign
         return memo;
@@ -37,19 +44,19 @@ module.exports = function makeBrainstemType(brainstemKey, typeOptions = defaultT
   }
 
   function fetchAll(options) {
-    return collectionActions.fetch(brainstemKey, options);
+    return collectionActions.fetch(brainstemKey, buildActionOptions(options));
   }
 
   function fetch(id, options) {
-    return modelActions.fetch(brainstemKey, id, options);
+    return modelActions.fetch(brainstemKey, id, buildActionOptions(options));
   }
 
   function save(id, attributes, options) {
-    return modelActions.save(brainstemKey, id, attributes, options);
+    return modelActions.save(brainstemKey, id, attributes, buildActionOptions(options));
   }
 
   function destroy(id, options) {
-    return modelActions.destroy(brainstemKey, id, options);
+    return modelActions.destroy(brainstemKey, id, buildActionOptions(options));
   }
 
   function matchesAction({ meta, payload }) {