Merge branch 'master' into rest-api-example

Author: jordangarcia

.eslintrc

@@ -0,0 +1,178 @@
+{
+  "env": {
+    "node": true,
+    "browser": true,
+    "amd": true
+  },
+  "ecmaFeatures": {
+    "arrowFunctions": true,
+    "classes": true,
+    "defaultParams": true,
+    "destructuring": true,
+    "forOf": true,
+    "objectLiteralShorthandMethods": true,
+    "objectLiteralShorthandProperties": true,
+    "spread": true,
+    "superInFunctions": true
+  },
+  "globals": {
+    "console": true,
+    "beforeEach": true,
+    "afterEach": true,
+    "it": true,
+    "describe": true,
+    "module": true,
+    "expect": true,
+    "exports": true,
+    "jasmine": true,
+    "spyOn": true,
+    "mocha": true,
+    "mochaPhantomJS": true
+  },
+  "rules": {
+    "comma-dangle": [1, "always-multiline"],
+    "no-cond-assign": 1,
+    "no-console": 1,
+    "no-constant-condition": 1,
+    "no-control-regex": 1,
+    "no-debugger": 1,
+    "no-dupe-args": 1,
+    "no-dupe-keys": 1,
+    "no-duplicate-case": 1,
+    "no-empty": 1,
+    "no-empty-class": 1,
+    "no-ex-assign": 1,
+    "no-extra-boolean-cast": 0,
+    "no-extra-parens": 0,
+    "no-extra-semi": 1,
+    "no-func-assign": 1,
+    "no-inner-declarations": 1,
+    "no-invalid-regexp": 1,
+    "no-irregular-whitespace": 1,
+    "no-negated-in-lhs": 1,
+    "no-obj-calls": 1,
+    "no-regex-spaces": 1,
+    "no-reserved-keys": 1,
+    "no-sparse-arrays": 1,
+    "no-unreachable": 1,
+    "use-isnan": 1,
+    "valid-jsdoc": 0,
+    "valid-typeof": 1,
+    "block-scoped-var": 1,
+    "complexity": 0,
+    "consistent-return": 0,
+    "curly": 1,
+    "default-case": 1,
+    "dot-notation": 0,
+    "dot-location": [1, "property"],
+    "eqeqeq": 1,
+    "guard-for-in": 1,
+    "no-alert": 1,
+    "no-caller": 1,
+    "no-div-regex": 0,
+    "no-else-return": 1,
+    "no-empty-label": 1,
+    "no-eq-null": 1,
+    "no-eval": 1,
+    "no-extend-native": 1,
+    "no-extra-bind": 1,
+    "no-fallthrough": 1,
+    "no-floating-decimal": 1,
+    "no-implied-eval": 1,
+    "no-iterator": 1,
+    "no-labels": 1,
+    "no-lone-blocks": 1,
+    "no-loop-func": 1,
+    "no-multi-spaces": 1,
+    "no-multi-str": 0,
+    "no-native-reassign": 0,
+    "no-new": 1,
+    "no-new-func": 1,
+    "no-new-wrappers": 1,
+    "no-octal": 1,
+    "no-octal-escape": 1,
+    "no-param-reassign": 0,
+    "no-process-env": 0,
+    "no-proto": 1,
+    "no-redeclare": 1,
+    "no-return-assign": 1,
+    "no-script-url": 1,
+    "no-self-compare": 1,
+    "no-sequences": 1,
+    "no-throw-literal": 1,
+    "no-unused-expressions": 1,
+    "no-void": 1,
+    "no-warning-comments": 0,
+    "no-with": 0,
+    "radix": 1,
+    "vars-on-top": 0,
+    "wrap-iife": [2, "any"],
+    "yoda": [1, "never", {"exceptRange": true}],
+    "strict": 0,
+    "no-catch-shadow": 0,
+    "no-delete-var": 1,
+    "no-label-var": 0,
+    "no-shadow": 0,
+    "no-shadow-restricted-names": 1,
+    "no-undef": 2,
+    "no-undef-init": 1,
+    "no-undefined": 0,
+    "no-unused-vars": [1, {"vars": "local", "args": "none"}],
+    "no-use-before-define": 0,
+    "indent": [1, 2, {"indentSwitchCase": true}],
+    "brace-style": [1, "1tbs", {"allowSingleLine": true}],
+    "camelcase": 0,
+    "comma-spacing": 1,
+    "consistent-this": 0,
+    "eol-last": 1,
+    "func-names": 0,
+    "func-style": 0,
+    "key-spacing": [1, {
+      "beforeColon": false,
+      "afterColon": true
+    }],
+    "linebreak-style": 0,
+    "max-nested-callbacks": 0,
+    "new-cap": [1, {"newIsCap": true, "capIsNew": false}],
+    "new-parens": 2,
+    "newline-after-var": 0,
+    "no-array-constructor": 1,
+    "no-continue": 0,
+    "no-inline-comments": 0,
+    "no-lonely-if": 1,
+    "no-mixed-spaces-and-tabs": 1,
+    "no-multiple-empty-lines": [1, {"max": 2}],
+    "no-nested-ternary": 1,
+    "no-new-object": 1,
+    "no-spaced-func": 1,
+    "no-ternary": 0,
+    "no-trailing-spaces": 1,
+    "no-underscore-dangle": 0,
+    "no-wrap-func": 1,
+    "one-var": [1, "never"],
+    "operator-assignment": 0,
+    "operator-linebreak": 0,
+    "padded-blocks": 0,
+    "quote-props": 0,
+    "quotes": [1, "single"],
+    "semi": [1, "never"],
+    "semi-spacing": [1, {"before": false, "after": true}],
+    "sort-vars": 0,
+    "space-after-keywords": [1, "always"],
+    "space-before-blocks": 1,
+    "space-before-function-paren": [1, "never"],
+    "space-in-brackets": 0,
+    "space-in-parens": [1, "never"],
+    "space-infix-ops": 1,
+    "space-return-throw-case": 1,
+    "space-unary-ops": [1, {"words": true, "nonwords": false}],
+    "spaced-line-comment": [1, "always", {"exceptions": ["-"]}],
+    "wrap-regex": 0,
+    "max-depth": 0,
+    "max-len": 0,
+    "max-params": 0,
+    "max-statements": 0,
+    "no-bitwise": 0,
+    "no-plusplus": 0
+  }
+}

