initial commit with combineReducers and mergeChildReducers

bdwain · bdwain · commit a2d2f819e8d1 · 2017-09-30T00:17:55.000-05:00
diff --git a/.babelrc b/.babelrc
@@ -0,0 +1,13 @@
+{
+  "presets": [["env", {"modules": false}]],
+  "plugins": [
+    "transform-object-rest-spread",
+    "transform-es3-member-expression-literals",
+    "transform-es3-property-literals"
+  ],
+  "env": {
+    "commonjs": {
+      "presets": [["env", {"modules": "commonjs"}]]
+    }
+  }
+}
diff --git a/.eslintrc b/.eslintrc
@@ -0,0 +1,3 @@
+{
+  "extends": "react-app",
+}
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,6 @@
+.DS_Store
+*.log
+node_modules
+dist
+lib
+es
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,8 @@
+language: node_js
+node_js:
+  - "node"
+
+cache: yarn
+
+script:
+  - yarn prepublishOnly
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,50 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at bryandwain@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,16 @@
+# Contributing to redux-loop
+
+## Code of Conduct
+
+Please note that this project is released with a [Contributor Code of
+Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to
+abide by its terms. Multiple language translations are available at
+[contributor-covenant.org](http://contributor-covenant.org/version/1/3/0/i18n/)
+
+
+## Issues
+
+Issues in which the maintainers have requested more information from the issue-
+creator and the issue-creator has not responded within 7 days will be closed
+with a note. Closed issues can be reopened once the issue-creator has responded
+with the information requested.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Bryan Wain
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
diff --git a/package.json b/package.json
@@ -0,0 +1,91 @@
+{
+  "name": "redux-loop-immutable",
+  "version": "0.0.0",
+  "description": "ImmutableJS Extensions for Redux Loop",
+  "main": "lib/index.js",
+  "module": "es/index.js",
+  "jsnext:main": "es/index.js",
+  "homepage": "https://github.com/redux-loop/redux-loop-immutable",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/redux-loop/redux-loop-immutable.git"
+  },
+  "bugs": {
+    "url": "https://github.com/redux-loop/redux-loop-immutable/issues"
+  },
+  "files": [
+    "dist",
+    "es",
+    "lib",
+    "src"
+  ],
+  "scripts": {
+    "clear": "rimraf lib dist es",
+    "lint": "eslint --max-warnings=0 src test",
+    "test": "cross-env BABEL_ENV=commonjs jest",
+    "build:commonjs": "cross-env BABEL_ENV=commonjs babel src --out-dir lib",
+    "build:es": "cross-env BABEL_ENV=es babel src --out-dir es",
+    "build:umd": "cross-env BABEL_ENV=es NODE_ENV=development rollup -c -i src/index.js -o dist/redux-loop-immutable.js",
+    "build:umd:min": "cross-env BABEL_ENV=es NODE_ENV=production rollup -c -i src/index.js -o dist/redux-loop-immutable.min.js",
+    "build": "yarn build:commonjs && yarn build:es && yarn build:umd && yarn build:umd:min",
+    "prebuild": "yarn run clear",
+    "prepublishOnly": "yarn lint && yarn test && yarn build"
+  },
+  "keywords": [
+    "redux",
+    "middleware",
+    "effects",
+    "side effects",
+    "elm",
+    "loop",
+    "immutable"
+  ],
+  "tags": [
+    "redux",
+    "middleware",
+    "effects",
+    "side effects",
+    "elm",
+    "loop",
+    "immutable"
+  ],
+  "author": "Bryan Wain <bryandwain@gmail.com>",
+  "license": "MIT",
+  "peerDependencies": {
+    "immutable": "^3.7.6",
+    "redux-loop": "^4.0.0"
+  },
+  "devDependencies": {
+    "babel-cli": "6.26.0",
+    "babel-core": "^6.3.15",
+    "babel-eslint": "^7.2.3",
+    "babel-plugin-external-helpers": "^6.22.0",
+    "babel-plugin-transform-es3-member-expression-literals": "6.22.0",
+    "babel-plugin-transform-es3-property-literals": "6.22.0",
+    "babel-plugin-transform-object-rest-spread": "6.26.0",
+    "babel-polyfill": "^6.26.0",
+    "babel-preset-env": "^1.6.0",
+    "cross-env": "^5.0.5",
+    "eslint": "^4.8.0",
+    "eslint-config-react-app": "^2.0.1",
+    "eslint-plugin-flowtype": "^2.37.0",
+    "eslint-plugin-import": "^2.7.0",
+    "eslint-plugin-jsx-a11y": "^5.1.1",
+    "eslint-plugin-react": "^7.4.0",
+    "immutable": "^3.7.6",
+    "jest": "^21.2.1",
+    "redux-loop": "^4.0.0",
+    "rimraf": "^2.6.2",
+    "rollup": "^0.50.0",
+    "rollup-plugin-babel": "^3.0.2",
+    "rollup-plugin-commonjs": "^8.2.1",
+    "rollup-plugin-node-resolve": "^3.0.0",
+    "rollup-plugin-replace": "^2.0.0",
+    "rollup-plugin-uglify": "^2.0.1"
+  },
+  "dependencies": {
+  },
+  "jest": {
+    "testRegex": "(/test/.*\\.spec.js)$"
+  }
+}
diff --git a/rollup.config.js b/rollup.config.js
@@ -0,0 +1,46 @@
+import nodeResolve from 'rollup-plugin-node-resolve';
+import babel from 'rollup-plugin-babel';
+import replace from 'rollup-plugin-replace';
+import uglify from 'rollup-plugin-uglify';
+import commonjs from 'rollup-plugin-commonjs';
+
+var env = process.env.NODE_ENV
+var config = {
+  output: {
+    format: 'umd'
+  },
+  name: 'ReduxLoopImmutable',
+  plugins: [
+    nodeResolve({
+      jsnext: true
+    }),
+    babel({
+      exclude: 'node_modules/**',
+      plugins: ['external-helpers']
+    }),
+    replace({
+      'process.env.NODE_ENV': JSON.stringify(env)
+    }),
+    commonjs({
+      include: 'node_modules/**',
+      namedExports: {
+        'node_modules/immutable/dist/immutable.js': [ 'Map', 'is', 'fromJS']
+      }
+    }),
+  ]
+}
+
+if (env === 'production') {
+  config.plugins.push(
+    uglify({
+      compress: {
+        pure_getters: true,
+        unsafe: true,
+        unsafe_comps: true,
+        warnings: false
+      }
+    })
+  )
+}
+
+export default config
diff --git a/src/combine-reducers.js b/src/combine-reducers.js
@@ -0,0 +1,11 @@
+import {Map} from 'immutable';
+import mergeChildReducers from './merge-child-reducers';
+
+//a helper to merge a bunch of reducers together with no shared root state
+//simpler version of mergeChildReducers for when the parent does nothing (like app root)
+
+export default function combineReducers(childMap){
+  return (rootState = Map(), action) => {
+    return mergeChildReducers(rootState, action, childMap);
+  };
+}
diff --git a/src/index.js b/src/index.js
@@ -0,0 +1,7 @@
+import combineReducers from './combine-reducers';
+import mergeChildReducers from './merge-child-reducers';
+
+export {
+  mergeChildReducers,
+  combineReducers
+};
diff --git a/src/merge-child-reducers.js b/src/merge-child-reducers.js
@@ -0,0 +1,78 @@
+import {loop, isLoop, getModel, getCmd, Cmd} from 'redux-loop';
+
+/*
+mergeChildReducers can be used to map child reducers to keys on a parent reducer.
+this can be used to nest your reducers, better organize the state, and make 
+reusable features with their own slices of state that can be placed on any page
+
+example:
+import childReducer from 'child'; 
+import child2Reducer from 'child2'; 
+
+function reducer(state, action){
+  let result;
+  switch(action.type){
+    case 'add1':
+      result = state.update('value', val => val + 1);
+      break;
+    case 'sideEffect'
+      result = loop(state, Cmd.action(whatever));
+      break;
+    default:
+      result = state;
+      break;
+  }
+  return mergeChildStates(result, action, {
+    child: childReducer //can be anything. result will be on state.child. Cmds will be run
+    child2: child2Reducer,
+    child3: null //child 3 will be removed from the state
+  });
+}
+
+params:
+parentResult is either the parent's new state or a loop containing the new state and a Cmd from the parent
+
+action is the action
+
+childMap is an object mapping key names on the parent state to a child reducer.
+the values should be child reducers or null. null values will cause their keys to be removed from state
+*/
+
+export default function mergeChildReducers(parentResult, action, childMap){
+  let initialState = parentResult, parentCmd;
+  if(isLoop(initialState)){
+    parentCmd = getCmd(initialState);
+    initialState = getModel(initialState);
+  }
+
+  let keys = Object.keys(childMap);
+  let cmds = parentCmd ? [parentCmd] : [];
+
+  const newState = initialState.withMutations(state => {
+    keys.forEach(key => {
+      let childReducer = childMap[key];
+      if(!childReducer){
+        state.delete(key);
+        return;
+      }
+      let currentChild = childReducer(state.get(key), action);
+      if(isLoop(currentChild)){
+        cmds.push(getCmd(currentChild));
+        currentChild = getModel(currentChild);
+      }
+      state.set(key, currentChild);
+    });
+  });
+  return loop(newState, getListCmdIfNeeded(cmds)); 
+}
+
+function getListCmdIfNeeded(cmds) {
+  switch(cmds.length) {
+    case 0:
+      return Cmd.none;
+    case 1:
+      return cmds[0];
+    default:
+      return Cmd.list(cmds);
+  }
+}
diff --git a/test/.eslintrc b/test/.eslintrc
@@ -0,0 +1,5 @@
+{
+  "env": {
+    "jest": true
+  }
+}
diff --git a/test/combine-reducers.spec.js b/test/combine-reducers.spec.js
diff --git a/test/merge-child-reducer.spec.js b/test/merge-child-reducer.spec.js
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "extends": "react-app",`
	`3`	`+}`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,6 @@ @@
 +.DS_Store
 +*.log
 +node_modules
 +dist
 +lib
 +es