v1.4.5 (prescottprue#225)

* display name logic is now internal (eliminates dependency)
* `try/catch` added around usage of profileFactory (incase provided `profileFactory` function throws an error)
* Fix possibility of race condition with `uniqueSet` - prescottprue#207
* Fix issue using storeAs with populates - prescottprue#216
* Profile docs improved for clarity
* `.eslintrc` added to tests folder (extends base`.eslintrc`)
* `PULL_REQUEST_TEMPLATE` simplified
* `ISSUE_TEMPLATE` simplified and includes link to [codesandbox](https://codesandbox.io/) instead of [codepen](http://codepen.io)
* Lint removed from tests

Author: prescottprue

.eslintignore

@@ -1,4 +1,3 @@
 examples/**
 coverage/**
 node_modules/**
-*.spec.js

.github/ISSUE_TEMPLATE.md

@@ -1,13 +1,13 @@
 **Do you want to request a *feature* or report a *bug*?**  
 
-(If this is a *usage question*, please **do not post it here**—post it on [gitter](https://gitter.im/redux-firebase/Lobby) or [Stack Overflow](http://stackoverflow.com/questions/tagged/react-redux-firebase) instead. If this is not a “feature” or a “bug”, or the phrase “How do I...?” applies, then it's probably a usage question.)
+(If this is a *usage question*, please **do not post it here**—post it on [gitter](https://gitter.im/redux-firebase/Lobby). If this is not a “feature” or a “bug”, or the phrase “How do I...?” applies, then it's probably a usage question.)
 
 
 **What is the current behavior?**
 
 
 
-**If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem via https://jsfiddle.net or similar.**
+**If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem via [codesandbox](https://codesandbox.io/) or similar.**
 
 
 
@@ -18,4 +18,4 @@
 **Which versions of dependencies, and which browser and OS are affected by this issue? Did this work in previous versions or setups?**
 
 <!-- Love react-redux-firebase? Please consider supporting our collective:
-👉  https://opencollective.com/react-redux-firebase/donate -->
+👉  https://opencollective.com/react-redux-firebase/donate -->

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,19 +1,12 @@
 ### Description
 
-<!-- Write Your Description Here ^  -->
-<!-- Some things that may be of interest to address:
-- Will a new version need to be released or is this a docs change?
-- Which version should this be published as a part of? ("ASAP", "no idea", and specific version number)
-- Does this impact the external API?
-- Will it need to be a breaking change? -->
 
 ### Check List
 If not relevant to pull request, check off as complete
 
 - [ ] All tests passing
-- [ ] Docs updated with any changes or examples
-- [ ] Added tests to ensure feature(s) work properly
+- [ ] Docs updated with any changes or examples if applicable
+- [ ] Added tests to ensure new feature(s) work properly
 
 ### Relevant Issues
-<!-- List Relevant Issues here -->
 <!-- * #1 -->

docs/auth.md

@@ -78,14 +78,31 @@ export default firebaseConnect()(SomeComponent)
         ```
 
 
+After logging in, profile and auth are available in redux state:
+
+```js
+import { connect } from 'react-redux'
+
+connect(() => ({
+  auth: pathToJS(firebase, 'auth'),
+  profile: pathToJS(firebase, 'profile')
+}))(SomeComponent)
+```
+
+For more information on how best to use these methods, visit the [auth recipes](/docs/recipes/auth.md)
+
 ##### Returns
-[**Promise**](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) with an object containing profile, user, (also credential if using oAuth provider) in case of success or the error otherwise.
+[**Promise**](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) with an object (or a string, see note) containing profile, user, (also credential if using oAuth provider) in case of success or the error otherwise.
+
+**NOTE**: For email authentication in `v1.4.*` and earlier - The user's UID (a [**String**](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)) is returned instead of an object. This will change in `v1.5.0` for consistency across all auth types.
 
 ##### Examples
 
+For complete usage examples visit the [auth recipes](/docs/recipes/auth.md)
+
    *Email*
 ```js
-// Call with info
+// NOTE: Account is not created during login for email auth. Use createUser
 this.props.firebase.login({
   email: 'test@test.com',
   password: 'testest1'

docs/queries.md

@@ -1,6 +1,11 @@
 # Queries
 
-When listening to paths, it is possible to modify the query with any of [Firebase's included query methods](https://firebase.google.com/docs/reference/js/firebase.database.Query). Below are examples using Firebase query methods as well as other methods that are included (such as 'populate').
+Query listeners are attached by using the `firebaseConnect` higher order component. `firebaseConnect` accepts an array of paths for which to create queries. When listening to paths, it is possible to modify the query with any of [Firebase's included query methods](https://firebase.google.com/docs/reference/js/firebase.database.Query).
+
+**NOTE:**
+By default the results of queries are stored in redux under the path of the query. If you would like to change where the query results are stored in redux, use [`storeAs` (more below)](#storeAs).
+
+Below are examples using Firebase query methods as well as other methods that are included (such as 'populate').
 
 ## once
 To load a firebase location once instead of binding, the once option can be used:
@@ -195,6 +200,41 @@ Can be used to keep internal parsing from happening. Useful when attempting to s
 ])
 ```
 
+
+## storeAs {#populate}
+
+By default the results of queries are stored in redux under the path of the query. If you would like to change where the query results are stored in redux, use `storeAs`:
+
+#### Examples
+1. Querying the same path with different query parameters
+
+```js
+@firebaseConnect(props => [
+  { path: 'projects' }
+  { path: 'projects', storeAs: 'myProjects', queryParams: ['orderByChild=uid', '123'] }
+])
+@connect(({ firebase }, props) => ({
+  projects: populatedDataToJS(firebase, 'projects'),
+  myProjects: populatedDataToJS(firebase, 'myProjects'), // use storeAs path to gather from redux
+}))
+```
+
+## ordered {#ordered}
+
+In order to get ordered data, use `orderedToJS`
+
+#### Examples
+1. Get list of projects ordered by key
+
+```js
+@firebaseConnect(props => [
+  { path: 'projects', queryParams: ['orderByKey'] }
+])
+@connect(({ firebase }, props) => ({
+  projects: orderedToJS(firebase, 'projects'),
+}))
+```
+
 ## Populate {#populate}
 
 Populate allows you to replace IDs within your data with other data from Firebase. This is very useful when trying to keep your data flat. Some would call it a _join_, but it was modeled after [the mongo populate method](http://mongoosejs.com/docs/populate.html).

docs/recipes/profile.md

@@ -1,11 +1,50 @@
-### Change Profile
-When signing up, you can modify how user profiles written to the database.
+# Profile
+
+Profile object is used to store data associated with a user.
+
+## Basic
+Include the `userProfile` parameter in config when setting up store middleware:
+
+```js
+const config = {
+  userProfile: 'users', // where profiles are stored in database
+}
+reactReduxFirebase(fbConfig, config)
+```
+
+Then later wrap a component with connect:
+
+```js
+import { connect } from 'react-redux'
+import { pathToJS } from 'react-redux-firebase'
+
+// grab profile from redux with connect
+connect((state) => {
+  return {
+    profile: pathToJS(state.firebase, 'profile') // profile passed as props.profile
+  }
+}))(SomeComponent) // pass component to be wrapped
+
+// or with some shorthand:
+connect(({ firebase }) => ({
+  profile: pathToJS(state.firebase, 'profile') // profile passed as props.profile
+}))(SomeComponent) // pass component to be wrapped
+```
+
+## Update Profile
+
+**NOTE:** This feature is only available in [`v1.5.*`](http://docs.react-redux-firebase.com/history/v1.5.0/docs/recipes/profile.html)
+
+The current users profile can be updated by using the `updateProfile` method, which is [only available in `v1.5.*`](http://docs.react-redux-firebase.com/history/v1.5.0/docs/recipes/profile.html).
+
+## Change How Profiles Are Stored
+The way user profiles are written to the database can be modified by passing the `profileFactory` parameter.
 
 ```js
 // within your createStore.js or store.js file include the following config
 const config = {
   userProfile: 'users', // where profiles are stored in database
-  profileFactory: (userData) => { // how profiles are stored in database
+  profileFactory: (userData, profileData) => { // how profiles are stored in database
     const { user } = userData
     return {
       email: user.email
@@ -14,7 +53,13 @@ const config = {
 }
 ```
 
-### Populate Parameters
+## List Online Users
+
+**NOTE:** This feature is only available in [`v2.0.0-*`](http://docs.react-redux-firebase.com/history/v2.0.0/)
+
+To list online users and/or track sessions, view the [presence recipe](http://docs.react-redux-firebase.com/history/v2.0.0/docs/recipes/auth.html#list-of-online-users-presence)
+
+## Populate Parameters
 If profile object contains an key or a list of keys as parameters, you can populate those parameters with the matching value from another location on firebase.
 
 #### List

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

@@ -6,8 +6,8 @@ import {
   firebaseConnect,
   isLoaded,
   pathToJS,
-  dataToJS // needed for full list and once
-  // orderedToJS // needed for ordered list
+  dataToJS, // needed for full list and once
+  // orderedToJS, // needed for ordered list
   // populatedDataToJS // needed for populated list
 } from 'react-redux-firebase'
 import CircularProgress from 'material-ui/CircularProgress'
@@ -19,19 +19,22 @@ import TodoItem from '../components/TodoItem'
 import NewTodoPanel from '../components/NewTodoPanel'
 import classes from './HomeContainer.scss'
 
-// const populates = [{ child: 'owner', root: 'users', keyProp: 'uid' }]
+const populates = [{ child: 'owner', root: 'users', keyProp: 'uid' }]
 
 @firebaseConnect([
   // 'todos' // sync full list of todos
   // { path: 'todos', type: 'once' } // for loading once instead of binding
   { path: 'todos', queryParams: ['orderByKey', 'limitToLast=5'] } // 10 most recent
   // { path: 'todos', populates } // populate
+  // { path: 'todos', storeAs: 'myTodos' } // store elsewhere in redux
 ])
 @connect(({ firebase }) => ({
   auth: pathToJS(firebase, 'auth'),
   account: pathToJS(firebase, 'profile'),
-  todos: dataToJS(firebase, 'todos')
-  // todos: populatedDataToJS(firebase, '/todos', populates), // if populating
+  todos: dataToJS(firebase, 'todos'),
+  // todos: orderedToJS(firebase, 'todos') // if looking for array
+  // todos: dataToJS(firebase, 'myTodos'), // if using storeAs
+  // todos: populatedDataToJS(firebase, 'todos', populates), // if populating
   // todos: orderedToJS(firebase, '/todos') // if using ordering such as orderByChild
 }))
 export default class Home extends Component {

package.json

@@ -1,14 +1,14 @@
 {
   "name": "react-redux-firebase",
-  "version": "1.4.4",
+  "version": "1.4.5",
   "description": "Redux integration for Firebase. Comes with a Higher Order Component for use with React.",
   "browser": "dist/react-redux-firebase.js",
   "main": "lib/index.js",
   "module": "es/index.js",
   "jsnext:main": "es/index.js",
   "scripts": {
     "clean": "rimraf dist",
-    "lint": "eslint src/** test/**",
+    "lint": "eslint src/** tests/**/**",
     "lint:fix": "npm run lint -- --fix",
     "test": "mocha -R spec --compilers js:babel-core/register ./tests/setup.js ./tests/**/*.spec.js",
     "test:cov": "istanbul cover ./node_modules/mocha/bin/_mocha -- ./tests/** --recursive --report lcov --compilers js:babel-register --require babel-polyfill",
@@ -32,11 +32,10 @@
   "dependencies": {
     "es6-promise": "^4.1.0",
     "firebase": "^3.9.0",
-    "hoist-non-react-statics": "^1.2.0",
+    "hoist-non-react-statics": "^2.2.0",
     "immutable": "^3.8.1",
     "jwt-decode": "^2.2.0",
-    "lodash": "^4.17.4",
-    "react-display-name": "^0.2.0"
+    "lodash": "^4.17.4"
   },
   "peerDependencies": {
     "react": "^0.14.6 || ^15.0.0"

src/actions/auth.js

@@ -198,14 +198,17 @@ export const createUserProfile = (dispatch, firebase, userData, profile) => {
     return Promise.resolve(userData)
   }
   const { database, _: { config } } = firebase
-  if (isFunction(config.profileFactory)) {
-    profile = config.profileFactory(userData, profile)
-  }
-  if (isFunction(config.profileDecorator)) {
-    if (isFunction(console.warn)) { // eslint-disable-line no-console
+  try {
+    if (isFunction(config.profileFactory)) {
+      profile = config.profileFactory(userData, profile)
+    }
+    if (isFunction(config.profileDecorator)) {
       console.warn('profileDecorator is Depreceated and will be removed in future versions. Please use profileFactory.') // eslint-disable-line no-console
+      profile = config.profileDecorator(userData, profile)
     }
-    profile = config.profileDecorator(userData, profile)
+  } catch (err) {
+    console.error('Error occured within profileFactory function:', err.toString ? err.toString() : err) // eslint-disable-line no-console
+    return Promise.reject(err)
   }
   // Check for user's profile at userProfile path if provided
   return database()

src/actions/query.js

@@ -148,7 +148,7 @@ export const watchEvent = (firebase, dispatch, { type, path, populates, queryPar
           })
           dispatch({
             type: SET,
-            path: resultPath,
+            path: storeAs || resultPath,
             data,
             timestamp: Date.now(),
             requesting: false,