release v2.1.0

.circleci/config.yml

@@ -183,6 +183,19 @@ jobs:
           command: |
             npm run lint -- --quiet
 
+  eslint-changed-files:
+    <<: *defaults
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - reaction-v2-node-modules-{{ checksum "package.json" }}-{{ checksum "package-lock.json" }}
+            - reaction-v2-node-modules-{{ .Branch }}
+            - reaction-v2-node-modules-master
+      - run:
+          name: Run Lint for Changed Files
+          command: .circleci/eslint-changed-files.sh
+
   graphql-lint:
     <<: *defaults
     steps:
@@ -350,6 +363,9 @@ workflows:
       - eslint:
           requires:
             - build
+      - eslint-changed-files:
+          requires:
+            - build
       - graphql-lint:
           requires:
             - build

.circleci/eslint-changed-files.sh

@@ -0,0 +1,44 @@
+#!/usr/bin/env bash
+
+# Please Use Google Shell Style: https://google.github.io/styleguide/shell.xml
+
+# ---- Start unofficial bash strict mode boilerplate
+# http://redsymbol.net/articles/unofficial-bash-strict-mode/
+set -o errexit  # always exit on error
+set -o errtrace # trap errors in functions as well
+set -o pipefail # don't ignore exit codes when piping output
+set -o posix    # more strict failures in subshells
+# set -x          # enable debugging
+
+IFS=$'\n\t'
+# ---- End unofficial bash strict mode boilerplate
+
+# Determine PR number from pull request link
+CIRCLE_PR_NUMBER="${CIRCLE_PR_NUMBER:-${CIRCLE_PULL_REQUEST##*/}}"
+if [[ -n "${CIRCLE_PR_NUMBER}" ]]; then
+  # Get PR from github API
+  org_repo=$(git remote -v |
+    head -1 |
+    awk '{print $2}' |
+    cut -d : -f 2 |
+    sed 's/\.git$//')
+  url="https://api.github.com/repos/${org_repo}/pulls/${CIRCLE_PR_NUMBER}"
+  # Determine target/base branch from API response
+  TARGET_BRANCH=$(curl --silent --location "${url}" | jq -r '.base.ref' || true)
+fi
+
+if [[ -z "${TARGET_BRANCH}" ]] || [[ ${TARGET_BRANCH} == "null" ]]; then
+  echo "Not a PR. Skipping eslint-changed-files."
+  exit 0
+fi
+
+echo "Getting list of changed files..."
+CHANGED_FILES=$(git diff --diff-filter=d --name-only "origin/${TARGET_BRANCH}"..$CIRCLE_BRANCH -- '*.js')
+
+# If we have changed files
+if [[ -n "${CHANGED_FILES}" ]]; then
+  echo "Files have been changed. Run eslint against these files."
+  echo "${CHANGED_FILES}" | xargs npm run lint:warnings
+else
+  echo "We have no changed files, don't run eslint-changed-files"
+fi

.github/issue_template.md

@@ -21,4 +21,4 @@ Not obligatory, but suggest a fix/reason for the bug
 
 
 ### Versions
-(run `reaction -v` from your reaction directory)
+(run `npm run version --silent` from your reaction directory)

.reaction/jsdoc/templates/fixtures/documents/binder.js

