Merge pull request #510 from HubSpot/exp-test-safe-v3

Expression test parity v3

src/main/java/com/hubspot/jinjava/el/ext/ExtendedParser.java

@@ -4,14 +4,23 @@
 import static de.odysseus.el.tree.impl.Builder.Feature.NULL_PROPERTIES;
 import static de.odysseus.el.tree.impl.Scanner.Symbol.COLON;
 import static de.odysseus.el.tree.impl.Scanner.Symbol.COMMA;
+import static de.odysseus.el.tree.impl.Scanner.Symbol.EQ;
+import static de.odysseus.el.tree.impl.Scanner.Symbol.FALSE;
+import static de.odysseus.el.tree.impl.Scanner.Symbol.GE;
+import static de.odysseus.el.tree.impl.Scanner.Symbol.GT;
 import static de.odysseus.el.tree.impl.Scanner.Symbol.IDENTIFIER;
 import static de.odysseus.el.tree.impl.Scanner.Symbol.LBRACK;
+import static de.odysseus.el.tree.impl.Scanner.Symbol.LE;
 import static de.odysseus.el.tree.impl.Scanner.Symbol.LPAREN;
+import static de.odysseus.el.tree.impl.Scanner.Symbol.LT;
+import static de.odysseus.el.tree.impl.Scanner.Symbol.NE;
 import static de.odysseus.el.tree.impl.Scanner.Symbol.QUESTION;
 import static de.odysseus.el.tree.impl.Scanner.Symbol.RBRACK;
 import static de.odysseus.el.tree.impl.Scanner.Symbol.RPAREN;
+import static de.odysseus.el.tree.impl.Scanner.Symbol.TRUE;
 
 import com.google.common.collect.Lists;
+import com.google.common.collect.Sets;
 import de.odysseus.el.tree.impl.Builder;
 import de.odysseus.el.tree.impl.Builder.Feature;
 import de.odysseus.el.tree.impl.Parser;
