@barchart/portfolio-api-common 1.2.0 → 1.2.1

package/lib/data/TransactionValidator.js

@@ -19,18 +19,31 @@ module.exports = (() => {
 		}
 
 		/**
-		 * Given a set of transaction, ensures that sequence numbers and dates
+		 * Given a set of transaction, ensures that all sequence numbers and dates
 		 * are properly ordered.
 		 *
 		 * @public
 		 * @static
 		 * @param {Array.<Object>} transactions
-		 * @return {boolean}
+		 * @return {Boolean}
 		 */
 		static validateOrder(transactions) {
+			return TransactionValidator.getInvalidIndex(transactions) < 0;
+		}
+
+		/**
+		 * Given a set of transaction, returns the index of the first transaction that with an invalid
+		 * sequence number or date.
+		 *
+		 * @public
+		 * @static
+		 * @param {Array.<Object>} transactions
+		 * @return {Number}
+		 */
+		static getInvalidIndex(transactions) {
 			assert.argumentIsArray(transactions, 'transactions');
 
-			return transactions.every((t, i) => t.sequence === (i + 1) && (i === 0 || !t.date.getIsBefore(transactions[i - 1].date)));
+			return transactions.findIndex((t, i) => t.sequence !== (i + 1) || (i !== 0 && t.date.getIsBefore(transactions[i - 1].date)));
 		}
 
 		/**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@barchart/portfolio-api-common",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "Common classes used by the Portfolio system",
   "author": {
     "name": "Bryan Ingle",

package/test/SpecRunner.js

@@ -1,4 +1,4 @@
-(function(){function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);var f=new Error("Cannot find module '"+o+"'");throw f.code="MODULE_NOT_FOUND",f}var l=n[o]={exports:{}};t[o][0].call(l.exports,function(e){var n=t[o][1][e];return s(n?n:e)},l,l.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o<r.length;o++)s(r[o]);return s}return e})()({1:[function(require,module,exports){
+(function(){function r(e,n,t){function o(i,f){if(!n[i]){if(!e[i]){var c="function"==typeof require&&require;if(!f&&c)return c(i,!0);if(u)return u(i,!0);var a=new Error("Cannot find module '"+i+"'");throw a.code="MODULE_NOT_FOUND",a}var p=n[i]={exports:{}};e[i][0].call(p.exports,function(r){var n=e[i][1][r];return o(n||r)},p,p.exports,r,e,n,t)}return n[i].exports}for(var u="function"==typeof require&&require,i=0;i<t.length;i++)o(t[i]);return o}return r})()({1:[function(require,module,exports){
 const uuid = require('uuid');
 
 const assert = require('@barchart/common-js/lang/assert'),
@@ -977,18 +977,31 @@ module.exports = (() => {
 		}
 
 		/**
-		 * Given a set of transaction, ensures that sequence numbers and dates
+		 * Given a set of transaction, ensures that all sequence numbers and dates
 		 * are properly ordered.
 		 *
 		 * @public
 		 * @static
 		 * @param {Array.<Object>} transactions
-		 * @return {boolean}
+		 * @return {Boolean}
 		 */
 		static validateOrder(transactions) {
+			return TransactionValidator.getInvalidIndex(transactions) < 0;
+		}
+
+		/**
+		 * Given a set of transaction, returns the index of the first transaction that with an invalid
+		 * sequence number or date.
+		 *
+		 * @public
+		 * @static
+		 * @param {Array.<Object>} transactions
+		 * @return {Number}
+		 */
+		static getInvalidIndex(transactions) {
 			assert.argumentIsArray(transactions, 'transactions');
 
-			return transactions.every((t, i) => t.sequence === (i + 1) && (i === 0 || !t.date.getIsBefore(transactions[i - 1].date)));
+			return transactions.findIndex((t, i) => t.sequence !== (i + 1) || (i !== 0 && t.date.getIsBefore(transactions[i - 1].date)));
 		}
 
 		/**
@@ -3951,14 +3964,31 @@ module.exports = function () {
 		}
 
 		/**
-   * Returns the parent node. If this is the root node, a null value is returned.
+   * Gets the root node.
    *
    * @public
-   * @returns {Tree|null}
+   * @returns {Tree}
    */
 
 
 		_createClass(Tree, [{
+			key: 'getRoot',
+			value: function getRoot() {
+				if (this.getIsRoot()) {
+					return this;
+				} else {
+					return this._parent.getRoot();
+				}
+			}
+
+			/**
+    * Returns the parent node. If this is the root node, a null value is returned.
+    *
+    * @public
+    * @returns {Tree|null}
+    */
+
+		}, {
 			key: 'getParent',
 			value: function getParent() {
 				return this._parent;
@@ -4059,6 +4089,23 @@ module.exports = function () {
 				}
 			}
 
+			/**
+    * Removes the current node from the parent tree. Use on a root node
+    * has no effect.
+    *
+    * @public
+    */
+
+		}, {
+			key: 'sever',
+			value: function sever() {
+				if (this.getIsRoot()) {
+					return;
+				}
+
+				this.getParent().removeChild(this);
+			}
+
 			/**
     * Searches the children nodes for the first child node that matches the
     * predicate.
@@ -4163,6 +4210,33 @@ module.exports = function () {
 				}
 			}
 
+			/**
+    * Climbs the tree, evaluating each parent until a predicate is matched. Once matched,
+    * the {@link Tree} node is returned. Otherwise, if the predicate cannot be matched,
+    * a null value is returned.
+    *
+    * @public
+    * @param {Tree~nodePredicate} predicate - A predicate that tests each child node. The predicate takes two arguments -- the node's value, and the node itself.
+    * @param {boolean=} includeCurrentNode - If true, the predicate will be applied to the current node.
+    * @returns {Tree|null}
+    */
+
+		}, {
+			key: 'findParent',
+			value: function findParent(predicate, includeCurrentNode) {
+				var returnRef = void 0;
+
+				if (is.boolean(includeCurrentNode) && includeCurrentNode && predicate(this.getValue(), this)) {
+					returnRef = this;
+				} else if (this._parent !== null) {
+					returnRef = this._parent.findParent(predicate, true);
+				} else {
+					returnRef = null;
+				}
+
+				return returnRef;
+			}
+
 			/**
     * Creates a representation of the tree using JavaScript objects and arrays.
     *
@@ -5453,6 +5527,20 @@ module.exports = function () {
 				return this._big.gt(getBig(other));
 			}
 
+			/**
+    * Returns true if the current instance is greater than or equal to the value.
+    *
+    * @public
+    * @param {Decimal|Number|String} other - The value to compare.
+    * @returns {Boolean}
+    */
+
+		}, {
+			key: 'getIsGreaterThanOrEqual',
+			value: function getIsGreaterThanOrEqual(other) {
+				return this._big.gte(getBig(other));
+			}
+
 			/**
     * Returns true if the current instance is less than the value.
     *
@@ -5467,6 +5555,20 @@ module.exports = function () {
 				return this._big.lt(getBig(other));
 			}
 
+			/**
+    * Returns true if the current instance is less than or equal to the value.
+    *
+    * @public
+    * @param {Decimal|Number|String} other - The value to compare.
+    * @returns {Boolean}
+    */
+
+		}, {
+			key: 'getIsLessThanOrEqual',
+			value: function getIsLessThanOrEqual(other) {
+				return this._big.lte(getBig(other));
+			}
+
 			/**
     * Returns true if the current instance is equal to the value.
     *
@@ -5666,9 +5768,9 @@ module.exports = function () {
 				assert.argumentIsRequired(a, 'a', Decimal, 'Decimal');
 				assert.argumentIsRequired(b, 'b', Decimal, 'Decimal');
 
-				if (a._big.gt(b)) {
+				if (a._big.gt(b._big)) {
 					return 1;
-				} else if (a._big.lt(b)) {
+				} else if (a._big.lt(b._big)) {
 					return -1;
 				} else {
 					return 0;
@@ -6129,12 +6231,10 @@ var _createClass = function () { function defineProperties(target, props) { for
 function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
 
 var assert = require('./assert'),
-    is = require('./is'),
     memoize = require('./memoize');
 
 var Currency = require('./Currency'),
-    Decimal = require('./Decimal'),
-    Enum = require('./Enum');
+    Decimal = require('./Decimal');
 
 module.exports = function () {
 	'use strict';
@@ -6314,12 +6414,7 @@ module.exports = function () {
 				assert.argumentIsRequired(amount, 'amount', Decimal, 'Decimal');
 				assert.argumentIsRequired(currency, 'currency', Currency, 'Currency');
 				assert.argumentIsRequired(desiredCurrency, 'desiredCurrency', Currency, 'Currency');
-
-				for (var _len = arguments.length, rates = Array(_len > 3 ? _len - 3 : 0), _key = 3; _key < _len; _key++) {
-					rates[_key - 3] = arguments[_key];
-				}
-
-				assert.argumentIsArray(rates, 'rates', Rate, 'Rate');
+				//assert.argumentIsArray(rates, 'rates', Rate, 'Rate');
 
 				var converted = void 0;
 
@@ -6329,6 +6424,10 @@ module.exports = function () {
 					var numerator = desiredCurrency;
 					var denominator = currency;
 
+					for (var _len = arguments.length, rates = Array(_len > 3 ? _len - 3 : 0), _key = 3; _key < _len; _key++) {
+						rates[_key - 3] = arguments[_key];
+					}
+
 					var rate = rates.find(function (r) {
 						return r.numerator === numerator && r.denominator === denominator || r.numerator === denominator && r.denominator === numerator;
 					});
@@ -6379,7 +6478,7 @@ module.exports = function () {
 	return Rate;
 }();
 
-},{"./Currency":17,"./Decimal":19,"./Enum":21,"./assert":24,"./is":26,"./memoize":27}],23:[function(require,module,exports){
+},{"./Currency":17,"./Decimal":19,"./assert":24,"./memoize":27}],23:[function(require,module,exports){
 'use strict';
 
 var assert = require('./assert'),
@@ -6407,8 +6506,8 @@ module.exports = function () {
 		unique: function unique(a) {
 			assert.argumentIsArray(a, 'a');
 
-			return a.filter(function (item, index, array) {
-				return array.indexOf(item) === index;
+			return this.uniqueBy(a, function (item) {
+				return item;
 			});
 		},
 
@@ -6419,7 +6518,7 @@ module.exports = function () {
    *
    * @static
    * @param {Array} a
-   * @param {Function} keySelector - The function, when applied to an item yields a unique key.
+   * @param {Function} keySelector - A function that returns a unique key for an item.
    * @returns {Array}
    */
 		uniqueBy: function uniqueBy(a, keySelector) {
@@ -6437,12 +6536,12 @@ module.exports = function () {
 
 		/**
    * Splits array into groups and returns an object (where the properties have
-   * arrays). Unlike the indexBy function, there can be many items
-   * which share the same key.
+   * arrays). Unlike the indexBy function, there can be many items which share
+   * the same key.
    *
    * @static
    * @param {Array} a
-   * @param {Function} keySelector - The function, when applied to an item yields a key.
+   * @param {Function} keySelector - A function that returns a unique key for an item.
    * @returns {Object}
    */
 		groupBy: function groupBy(a, keySelector) {
@@ -6469,7 +6568,7 @@ module.exports = function () {
    *
    * @static
    * @param {Array} a
-   * @param {Function} keySelector - The function, when applied to an item yields a key.
+   * @param {Function} keySelector - A function that returns a unique key for an item.
    * @returns {Array}
    */
 		batchBy: function batchBy(a, keySelector) {
@@ -6498,12 +6597,11 @@ module.exports = function () {
 
 		/**
    * Splits array into groups and returns an object (where the properties are items from the
-   * original array). Unlike the groupBy, Only one item can have a given key
-   * value.
+   * original array). Unlike the groupBy, only one item can have a given key value.
    *
    * @static
    * @param {Array} a
-   * @param {Function} keySelector - The function, when applied to an item yields a unique key.
+   * @param {Function} keySelector - A function that returns a unique key for an item.
    * @returns {Object}
    */
 		indexBy: function indexBy(a, keySelector) {
@@ -6669,14 +6767,31 @@ module.exports = function () {
    * @returns {Array}
    */
 		difference: function difference(a, b) {
+			return this.differenceBy(a, b, function (item) {
+				return item;
+			});
+		},
+
+
+		/**
+   * Set difference operation, where the uniqueness is determined by a delegate.
+   *
+   * @static
+   * @param {Array} a
+   * @param {Array} b
+   * @param {Function} keySelector - A function that returns a unique key for an item.
+   * @returns {Array}
+   */
+		differenceBy: function differenceBy(a, b, keySelector) {
 			assert.argumentIsArray(a, 'a');
 			assert.argumentIsArray(b, 'b');
+			assert.argumentIsRequired(keySelector, 'keySelector', Function);
 
 			var returnRef = [];
 
 			a.forEach(function (candidate) {
 				var exclude = b.some(function (comparison) {
-					return candidate === comparison;
+					return keySelector(candidate) === keySelector(comparison);
 				});
 
 				if (!exclude) {
@@ -6699,7 +6814,23 @@ module.exports = function () {
    * @returns {Array}
    */
 		differenceSymmetric: function differenceSymmetric(a, b) {
-			return this.union(this.difference(a, b), this.difference(b, a));
+			return this.differenceSymmetricBy(a, b, function (item) {
+				return item;
+			});
+		},
+
+
+		/**
+   * Set symmetric difference operation, where the uniqueness is determined by a delegate.
+   *
+   * @static
+   * @param {Array} a
+   * @param {Array} b
+   * @param {Function} keySelector - A function that returns a unique key for an item.
+   * @returns {Array}
+   */
+		differenceSymmetricBy: function differenceSymmetricBy(a, b, keySelector) {
+			return this.unionBy(this.differenceBy(a, b, keySelector), this.differenceBy(b, a, keySelector), keySelector);
 		},
 
 
@@ -6712,14 +6843,31 @@ module.exports = function () {
    * @returns {Array}
    */
 		union: function union(a, b) {
+			return this.unionBy(a, b, function (item) {
+				return item;
+			});
+		},
+
+
+		/**
+   * Set union operation, where the uniqueness is determined by a delegate.
+   *
+   * @static
+   * @param {Array} a
+   * @param {Array} b
+   * @param {Function} keySelector - A function that returns a unique key for an item.
+   * @returns {Array}
+   */
+		unionBy: function unionBy(a, b, keySelector) {
 			assert.argumentIsArray(a, 'a');
 			assert.argumentIsArray(b, 'b');
+			assert.argumentIsRequired(keySelector, 'keySelector', Function);
 
 			var returnRef = a.slice();
 
 			b.forEach(function (candidate) {
 				var exclude = returnRef.some(function (comparison) {
-					return candidate === comparison;
+					return keySelector(candidate) === keySelector(comparison);
 				});
 
 				if (!exclude) {
@@ -6740,6 +6888,22 @@ module.exports = function () {
    * @returns {Array}
    */
 		intersection: function intersection(a, b) {
+			return this.intersectionBy(a, b, function (item) {
+				return item;
+			});
+		},
+
+
+		/**
+   * Set intersection operation, where the uniqueness is determined by a delegate.
+   *
+   * @static
+   * @param {Array} a
+   * @param {Array} b
+   * @param {Function} keySelector - A function that returns a unique key for an item.
+   * @returns {Array}
+   */
+		intersectionBy: function intersectionBy(a, b, keySelector) {
 			assert.argumentIsArray(a, 'a');
 			assert.argumentIsArray(b, 'b');
 
@@ -6747,7 +6911,7 @@ module.exports = function () {
 
 			a.forEach(function (candidate) {
 				var include = b.some(function (comparison) {
-					return candidate === comparison;
+					return keySelector(candidate) === comparison;
 				});
 
 				if (include) {
@@ -6756,6 +6920,30 @@ module.exports = function () {
 			});
 
 			return returnRef;
+		},
+
+
+		/**
+   * Removes the first item from an array which matches a predicate.
+   *
+   * @static
+   * @public
+   * @param {Array} a
+   * @param {Function} predicate
+   * @returns {Boolean}
+   */
+		remove: function remove(a, predicate) {
+			assert.argumentIsArray(a, 'a');
+			assert.argumentIsRequired(predicate, 'predicate', Function);
+
+			var index = a.findIndex(predicate);
+			var found = !(index < 0);
+
+			if (found) {
+				a.splice(index, 1);
+			}
+
+			return found;
 		}
 	};
 }();