You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2024/08/15 07:52:58 UTC

(camel) 04/10: CAMEL-21081: Add iif function to simple language

This is an automated email from the ASF dual-hosted git repository.

davsclaus pushed a commit to branch iif
in repository https://gitbox.apache.org/repos/asf/camel.git

commit 8181165d14f3feaa61f4dbbce4cc21fcb1ca8777
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Wed Aug 14 17:39:57 2024 +0200

    CAMEL-21081: Add iif function to simple language
---
 .../language/csimple/joor/OriginalSimpleTest.java  | 21 ++++++++----
 .../modules/languages/pages/simple-language.adoc   |  2 +-
 .../language/csimple/CSimpleCodeGenerator.java     |  6 ++--
 .../camel/language/csimple/CSimpleHelper.java      | 19 ++++++++---
 .../language/simple/SimpleExpressionBuilder.java   | 36 ++++++++++++++++++++
 .../language/simple/SimpleExpressionParser.java    |  6 +++-
 .../language/simple/SimplePredicateParser.java     |  6 +++-
 .../camel/language/simple/ast/BaseSimpleNode.java  |  3 ++
 .../language/simple/ast/BinaryExpression.java      |  4 +++
 .../language/simple/ast/LogicalExpression.java     |  4 +++
 .../simple/ast/SimpleFunctionExpression.java       | 39 +++++++++++++++++++---
 .../camel/language/simple/ast/UnaryExpression.java |  4 +++
 .../camel/builder/ExpressionBuilderTest.java       | 13 --------
 .../apache/camel/language/simple/SimpleTest.java   | 15 +++++++++
 .../camel/support/builder/ExpressionBuilder.java   | 29 ----------------
 15 files changed, 144 insertions(+), 63 deletions(-)

