WIP: implement code coverage with karma-coverage

TODO:

- [ ] implement karma running with grunt so we can have multiple karma
configs (need specific settings for coverage)
- [ ] 100% test coverage or ignore utils file
- [ ] setup coveralls with grunt-karma-coveralls
- [ ] add coveralls badge to README

Author: jordangarcia

.gitignore

@@ -1 +1,2 @@
 node_modules/
+coverage/

karma.conf.js

@@ -14,33 +14,46 @@ module.exports = function(config) {
 
     // list of files / patterns to load in the browser
     files: [
-      'tests/*-tests.js'
+      'tests/*-tests.js',
     ],
 
 
     // list of files to exclude
     exclude: [
     ],
 
+    reporters: ['html'],
 
     // preprocess matching files before serving them to the browser
     // available preprocessors: https://npmjs.org/browse/keyword/karma-preprocessor
     preprocessors: {
-      'tests/*-tests.js': ['webpack']
+      'tests/*-tests.js': ['webpack'],
+    },
+
+    coverageReporter: {
+      type: "html",
+      dir: "coverage/"
     },
 
     webpack: {
       module: {
         loaders: [
           { test: /\.js$/, loader: 'jstransform-loader' },
+        ],
+        postLoaders: [
+          {
+            test: /\.js$/,
+            exclude: /(test|node_modules|bower_components)\//,
+            loader: 'istanbul-instrumenter'
+          }
         ]
       },
+
     },
 
     // test results reporter to use
     // possible values: 'dots', 'progress'
     // available reporters: https://npmjs.org/browse/keyword/karma-reporter
-    reporters: ['html'],
 
 
     // web server port

package.json

@@ -4,8 +4,9 @@
   "description": "Immutable, reactive Flux architecture. UI Agnostic.",
   "main": "dist/nuclear.js",
   "scripts": {
-    "test": "./node_modules/karma/bin/karma start --single-run --browsers=PhantomJS --reporters=progress --log-level error",
-    "test-html": "karma start"
+    "test": "./node_modules/karma/bin/karma start --single-run --browsers=PhantomJS --reporters=progress --log-level=error",
+    "coverage": "./node_modules/karma/bin/karma start --single-run --browsers=PhantomJS --reporters=coverage --log-level=error",
+    "test-html": "./node_modules/karma/bin/karma start --browsers=Chrome --reporters=html --log-level=error"
   },
   "author": "Jordan Garcia",
   "license": "MIT",
@@ -44,6 +45,11 @@
     "react": "^0.13.2",
     "karma-phantomjs-launcher": "^0.1.4",
     "karma-es5-shim": "https://github.com/pokehanai/karma-es5-shim/archive/v2.1.0.tar.gz",
-    "webpack": "^1.8.11"
+    "webpack": "^1.8.11",
+    "grunt": "^0.4.5",
+    "karma-coverage": "^0.3.1",
+    "grunt-karma-coveralls": "^2.5.3",
+    "istanbul": "^0.3.13",
+    "istanbul-instrumenter-loader": "^0.1.2"
   }
 }

src/change-observer.js

@@ -16,38 +16,41 @@ class ChangeObserver {
   constructor(initialState, evaluator) {
     this.__prevState = initialState
     this.__evaluator = evaluator
-    this.__prevValues = Immutable.Map({})
+    this.__prevValues = Immutable.Map()
     this.__observers = []
   }
 
   /**
    * @param {Immutable.Map} newState
    */
   notifyObservers(newState) {
-    var currentValues = Immutable.Map()
+    if (this.__observers.length > 0) {
+      var currentValues = Immutable.Map()
 
-    this.__observers.forEach(entry => {
-      var getter = entry.getter
-      var code = hashCode(getter)
-      var prevState = this.__prevState
-      var prevValue
+      this.__observers.forEach(entry => {
+        var getter = entry.getter
+        var code = hashCode(getter)
+        var prevState = this.__prevState
+        var prevValue
 
-      if (this.__prevValues.has(code)) {
-        prevValue = this.__prevValues.get(code)
-      } else {
-        prevValue = this.__evaluator.evaluate(prevState, getter)
-        this.__prevValues = this.__prevValues.set(code, prevValue)
-      }
+        if (this.__prevValues.has(code)) {
+          prevValue = this.__prevValues.get(code)
+        } else {
+          prevValue = this.__evaluator.evaluate(prevState, getter)
+          this.__prevValues = this.__prevValues.set(code, prevValue)
+        }
 
-      var currValue = this.__evaluator.evaluate(newState, getter)
+        var currValue = this.__evaluator.evaluate(newState, getter)
 
-      if (!isEqual(prevValue, currValue)) {
-        entry.handler.call(null, currValue)
-        currentValues = currentValues.set(code, currValue)
-      }
-    })
+        if (!isEqual(prevValue, currValue)) {
+          entry.handler.call(null, currValue)
+          currentValues = currentValues.set(code, currValue)
+        }
+      })
+
+      this.__prevValues = currentValues
+    }
     this.__prevState = newState
-    this.__prevValues = currentValues
   }
 
   /**
@@ -74,6 +77,16 @@ class ChangeObserver {
     }
   }
 
+  /**
+   * Updates the change appliers prevState when silent store registration happens
+   * this allows the proper hasChanged check for notify observers if a store registration
+   * happens in between
+   * @param {Immutable.Map} prevState
+   */
+  updatePreviousState(prevState) {
+    this.__prevState = prevState
+  }
+
   /**
    * Resets and clears all observers and reinitializes back to the supplied
    * previous state
@@ -82,7 +95,7 @@ class ChangeObserver {
    */
   reset(prevState) {
     this.__prevState = prevState
-    this.__prevValues = Immutable.Map({})
+    this.__prevValues = Immutable.Map()
     this.__observers = []
   }
 }

