v2.0.0 beta.5 (#229)

* Fix bug in `updateProfile` method - #210
* Fix population with deep root - #223
* Fix RN sources must be an object error - #228, #231
* Fix an issue using string notation within `profileParamsToPopulate`
* `hoist-non-react-statics` updated
* `npm run docs:upload` added for uploading version specific docs (`npm run docs:publish` still used for publishing main version)
* fixed login method return signature (object including `user`) - #206

Author: prescottprue

.eslintignore

@@ -1,3 +1,5 @@
 examples/**
 coverage/**
 node_modules/**
+_book/**
+_site/**

.gitignore

@@ -5,8 +5,10 @@ coverage
 dist
 es
 lib
-_book
+_book/**
+_site/**
 # Logs
 *.log
 .DS_Store
 examples/complete/react-native/ios/build
+/.idea

bin/api-docs-upload.js

@@ -0,0 +1,82 @@
+const exec = require('child-process-promise').exec
+const version = require('../package.json').version
+
+/**
+  NOTE: Split into two arrays because gsutil acts differently when
+  no files exist at a location. First array includes at least one file for each
+  folder that will be copied in the second.
+*/
+const first = [
+  '_book/index.html',
+  '_book/search_index.json',
+  '_book/gitbook/gitbook.js',
+  '_book/docs/README.md'
+]
+
+const second = [
+  '_book/gitbook/**',
+  '_book/docs/**'
+]
+
+const project = 'docs.react-redux-firebase.com'
+
+/**
+ * Run shell command with error handling.
+ * @param  {String} cmd - Command to run
+ * @return {Promise} Resolves with stdout of running command
+ * @private
+ */
+const runCommand = (cmd) => {
+  const baseCommand = cmd.split(' ')[0]
+  return exec(baseCommand)
+    .catch((err) =>
+      err.message && err.message.indexOf('not found') !== -1
+        ? Promise.reject(new Error(`${baseCommand} must be installed to upload`))
+        : Promise.reject(err)
+    )
+}
+
+/**
+ * Upload file or folder to cloud storage. gsutil is used instead of
+ * google-cloud/storage module so that folders can be uploaded.
+ * @param  {String} entityPath - Local path for entity (file/folder) to upload
+ * @return {Promise} Resolve with an object containing stdout and uploadPath
+ * @private
+ */
+const upload = (entityPath) => {
+  const prefix = `history/${version.split('-')[0]}`
+  const uploadPath = `${project}/${prefix}/${entityPath.replace('_book/', '').replace('/**', '')}`
+  return runCommand(`gsutil -m cp -r -a public-read ${entityPath} gs://${uploadPath}`)
+    .then((stdout) => ({ stdout, uploadPath }))
+}
+
+/**
+ * Upload list of files or folders to Google Cloud Storage
+ * @param  {Array} files - List of files/folders to upload
+ * @return {Promise} Resolves with an array of upload results
+ * @private
+ */
+const uploadList = (files) => {
+  return Promise.all(
+    files.map(file =>
+      upload(file)
+        .then(({ uploadPath }) => {
+          console.log(`Successfully uploaded: ${uploadPath}`) // eslint-disable-line no-console
+          return file
+        })
+    )
+  )
+}
+
+(function () {
+  uploadList(first)
+    .then(() => uploadList(second))
+    .then(() => {
+      console.log('Docs uploaded successfully') // eslint-disable-line no-console
+      process.exit(0)
+    })
+    .catch((err) => {
+      console.log('Error uploading docs:', err.message) // eslint-disable-line no-console
+      process.exit(1)
+    })
+})()

examples/complete/material/src/routes/Home/containers/HomeContainer.js

@@ -7,7 +7,7 @@ import {
   firebaseConnect,
   isLoaded,
   isEmpty,
-  populate // for populated list
+  // populate // for populated list
 } from 'react-redux-firebase'
 import CircularProgress from 'material-ui/CircularProgress'
 import Snackbar from 'material-ui/Snackbar'
@@ -20,27 +20,30 @@ import classes from './HomeContainer.scss'
 
 const populates = [{ child: 'owner', root: 'users' }]
 
+// Pass an array of path settings to create Firebase queries
 @firebaseConnect([
   // 'todos' // sync full list of todos
   // { path: 'todos', populates }, // gather data to populate owners (uid => object)
   // { path: 'todos', type: 'once' } // for loading once instead of binding
-  { path: 'todos', queryParams: ['orderByKey', 'limitToLast=5'] } // 10 most recent
+  { path: 'todos', queryParams: ['orderByKey', 'limitToLast=10'] }, // 10 most recent
+  // { path: 'todos', storeAs: 'myTodos' }, // store somewhere else in redux
+  // { path: 'todos', queryParams: ['orderByKey', 'limitToLast=5'] } // 10 most recent
 ])
+// Get data from redux and pass in as props
 @connect(
-  // get auth, profile, and data from
   ({ firebase, firebase: { auth, profile, data: { todos } } }) => ({
     auth,
     profile,
     todos,
     // todos: populate(firebase, 'todos', populates) // populate todos with users data from redux
-    // todos: firebase.ordered.todos // if using ordering such as orderByChild
+    // todos: firebase.ordered.todos // if using ordering such as orderByChild or orderByKey
   })
 )
 export default class Home extends Component {
   static propTypes = {
     todos: PropTypes.oneOfType([
-      PropTypes.object, // object if using dataToJS
-      PropTypes.array // array if using orderedToJS
+      PropTypes.object, // object if using firebase.data
+      PropTypes.array // array if using firebase.ordered
     ]),
     firebase: PropTypes.shape({
       set: PropTypes.func.isRequired,

examples/complete/material/yarn.lock

@@ -2849,6 +2849,10 @@ istanbul-lib-instrument@^1.1.4:
     istanbul-lib-coverage "^1.1.1"
     semver "^5.3.0"
 
+jest-docblock@^20.0.1:
+  version "20.0.3"
+  resolved "https://registry.yarnpkg.com/jest-docblock/-/jest-docblock-20.0.3.tgz#17bea984342cc33d83c50fbe1545ea0efaa44712"
+
 joi@^6.10.1:
   version "6.10.1"
   resolved "https://registry.yarnpkg.com/joi/-/joi-6.10.1.tgz#4d50c318079122000fe5f16af1ff8e1917b77e06"
@@ -4073,7 +4077,7 @@ promise@^7.0.3, promise@^7.1.1:
   dependencies:
     asap "~2.0.3"
 
-[email protected], prop-types@^15.5.4, prop-types@^15.5.6:
+[email protected]:
   version "15.5.8"
   resolved "https://registry.yarnpkg.com/prop-types/-/prop-types-15.5.8.tgz#6b7b2e141083be38c8595aa51fc55775c7199394"
   dependencies:

package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-redux-firebase",
-  "version": "2.0.0-beta.4",
+  "version": "2.0.0-beta.5",
   "description": "Redux integration for Firebase. Comes with a Higher Order Component for use with React.",
   "main": "lib/index.js",
   "module": "es/index.js",
@@ -28,7 +28,8 @@
     "docs:api": "node bin/api-docs-generate",
     "docs:build": "npm run docs:prepare && gitbook build -g prescottprue/react-redux-firebase && npm run docs:api",
     "docs:watch": "npm run docs:prepare && gitbook serve",
-    "docs:publish": "npm run docs:clean && npm run docs:build && cp CNAME _book && cd _book && git init && git commit --allow-empty -m 'update book' && git checkout -b gh-pages && touch .nojekyll && git add . && git commit -am 'update book' && git push [email protected]:prescottprue/react-redux-firebase gh-pages --force"
+    "docs:publish": "npm run docs:clean && npm run docs:build && cp CNAME _book && cd _book && git init && git commit --allow-empty -m 'update book' && git checkout -b gh-pages && touch .nojekyll && git add . && git commit -am 'update book' && git push [email protected]:prescottprue/react-redux-firebase gh-pages --force",
+    "docs:upload": "node bin/api-docs-upload"
   },
   "license": "MIT",
   "homepage": "https://github.com/prescottprue/react-redux-firebase#readme",
@@ -56,10 +57,10 @@
     "redux-react-firebase"
   ],
   "dependencies": {
-    "hoist-non-react-statics": "^1.2.0",
+    "hoist-non-react-statics": "^2.2.2",
     "jwt-decode": "^2.2.0",
     "lodash": "^4.17.4",
-    "prop-types": "^15.5.8"
+    "prop-types": "^15.5.10"
   },
   "peerDependencies": {
     "react": "^0.14.6 || ^15.0.0-0 || ^16.0.0-0"
@@ -69,8 +70,8 @@
     "babel-core": "^6.24.0",
     "babel-eslint": "^7.2.1",
     "babel-loader": "^7.1.1",
-    "babel-plugin-lodash": "^3.2.11",
     "babel-plugin-add-module-exports": "^0.2.1",
+    "babel-plugin-lodash": "^3.2.11",
     "babel-plugin-transform-class-properties": "^6.23.0",
     "babel-plugin-transform-decorators-legacy": "^1.3.4",
     "babel-plugin-transform-object-assign": "^6.22.0",
@@ -81,6 +82,7 @@
     "babel-register": "^6.24.0",
     "chai": "^3.5.0",
     "chai-as-promised": "^6.0.0",
+    "child-process-promise": "^2.2.1",
     "codecov": "^2.1.0",
     "cross-env": "^1.0.7",
     "docdown": "^0.7.2",

src/actions/auth.js

@@ -64,7 +64,7 @@ export const watchUserProfile = (dispatch, firebase) => {
         } else {
           // TODO: Share population logic with query action
           // Convert each populate string in array into an array of once query promises
-          promisesForPopulate(firebase, snap.val(), profileParamsToPopulate)
+          promisesForPopulate(firebase, snap.key, snap.val(), profileParamsToPopulate)
             .then(data => {
               // Fire actions for placement of data gathered in populate into redux
               forEach(data, (result, path) => {
@@ -262,15 +262,17 @@ export const init = (dispatch, firebase) => {
  */
 export const login = (dispatch, firebase, credentials) => {
   dispatchLoginError(dispatch, null)
-  let { method, params } = getLoginMethodAndParams(firebase, credentials)
+  const { method, params } = getLoginMethodAndParams(firebase, credentials)
 
   return firebase.auth()[method](...params)
     .then((userData) => {
       // Handle null response from getRedirectResult before redirect has happened
       if (!userData) return Promise.resolve(null)
 
       // For email auth return uid (createUser is used for creating a profile)
-      if (method === 'signInWithEmailAndPassword') return userData.uid
+      if (method === 'signInWithEmailAndPassword') {
+        return { user: userData }
+      }
 
       // For token auth, the user key doesn't exist. Instead, return the JWT.
       if (method === 'signInWithCustomToken') {
@@ -470,17 +472,20 @@ export const updateProfile = (dispatch, firebase, profileUpdate) => {
   dispatch({ type: actionTypes.PROFILE_UPDATE_START, payload: profileUpdate })
 
   const { database, _: { config, authUid } } = firebase
-
-  return database()
-    .ref(`${config.userProfile}/${authUid}`)
+  const profileRef = database().ref(`${config.userProfile}/${authUid}`)
+  return profileRef
     .update(profileUpdate)
-    .then((snap) => {
-      dispatch({
-        type: actionTypes.PROFILE_UPDATE_SUCCESS,
-        payload: snap.val()
-      })
-      return snap.val()
-    })
+    .then(() =>
+      profileRef
+        .once('value')
+        .then((snap) => {
+          dispatch({
+            type: actionTypes.PROFILE_UPDATE_SUCCESS,
+            payload: snap.val()
+          })
+          return snap
+        })
+    )
     .catch((payload) => {
       dispatch({ type: actionTypes.PROFILE_UPDATE_ERROR, payload })
       return Promise.reject(payload)

src/actions/query.js

@@ -85,7 +85,7 @@ export const watchEvent = (firebase, dispatch, { type, path, populates, queryPar
           if (snapshot.val() !== null) {
             const ordered = []
             snapshot.forEach((child) => {
-              ordered.push({ key: child.key, ...child.val() })
+              ordered.push({ key: child.key, value: child.val() })
             })
             dispatch({
               type: SET,
@@ -112,10 +112,10 @@ export const watchEvent = (firebase, dispatch, { type, path, populates, queryPar
       // create an array for preserving order of children under ordered
       const ordered = []
       if (e === 'child_added') {
-        ordered.push({ key: snapshot.key, ...snapshot.val() })
+        ordered.push({ key: snapshot.key, value: snapshot.val() })
       } else {
         snapshot.forEach((child) => {
-          ordered.push({ key: child.key, ...child.val() })
+          ordered.push({ key: child.key, value: child.val() })
         })
       }
 

src/helpers.js

@@ -105,11 +105,10 @@ export const buildChildList = (state, list, p) =>
     if (val === true) {
       getKey = key
     }
+    const dotRoot = compact(p.root.split('/')).join('.')
     const pathString = p.childParam
-      ? `${p.root}.${getKey}.${p.childParam}`
-      : `${p.root}.${getKey}`
-
-    // console.log('path string:', { pathString, state })
+      ? `${dotRoot}.${getKey}.${p.childParam}`
+      : `${dotRoot}.${getKey}`
     // Set to child under key if populate child exists
     if (get(state.data, pathString)) {
       return p.keyProp
@@ -155,7 +154,7 @@ export const populate = (state, path, populates, notSetValue) => {
     return notSetValue
   }
   // test if data is a single object vs a list of objects, try generating
-  // populates and testing for key presence
+  // populates and testing for key existence
   const populatesForData = getPopulateObjs(
     isFunction(populates)
       ? populates(last(split(path, '/')), get(data, dotPath))
@@ -171,9 +170,10 @@ export const populate = (state, path, populates, notSetValue) => {
         // populate child is key
         if (isString(get(get(data, dotPath), p.child))) {
           const key = get(get(data, dotPath), p.child)
+          const dotRoot = compact(p.root.split('/')).join('.')
           const pathString = p.childParam
-            ? `${p.root}.${key}.${p.childParam}`
-            : `${p.root}.${key}`
+            ? `${dotRoot}.${key}.${p.childParam}`
+            : `${dotRoot}.${key}`
 
           if (get(data, pathString)) {
             return set({}, p.child, p.keyProp
@@ -211,9 +211,10 @@ export const populate = (state, path, populates, notSetValue) => {
         if (isString(get(child, p.child))) {
           const key = get(child, p.child)
           // attach child paramter if it exists
+          const dotRoot = compact(p.root.split('/')).join('.')
           const pathString = p.childParam
-            ? `${p.root}.${key}.${p.childParam}`
-            : `${p.root}.${key}`
+            ? `${dotRoot}.${key}.${p.childParam}`
+            : `${dotRoot}.${key}`
           if (get(data, pathString)) {
             return set({}, p.child, (p.keyProp
               ? { [p.keyProp]: key, ...get(data, pathString) }

src/utils/populate.js

@@ -131,9 +131,11 @@ export const promisesForPopulate = (firebase, dataKey, originalData, populatesIn
   let results = {}
 
   // test if data is a single object, try generating populates and looking for the child
-  const populatesForData = getPopulateObj(isFunction(populatesIn)
-    ? populatesIn(dataKey, originalData)
-    : populatesIn)
+  const populatesForData = getPopulateObjs(
+    isFunction(populatesIn)
+      ? populatesIn(dataKey, originalData)
+      : populatesIn
+  )
 
   const dataHasPopulateChilds = every(populatesForData, (populate) => (
     has(originalData, populate.child)