Merge pull request #332 from hoijnet/issue/317-no-evaluate-in-fluent

fix(woql): Add evaluate() method for fluent/chained query style

Author: hoijnet

lib/query/woqlQuery.js

@@ -920,6 +920,19 @@ WOQLQuery.prototype.eval = function (arithExp, resultVarName) {
   return this;
 };
 
+/**
+ * Evaluates the passed arithmetic expression and generates or matches the result value.
+ * Alias for eval() to support both naming conventions in fluent/chained style.
+ * @param {object|WOQLQuery|string} arithExp - A WOQL query containing a valid arithmetic expression
+ * @param {string|number|Var} resultVarName - Either a variable to store the result, or a numeric
+ * literal to test against the evaluated expression
+ * @returns {WOQLQuery}
+ */
+
+WOQLQuery.prototype.evaluate = function (arithExp, resultVarName) {
+  return this.eval(arithExp, resultVarName);
+};
+
 /**
  * Adds the numbers together
  * @param {...(string|number|Var)} args - a variable or numeric containing the values to add

test/woql.spec.js

@@ -190,6 +190,34 @@ describe('woql queries', () => {
     expect(woqlObject.json()).to.eql(woqlMathJson.evalJson);
   });
 
+  it('check the evaluate method (functional style)', () => {
+    const woqlObject = WOQL.evaluate('1+2', 'b');
+    expect(woqlObject.json()).to.eql(woqlMathJson.evalJson);
+  });
+
+  it('check the evaluate method (fluent style)', () => {
+    // Test the reported bug: WOQL.limit(100).evaluate(...)
+    const woqlObject = WOQL.limit(100).evaluate(WOQL.times(2, 3), 'v:result');
+    const json = woqlObject.json();
+    
+    // Should have Limit with nested query
+    expect(json).to.have.property('@type', 'Limit');
+    expect(json).to.have.property('limit', 100);
+    expect(json).to.have.property('query');
+    
+    // Nested query should be Eval
+    expect(json.query).to.have.property('@type', 'Eval');
+    expect(json.query).to.have.property('expression');
+    expect(json.query.expression).to.have.property('@type', 'Times');
+  });
+
+  it('check evaluate and eval produce identical results', () => {
+    const withEval = WOQL.limit(10).eval(WOQL.plus(5, 3), 'x');
+    const withEvaluate = WOQL.limit(10).evaluate(WOQL.plus(5, 3), 'x');
+    
+    expect(withEval.json()).to.deep.eql(withEvaluate.json());
+  });
+
   it('check the minus method', () => {
     const woqlObject = WOQL.minus('2', '1');
     expect(woqlObject.json()).to.eql(woqlMathJson.minusJson);
@@ -490,7 +518,6 @@ describe('woql queries', () => {
         WOQL.eval(WOQL.times(3,4), v.a),
         WOQL.eval(WOQL.times(v.a, 3),v.res)
       ).json();
-    console.log(JSON.stringify(wq));
     expect(wq).to.deep.eql(
       {"@type":"And","and":[{"@type":"Eval","expression":{"@type":"Times","left":{"@type":"ArithmeticValue","data":{"@type":"xsd:decimal","@value":3}},"right":{"@type":"ArithmeticValue","data":{"@type":"xsd:decimal","@value":4}}},"result":{"@type":"ArithmeticValue","variable":"a"}},{"@type":"Eval","expression":{"@type":"Times","left":{"@type":"ArithmeticValue","variable":"a"},"right":{"@type":"ArithmeticValue","data":{"@type":"xsd:decimal","@value":3}}},"result":{"@type":"ArithmeticValue","variable":"res"}}]})
   });