@@ -33,6 +42,7 @@
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.Set;
 import javax.el.ELException;
 
 public class ExtendedParser extends Parser {
@@ -53,6 +63,19 @@ public class ExtendedParser extends Parser {
   static final Scanner.ExtensionToken TRUNC_DIV = TruncDivOperator.TOKEN;
   static final Scanner.ExtensionToken POWER_OF = PowerOfOperator.TOKEN;
 
+  static final Set<Symbol> VALID_SYMBOLS_FOR_EXP_TEST = Sets.newHashSet(
+    IDENTIFIER,
+    EQ,
+    NE,
+    LT,
+    LE,
+    GT,
+    GE,
+    TRUE,
+    FALSE,
+    CollectionMembershipOperator.TOKEN.getSymbol()
+  );
+
   static {
     ExtendedScanner.addKeyToken(IF);
     ExtendedScanner.addKeyToken(ELSE);
@@ -396,13 +419,14 @@ protected AstNode value() throws ScanException, ParseException {
           } else if (
             "is".equals(getToken().getImage()) &&
             "not".equals(lookahead(0).getImage()) &&
-            lookahead(1).getSymbol() == IDENTIFIER
+            isPossibleExpTest(lookahead(1).getSymbol())
           ) {
             consumeToken(); // 'is'
             consumeToken(); // 'not'
             v = buildAstMethodForIdentifier(v, "evaluateNegated");
           } else if (
-            "is".equals(getToken().getImage()) && lookahead(0).getSymbol() == IDENTIFIER
+            "is".equals(getToken().getImage()) &&
+            isPossibleExpTest(lookahead(0).getSymbol())
           ) {
             consumeToken(); // 'is'
             v = buildAstMethodForIdentifier(v, "evaluate");
@@ -413,6 +437,10 @@ protected AstNode value() throws ScanException, ParseException {
     }
   }
 
+  private boolean isPossibleExpTest(Symbol symbol) {
+    return VALID_SYMBOLS_FOR_EXP_TEST.contains(symbol);
+  }
+
   private AstNode buildAstMethodForIdentifier(AstNode astNode, String property)
     throws ScanException, ParseException {
     String exptestName = consumeToken().getImage();

src/main/java/com/hubspot/jinjava/interpret/InvalidReason.java

@@ -10,6 +10,7 @@ public enum InvalidReason {
   JSON_WRITE("object could not be written as a string"),
   REGEX("with value %s must be valid regex"),
   POSITIVE_NUMBER("with value %s must be a positive number"),
+  NOT_ITERABLE("with value '%s' must be iterable"),
   NON_ZERO_NUMBER("with value %s must be non-zero"),
   NULL_IN_LIST("of type 'list' cannot contain a null item"),
   NULL_ATTRIBUTE_IN_LIST(

src/main/java/com/hubspot/jinjava/lib/exptest/ExpTestLibrary.java

@@ -15,6 +15,20 @@ protected void registerDefaults() {
       IsDefinedExpTest.class,
       IsDivisibleByExpTest.class,
       IsEqualToExpTest.class,
+      IsEqExpTest.class,
+      IsEqualsSymbolExpTest.class,
+      IsNeExpTest.class,
+      IsNotEqualToSymbolExpTest.class,
+      IsLtTest.class,
+      IsLessThanExpTest.class,
+      IsLessThanSymbolExpTest.class,
+      IsLeTest.class,
+      IsLessThanOrEqualToSymbolExpTest.class,
+      IsGtTest.class,
+      IsGreaterThanExpTest.class,
+      IsGreaterThanSymbolExpTest.class,
+      IsGeTest.class,
+      IsGreaterThanOrEqualToSymbolExpTest.class,
       IsEvenExpTest.class,
       IsIterableExpTest.class,
       IsLowerExpTest.class,
@@ -24,14 +38,20 @@ protected void registerDefaults() {
       IsOddExpTest.class,
       IsSameAsExpTest.class,
       IsSequenceExpTest.class,
+      IsBooleanExpTest.class,
+      IsIntegerExpTest.class,
+      IsFloatExpTest.class,
       IsStringExpTest.class,
       IsStringContainingExpTest.class,
       IsStringStartingWithExpTest.class,
+      IsTrueExpTest.class,
+      IsFalseExpTest.class,
       IsTruthyExpTest.class,
       IsUndefinedExpTest.class,
       IsUpperExpTest.class,
       IsContainingAllExpTest.class,
       IsContainingExpTest.class,
+      IsInExpTest.class,
       IsWithinExpTest.class
     );
   }

src/main/java/com/hubspot/jinjava/lib/exptest/IsBooleanExpTest.java

@@ -0,0 +1,30 @@
+package com.hubspot.jinjava.lib.exptest;
+
+import com.hubspot.jinjava.doc.annotations.JinjavaDoc;
+import com.hubspot.jinjava.doc.annotations.JinjavaParam;
+import com.hubspot.jinjava.doc.annotations.JinjavaSnippet;
+import com.hubspot.jinjava.interpret.JinjavaInterpreter;
+
+@JinjavaDoc(
+  value = "Return true if object is a boolean (in a strict sense, not in its ability to evaluate to a truthy expression)",
+  input = @JinjavaParam(value = "value", type = "object", required = true),
+  snippets = {
+    @JinjavaSnippet(
+      code = "{% if true is boolean %}\n" +
+      "      <!--this code will always render-->\n" +
+      "{% endif %}"
+    )
+  }
+)
+public class IsBooleanExpTest implements ExpTest {
+
+  @Override
+  public String getName() {
+    return "boolean";
+  }
+
+  @Override
+  public boolean evaluate(Object var, JinjavaInterpreter interpreter, Object... args) {
+    return var instanceof Boolean;
+  }
+}

src/main/java/com/hubspot/jinjava/lib/exptest/IsEqExpTest.java

@@ -0,0 +1,12 @@
+package com.hubspot.jinjava.lib.exptest;
+
+import com.hubspot.jinjava.doc.annotations.JinjavaDoc;
+
+@JinjavaDoc(value = "", aliasOf = "equalto")
+public class IsEqExpTest extends IsEqualToExpTest {
+
+  @Override
+  public String getName() {
+    return "eq";
+  }
+}

src/main/java/com/hubspot/jinjava/lib/exptest/IsEqualsSymbolExpTest.java

@@ -0,0 +1,12 @@
+package com.hubspot.jinjava.lib.exptest;
+
+import com.hubspot.jinjava.doc.annotations.JinjavaDoc;
+
+@JinjavaDoc(value = "", aliasOf = "equalto")
+public class IsEqualsSymbolExpTest extends IsEqualToExpTest {
+
+  @Override
+  public String getName() {
+    return "==";
+  }
+}

src/main/java/com/hubspot/jinjava/lib/exptest/IsFalseExpTest.java

@@ -0,0 +1,30 @@
+package com.hubspot.jinjava.lib.exptest;
+
+import com.hubspot.jinjava.doc.annotations.JinjavaDoc;
+import com.hubspot.jinjava.doc.annotations.JinjavaParam;
+import com.hubspot.jinjava.doc.annotations.JinjavaSnippet;
+import com.hubspot.jinjava.interpret.JinjavaInterpreter;
+
+@JinjavaDoc(
+  value = "Return true if object is a boolean and false",
+  input = @JinjavaParam(value = "value", type = "object", required = true),
+  snippets = {
+    @JinjavaSnippet(
+      code = "{% if false is false %}\n" +
+      "      <!--this code will always render-->\n" +
+      "{% endif %}"
+    )
+  }
+)
+public class IsFalseExpTest implements ExpTest {
+
+  @Override
+  public String getName() {
+    return "false";
+  }
+
+  @Override
+  public boolean evaluate(Object var, JinjavaInterpreter interpreter, Object... args) {
+    return var instanceof Boolean && !(Boolean) var;
+  }
+}

src/main/java/com/hubspot/jinjava/lib/exptest/IsFloatExpTest.java

@@ -0,0 +1,35 @@
+package com.hubspot.jinjava.lib.exptest;
+
+import com.hubspot.jinjava.doc.annotations.JinjavaDoc;
+import com.hubspot.jinjava.doc.annotations.JinjavaParam;
+import com.hubspot.jinjava.doc.annotations.JinjavaSnippet;
+import com.hubspot.jinjava.interpret.JinjavaInterpreter;
+import java.math.BigDecimal;
+
+@JinjavaDoc(
+  value = "Return true if object is a float",
+  input = @JinjavaParam(value = "value", type = "object", required = true),
+  snippets = {
+    @JinjavaSnippet(
+      code = "{% if num is float %}\n" +
+      "      <!--code to render if num contains an floating point value-->\n" +
+      "{% endif %}"
+    )
+  }
+)
+public class IsFloatExpTest implements ExpTest {
+
+  @Override
+  public String getName() {
+    return "float";
+  }
+
+  @Override
+  public boolean evaluate(Object var, JinjavaInterpreter interpreter, Object... args) {
+    return (
+      var instanceof Double ||
+      var instanceof Float ||
+      (var instanceof BigDecimal && ((BigDecimal) var).scale() > 0)
+    );
+  }
+}

src/main/java/com/hubspot/jinjava/lib/exptest/IsGeTest.java

@@ -0,0 +1,55 @@
+package com.hubspot.jinjava.lib.exptest;
+
+import com.hubspot.jinjava.doc.annotations.JinjavaDoc;
+import com.hubspot.jinjava.doc.annotations.JinjavaParam;
+import com.hubspot.jinjava.doc.annotations.JinjavaSnippet;
+import com.hubspot.jinjava.el.TruthyTypeConverter;
+import com.hubspot.jinjava.interpret.JinjavaInterpreter;
+import com.hubspot.jinjava.interpret.TemplateSyntaxException;
+import de.odysseus.el.misc.BooleanOperations;
+import de.odysseus.el.misc.TypeConverter;
+
+@JinjavaDoc(
+  value = "Returns true if the first object's value is greater than or equal to the second object's value",
+  input = @JinjavaParam(value = "first", type = "object", required = true),
+  params = {
+    @JinjavaParam(
+      value = "other",
+      type = "object",
+      desc = "Another object to compare against",
+      required = true
+    )
+  },
+  snippets = {
+    @JinjavaSnippet(
+      code = "{% if foo.expression is ge 42 %}\n" +
+      "    the foo attribute evaluates to the constant 42\n" +
+      "{% endif %}\n"
+    ),
+    @JinjavaSnippet(
+      desc = "Usage with the selectattr filter",
+      code = "{{ users|selectattr(\"num\", \"ge\", \"2\") }}"
+    )
+  }
+)
+public class IsGeTest implements ExpTest {
+  private static final TypeConverter TYPE_CONVERTER = new TruthyTypeConverter();
+
+  @Override
+  public String getName() {
+    return "ge";
+  }
+
+  @Override
+  public boolean evaluate(Object var, JinjavaInterpreter interpreter, Object... args) {
+    if (args.length == 0) {
+      throw new TemplateSyntaxException(
+        interpreter,
+        getName(),
+        "requires 1 argument (other object to compare against)"
+      );
+    }
+
+    return BooleanOperations.ge(TYPE_CONVERTER, var, args[0]);
+  }
+}

src/main/java/com/hubspot/jinjava/lib/exptest/IsGreaterThanExpTest.java

@@ -0,0 +1,12 @@
+package com.hubspot.jinjava.lib.exptest;
+
+import com.hubspot.jinjava.doc.annotations.JinjavaDoc;
+
+@JinjavaDoc(value = "", aliasOf = "gt")
+public class IsGreaterThanExpTest extends IsGtTest {
+
+  @Override
+  public String getName() {
+    return "greaterthan";
+  }
+}

src/main/java/com/hubspot/jinjava/lib/exptest/IsGreaterThanOrEqualToSymbolExpTest.java

@@ -0,0 +1,12 @@
+package com.hubspot.jinjava.lib.exptest;
+
+import com.hubspot.jinjava.doc.annotations.JinjavaDoc;
+
+@JinjavaDoc(value = "", aliasOf = "ge")
+public class IsGreaterThanOrEqualToSymbolExpTest extends IsGeTest {
+
+  @Override
+  public String getName() {
+    return ">=";
+  }
+}

src/main/java/com/hubspot/jinjava/lib/exptest/IsGreaterThanSymbolExpTest.java

@@ -0,0 +1,12 @@
+package com.hubspot.jinjava.lib.exptest;
+
+import com.hubspot.jinjava.doc.annotations.JinjavaDoc;
+
+@JinjavaDoc(value = "", aliasOf = "gt")
+public class IsGreaterThanSymbolExpTest extends IsGtTest {
+
+  @Override
+  public String getName() {
+    return ">";
+  }
+}