Merge branch 'advanced-tools-for-redux' into develop

Author: birdofpreyru

__tests__/__snapshots__/index.js.snap

@@ -11,6 +11,16 @@ Object {
   "MetaTags": [Function],
   "NavLink": [Function],
   "ScalableRect": [Function],
+  "actions": Object {
+    "collection": Object {
+      "addItems": [Function],
+      "bookItems": [Function],
+      "clean": [Function],
+      "freeItems": [Function],
+      "loadItemDone": [Function],
+      "loadItemInit": [Function],
+    },
+  },
   "client": [Function],
   "config": undefined,
   "isomorphy": Object {
@@ -20,6 +30,9 @@ Object {
     "isProdBuild": [Function],
     "isServerSide": [Function],
   },
+  "reducers": Object {
+    "collection": [Function],
+  },
   "redux": Object {
     "combineReducers": [Function],
     "createActions": [Function],
@@ -130,6 +143,16 @@ Object {
   "MetaTags": [Function],
   "NavLink": [Function],
   "ScalableRect": [Function],
+  "actions": Object {
+    "collection": Object {
+      "addItems": [Function],
+      "bookItems": [Function],
+      "clean": [Function],
+      "freeItems": [Function],
+      "loadItemDone": [Function],
+      "loadItemInit": [Function],
+    },
+  },
   "client": [Function],
   "config": Config {
     "SECRET": Object {
@@ -144,6 +167,9 @@ Object {
     "isProdBuild": [Function],
     "isServerSide": [Function],
   },
+  "reducers": Object {
+    "collection": [Function],
+  },
   "redux": Object {
     "combineReducers": [Function],
     "createActions": [Function],

src/index.js

@@ -1,3 +1,4 @@
+import actions from 'actions';
 import AppChunk from 'containers/AppChunk';
 import Avatar from 'components/Avatar';
 import Button from 'components/Button';
@@ -6,6 +7,7 @@ import DevTools from 'components/DevTools';
 import Link from 'components/Link';
 import MetaTags from 'components/MetaTags';
 import NavLink from 'components/NavLink';
+import reducers from 'reducers';
 import ScalableRect from 'components/ScalableRect';
 import * as utils from 'utils';
 
@@ -17,6 +19,7 @@ const server = utils.isomorphy.isServerSide() ?
   requireWeak('topcoder-react-utils/dist/server') : null;
 
 module.exports = {
+  actions,
   AppChunk,
   Avatar,
   Button,
@@ -26,6 +29,7 @@ module.exports = {
   NavLink,
   MetaTags,
   ScalableRect,
+  reducers,
   server,
   ...utils,
 };

src/shared/actions/collection.js

@@ -0,0 +1,81 @@
+/**
+ * Proof-of-concept code. Will be documented once stable. In case of any
+ * questions before that, feel free to contact `birdofpreyru`.
+ */
+
+import _ from 'lodash';
+import * as redux from 'utils/redux';
+
+/**
+ * Adds items to the collection.
+ * @param {Object} index Item ID > item mapping for the items to add.
+ * @return {Object}
+ */
+function addItems(index) {
+  return { index, timestamp: Date.now() };
+}
+
+/**
+ * Increments counters of item references.
+ * @param {String|String[]} ids
+ * @param {Number} factor Optional.
+ * @return {String[]}
+ */
+function bookItems(ids, factor = 1) {
+  return { factor, ids: _.isArray(ids) ? ids : [ids] };
+}
+
+/**
+ * Removes from the state all unuzed items with timestamps older than maxage.
+ * @param {Number} timestamp
+ */
+function clean(timestamp) {
+  return timestamp;
+}
+
+/**
+ * Decreases counters of item references.
+ * @param {String|String[]} ids
+ * @param {Number} factor Optional.
+ * @return {String[]}
+ */
+function freeItems(ids, factor = 1) {
+  return { factor, ids: _.isArray(ids) ? ids : [ids] };
+}
+
+/**
+ * Inits loading of an item.
+ * @param {String} operationId
+ * @param {String} itemId
+ * @return {Object}
+ */
+function loadItemInit(operationId, itemId) {
+  return { itemId, operationId };
+}
+
+/**
+ * Finalizes loading of an item.
+ * @param {String} operationId
+ * @param {String} itemId
+ * @param {Any} item
+ * @return {Object}
+ */
+function loadItemDone(operationId, itemId, item) {
+  return {
+    item,
+    itemId,
+    operationId,
+    timestamp: Date.now(),
+  };
+}
+
+export default redux.createActions({
+  COLLECTION: {
+    ADD_ITEMS: addItems,
+    BOOK_ITEMS: bookItems,
+    CLEAN: clean,
+    FREE_ITEMS: freeItems,
+    LOAD_ITEM_INIT: loadItemInit,
+    LOAD_ITEM_DONE: loadItemDone,
+  },
+});

src/shared/actions/index.js

@@ -0,0 +1,5 @@
+import collection from './collection';
+
+export default {
+  ...collection,
+};

src/shared/reducers/collection.js

@@ -0,0 +1,106 @@
+/**
+ * Proof-of-concept code. Will be documented once stable. In case of any
+ * questions before that, feel free to contact `birdofpreyru`.
+ */
+
+import _ from 'lodash';
+import actions from 'actions/collection';
+import * as redux from 'utils/redux';
+
+/**
+ * Inits, or replaces by its clone, the slot indexed under the specified id.
+ * Returns the new slot indexed by that id.
+ *
+ * BEWARE: It mutates the index.
+ *
+ * @param {Object} index
+ * @param {String} id
+ * @return {Object}
+ */
+function prepare(index, id) {
+  let slot = index[id];
+  slot = slot ? _.clone(slot) : {
+    item: null,
+    loadingOperationId: '',
+    numRefs: 0,
+    timestamp: 0,
+  };
+  index[id] = slot; // eslint-disable-line no-param-reassign
+  return slot;
+}
+
+function onAddItems(state, action) {
+  const { index, timestamp } = action.payload;
+  const result = _.clone(state);
+  _.forOwn(index, (item, id) => {
+    const slot = prepare(result, id);
+    slot.timestamp = timestamp;
+    slot.item = item;
+  });
+  return result;
+}
+
+function onBookItems(state, { payload: { factor, ids } }) {
+  const result = _.clone(state);
+  ids.forEach((id) => {
+    prepare(result, id).numRefs += factor;
+  });
+  return result;
+}
+
+function onClean(state, { payload }) {
+  const result = _.clone(state);
+  _.forOwn(state, (item, id) => {
+    const slot = state[id];
+    if (slot.numRefs || slot.loadingOperationId
+      || slot.timestamp > payload) return;
+    delete result[id];
+  });
+  return result;
+}
+
+function onFreeItems(state, { payload: { factor, ids } }) {
+  const result = _.clone(state);
+  ids.forEach((id) => {
+    prepare(result, id).numRefs -= factor;
+  });
+  return result;
+}
+
+function onLoadItemInit(state, { payload }) {
+  const { itemId, operationId } = payload;
+  const result = _.clone(state);
+  const slot = prepare(result, itemId);
+  slot.loadingOperationId = operationId;
+  return result;
+}
+
+function onLoadItemDone(state, { payload }) {
+  const {
+    item,
+    itemId,
+    operationId,
+    timestamp,
+  } = payload;
+  const slot = state[itemId];
+  if (!slot || slot.loadingOperationId !== operationId) return state;
+  return {
+    ...state,
+    [itemId]: {
+      ...slot,
+      item,
+      loadingOperationId: '',
+      timestamp,
+    },
+  };
+}
+
+const a = actions.collection;
+export default redux.handleActions({
+  [a.addItems]: onAddItems,
+  [a.bookItems]: onBookItems,
+  [a.clean]: onClean,
+  [a.freeItems]: onFreeItems,
+  [a.loadItemInit]: onLoadItemInit,
+  [a.loadItemDone]: onLoadItemDone,
+}, {});

src/shared/reducers/index.js

@@ -0,0 +1,5 @@
+import collection from './collection';
+
+export default {
+  collection,
+};