@briza/illogical 1.6.0 → 1.6.1

package/changelog.md

@@ -1,5 +1,9 @@
 # illogical changelog
 
+## 1.6.1
+
+- Bugfix on Arithmetic evaluate. Returns false when ContextValue is not present in the Context.
+
 ## 1.6.0
 
 - Added support for Arithmetic expressions within other Comparison expressions. This allows for

package/lib/illogical.esm.js

@@ -135,6 +135,27 @@ class Arithmetic {
     _defineProperty(this, "type", EvaluableType.Expression);
   }
 
+  /**
+   * Helper function to assist with arithmetic evaluation. Ensures that all
+   * operands are present and are numbers. Throws error if any operand is not a
+   * number.
+   *
+   * @param {Result[]} results
+   * @returns {number[] | false} false if any operand is missing, otherwise the
+   *   array of numbers
+   */
+  getResultValues(results) {
+    const presentValues = results.filter(result => result !== null && result !== undefined);
+    // If we have missing context values the result must be false
+    if (presentValues.length !== results.length) {
+      return false;
+    }
+    if (!areAllNumbers(presentValues)) {
+      throw new Error(`operands must be numbers for ${this.constructor.name}`);
+    }
+    return presentValues;
+  }
+
   /**
    * Performs the arithmetic operation on the operands evaluated values.
    * @param {Result[]} results Operand result values.
@@ -204,11 +225,11 @@ class Divide extends Arithmetic {
     super('/', OPERATOR$l, operands);
   }
   operate(results) {
-    if (!areAllNumbers(results)) {
-      throw new Error('operands must be numbers for divide');
+    const presentResults = this.getResultValues(results);
+    if (presentResults === false) {
+      return false;
     }
-    const result = results.reduce((acc, result) => acc / result);
-    return result;
+    return presentResults.reduce((acc, result) => acc / result);
   }
 }
 
@@ -247,10 +268,11 @@ class Multiply extends Arithmetic {
     super('*', OPERATOR$k, operands);
   }
   operate(results) {
-    if (!areAllNumbers(results)) {
-      throw new Error('operands must be numbers for multiply');
+    const presentResults = this.getResultValues(results);
+    if (presentResults === false) {
+      return false;
     }
-    return results.reduce((acc, result) => multiplyWithExpectedDecimals(acc, result));
+    return presentResults.reduce((acc, result) => multiplyWithExpectedDecimals(acc, result));
   }
 }
 
@@ -278,10 +300,11 @@ class Subtract extends Arithmetic {
     super('-', OPERATOR$j, operands);
   }
   operate(results) {
-    if (!areAllNumbers(results)) {
-      throw new Error('operands must be numbers for subtract');
+    const presentResults = this.getResultValues(results);
+    if (presentResults === false) {
+      return false;
     }
-    return results.reduce((acc, result) => subtractWithExpectedDecimals(acc, result));
+    return presentResults.reduce((acc, result) => subtractWithExpectedDecimals(acc, result));
   }
 }
 
@@ -309,10 +332,11 @@ class Sum extends Arithmetic {
     super('+', OPERATOR$i, operands);
   }
   operate(results) {
-    if (!areAllNumbers(results)) {
-      throw new Error('operands must be numbers for sum');
+    const presentResults = this.getResultValues(results);
+    if (presentResults === false) {
+      return false;
     }
-    return results.reduce((acc, result) => addWithExpectedDecimals(acc, result));
+    return presentResults.reduce((acc, result) => addWithExpectedDecimals(acc, result));
   }
 }
 

package/lib/illogical.js

@@ -139,6 +139,27 @@ class Arithmetic {
     _defineProperty(this, "type", EvaluableType.Expression);
   }
 
+  /**
+   * Helper function to assist with arithmetic evaluation. Ensures that all
+   * operands are present and are numbers. Throws error if any operand is not a
+   * number.
+   *
+   * @param {Result[]} results
+   * @returns {number[] | false} false if any operand is missing, otherwise the
+   *   array of numbers
+   */
+  getResultValues(results) {
+    const presentValues = results.filter(result => result !== null && result !== undefined);
+    // If we have missing context values the result must be false
+    if (presentValues.length !== results.length) {
+      return false;
+    }
+    if (!areAllNumbers(presentValues)) {
+      throw new Error(`operands must be numbers for ${this.constructor.name}`);
+    }
+    return presentValues;
+  }
+
   /**
    * Performs the arithmetic operation on the operands evaluated values.
    * @param {Result[]} results Operand result values.
@@ -208,11 +229,11 @@ class Divide extends Arithmetic {
     super('/', OPERATOR$l, operands);
   }
   operate(results) {
-    if (!areAllNumbers(results)) {
-      throw new Error('operands must be numbers for divide');
+    const presentResults = this.getResultValues(results);
+    if (presentResults === false) {
+      return false;
     }
-    const result = results.reduce((acc, result) => acc / result);
-    return result;
+    return presentResults.reduce((acc, result) => acc / result);
   }
 }
 
@@ -251,10 +272,11 @@ class Multiply extends Arithmetic {
     super('*', OPERATOR$k, operands);
   }
   operate(results) {
-    if (!areAllNumbers(results)) {
-      throw new Error('operands must be numbers for multiply');
+    const presentResults = this.getResultValues(results);
+    if (presentResults === false) {
+      return false;
     }
-    return results.reduce((acc, result) => multiplyWithExpectedDecimals(acc, result));
+    return presentResults.reduce((acc, result) => multiplyWithExpectedDecimals(acc, result));
   }
 }
 
@@ -282,10 +304,11 @@ class Subtract extends Arithmetic {
     super('-', OPERATOR$j, operands);
   }
   operate(results) {
-    if (!areAllNumbers(results)) {
-      throw new Error('operands must be numbers for subtract');
+    const presentResults = this.getResultValues(results);
+    if (presentResults === false) {
+      return false;
     }
-    return results.reduce((acc, result) => subtractWithExpectedDecimals(acc, result));
+    return presentResults.reduce((acc, result) => subtractWithExpectedDecimals(acc, result));
   }
 }
 
@@ -313,10 +336,11 @@ class Sum extends Arithmetic {
     super('+', OPERATOR$i, operands);
   }
   operate(results) {
-    if (!areAllNumbers(results)) {
-      throw new Error('operands must be numbers for sum');
+    const presentResults = this.getResultValues(results);
+    if (presentResults === false) {
+      return false;
     }
-    return results.reduce((acc, result) => addWithExpectedDecimals(acc, result));
+    return presentResults.reduce((acc, result) => addWithExpectedDecimals(acc, result));
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@briza/illogical",
-  "version": "1.6.0",
+  "version": "1.6.1",
   "description": "A micro conditional javascript engine used to parse the raw logical and comparison expressions, evaluate the expression in the given data context, and provide access to a text form of the given expressions.",
   "main": "lib/illogical.js",
   "module": "lib/illogical.esm.js",
@@ -29,7 +29,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git@github.com:briza-insurance/illogical.git"
+    "url": "git+ssh://git@github.com/briza-insurance/illogical.git"
   },
   "bugs": {
     "url": "https://github.com/briza-insurance/illogical/issues"

package/types/expression/arithmetic/index.d.ts

@@ -17,6 +17,16 @@ export declare abstract class Arithmetic implements Evaluable {
      * @param {Operand[]} operands Operands.
      */
     constructor(operator: string, operatorSymbol: symbol, operands: Operand[]);
+    /**
+     * Helper function to assist with arithmetic evaluation. Ensures that all
+     * operands are present and are numbers. Throws error if any operand is not a
+     * number.
+     *
+     * @param {Result[]} results
+     * @returns {number[] | false} false if any operand is missing, otherwise the
+     *   array of numbers
+     */
+    protected getResultValues(results: Result[]): number[] | false;
     /**
      * Performs the arithmetic operation on the operands evaluated values.
      * @param {Result[]} results Operand result values.