Merge branch 'master' into next

Author: Scott Prue

docs/api/connect.md

@@ -56,7 +56,7 @@ import { firebaseConnect } from 'react-redux-firebase'
 export default firebaseConnect()(App)
 ```
 
-_Data_
+_Ordered Data_
 
 ```javascript
 import { compose } from 'redux'
@@ -71,56 +71,40 @@ const enhance = compose(
     todos: state.firebase.ordered.todos
   })
 )
+
 // use enhnace to pass todos list as props.todos
 const Todos = enhance(({ todos })) =>
   <div>
     {JSON.stringify(todos, null, 2)}
   </div>
 )
+
+export default enhance(Todos)
 ```
 
 _Data that depends on props_
 
 ```javascript
 import { compose } from 'redux'
 import { connect } from 'react-redux'
-import { firebaseConnect } from 'react-redux-firebase'
+import { firebaseConnect, getVal } from 'react-redux-firebase'
 
 const enhance = compose(
   firebaseConnect((props) => ([
     `posts/${props.postId}` // sync /posts/postId from firebase into redux
   ]),
-  connect(({ firebase: { data } }, props) => ({
-    todo: data.posts && data.todos[postId],
+  connect((state, props) => ({
+    post: getVal(state.firebase.data, `posts/${props.postId}`),
   })
 )
 
-const Posts = ({ done, text, author }) => (
-  <article>
-    <h1>{title}</h1>
-    <h2>By {author.name}</h2>
-    <div>{content}</div>
-  </article>
+const Post = ({ post }) => (
+  <div>
+    {JSON.stringify(post, null, 2)}
+  </div>
 )
 
-export default enhance(Posts)
-```
-
-_Data that depends on state_
-
-```javascript
-import { compose } from 'redux'
-import { connect } from 'react-redux'
-import { firebaseConnect } from 'react-redux-firebase'
-
-export default compose(
-  firebaseConnect((props, store) => ([
-    `todos/${store.getState().firebase.auth.uid}`
-  ]),
-  connect(({ firebase: { data, auth } }) => ({
-    todosList: data.todos && data.todos[auth.uid],
-  }))
-)(SomeComponent)
+export default enhance(Post)
 ```
 
 Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** that accepts a component to wrap and returns the wrapped component

docs/api/enhancer.md

@@ -27,7 +27,7 @@ along side applyMiddleware.
         profile when logging in. (default: `true`)
     -   `config.resetBeforeLogin` **[Boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Whether or not to empty profile
         and auth state on login
-    -   `config.perserveOnLogout` **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) \| [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array))** Data parameters to perserve
+    -   `config.preserveOnLogout` **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) \| [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array))** Data parameters to preserve
         when logging out. If Array is passed, each item represents keys
         within `state.firebase.data` to preserve. If an object is passed,
         keys associate with slices of state to preserve, and the values can be either

src/enhancer.js

@@ -26,7 +26,7 @@ let firebaseInstance
  * profile when logging in. (default: `true`)
  * @param {Boolean} config.resetBeforeLogin - Whether or not to empty profile
  * and auth state on login
- * @param {Object|Array} config.perserveOnLogout - Data parameters to perserve
+ * @param {Object|Array} config.preserveOnLogout - Data parameters to preserve
  * when logging out. If Array is passed, each item represents keys
  * within `state.firebase.data` to preserve. If an object is passed,
  * keys associate with slices of state to preserve, and the values can be either

src/firebaseConnect.js

@@ -111,7 +111,7 @@ export const createFirebaseConnect = (storeKey = 'store') => (
  * // props.firebase set on App component as firebase object with helpers
  * import { firebaseConnect } from 'react-redux-firebase'
  * export default firebaseConnect()(App)
- * @example <caption>Data</caption>
+ * @example <caption>Ordered Data</caption>
  * import { compose } from 'redux'
  * import { connect } from 'react-redux'
  * import { firebaseConnect } from 'react-redux-firebase'
@@ -124,47 +124,35 @@ export const createFirebaseConnect = (storeKey = 'store') => (
  *     todos: state.firebase.ordered.todos
  *   })
  * )
+ * 
  * // use enhnace to pass todos list as props.todos
  * const Todos = enhance(({ todos })) =>
  *   <div>
  *     {JSON.stringify(todos, null, 2)}
  *   </div>
  * )
+ * 
+ * export default enhance(Todos)
  * @example <caption>Data that depends on props</caption>
  * import { compose } from 'redux'
  * import { connect } from 'react-redux'
- * import { firebaseConnect } from 'react-redux-firebase'
+ * import { firebaseConnect, getVal } from 'react-redux-firebase'
  *
  * const enhance = compose(
  *   firebaseConnect((props) => ([
  *     `posts/${props.postId}` // sync /posts/postId from firebase into redux
  *   ]),
- *   connect(({ firebase: { data } }, props) => ({
- *     todo: data.posts && data.todos[postId],
+ *   connect((state, props) => ({
+ *     post: getVal(state.firebase.data, `posts/${props.postId}`),
  *   })
  * )
  *
- * const Posts = ({ done, text, author }) => (
- *   <article>
- *     <h1>{title}</h1>
- *     <h2>By {author.name}</h2>
- *     <div>{content}</div>
- *   </article>
+ * const Post = ({ post }) => (
+ *   <div>
+ *     {JSON.stringify(post, null, 2)}
+ *   </div>
  * )
  *
- * export default enhance(Posts)
- * @example <caption>Data that depends on state</caption>
- * import { compose } from 'redux'
- * import { connect } from 'react-redux'
- * import { firebaseConnect } from 'react-redux-firebase'
- *
- * export default compose(
- *   firebaseConnect((props, store) => ([
- *     `todos/${store.getState().firebase.auth.uid}`
- *   ]),
- *   connect(({ firebase: { data, auth } }) => ({
- *     todosList: data.todos && data.todos[auth.uid],
- *   }))
- * )(SomeComponent)
+ * export default enhance(Post)
  */
 export default createFirebaseConnect()