Master v1.0.0

README.md

@@ -1,4 +1,4 @@
-# redux-leaves
+# Redux Leaves
 
 Write once. Reduce anywhere.
 
@@ -17,11 +17,11 @@ npm install --save redux-leaves
 [Main documentation website](https://redux-leaves.js.org)
 
 ### Getting started
-- [Overview](docs/intro/README.md)
-- [30 second demo](docs/examples/basicExample.md)
+- [Overview](https://redux-leaves.js.org/docs/intro/overview)
+- [30 second demo](https://runkit.com/richardcrng/redux-leaves-playground/)
 
 ### API reference
-- [Core: `reduxLeaves(initialState, reducers)`](docs/README.md)
+- [Core: `reduxLeaves(initialState, reducers)`](https://redux-leaves.js.org/docs/redux-leaves)
 
 ### Testing
 

docs/api/bundle.md

@@ -94,12 +94,11 @@ const store = createStore(reducer)
 
 const incrementThenPush = bundle([
   actions.counter.create.increment(),
-  actions.list.create.apply((leafState, treeState) => [...leafState, treeState.counter])
+  actions.list.create.do((leafState, treeState) => [...leafState, treeState.counter])
 ])
 
 const pushThenIncrement = bundle([
-  actions.list.create.apply((leafState, treeState) => [...leafState, treeState.counter]),    
-  actions.counter.create.increment()
+  actions.list.create.do((leafState, treeState) => [...leafState, treeState.counter]),    actions.counter.create.increment()
 ])
 
 store.dispatch(incrementThenPush)

docs/api/bundle.spec.js

@@ -59,11 +59,11 @@ describe('bundle bundles together actions into a single one', () => {
     test('Processes actions in the order passed into the array', () => {
       const incrementThenPush = bundle([
         actions.counter.create.increment(),
-        actions.list.create.apply((leafState, treeState) => [...leafState, treeState.counter])
+        actions.list.create.do((leafState, treeState) => [...leafState, treeState.counter])
       ])
 
       const pushThenIncrement = bundle([
-        actions.list.create.apply((leafState, treeState) => [...leafState, treeState.counter]), actions.counter.create.increment()
+        actions.list.create.do((leafState, treeState) => [...leafState, treeState.counter]), actions.counter.create.increment()
       ])
 
       store.dispatch(incrementThenPush)

docs/defaults/do.md

@@ -0,0 +1,71 @@
+---
+id: do
+title: do
+hide_title: true
+sidebar_label: do
+---
+
+# `do(callback)`
+**`create.do`**
+**`create(actionType).do`**
+*Appropriate leaf state: any*
+
+Returns an (action) object that the [reduxLeaves](../README.md) reducer uses to non-mutatively update the leaf's state to the return value of `callback(leafState, treeState)`.
+
+*Note: creating an action using `do(callback)` does not follow Redux's non-enforced recommendation that [actions should always be serializable](https://redux.js.org/faq/actions#why-should-type-be-a-string-or-at-least-serializable-why-should-my-action-types-be-constants), since the resultant action will have the function `callback` as its `payload`.*
+
+## Parameters
+- `callback` *(function)*: invoked by the leaf's reducer with two arguments, `leafState` and `entireState`
+
+## Returns
+`action` *(object)*: an object to dispatch to the `store`
+
+## Example
+```js
+import { createStore } from 'redux'
+import reduxLeaves from 'reduxLeaves'
+
+const initialState = {
+  bool: false,
+  num: 2,
+  str: 'foo',
+  arr: [1, 2, 3]
+}
+
+const [reducer, actions] = reduxLeaves(initialState)
+const store = createStore(reducer)
+```
+
+### Calling `create.do` on a leaf:
+
+```js
+const doToString = actions.str.create.do
+store.dispatch(doToString(state => state.toUpperCase()))
+console.log(store.getState().str) // 'FOO'
+```
+
+### Calling `create(actionType).do` on a leaf:
+
+```js
+const doToBoolean = actions.bool.create('APPLY_TO_BOOLEAN').do
+store.dispatch(doToBoolean(state => !state))
+console.log(store.getState().bool) // true
+```
+
+### Calling `create.do` on a branch:
+
+```js
+const doToState = actions.create.do
+store.dispatch(doToState(state => ({ num: state.num, arr: state.arr }))
+console.log(store.getState()) // { num: 2, arr: [1, 2, 3] }
+```
+
+### Calling `create.do` with two arguments:
+
+```js
+const doToArray = actions.arr.create.do
+store.dispatch(doToArray(
+  (leafState, treeState) => leafState.map(element => element * treeState.num)
+))
+console.log(store.getState()) // { num: 2, arr: [2, 4, 6] }
+```

docs/defaults/do.spec.js

@@ -0,0 +1,41 @@
+import { createStore } from "redux";
+import reduxLeaves from '../../src';
+
+describe("leaf.create.do(callback): returns an action that, when dispatched, updates the leaf's state to the return value of callback(state, entireState)", () => {
+  const initialState = {
+    bool: false,
+    num: 2,
+    str: 'foo',
+    arr: [1, 2, 3],
+    obj: {}
+  }
+
+  const [reducer, actions] = reduxLeaves(initialState)
+  const store = createStore(reducer)
+
+  test("Calling create.do on a leaf", () => {
+    const doToString = actions.str.create.do
+    store.dispatch(doToString(state => state.toUpperCase()))
+    expect(store.getState().str).toBe('FOO')
+  })
+
+  test("Calling create(actionType).do on a leaf", () => {
+    const doToBoolean = actions.bool.create('APPLY_TO_BOOLEAN').do
+    store.dispatch(doToBoolean(state => !state))
+    expect(store.getState().bool).toBe(true)
+  })
+
+  test("Calling create.do on a branch", () => {
+    const doToState = actions.create.do
+    store.dispatch(doToState(state => ({ num: state.num, arr: state.arr })))
+    expect(store.getState()).toEqual({ num: 2, arr: [1, 2, 3] })
+  })
+
+  test("Calling create.do with two arguments", () => {
+    const doToArray = actions.arr.create.do
+    store.dispatch(doToArray(
+      (leafState, treeState) => leafState.map(element => element * treeState.num)
+    ))
+    expect(store.getState()).toEqual({ num: 2, arr: [2, 4, 6] })
+  })
+})