CHANGELOG.md

@@ -1,19 +1,92 @@
-## 1.0.2
+## 1.1.0 (proposed)
 
-- **deprecated** `reactor.registerStore` will be deprecated in 1.1.x - use `reactor.registerStores` instead.  Add deprecation warning.
-- **fixed** properly observe getters when passing `silent=true` for `registerStores` - this option no longer makes sense as it makes future observations unreliable.
-- **fixed** support `Utils.isFunction` in all browsers (#57)
-- **improvement** in Evaluator dont evaluate getter args twice when there is a stale value
+- **[NEW]** added `Reactor#serialize`, `Reactor#loadState`, `Store#serialize` and `Store#deserialize` methods
+- **[NEW]** added `Reactor#batch` to allow batch dispatches before notify observers
+- **[FIXED]** fix Evaluator locking if getter evaluation errors
 
-## 1.0.1
+### API Additions
 
-- **added** Expose createReactMixin functionality on Nuclear singleton
-- **fixed** Fix new Store() from throwing error when not passed a config object
+#### `Reactor#serialize()`
 
-## 1.0.0
-- **Huge optimizations for `Reactor.evaluate` and `Reactor.observe`** - These values are now very efficiently memoized by leveraging that fact that getters are pure functions and are transforming immutable data.  This means that complex transformations wont be reevaluated unless its direct dependencies or underlying state change.
-- **Built in support for React** - No need for the NuclearReactMixin, simply use `reactor.ReactMixin`
-- **breaking** `Reactor.get( ...getters, transformFn )` -> `Reactor.evaluate( getter )`
-- **breaking** `Reactor.getJS( ...getters, transformFn )` -> `Reactor.evaluateToJS( getter )`
-- **breaking** keypaths must always be arrays, no more support for 'foo.bar' style keypaths
-- **breaking** Getters are no longer a constructor, instead they are plain arrays of the form:
+Returns a plain javascript object representing the application state.  By defualt this maps over all stores and returns `toJS(storeState)`.
+
+```js
+reactor.loadState(reactor.serialize())
+```
+
+#### `Reactor#loadState( state )`
+
+Takes a plain javascript object and merges into the reactor state, using `store.deserialize`
+
+This can be useful if you need to load data already on the page.
+
+```js
+reactor.loadState({
+  stringStore: 'bar',
+  listStore: [4,5,6],
+})
+```
+
+#### `Store#serialize`
+
+Serialization method for the store's data, by default its implemented as `Nuclear.toJS' which converts ImmutableJS objects to plain javascript.
+This is overridable for your specific data needs.
+
+```js
+// serializing an Immutable map while preserving numerical keys
+Nuclear.Store({
+  // ...
+  serialize(state) {
+    if (!state) {
+      return state;
+    }
+    return state.entrySeq().toJS()
+  },
+  // ...
+})
+```
+
+#### `Store#deserialize`
+
+Serialization method for the store's data, by default its implemented as `Nuclear.toImmutable' which converts plain javascript objects to ImmutableJS data structures.
+This is overridable for your specific data needs.
+
+```js
+// deserializing an array of arrays [[1, 'one'], [2, 'two']] to an Immutable.Map
+Nuclear.Store({
+  // ...
+  deserialize(state) {
+    return Immutable.Map(state)
+  },
+  // ...
+})
+```
+
+## 1.0.5 (June 4, 2015)
+
+- **[NEW]** Configured linting using [eslint](http://eslint.org/). Linting is now part of the [contributing process](https://github.com/optimizely/nuclear-js/blob/master/CONTRIBUTING.md). Eslint can be run using: `grunt eslint`
+- **[NEW]** Implemented new developer docs landing page. This website is still in beta. You can view it here: http://optimizely.github.io/nuclear-js/
+- **[FIXED]** Removed accidentally checked in node_modules directory.
+- **[FIXED]** Addressed all the lint warnings and errors in the codebase using the new rules in `.eslintrc`
+- **[FIXED]** Updated documentation.
+
+## 1.0.2 (May 14, 2015)
+
+- **[DEPRECATED]** `reactor.registerStore` will be deprecated in 1.1.x - use `reactor.registerStores` instead.  Added deprecation warning.
+- **[FIXED]** Now properly observing getters when passing `silent=true` for `registerStores` - this option no longer makes sense as it makes future observations unreliable.
+- **[FIXED]** Support `Utils.isFunction` in all browsers. [#57](https://github.com/optimizely/nuclear-js/pull/57)
+- **[FIXED]** Evaluator now doesn't evaluate getter args twice when there is a stale value.
+
+## 1.0.1 (April 27, 2015)
+
+- **[NEW]** Expose `createReactMixin` functionality on Nuclear singleton.
+- **[FIXED]** Fix `new Store()` from throwing error when not passed a config object.
+
+## 1.0.0 (April 25, 2015)
+
+- **[NEW]** Built in support for React. No need for the `NuclearReactMixin`, simply use `reactor.ReactMixin`
+- **[BREAKING]** `Reactor.get( ...getters, transformFn )` -> `Reactor.evaluate( getter )`
+- **[BREAKING]** `Reactor.getJS( ...getters, transformFn )` -> `Reactor.evaluateToJS( getter )`
+- **[BREAKING]** Keypaths must always be arrays, no more support for 'foo.bar' style keypaths.
+- **[BREAKING]** Getters are no longer a constructor, instead they are plain arrays.
+- **[FIXED]** Huge optimizations for `Reactor.evaluate` and `Reactor.observe` - These values are now very efficiently memoized by leveraging that fact that getters are pure functions and are transforming immutable data. This means that complex transformations won't be reevaluated unless its direct dependencies or underlying state change.

CONTRIBUTING.md

@@ -3,6 +3,7 @@
 Welcome to NuclearJS!
 If you are reading this, it probably means that you are interested in contributing to this awesome open source project.
 To make the process of contributing more straightforward, we have prepared this guideline for you.
+To learn more about NuclearJS, check out our new [developer website!](http://optimizely.github.io/nuclear-js/)
 
 ## Development Setup
 
@@ -24,7 +25,9 @@ To run unit tests in PhantomJS + Coverage run: `grunt karma:coverage`
 
 ## Style Guide
 
-Nothing special here. Just write good, clean JavaScript. Some general rules:
+Nothing special here. Just write good, clean JavaScript. We've made it easier to check your styling now by using [eslint.](http://eslint.org/) To get instant feedback on any styling violations, simply run: `grunt eslint`
+
+Some general rules:
 
  - 2 space indentation (no tabs).
  - Prefer `'` over `"`.
@@ -44,8 +47,8 @@ Nothing special here. Just write good, clean JavaScript. Some general rules:
 ### Sending in a Pull Request Checklist
 
  - [ ] Work only in the `src` folder and please DO NOT check in anything in the `dist` folder.
- - [ ] Follow the [Style Guide.](https://github.com/optimizely/nuclear-js/blob/master/CONTRIBUTING.md#style-guide)
+ - [ ] Follow the [Style Guide.](https://github.com/optimizely/nuclear-js/blob/master/CONTRIBUTING.md#style-guide) Make sure that there are no lint errors or warnings after running: `grunt eslint`
  - [ ] Squash commits that are very small and redundant.
- - [ ] Make sure all tests pass.
+ - [ ] Make sure all tests pass after running: `grunt test`
  - [ ] If you are implementing a new feature, be sure to add new tests for that feature.
  - [ ] Provide us with a detailed description of commits and changes.

Gruntfile.js

@@ -1,4 +1,4 @@
-module.exports = function (grunt) {
+module.exports = function(grunt) {
   require('load-grunt-config')(grunt)
   // load npm tasks
   grunt.loadNpmTasks('grunt-karma')