Compose function now has it's own tests (that handle fbConfig not being complete).

Author: prescottprue

src/helpers.js

@@ -1,7 +1,18 @@
 import { size, map } from 'lodash'
 
-const fixPath = path => ((path.substring(0, 1) === '/') ? '' : '/') + path
-
+/**
+ * @description Fix path by adding "/" to path if needed
+ * @param {String} path - Path string to fix
+ * @return {String} path - Fixed path
+ */
+export const fixPath = path =>
+  ((path.substring(0, 1) === '/') ? '' : '/') + path
+
+/**
+ * @description Convert Immutable Map to a Javascript object
+ * @param {Object} data - Immutable Map to be converted to JS object
+ * @return {Object} data - Javascript version of Immutable Map
+ */
 export const toJS = data => {
   if (data && data.toJS) {
     return data.toJS()
@@ -10,6 +21,11 @@ export const toJS = data => {
   return data
 }
 
+/**
+ * @description Convert parameter from Immutable Map to a Javascript object
+ * @param {Object} data - Immutable Map to be converted to JS object
+ * @return {Object} data - Javascript version of Immutable Map
+ */
 export const pathToJS = (data, path, notSetValue) => {
   if (!data) {
     return notSetValue
@@ -24,6 +40,13 @@ export const pathToJS = (data, path, notSetValue) => {
   return data
 }
 
+/**
+ * @description Convert parameter under "data" path of Immutable Map to a Javascript object
+ * @param {Object} data - Immutable Map to be converted to JS object
+ * @param {String} path - Path of parameter to load
+ * @param {Object|String|Boolean} notSetValue - Value to return if value is not found
+ * @return {Object} data - Javascript version of Immutable Map
+ */
 export const dataToJS = (data, path, notSetValue) => {
   if (!data) {
     return notSetValue
@@ -40,6 +63,14 @@ export const dataToJS = (data, path, notSetValue) => {
   return data
 }
 
+/**
+ * @description Load custom object from within store
+ * @param {Object} data - Immutable Map from store to be converted to JS object
+ * @param {String} path - Path of parameter to load
+ * @param {String} customPath - Part of store from which to load
+ * @param {Object|String|Boolean} notSetValue - Value to return if value is not found
+ * @return {Object} data - Javascript version of custom path within Immutable Map
+ */
 export const customToJS = (data, path, custom, notSetValue) => {
   if (!(data && data.getIn)) {
     return notSetValue
@@ -56,8 +87,14 @@ export const customToJS = (data, path, custom, notSetValue) => {
   return data
 }
 
+/**
+ * @description Convert Immutable Map to a Javascript object
+ * @param {Object} snapshot - Snapshot from store
+ * @param {String} path - Path of snapshot to load
+ * @return {Object} notSetValue - Value to return if snapshot is not found
+ */
 export const snapshotToJS = (snapshot, path, notSetValue) => {
-  if (!(snapshot && snapshot.getIn)) {
+  if (!snapshot) {
     return notSetValue
   }
 
@@ -72,6 +109,11 @@ export const snapshotToJS = (snapshot, path, notSetValue) => {
   return snapshot
 }
 
+/**
+ * @description Detect whether items are loaded yet or not
+ * @param {Object} item - Item to check loaded status of. A comma seperated list is also acceptable.
+ * @return {Boolean} isLoaded - Whether or not item is loaded
+ */
 export const isLoaded = function () {
   if (!arguments || !arguments.length) {
     return true
@@ -80,8 +122,21 @@ export const isLoaded = function () {
   return map(arguments, a => a !== undefined).reduce((a, b) => a && b)
 }
 
+/**
+ * @description Detect whether items are empty or not
+ * @param {Object} item - Item to check loaded status of. A comma seperated list is also acceptable.
+ * @return {Boolean} isEmpty - Whether or not item is empty
+ */
 export const isEmpty = data => {
   return !(data && size(data))
 }
 
-export default { toJS, pathToJS, dataToJS, snapshotToJS, customToJS, isLoaded, isEmpty }
+export default {
+  toJS,
+  pathToJS,
+  dataToJS,
+  snapshotToJS,
+  customToJS,
+  isLoaded,
+  isEmpty
+}

src/utils/auth.js

@@ -1,5 +1,6 @@
 import { capitalize, isArray, isString } from 'lodash'
 import { supportedAuthProviders } from '../constants'
+
 /**
  * @description Get correct login method and params order based on provided credentials
  * @param {Object} firebase - Internal firebase object

test/unit/compose.spec.js

@@ -1,13 +1,40 @@
 /* global describe expect it */
-import compose from '../../src/compose'
+import { omit } from 'lodash'
+import { createStore, combineReducers, compose } from 'redux'
+import composeFunc from '../../src/compose'
 const exampleData = { data: { some: 'data' } }
+const reducer = () => console.log('reducer', {})
+const generateCreateStore = (params) =>
+  compose(composeFunc(
+    omit(fbConfig, params),
+    { userProfile: 'users', enableLogging: true }
+  ))(createStore)
 
-// TODO: Use immutable object so functions exist on object
 describe('Compose', () => {
   it('is a function', () => {
-    expect(compose).to.be.a.function
+    expect(composeFunc).to.be.a.function
   })
   it('returns an object', () => {
-    expect(compose(fbConfig)).to.be.an.object
+    expect(composeFunc(fbConfig)).to.be.a.function
   })
+  it('allows enabling of Firebase database logging', () => {
+    const createStoreWithFirebase = compose(composeFunc(
+      fbConfig,
+      { userProfile: 'users', enableLogging: true }
+    ))(createStore)
+    expect(createStoreWithFirebase(reducer)).to.be.an.object
+  })
+  describe('throws for missing fbConfig parameters', () => {
+
+    it('databaseURL', () => {
+      expect(() => generateCreateStore('databaseURL')(reducer)).to.throw('Firebase databaseURL is required')
+    })
+    it('authDomain', () => {
+      expect(() => generateCreateStore('authDomain')(reducer)).to.throw('Firebase authDomain is required')
+    })
+    it('apiKey', () => {
+      expect(() => generateCreateStore('apiKey')(reducer)).to.throw('Firebase apiKey is required')
+    })
+  })
+
 })

test/unit/connect.spec.js

@@ -41,23 +41,6 @@ describe('Connect', () => {
       : prev
   }
 
-  it('throws for invalid databaseURL', () => {
-    const createStoreWithMiddleware = compose(
-      reduxFirebase({}, { userProfile: 'users' }),
-      typeof window === 'object' && typeof window.devToolsExtension !== 'undefined' ? window.devToolsExtension() : f => f
-    )(createStore)
-
-    expect(createStoreWithMiddleware).to.throw(Error)
-  })
-
-  it('throws for invalid authDomain', () => {
-    const createStoreWithMiddleware = compose(
-      reduxFirebase({ databaseURL }, { userProfile: 'users' }),
-      typeof window === 'object' && typeof window.devToolsExtension !== 'undefined' ? window.devToolsExtension() : f => f
-    )(createStore)
-
-    expect(createStoreWithMiddleware).to.throw(Error)
-  })
 
   it('should receive the store in the context', () => {
     const createStoreWithMiddleware = compose(
@@ -80,8 +63,10 @@ describe('Connect', () => {
     )
 
     const container = TestUtils.findRenderedComponentWithType(tree, Container)
+    container.setState({
+      testState: 'somethingElse'
+    })
     expect(container.context.store).to.equal(store)
   })
 
-
 })

test/unit/helpers.spec.js

@@ -78,16 +78,24 @@ describe('Helpers:', () => {
       expect(helpers).to.respondTo('snapshotToJS')
     })
     it('passes notSetValue', () => {
-      expect(helpers.snapshotToJS({}, '/some', exampleData))
+      const fakeState = { }
+      expect(helpers.snapshotToJS(fakeState, '/some', exampleData))
         .to
-        .equal(exampleData)
+        .equal(fakeState)
     })
     it('gets data from state', () => {
       const path = 'some'
       expect(helpers.snapshotToJS(exampleState, path, exampleData))
         .to
         .equal(exampleData.snapshot[path])
     })
+    it('returns snapshot for non-immutable', () => {
+      const path = 'some'
+      const fakeState = { }
+      expect(helpers.snapshotToJS(fakeState, path, exampleData))
+        .to
+        .equal(fakeState)
+    })
   })
 
   describe('isLoaded', () => {