Merge pull request #17 from kouhin/feature/release/v2.3.0

Release/v2.3.0

Author: kouhin

README.md

@@ -1,6 +1,8 @@
 redux-memoize
 =============
 
+[![Greenkeeper badge](https://badges.greenkeeper.io/kouhin/redux-memoize.svg)](https://greenkeeper.io/)
+
 Memoize action creator for [redux](http://redux.js.org), and let you dispatch common/thunk/promise/async action whenever you want to, without worrying about duplication.
 
 [![CircleCI](https://img.shields.io/circleci/project/github/kouhin/redux-memoize.svg)](https://circleci.com/gh/kouhin/redux-memoize/tree/develop)
@@ -161,6 +163,7 @@ Create a redux [middleware](http://redux.js.org/docs/advanced/Middleware.html).
   - _Object_: Default opts for memorize().
   - **Default**: `{ ttl:0, enabled: true, isEqual: lodash.isEqual }`]. **ttl is REQUIRED, You SHOULD set a ttl > 0 in millisecond**
   - There is another options `disableTTL`. The default value is `true` on server and `false` on browser. By default, cached action creator will not be evicted by setTimeout with TTL on server in order to prevent memory leak. You can enable it for test purpose.
+  - You can pass a customized cache by `cache` instead of default cache `new WeakMap()`.
 
 #### Returns
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "redux-memoize",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "Memoize action creator for redux, and let you dispatch common/thunk/promise/async action whenever you want to, without worrying about duplication",
   "main": "lib/index.js",
   "directories": {
@@ -44,13 +44,15 @@
     "babel-cli": "^6.23.0",
     "babel-core": "^6.23.1",
     "babel-eslint": "^7.1.1",
+    "babel-jest": "^20.0.3",
     "babel-plugin-transform-runtime": "^6.23.0",
     "babel-preset-env": "^1.2.1",
     "babel-preset-stage-0": "^6.22.0",
     "chai": "^3.5.0",
-    "eslint-config-airbnb-deps": "^14.1.0",
+    "eslint": "^3.19.0",
+    "eslint-config-airbnb-deps": "^15.0.1",
     "eslint-plugin-babel": "^4.1.1",
-    "jest": "^19.0.2",
+    "jest": "^20.0.3",
     "redux": "^3.6.0",
     "redux-thunk": "^2.2.0",
     "rimraf": "^2.6.1"

src/index.js

@@ -37,7 +37,7 @@ export default function createMemoizeMiddleware(options = {}) {
     ...globalOptions
   } = options;
 
-  const cache = new Map();
+  const cache = options.cache || new WeakMap();
   const middleware = ({ dispatch, getState }) => next => (action) => {
     if (typeof action === 'object' && action.type === ACTION_TYPE) {
       const { fn, args } = action.payload;
@@ -74,16 +74,7 @@ export default function createMemoizeMiddleware(options = {}) {
     }
     return next(action);
   };
-  middleware.getAll = () => {
-    const result = [];
-    const cacheValues = Array.from(cache.values());
-    cacheValues.forEach((fnCache) => {
-      Array.from(fnCache.values()).forEach((value) => {
-        result.push(value);
-      });
-    });
-    return result;
-  };
+  middleware.cache = cache;
   return middleware;
 }
 

test/middleware.spec.js

@@ -10,6 +10,17 @@ function configureStore(reducer) {
   )(createStore)(reducer);
 }
 
+function getAll(cache) {
+  const result = [];
+  const cacheValues = Array.from(cache.values());
+  cacheValues.forEach((fnCache) => {
+    Array.from(fnCache.values()).forEach((value) => {
+      result.push(value);
+    });
+  });
+  return result;
+}
+
 describe('memoize', () => {
   function actionCreator() {
     return {
@@ -208,7 +219,7 @@ describe('unit test', () => {
       };
     });
 
-    const memoizeMiddleware = createMemoizeMiddleware({ ttl: 200 });
+    const memoizeMiddleware = createMemoizeMiddleware({ ttl: 200, cache: new Map() });
 
     const store = applyMiddleware(
       memoizeMiddleware,
@@ -223,8 +234,8 @@ describe('unit test', () => {
     expect(typeof result3.then).toBe('function');
     expect(result1 === result3).toBeTruthy();
     expect(result1 === result2).not.toBeTruthy();
-    expect(memoizeMiddleware.getAll().length).toBe(2);
-    Promise.all(memoizeMiddleware.getAll())
+    expect(getAll(memoizeMiddleware.cache).length).toBe(2);
+    Promise.all(getAll(memoizeMiddleware.cache))
       .then(() => {
         expect(thunkCreatorCalled).toBe(2);
         expect(store.getState()).toBe(5);
@@ -247,7 +258,11 @@ describe('unit test', () => {
       payload: num,
     }));
 
-    const memoizeMiddleware = createMemoizeMiddleware({ ttl: 200, disableTTL: false });
+    const memoizeMiddleware = createMemoizeMiddleware({
+      ttl: 200,
+      disableTTL: false,
+      cache: new Map(),
+    });
 
     const store = applyMiddleware(
       memoizeMiddleware,
@@ -262,7 +277,7 @@ describe('unit test', () => {
     expect(typeof result3.then).toBe('function');
     expect(result1 === result3).toBeTruthy();
     expect(result1 === result2).not.toBeTruthy();
-    expect(memoizeMiddleware.getAll().length).toBe(2);
+    expect(getAll(memoizeMiddleware.cache).length).toBe(2);
     expect(store.getState()).toBe(5);
     new Promise((resolve) => {
       setTimeout(() => {
@@ -314,6 +329,7 @@ describe('unit test', () => {
     const memoizeMiddleware = createMemoizeMiddleware({
       disableTTL: false,
       ttl: 50,
+      cache: new Map(),
     });
 
     const store = applyMiddleware(
@@ -329,7 +345,7 @@ describe('unit test', () => {
     expect(typeof result3.then).toBe('function');
     expect(result1 === result3).toBeTruthy();
     expect(result1 === result2).not.toBeTruthy();
-    expect(memoizeMiddleware.getAll().length).toBe(2);
+    expect(getAll(memoizeMiddleware.cache).length).toBe(2);
     expect(store.getState()).toBe(5);
     new Promise((resolve) => {
       setTimeout(() => {
@@ -393,7 +409,7 @@ describe('unit test', () => {
       };
     });
 
-    const memoizeMiddleware = createMemoizeMiddleware({ ttl: 200 });
+    const memoizeMiddleware = createMemoizeMiddleware({ ttl: 200, cache: new Map() });
 
     const store = applyMiddleware(
       thunkMiddleware,
@@ -409,8 +425,8 @@ describe('unit test', () => {
     expect(typeof result3.then).toBe('function');
     expect(result1 === result3).toBeTruthy();
     expect(result1 === result2).not.toBeTruthy();
-    expect(memoizeMiddleware.getAll().length).toBe(2);
-    Promise.all(memoizeMiddleware.getAll())
+    expect(getAll(memoizeMiddleware.cache).length).toBe(2);
+    Promise.all(getAll(memoizeMiddleware.cache))
       .then(() => {
         expect(thunkCreatorCalled).toBe(2);
         expect(thunkCalled).toBe(2);