src/evaluator.js

@@ -134,8 +134,6 @@ class Evaluator {
    * @param {Getter}
    */
   untrack(getter) {
-    var code = hashCode(getter)
-    this.__cachedGetters = this.__cachedGetters.remove(code)
     // TODO untrack all depedencies
   }
 

src/getter.js

@@ -19,26 +19,6 @@ function isGetter(toTest) {
   return (isArray(toTest) && isFunction(toTest[toTest.length - 1]))
 }
 
-
-/**
- * Recursive function to flatten deps of a getter
- * @param {Getter} getter
- * @return {Array.<KeyPath>} unique flatten deps
- */
-function unwrapDeps(getter) {
-  var accum = Immutable.Set()
-  var deps = getter.slice(0, getter.length - 1)
-
-  return accum.withMutations(accum => {
-    deps.forEach((dep) => {
-      isGetter(dep)
-        ? accum.union(unwrapDeps(dep))
-        : accum.add(dep)
-    })
-    return accum
-  })
-}
-
 /**
  * Returns the compute function from a getter
  * @param {Getter} getter
@@ -71,7 +51,6 @@ function fromKeyPath(keyPath) {
 
 
 module.exports = {
-  unwrapDeps: unwrapDeps,
   isGetter: isGetter,
   getComputeFn: getComputeFn,
   getDeps: getDeps,

src/hash-code.js

@@ -16,10 +16,6 @@ module.exports = function(getter, dontCache) {
     return getter.__hashCode
   }
 
-  if (!isGetter(getter)) {
-    throw new Error("Invalid getter!  Must be of the form: [<KeyPath>, ...<KeyPath>, <function>]")
-  }
-
   var hashCode = Immutable.fromJS(getter).hashCode()
 
   if (!dontCache) {

src/reactor.js

@@ -135,41 +135,26 @@ class Reactor {
   }
 
   /**
-   * Attachs a store to a non-running or running nuclear reactor.  Will emit change
-   * @param {string} id
-   * @param {Store} store
-   * @param {boolean} silent should not notify observers of state change
+   * @param {Array.<string, Store>} stores
    */
-  registerStore(id, store, silent) {
-    if (this.__stores.get(id)) {
-      console.warn("Store already defined for id=" + id)
-    }
+  registerStores(stores) {
+    each(stores, (store, id) => {
+      if (this.__stores.get(id)) {
+        console.warn("Store already defined for id=" + id)
+      }
 
-    var initialState = store.getInitialState()
+      var initialState = store.getInitialState()
 
-    if (this.debug && !isImmutableValue(initialState)) {
-      throw new Error("Store getInitialState() must return an immutable value, did you forget to call toImmutable")
-    }
+      if (this.debug && !isImmutableValue(initialState)) {
+        throw new Error("Store getInitialState() must return an immutable value, did you forget to call toImmutable")
+      }
 
-    this.__stores = this.__stores.set(id, store)
-    this.__state = this.__state.set(id, initialState)
+      this.__stores = this.__stores.set(id, store)
+      this.__state = this.__state.set(id, initialState)
 
-    if (!silent) {
-      this.__changeObserver.notifyObservers(this.__state)
-    }
-  }
-
-  /**
-   * @param {Array.<string, Store>} stores
-   * @param {boolean} silent should not notify observers of state change
-   */
-  registerStores(stores, silent) {
-    each(stores, (store, id) => {
-      this.registerStore(id, store, true)
     })
-    if (!silent) {
-      this.__changeObserver.notifyObservers(this.__state)
-    }
+
+    this.__changeObserver.notifyObservers(this.__state)
   }
 
   /**

src/utils.js

@@ -1,15 +1,3 @@
-/**
- * Ensures that the inputted value is an array
- * @param {*} val
- * @return {array}
- */
-exports.coerceArray = function(val) {
-  if (!exports.isArray(val)) {
-    return [val]
-  }
-  return val
-}
-
 /**
  * Checks if the passed in value is a number
  * @param {*} val

tests/evaluator-tests.js

@@ -138,6 +138,16 @@ describe('Evaluator', () => {
     })
   })
 
+  describe("when evaluating an invalid keypath / getter", () => {
+    it("should throw an error", () => {
+      var invalidGetter = { foo: 'bar' };
+
+      expect(function() {
+        evaluator.evaluate(invalidGetter)
+      }).toThrow()
+    })
+  })
+
   describe("when evaluating a getter that returns a mutable value", () => {
     it("should return a reference to that value", () => {
       var proj1 = { id: 1, description: 'proj 1' }

tests/getter-tests.js

@@ -23,4 +23,13 @@ describe('Getter', () => {
       expect(isGetter([getter1, ['foo'], (a, b) => a + b])).toBe(true)
     })
   })
+
+  describe("fromKeyPath", () => {
+    it('should throw an Error for a nonvalid KeyPath', () => {
+      var invalidKeypath = 'foo.bar'
+      expect(function() {
+        Getter.fromKeyPath(invalidKeypath)
+      }).toThrow()
+    })
+  })
 })