@@ -30,7 +30,7 @@ var dataBinderOptions = exports.dataBinderOptions = {
 /**
  * You can unbind previously bound objects from here.
  *
- * @param {string} path The path that was bound using {@link module:documents/binder.bind}
+ * @param {String} path The path that was bound using {@link module:documents/binder.bind}
  * @param {*} record The object that was bound
  */
 exports.unbind = function ( path, record ) {
@@ -63,9 +63,9 @@ exports.unbind = function ( path, record ) {
 
 /**
  * Bind to a property somewhere in an object. The property is found using dot notation and can be arbitrarily deep.
- * @param {string} path The path into the object to locate the property. For instance this could be `"_id"`, `"name.last"`.
+ * @param {String} path The path into the object to locate the property. For instance this could be `"_id"`, `"name.last"`.
  * or `"some.really.really.long.path.including.an.array.2.name"`
- * @param {object} record Anything you can hang a property off of
+ * @param {Object} record Anything you can hang a property off of
  * @param {options} options What you wanna do with the doohicky when yoyu bind it.
  * @param {function(*):Promise|*=} options.getter This is the method to run when getting the value. When it runs, you will receive
  * a single parameter which is the current value as the object understands it. You can return the value directly, just raise an event or

.reaction/jsdoc/templates/fixtures/documents/collector.js

@@ -21,7 +21,7 @@ var CollectorBase = dcl( Destroyable, {
 		}
 		/**
 		 * The collection that being managed
-		 * @type {object|array}
+		 * @type {Object|Array}
 		 */
 		this.heap = obj || {};
 		// mixin the probe
@@ -43,7 +43,7 @@ var CollectorBase = dcl( Destroyable, {
 		 * See http://en.wikipedia.org/wiki/Fisher-Yates_shuffle.
 		 * @function
 		 * @memberOf module:documents/collector~CollectorBase#
-		 * @returns {array}
+		 * @returns {Array}
 		 */
 		this.shuffle = sys.bind( sys.shuffle, this, this.heap );
 
@@ -60,9 +60,9 @@ var CollectorBase = dcl( Destroyable, {
 	 * Iterate over each item in the collection, or a subset that matches a query. This supports two signatures:
 	 * `.each(query, function)` and `.each(function)`. If you pass in a query, only the items that match the query
 	 * are iterated over.
-	 * @param {object=} query A query to evaluate
+	 * @param {Object=} query A query to evaluate
 	 * @param {function(val, key)} iterator Function to execute against each item in the collection
-	 * @param {object=} thisobj The value of `this`
+	 * @param {Object=} thisobj The value of `this`
 	 */
 	each          : function ( query, iterator, thisobj ) {
 		if ( sys.isPlainObject( query ) ) {
@@ -75,14 +75,14 @@ var CollectorBase = dcl( Destroyable, {
 	},
 	/**
 	 * Returns the collection as an array. If it is already an array, it just returns that.
-	 * @return {array}
+	 * @returns {Array}
 	 */
 	toArray       : function () {
 		return sys.toArray( this.heap );
 	},
 	/**
 	 * Supports conversion to a JSON string or for passing over the wire
-	 * @return {object}
+	 * @return {Object}
 	 * @returns {Object|array}
 	 */
 	toJSON        : function () {
@@ -92,9 +92,9 @@ var CollectorBase = dcl( Destroyable, {
 	 * Maps the contents to an array by iterating over it and transforming it. You supply the iterator. Supports two signatures:
 	 * `.map(query, function)` and `.map(function)`. If you pass in a query, only the items that match the query
 	 * are iterated over.
-	 * @param {object=} query A query to evaluate
+	 * @param {Object=} query A query to evaluate
 	 * @param {function(val, key)} iterator Function to execute against each item in the collection
-	 * @param {object=} thisobj The value of `this`
+	 * @param {Object=} thisobj The value of `this`
 	 */
 	map           : function ( query, iterator, thisobj ) {
 		if ( sys.isPlainObject( query ) ) {
@@ -110,10 +110,10 @@ var CollectorBase = dcl( Destroyable, {
 	 * callback, where each successive callback execution consumes the return value of the previous execution. If accumulator
 	 * is not passed, the first element of the collection will be used as the initial accumulator value.
 	 * are iterated over.
-	 * @param {object=} query A query to evaluate
+	 * @param {Object=} query A query to evaluate
 	 * @param {function(result, val, key)} iterator The function that will be executed in each item in the collection
 	 * @param {*=} accumulator Initial value of the accumulator.
-	 * @param {object=} thisobj The value of `this`
+	 * @param {Object=} thisobj The value of `this`
 	 * @return {*}
 	 */
 	reduce        : function ( query, iterator, accumulator, thisobj ) {
@@ -129,11 +129,11 @@ var CollectorBase = dcl( Destroyable, {
 	 * Creates an object composed of keys returned from running each element
 	 * of the collection through the given callback. The corresponding value of each key
 	 * is the number of times the key was returned by the callback.
-	 * @param {object=} query A query to evaluate. If you pass in a query, only the items that match the query
+	 * @param {Object=} query A query to evaluate. If you pass in a query, only the items that match the query
 	 * are iterated over.
 	 * @param  {function(value, key, collection)} iterator
-	 * @param {object=} thisobj The value of `this`
-	 * @return {object}
+	 * @param {Object=} thisobj The value of `this`
+	 * @return {Object}
 	 */
 	countBy       : function ( query, iterator, thisobj ) {
 		if ( sys.isPlainObject( query ) ) {
@@ -148,11 +148,11 @@ var CollectorBase = dcl( Destroyable, {
 	 * Creates an object composed of keys returned from running each element of the collection through the callback.
 	 * The corresponding value of each key is an array of elements passed to callback that returned the key.
 	 * The callback is invoked with three arguments: (value, index|key, collection).
-	 * @param {object=} query A query to evaluate . If you pass in a query, only the items that match the query
+	 * @param {Object=} query A query to evaluate . If you pass in a query, only the items that match the query
 	 * are iterated over.
 	 * @param {function(value, key, collection)} iterator
-	 * @param {object=} thisobj The value of `this`
-	 * @return {object}
+	 * @param {Object=} thisobj The value of `this`
+	 * @return {Object}
 	 */
 	groupBy       : function ( query, iterator, thisobj ) {
 		if ( sys.isPlainObject( query ) ) {
@@ -166,9 +166,9 @@ var CollectorBase = dcl( Destroyable, {
 	/**
 	 * Reduce the collection to a single value. Supports two signatures:
 	 * `.pluck(query, function)` and `.pluck(function)`
-	 * @param {object=} query The query to evaluate. If you pass in a query, only the items that match the query
+	 * @param {Object=} query The query to evaluate. If you pass in a query, only the items that match the query
 	 * are iterated over.
-	 * @param {string} property The property that will be 'plucked' from the contents of the collection
+	 * @param {String} property The property that will be 'plucked' from the contents of the collection
 	 * @return {*}
 	 */
 	pluck         : function ( query, property ) {
@@ -184,11 +184,11 @@ var CollectorBase = dcl( Destroyable, {
 	},
 	/**
 	 * Returns a sorted copy of the collection.
-	 * @param {object=} query The query to evaluate. If you pass in a query, only the items that match the query
+	 * @param {Object=} query The query to evaluate. If you pass in a query, only the items that match the query
 	 * are iterated over.
 	 * @param {function(value, key)} iterator
-	 * @param {object=} thisobj The value of `this`
-	 * @return {array}
+	 * @param {Object=} thisobj The value of `this`
+	 * @returns {Array}
 	 */
 	sortBy        : function ( query, iterator, thisobj ) {
 		if ( sys.isPlainObject( query ) ) {
@@ -202,10 +202,10 @@ var CollectorBase = dcl( Destroyable, {
 	/**
 	 * Retrieves the maximum value of an array. If callback is passed,
 	 * it will be executed for each value in the array to generate the criterion by which the value is ranked.
-	 * @param {object=} query A query to evaluate . If you pass in a query, only the items that match the query
+	 * @param {Object=} query A query to evaluate . If you pass in a query, only the items that match the query
 	 * are iterated over.
 	 * @param {function(value, key, collection)} iterator
-	 * @param {object=} thisobj The value of `this`
+	 * @param {Object=} thisobj The value of `this`
 	 * @return {number}
 	 */
 	max           : function ( query, iterator, thisobj ) {
@@ -220,10 +220,10 @@ var CollectorBase = dcl( Destroyable, {
 	/**
 	 * Retrieves the minimum value of an array. If callback is passed,
 	 * it will be executed for each value in the array to generate the criterion by which the value is ranked.
-	 * @param {object=} query A query to evaluate . If you pass in a query, only the items that match the query
+	 * @param {Object=} query A query to evaluate . If you pass in a query, only the items that match the query
 	 * are iterated over.
 	 * @param {function(value, key, collection)} iterator
-	 * @param {object=} thisobj The value of `this`
+	 * @param {Object=} thisobj The value of `this`
 	 * @return {number}
 	 */
 	min           : function ( query, iterator, thisobj ) {
@@ -273,7 +273,7 @@ var ACollector = dcl( CollectorBase, {
 			this.heap = obj || [];
 			/**
 			 * Creates an array of array elements not present in the other arrays using strict equality for comparisons, i.e. ===.
-			 * @returns {array}
+			 * @returns {Array}
 			 */
 			this.difference = sys.bind( sys.difference, this, this.heap );
 			/**
@@ -329,10 +329,10 @@ var ACollector = dcl( CollectorBase, {
 		/**
 		 * Flattens a nested array (the nesting can be to any depth). If isShallow is truthy, array will only be flattened a single level.
 		 * If callback is passed, each element of array is passed through a callback before flattening.
-		 * @param {object=} query A query to evaluate . If you pass in a query, only the items that match the query
+		 * @param {Object=} query A query to evaluate . If you pass in a query, only the items that match the query
 		 * are iterated over.
 		 * @param {function(value, key, collection)} iterator,
-		 * @param {object=} thisobj The value of `this`
+		 * @param {Object=} thisobj The value of `this`
 		 * @return {number}
 		 */
 		flatten     : function ( query, iterator, thisobj ) {
@@ -380,8 +380,8 @@ exports.object = function ( obj ) {
  Returns true if all items match the query. Aliases as `all`
  @function
 
- @param {object} qu The query to execute
- @returns {boolean}
+ @param {Object} qu The query to execute
+ @returns {Boolean}
  @name every
  @memberOf module:documents/collector~CollectorBase#
  */
@@ -391,8 +391,8 @@ exports.object = function ( obj ) {
  Returns true if any of the items match the query. Aliases as `any`
  @function
 
- @param {object} qu The query to execute
- @returns {boolean}
+ @param {Object} qu The query to execute
+ @returns {Boolean}
  @memberOf module:documents/collector~CollectorBase#
  @name some
  */
@@ -401,8 +401,8 @@ exports.object = function ( obj ) {
 /**
  Returns the set of unique records that match a query
 
- @param {object} qu The query to execute.
- @return {array}
+ @param {Object} qu The query to execute.
+ @returns {Array}
  @memberOf module:documents/collector~CollectorBase#
  @name unique
  @method
@@ -412,8 +412,8 @@ exports.object = function ( obj ) {
  Returns true if all items match the query. Aliases as `every`
  @function
 
- @param {object} qu The query to execute
- @returns {boolean}
+ @param {Object} qu The query to execute
+ @returns {Boolean}
  @name all
  @memberOf module:documents/collector~CollectorBase#
  */
@@ -423,8 +423,8 @@ exports.object = function ( obj ) {
  Returns true if any of the items match the query. Aliases as `all`
  @function
 
- @param {object} qu The query to execute
- @returns {boolean}
+ @param {Object} qu The query to execute
+ @returns {Boolean}
  @memberOf module:documents/collector~CollectorBase#
  @name any
  */
@@ -433,8 +433,8 @@ exports.object = function ( obj ) {
 /**
  Remove all items in the object/array that match the query
 
- @param {object} qu The query to execute. See {@link module:ink/probe.queryOperators} for the operators you can use.
- @return {object|array} The array or object as appropriate without the records.
+ @param {Object} qu The query to execute. See {@link module:ink/probe.queryOperators} for the operators you can use.
+ @return {Object|Array} The array or object as appropriate without the records.
  @memberOf module:documents/collector~CollectorBase#
  @name remove
  @method
@@ -444,8 +444,8 @@ exports.object = function ( obj ) {
  Returns the first record that matches the query and returns its key or index depending on whether `obj` is an object or array respectively.
  Aliased as `seekKey`.
 
- @param {object} qu The query to execute.
- @returns {object}
+ @param {Object} qu The query to execute.
+ @returns {Object}
  @memberOf module:documents/collector~CollectorBase#
  @name findOneKey
  @method
@@ -455,8 +455,8 @@ exports.object = function ( obj ) {
 /**
  Returns the first record that matches the query. Aliased as `seek`.
 
- @param {object} qu The query to execute.
- @returns {object}
+ @param {Object} qu The query to execute.
+ @returns {Object}
  @memberOf module:documents/collector~CollectorBase#
  @name findOne
  @method
@@ -467,8 +467,8 @@ exports.object = function ( obj ) {
  Find all records that match a query and returns the keys for those items. This is similar to {@link module:ink/probe.find} but instead of returning
  records, returns the keys. If `obj` is an object it will return the hash key. If 'obj' is an array, it will return the index
 
- @param {object} qu The query to execute.
- @returns {array}
+ @param {Object} qu The query to execute.
+ @returns {Array}
  @memberOf module:documents/collector~CollectorBase#
  @name findKeys
  @method
@@ -478,8 +478,8 @@ exports.object = function ( obj ) {
 /**
  Find all records that match a query
 
- @param {object} qu The query to execute.
- @returns {array} The results
+ @param {Object} qu The query to execute.
+ @returns {Array} The results
  @memberOf module:documents/collector~CollectorBase#
  @name find
  @method
@@ -488,8 +488,8 @@ exports.object = function ( obj ) {
 /**
  Updates all records in obj that match the query. See {@link module:ink/probe.updateOperators} for the operators that are supported.
 
- @param {object} qu The query which will be used to identify the records to updated
- @param {object} setDocument The update operator. See {@link module:ink/probe.updateOperators}
+ @param {Object} qu The query which will be used to identify the records to updated
+ @param {Object} setDocument The update operator. See {@link module:ink/probe.updateOperators}
  @memberOf module:documents/collector~CollectorBase#
  @name update
  @method