Support for top level IfBlock and ForBlock directives in SQL transformation (#840)

Author: nakamura-to

doma-core/src/main/java/org/seasar/doma/internal/jdbc/dialect/AbstractTransformer.java

@@ -0,0 +1,47 @@
+package org.seasar.doma.internal.jdbc.dialect;
+
+import org.seasar.doma.internal.jdbc.sql.SimpleSqlNodeVisitor;
+import org.seasar.doma.internal.jdbc.sql.node.ElseifNode;
+import org.seasar.doma.internal.jdbc.sql.node.EndNode;
+import org.seasar.doma.internal.jdbc.sql.node.ForBlockNode;
+import org.seasar.doma.internal.jdbc.sql.node.IfBlockNode;
+import org.seasar.doma.jdbc.SqlNode;
+
+abstract class AbstractTransformer extends SimpleSqlNodeVisitor<SqlNode, Void> {
+
+  @Override
+  protected SqlNode defaultAction(SqlNode node, Void p) {
+    return node;
+  }
+
+  @Override
+  public SqlNode visitForBlockNode(ForBlockNode node, Void unused) {
+    ForBlockNode result = new ForBlockNode();
+    result.setForNode(node.getForNode());
+    result.setEndNode(visitEndNode(node.getEndNode(), unused));
+    return result;
+  }
+
+  @Override
+  public SqlNode visitIfBlockNode(IfBlockNode node, Void unused) {
+    IfBlockNode result = new IfBlockNode();
+    result.setIfNode(node.getIfNode());
+    for (ElseifNode elseifNode : node.getElseifNodes()) {
+      result.addElseifNode(elseifNode);
+    }
+    if (node.isElseNodeExistent()) {
+      result.setElseNode(node.getElseNode());
+    }
+    result.setEndNode(visitEndNode(node.getEndNode(), unused));
+    return result;
+  }
+
+  @Override
+  public EndNode visitEndNode(EndNode node, Void unused) {
+    EndNode result = new EndNode(node.getText());
+    for (SqlNode child : node.getChildren()) {
+      result.appendNode(child.accept(this, unused));
+    }
+    return result;
+  }
+}

doma-core/src/main/java/org/seasar/doma/internal/jdbc/dialect/StandardCountCalculatingTransformer.java

@@ -1,10 +1,9 @@
 package org.seasar.doma.internal.jdbc.dialect;
 
-import org.seasar.doma.internal.jdbc.sql.SimpleSqlNodeVisitor;
 import org.seasar.doma.internal.jdbc.sql.node.AnonymousNode;
 import org.seasar.doma.jdbc.SqlNode;
 
-public class StandardCountCalculatingTransformer extends SimpleSqlNodeVisitor<SqlNode, Void> {
+public class StandardCountCalculatingTransformer extends AbstractTransformer {
 
   protected boolean processed;
 
@@ -15,9 +14,4 @@ public SqlNode transform(SqlNode sqlNode) {
     }
     return result;
   }
-
-  @Override
-  protected SqlNode defaultAction(SqlNode node, Void p) {
-    return node;
-  }
 }

doma-core/src/main/java/org/seasar/doma/internal/jdbc/dialect/StandardCountGettingTransformer.java

@@ -1,14 +1,13 @@
 package org.seasar.doma.internal.jdbc.dialect;
 
-import org.seasar.doma.internal.jdbc.sql.SimpleSqlNodeVisitor;
 import org.seasar.doma.internal.jdbc.sql.node.AnonymousNode;
 import org.seasar.doma.internal.jdbc.sql.node.FragmentNode;
 import org.seasar.doma.internal.jdbc.sql.node.FromClauseNode;
 import org.seasar.doma.internal.jdbc.sql.node.SelectClauseNode;
 import org.seasar.doma.internal.jdbc.sql.node.SelectStatementNode;
 import org.seasar.doma.jdbc.SqlNode;
 
-public class StandardCountGettingTransformer extends SimpleSqlNodeVisitor<SqlNode, Void> {
+public class StandardCountGettingTransformer extends AbstractTransformer {
 
   protected boolean processed;
 
@@ -47,9 +46,4 @@ public SqlNode visitSelectStatementNode(SelectStatementNode node, Void p) {
     result.setOptionClauseNode(node.getOptionClauseNode());
     return result;
   }
-
-  @Override
-  public SqlNode defaultAction(SqlNode node, Void p) {
-    return node;
-  }
 }

doma-core/src/main/java/org/seasar/doma/internal/jdbc/dialect/StandardForUpdateTransformer.java

@@ -2,12 +2,11 @@
 
 import static org.seasar.doma.internal.util.AssertionUtil.assertNotNull;
 
-import org.seasar.doma.internal.jdbc.sql.SimpleSqlNodeVisitor;
 import org.seasar.doma.internal.jdbc.sql.node.AnonymousNode;
 import org.seasar.doma.jdbc.SelectForUpdateType;
 import org.seasar.doma.jdbc.SqlNode;
 
-public class StandardForUpdateTransformer extends SimpleSqlNodeVisitor<SqlNode, Void> {
+public class StandardForUpdateTransformer extends AbstractTransformer {
 
   protected final SelectForUpdateType forUpdateType;
 
@@ -32,9 +31,4 @@ public SqlNode transform(SqlNode sqlNode) {
     }
     return result;
   }
-
-  @Override
-  protected SqlNode defaultAction(SqlNode node, Void p) {
-    return node;
-  }
 }

doma-core/src/main/java/org/seasar/doma/internal/jdbc/dialect/StandardPagingTransformer.java

@@ -10,7 +10,7 @@
 import org.seasar.doma.jdbc.SqlNode;
 import org.seasar.doma.message.Message;
 
-public class StandardPagingTransformer extends SimpleSqlNodeVisitor<SqlNode, Void> {
+public class StandardPagingTransformer extends AbstractTransformer {
 
   private final AliasReplacer replacer = new AliasReplacer();
 
@@ -90,11 +90,6 @@ public SqlNode visitSelectStatementNode(SelectStatementNode node, Void p) {
     return result;
   }
 
-  @Override
-  protected SqlNode defaultAction(SqlNode node, Void p) {
-    return node;
-  }
-
   protected static class AliasReplacer extends SimpleSqlNodeVisitor<SqlNode, Void> {
 
     @Override

doma-core/src/test/java/org/seasar/doma/internal/jdbc/dialect/PostgresPagingTransformerTest.java

@@ -2,13 +2,21 @@
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
 import java.util.function.Function;
 import org.junit.jupiter.api.Test;
+import org.seasar.doma.internal.expr.ExpressionEvaluator;
+import org.seasar.doma.internal.expr.Value;
 import org.seasar.doma.internal.jdbc.mock.MockConfig;
 import org.seasar.doma.internal.jdbc.sql.NodePreparedSqlBuilder;
 import org.seasar.doma.internal.jdbc.sql.SqlParser;
+import org.seasar.doma.jdbc.Config;
 import org.seasar.doma.jdbc.PreparedSql;
 import org.seasar.doma.jdbc.SqlKind;
+import org.seasar.doma.jdbc.SqlLogType;
 import org.seasar.doma.jdbc.SqlNode;
 
 public class PostgresPagingTransformerTest {
@@ -60,4 +68,38 @@ public void testLimitOnly() {
     PreparedSql sql = sqlBuilder.build(sqlNode, Function.identity());
     assertEquals(expected, sql.getRawSql());
   }
+
+  @Test
+  public void testOffsetLimit_after_ForBlock() {
+    String expected = "with fuga as (select * from hoge) select * from fuga  limit 10 offset 5";
+    PostgresPagingTransformer transformer = new PostgresPagingTransformer(5, 10);
+    SqlParser parser = new SqlParser("/*%for each : list*//*#each*//*%end*/ select * from fuga");
+    SqlNode originalSqlNode = parser.parse();
+    SqlNode sqlNode = transformer.transform(originalSqlNode);
+    Config config = new MockConfig();
+    Map<String, Value> map = new HashMap<>();
+    map.put(
+        "list",
+        new Value(List.class, Collections.singletonList("with fuga as (select * from hoge)")));
+    ExpressionEvaluator evaluator =
+        new ExpressionEvaluator(
+            map, config.getDialect().getExpressionFunctions(), config.getClassHelper());
+    NodePreparedSqlBuilder sqlBuilder =
+        new NodePreparedSqlBuilder(config, SqlKind.SELECT, "dummyPath", evaluator, SqlLogType.RAW);
+    PreparedSql sql = sqlBuilder.build(sqlNode, Function.identity());
+    assertEquals(expected, sql.getRawSql());
+  }
+
+  @Test
+  public void testOffsetLimit_after_IfBlock() {
+    String expected = "with fuga as (select * from hoge) select * from fuga  limit 10 offset 5";
+    PostgresPagingTransformer transformer = new PostgresPagingTransformer(5, 10);
+    SqlParser parser =
+        new SqlParser("/*%if true*/with fuga as (select * from hoge)/*%end*/ select * from fuga");
+    SqlNode sqlNode = transformer.transform(parser.parse());
+    NodePreparedSqlBuilder sqlBuilder =
+        new NodePreparedSqlBuilder(new MockConfig(), SqlKind.SELECT, "dummyPath");
+    PreparedSql sql = sqlBuilder.build(sqlNode, Function.identity());
+    assertEquals(expected, sql.getRawSql());
+  }
 }