diff --git a/components/camel-csimple-joor/src/test/java/org/apache/camel/language/csimple/joor/OriginalSimpleTest.java b/components/camel-csimple-joor/src/test/java/org/apache/camel/language/csimple/joor/OriginalSimpleTest.java
index 216ee7b981d..168709b2385 100644
--- a/components/camel-csimple-joor/src/test/java/org/apache/camel/language/csimple/joor/OriginalSimpleTest.java
+++ b/components/camel-csimple-joor/src/test/java/org/apache/camel/language/csimple/joor/OriginalSimpleTest.java
@@ -2090,13 +2090,22 @@ public class OriginalSimpleTest extends LanguageTestSupport {
 
     @Test
     public void testIif() {
-        assertExpression("${iif(true, \"yes\", \"no\")}", "yes");
-        assertExpression("${iif(false, \"yes\", \"no\")}", "no");
+        exchange.getIn().setHeader("foo", 44);
+        assertExpression("${iif(${headerAs(foo,int)} > 0,'positive','negative')}", "positive");
+        exchange.getIn().setHeader("foo", -123);
+        assertExpression("${iif(${headerAs(foo,int)} > 0,'positive','negative')}", "negative");
 
-        // above assertion fails
-        //exchange.setVariable("cheese", "gauda");
-        //exchange.getMessage().setHeader("counter", 3);
-        //assertExpression("${iif(true, ${variableAs('cheese', 'String')}, ${headerAs('counter', 'Integer')})}", "no");
+        exchange.getIn().setBody("Hello World");
+        exchange.getIn().setHeader("foo", 44);
+        assertExpression("${iif(${headerAs(foo,int)} > 0,${body},'Bye World')}", "Hello World");
+        exchange.getIn().setHeader("foo", -123);
+        assertExpression("${iif(${headerAs(foo,int)} > 0,${body},'Bye World')}", "Bye World");
+        assertExpression("${iif(${headerAs(foo,int)} > 0,${body},${null})}", null);
+
+        exchange.setVariable("cheese", "gauda");
+        exchange.getMessage().setHeader("counter", 3);
+        assertExpression("${iif(true, ${variableAs('cheese', 'String')}, ${headerAs('counter', 'Integer')})}", "gauda");
+        assertExpression("${iif(false, ${variableAs('cheese', 'String')}, ${headerAs('counter', 'Integer')})}", "3");
     }
 
     @Override
diff --git a/core/camel-core-languages/src/main/docs/modules/languages/pages/simple-language.adoc b/core/camel-core-languages/src/main/docs/modules/languages/pages/simple-language.adoc
index d929d2daf36..ac47f5fafee 100644
--- a/core/camel-core-languages/src/main/docs/modules/languages/pages/simple-language.adoc
+++ b/core/camel-core-languages/src/main/docs/modules/languages/pages/simple-language.adoc
@@ -315,7 +315,7 @@ For _input_ you can choose `header:key`, `exchangeProperty:key` or `variable:key
 |pretty(exp) | String | Converts the inlined expression to a String, and attempts to pretty print if JSon or XML, otherwise the expression is returned as the String value.
 
 |iif(predicate, trueExp, falseExp) | Object | Evaluates the `predicate` expression and returns the value of `trueExp` if the predicate is
-true, otherwise the value of `falseExp` is returned.
+true, otherwise the value of `falseExp` is returned. This function is similar to the ternary operator in Java.
 
 |=======================================================================
 
diff --git a/core/camel-core-languages/src/main/java/org/apache/camel/language/csimple/CSimpleCodeGenerator.java b/core/camel-core-languages/src/main/java/org/apache/camel/language/csimple/CSimpleCodeGenerator.java
index bbb1cb144ee..10c491cb2da 100644
--- a/core/camel-core-languages/src/main/java/org/apache/camel/language/csimple/CSimpleCodeGenerator.java
+++ b/core/camel-core-languages/src/main/java/org/apache/camel/language/csimple/CSimpleCodeGenerator.java
@@ -121,9 +121,6 @@ public class CSimpleCodeGenerator {
         sb.append(
                 "    public Object evaluate(CamelContext context, Exchange exchange, Message message, Object body) throws Exception {\n");
         sb.append("        ");
-        if (!script.contains("return ")) {
-            sb.append("return ");
-        }
 
         if (predicate) {
             CSimplePredicateParser parser = new CSimplePredicateParser();
@@ -141,6 +138,9 @@ public class CSimpleCodeGenerator {
             }
         }
 
+        if (!script.contains("return ")) {
+            sb.append("return ");
+        }
         sb.append(script);
         if (!script.endsWith("}") && !script.endsWith(";")) {
             sb.append(";");
diff --git a/core/camel-core-languages/src/main/java/org/apache/camel/language/csimple/CSimpleHelper.java b/core/camel-core-languages/src/main/java/org/apache/camel/language/csimple/CSimpleHelper.java
index 7a244c57dc8..941e90fc6b9 100644
--- a/core/camel-core-languages/src/main/java/org/apache/camel/language/csimple/CSimpleHelper.java
+++ b/core/camel-core-languages/src/main/java/org/apache/camel/language/csimple/CSimpleHelper.java
@@ -24,6 +24,8 @@ import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Random;
+import java.util.function.Predicate;
+import java.util.function.Supplier;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
@@ -355,9 +357,7 @@ public final class CSimpleHelper {
     private static Object doDate(Exchange exchange, String commandWithOffsets, String timezone, String pattern) {
         final String command = commandWithOffsets.split("[+-]", 2)[0].trim();
         final List<Long> offsets = LanguageHelper.captureOffsets(commandWithOffsets, OFFSET_PATTERN);
-
         Date date = evalDate(exchange, command);
-
         return LanguageHelper.applyDateOffsets(date, offsets, pattern, timezone);
     }
 
@@ -695,8 +695,17 @@ public final class CSimpleHelper {
         return num;
     }
 
-    public static Object iif(Exchange exchange, Object condition, Object trueResult, Object falseResult) {
-        boolean evaluatedCondition = exchange.getContext().getTypeConverter().convertTo(boolean.class, exchange, condition);
-        return evaluatedCondition ? trueResult : falseResult;
+    public static Object iif(Exchange exchange, Predicate pred, Supplier val1, Supplier val2) {
+        boolean match = pred.test(exchange);
+        if (match) {
+            return val1.get();
+        } else {
+            return val2.get();
+        }
     }
+
+    public static <T> T convert(Exchange exchange, Class<T> type, Object value) {
+        return exchange.getContext().getTypeConverter().convertTo(type, exchange, value);
+    }
+
 }
diff --git a/core/camel-core-languages/src/main/java/org/apache/camel/language/simple/SimpleExpressionBuilder.java b/core/camel-core-languages/src/main/java/org/apache/camel/language/simple/SimpleExpressionBuilder.java
index 6de95363116..dab6fdb1ec4 100644
--- a/core/camel-core-languages/src/main/java/org/apache/camel/language/simple/SimpleExpressionBuilder.java
+++ b/core/camel-core-languages/src/main/java/org/apache/camel/language/simple/SimpleExpressionBuilder.java
@@ -32,6 +32,7 @@ import org.apache.camel.Exchange;
 import org.apache.camel.ExchangePropertyKey;
 import org.apache.camel.Expression;
 import org.apache.camel.InvalidPayloadException;
+import org.apache.camel.Predicate;
 import org.apache.camel.spi.ClassResolver;
 import org.apache.camel.spi.ExchangeFormatter;
 import org.apache.camel.spi.Language;
@@ -176,6 +177,41 @@ public final class SimpleExpressionBuilder {
         };
     }
 
+    /**
+     * A ternary condition expression
+     */
+    public static Expression iifExpression(final String predicate, final String trueValue, final String falseValue) {
+        return new ExpressionAdapter() {
+            private Predicate pred;
+            private Expression expTrue;
+            private Expression expFalse;
+
+            @Override
+            public void init(CamelContext context) {
+                pred = context.resolveLanguage("simple").createPredicate(predicate);
+                pred.init(context);
+                expTrue = context.resolveLanguage("simple").createExpression(trueValue);
+                expTrue.init(context);
+                expFalse = context.resolveLanguage("simple").createExpression(falseValue);
+                expFalse.init(context);
+            }
+
+            @Override
+            public Object evaluate(Exchange exchange) {
+                if (pred.matches(exchange)) {
+                    return expTrue.evaluate(exchange, Object.class);
+                } else {
+                    return expFalse.evaluate(exchange, Object.class);
+                }
+            }
+
+            @Override
+            public String toString() {
+                return "iif(" + predicate + "," + trueValue + "," + falseValue + ")";
+            }
+        };
+    }
+
     /**
      * Joins together the values from the expression
      */
diff --git a/core/camel-core-languages/src/main/java/org/apache/camel/language/simple/SimpleExpressionParser.java b/core/camel-core-languages/src/main/java/org/apache/camel/language/simple/SimpleExpressionParser.java
index 87ff7507178..267f0480bfb 100644
--- a/core/camel-core-languages/src/main/java/org/apache/camel/language/simple/SimpleExpressionParser.java
+++ b/core/camel-core-languages/src/main/java/org/apache/camel/language/simple/SimpleExpressionParser.java
@@ -23,6 +23,7 @@ import java.util.concurrent.atomic.AtomicInteger;
 
 import org.apache.camel.CamelContext;
 import org.apache.camel.Expression;
+import org.apache.camel.language.simple.ast.BaseSimpleNode;
 import org.apache.camel.language.simple.ast.LiteralExpression;
 import org.apache.camel.language.simple.ast.LiteralNode;
 import org.apache.camel.language.simple.ast.SimpleFunctionEnd;
@@ -240,7 +241,10 @@ public class SimpleExpressionParser extends BaseSimpleParser {
                 }
             }
         }
-        return sb.toString();
+        String code = sb.toString();
+        code = code.replace(BaseSimpleNode.CODE_START, "");
+        code = code.replace(BaseSimpleNode.CODE_END, "");
+        return code;
     }
 
     // --------------------------------------------------------------
diff --git a/core/camel-core-languages/src/main/java/org/apache/camel/language/simple/SimplePredicateParser.java b/core/camel-core-languages/src/main/java/org/apache/camel/language/simple/SimplePredicateParser.java
index b7df246923b..017af5fc677 100644
--- a/core/camel-core-languages/src/main/java/org/apache/camel/language/simple/SimplePredicateParser.java
+++ b/core/camel-core-languages/src/main/java/org/apache/camel/language/simple/SimplePredicateParser.java
@@ -28,6 +28,7 @@ import java.util.concurrent.atomic.AtomicBoolean;
 import org.apache.camel.CamelContext;
 import org.apache.camel.Expression;
 import org.apache.camel.Predicate;
+import org.apache.camel.language.simple.ast.BaseSimpleNode;
 import org.apache.camel.language.simple.ast.BinaryExpression;
 import org.apache.camel.language.simple.ast.BooleanExpression;
 import org.apache.camel.language.simple.ast.DoubleQuoteEnd;
@@ -187,7 +188,10 @@ public class SimplePredicateParser extends BaseSimpleParser {
                 sb.append(exp);
             }
         }
-        return sb.toString();
+        String code = sb.toString();
+        code = code.replace(BaseSimpleNode.CODE_START, "");
+        code = code.replace(BaseSimpleNode.CODE_END, "");
+        return code;
     }
 
     /**
diff --git a/core/camel-core-languages/src/main/java/org/apache/camel/language/simple/ast/BaseSimpleNode.java b/core/camel-core-languages/src/main/java/org/apache/camel/language/simple/ast/BaseSimpleNode.java
index 374212071f3..1519c10e78e 100644
--- a/core/camel-core-languages/src/main/java/org/apache/camel/language/simple/ast/BaseSimpleNode.java
+++ b/core/camel-core-languages/src/main/java/org/apache/camel/language/simple/ast/BaseSimpleNode.java
@@ -24,6 +24,9 @@ import org.apache.camel.language.simple.types.SimpleToken;
  */
 public abstract class BaseSimpleNode implements SimpleNode {
 
+    public static final String CODE_START = "\"@@code[[";
+    public static final String CODE_END = "]]code@@\"";
+
     protected final SimpleToken token;
 
     protected BaseSimpleNode(SimpleToken token) {
diff --git a/core/camel-core-languages/src/main/java/org/apache/camel/language/simple/ast/BinaryExpression.java b/core/camel-core-languages/src/main/java/org/apache/camel/language/simple/ast/BinaryExpression.java
index 76931d3b3c8..c6c715f957b 100644
--- a/core/camel-core-languages/src/main/java/org/apache/camel/language/simple/ast/BinaryExpression.java
+++ b/core/camel-core-languages/src/main/java/org/apache/camel/language/simple/ast/BinaryExpression.java
@@ -282,6 +282,10 @@ public class BinaryExpression extends BaseSimpleNode {
 
     @Override
     public String createCode(String expression) throws SimpleParserException {
+        return CODE_START + doCreateCode(expression) + CODE_END;
+    }
+
+    private String doCreateCode(String expression) throws SimpleParserException {
         org.apache.camel.util.ObjectHelper.notNull(left, "left node", this);
         org.apache.camel.util.ObjectHelper.notNull(right, "right node", this);
 
diff --git a/core/camel-core-languages/src/main/java/org/apache/camel/language/simple/ast/LogicalExpression.java b/core/camel-core-languages/src/main/java/org/apache/camel/language/simple/ast/LogicalExpression.java
index 99caa50af08..f158d22651a 100644
--- a/core/camel-core-languages/src/main/java/org/apache/camel/language/simple/ast/LogicalExpression.java
+++ b/core/camel-core-languages/src/main/java/org/apache/camel/language/simple/ast/LogicalExpression.java
@@ -123,6 +123,10 @@ public class LogicalExpression extends BaseSimpleNode {
 
     @Override
     public String createCode(String expression) throws SimpleParserException {
+        return CODE_START + doCreateCode(expression) + CODE_END;
+    }
+
+    private String doCreateCode(String expression) throws SimpleParserException {
         ObjectHelper.notNull(left, "left node", this);
         ObjectHelper.notNull(right, "right node", this);
 
diff --git a/core/camel-core-languages/src/main/java/org/apache/camel/language/simple/ast/SimpleFunctionExpression.java b/core/camel-core-languages/src/main/java/org/apache/camel/language/simple/ast/SimpleFunctionExpression.java
index ee10e69920f..fa23e2938dd 100644
--- a/core/camel-core-languages/src/main/java/org/apache/camel/language/simple/ast/SimpleFunctionExpression.java
+++ b/core/camel-core-languages/src/main/java/org/apache/camel/language/simple/ast/SimpleFunctionExpression.java
@@ -841,6 +841,21 @@ public class SimpleFunctionExpression extends LiteralExpression {
             }
             return SimpleExpressionBuilder.newEmptyExpression(value);
         }
+        // iif function
+        remainder = ifStartsWithReturnRemainder("iif(", function);
+        if (remainder != null) {
+            String values = StringHelper.beforeLast(remainder, ")");
+            if (values == null || ObjectHelper.isEmpty(values)) {
+                throw new SimpleParserException(
+                        "Valid syntax: ${iif(predicate,trueExpression,falseExpression)} was: " + function, token.getIndex());
+            }
+            String[] tokens = StringQuoteHelper.splitSafeQuote(values, ',');
+            if (tokens.length > 3) {
+                throw new SimpleParserException(
+                        "Valid syntax: ${iif(predicate,trueExpression,falseExpression)} was: " + function, token.getIndex());
+            }
+            return SimpleExpressionBuilder.iifExpression(tokens[0].trim(), tokens[1].trim(), tokens[2].trim());
+        }
 
         return null;
     }
@@ -857,6 +872,10 @@ public class SimpleFunctionExpression extends LiteralExpression {
 
     @Override
     public String createCode(String expression) throws SimpleParserException {
+        return CODE_START + doCreateCode(expression) + CODE_END;
+    }
+
+    private String doCreateCode(String expression) throws SimpleParserException {
         String function = getText();
 
         // return the function directly if we can create function without analyzing the prefix
@@ -1791,7 +1810,7 @@ public class SimpleFunctionExpression extends LiteralExpression {
             return "empty(exchange, " + value + ")";
         }
 
-        // iif function
+        // iif function (need to work on the original function to know the token positions
         remainder = ifStartsWithReturnRemainder("iif(", function);
         if (remainder != null) {
             String values = StringHelper.beforeLast(remainder, ")");
@@ -1799,12 +1818,24 @@ public class SimpleFunctionExpression extends LiteralExpression {
                 throw new SimpleParserException(
                         "Valid syntax: ${iif(predicate,trueExpression,falseExpression)} was: " + function, token.getIndex());
             }
-            String[] tokens = StringQuoteHelper.splitSafeQuote(values, ',');
-            if (tokens.length > 3) {
+            String[] tokens = StringQuoteHelper.splitSafeQuote(values, ',', false, true);
+            if (tokens.length != 3) {
                 throw new SimpleParserException(
                         "Valid syntax: ${iif(predicate,trueExpression,falseExpression)} was: " + function, token.getIndex());
             }
-            return "iif(exchange, " + values + ")";
+            // single quotes should be double quotes
+            for (int i = 0; i < 3; i++) {
+                String s = tokens[i];
+                if (StringHelper.isSingleQuoted(s)) {
+                    s = StringHelper.removeLeadingAndEndingQuotes(s);
+                    s = StringQuoteHelper.doubleQuote(s);
+                    tokens[i] = s;
+                }
+            }
+
+            return "Object o = " + tokens[0]
+                   + ";\n        boolean b = convert(exchange, boolean.class, o);\n        return b ? " + tokens[1] + " : "
+                   + tokens[2];
         }
 
         return null;
diff --git a/core/camel-core-languages/src/main/java/org/apache/camel/language/simple/ast/UnaryExpression.java b/core/camel-core-languages/src/main/java/org/apache/camel/language/simple/ast/UnaryExpression.java
index e87c8a5d4e4..cf1db601657 100644
--- a/core/camel-core-languages/src/main/java/org/apache/camel/language/simple/ast/UnaryExpression.java
+++ b/core/camel-core-languages/src/main/java/org/apache/camel/language/simple/ast/UnaryExpression.java
@@ -147,6 +147,10 @@ public class UnaryExpression extends BaseSimpleNode {
 
     @Override
     public String createCode(String expression) throws SimpleParserException {
+        return CODE_START + doCreateCode(expression) + CODE_END;
+    }
+
+    private String doCreateCode(String expression) throws SimpleParserException {
         ObjectHelper.notNull(left, "left node", this);
 
         final String number = left.createCode(expression);
diff --git a/core/camel-core/src/test/java/org/apache/camel/builder/ExpressionBuilderTest.java b/core/camel-core/src/test/java/org/apache/camel/builder/ExpressionBuilderTest.java
index c636d5ba4d9..3adb9290a70 100644
--- a/core/camel-core/src/test/java/org/apache/camel/builder/ExpressionBuilderTest.java
+++ b/core/camel-core/src/test/java/org/apache/camel/builder/ExpressionBuilderTest.java
@@ -141,19 +141,6 @@ public class ExpressionBuilderTest extends TestSupport {
         assertExpression(expression, exchange, "Hello big World");
     }
 
-    @Test
-    public void testIif() {
-        Expression expression
-                = iifExpression(simpleExpression("true"), constantExpression("true value"), constantExpression("false value"));
-        expression.init(camelContext);
-        assertEquals("true value", expression.evaluate(exchange, String.class));
-
-        expression
-                = iifExpression(simpleExpression("false"), constantExpression("true value"), constantExpression("false value"));
-        expression.init(camelContext);
-        assertEquals("false value", expression.evaluate(exchange, String.class));
-    }
-
     @Override
     @BeforeEach
     public void setUp() throws Exception {
diff --git a/core/camel-core/src/test/java/org/apache/camel/language/simple/SimpleTest.java b/core/camel-core/src/test/java/org/apache/camel/language/simple/SimpleTest.java
index 46bec4cc7b7..3b16729a7b6 100644
--- a/core/camel-core/src/test/java/org/apache/camel/language/simple/SimpleTest.java
+++ b/core/camel-core/src/test/java/org/apache/camel/language/simple/SimpleTest.java
@@ -2114,6 +2114,21 @@ public class SimpleTest extends LanguageTestSupport {
         assertExpression("${substring(0,0,${header.foo})}", "1234567890");
     }
 
+    @Test
+    public void testIif() {
+        exchange.getIn().setHeader("foo", 44);
+        assertExpression("${iif(${header.foo} > 0,'positive','negative')}", "positive");
+        exchange.getIn().setHeader("foo", -123);
+        assertExpression("${iif(${header.foo} > 0,'positive','negative')}", "negative");
+
+        exchange.getIn().setBody("Hello World");
+        exchange.getIn().setHeader("foo", 44);
+        assertExpression("${iif(${header.foo} > 0,${body},'Bye World')}", "Hello World");
+        exchange.getIn().setHeader("foo", -123);
+        assertExpression("${iif(${header.foo} > 0,${body},'Bye World')}", "Bye World");
+        assertExpression("${iif(${header.foo} > 0,${body},${null})}", null);
+    }
+
     @Test
     public void testListRemoveByInstance() {
         List<Object> data = new ArrayList<>();
diff --git a/core/camel-support/src/main/java/org/apache/camel/support/builder/ExpressionBuilder.java b/core/camel-support/src/main/java/org/apache/camel/support/builder/ExpressionBuilder.java
index d87fb183992..ac696463421 100644
--- a/core/camel-support/src/main/java/org/apache/camel/support/builder/ExpressionBuilder.java
+++ b/core/camel-support/src/main/java/org/apache/camel/support/builder/ExpressionBuilder.java
@@ -2556,35 +2556,6 @@ public class ExpressionBuilder {
         };
     }
 
-    public static Expression iifExpression(
-            final Expression predicate, final Expression trueExpression, final Expression falseExpression) {
-        return new ExpressionAdapter() {
-            private Predicate pred;
-
-            @Override
-            public Object evaluate(Exchange exchange) {
-                if (pred.matches(exchange)) {
-                    return trueExpression.evaluate(exchange, Object.class);
-                } else {
-                    return falseExpression.evaluate(exchange, Object.class);
-                }
-            }
-
-            @Override
-            public void init(CamelContext context) {
-                super.init(context);
-                pred = PredicateBuilder.toPredicate(predicate);
-                trueExpression.init(context);
-                falseExpression.init(context);
-            }
-
-            @Override
-            public String toString() {
-                return "iif(" + predicate + ", " + trueExpression + ", " + falseExpression + ")";
-            }
-        };
-    }
-
     private static String prettyXml(String rawXml) {
         try {
             boolean includeDeclaration = rawXml.startsWith("<?xml");