Merge pull request #276 from kakusuke/foreach-array

nakamura-to · web-flow · commit 0200a5e18972 · 2019-01-28T21:03:09.000+09:00
support Array Object in %for clause
diff --git a/src/main/java/org/seasar/doma/internal/apt/Types.java b/src/main/java/org/seasar/doma/internal/apt/Types.java
@@ -2,13 +2,27 @@
 
 import static org.seasar.doma.internal.util.AssertionUtil.assertNotNull;
 
-import java.util.*;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
 import javax.annotation.processing.ProcessingEnvironment;
 import javax.lang.model.element.Element;
 import javax.lang.model.element.TypeElement;
 import javax.lang.model.element.TypeParameterElement;
-import javax.lang.model.type.*;
+import javax.lang.model.type.ArrayType;
+import javax.lang.model.type.DeclaredType;
+import javax.lang.model.type.ExecutableType;
+import javax.lang.model.type.NoType;
+import javax.lang.model.type.NullType;
+import javax.lang.model.type.PrimitiveType;
+import javax.lang.model.type.TypeKind;
+import javax.lang.model.type.TypeMirror;
+import javax.lang.model.type.TypeVariable;
+import javax.lang.model.type.WildcardType;
 import javax.lang.model.util.SimpleElementVisitor8;
+import javax.lang.model.util.SimpleTypeVisitor6;
 import javax.lang.model.util.SimpleTypeVisitor8;
 import javax.lang.model.util.TypeKindVisitor8;
 
@@ -153,6 +167,18 @@ public TypeVariable visitTypeVariable(TypeVariable t, Void p) {
         null);
   }
 
+  public ArrayType toArrayType(TypeMirror typeMirror) {
+    assertNotNull(typeMirror);
+    return typeMirror.accept(
+        new SimpleTypeVisitor6<ArrayType, Void>() {
+
+          public ArrayType visitArray(ArrayType t, Void p) {
+            return t;
+          }
+        },
+        null);
+  }
+
   public boolean isAssignable(TypeMirror lhs, Class<?> rhs) {
     assertNotNull(lhs, rhs);
     TypeElement typeElement = ctx.getElements().getTypeElement(rhs);
@@ -197,6 +223,15 @@ public boolean isSameType(TypeMirror typeMirror, Class<?> clazz) {
     if (typeMirror.getKind() == TypeKind.VOID) {
       return clazz == void.class;
     }
+    if (clazz.isArray()) {
+      TypeElement componentType = ctx.getElements().getTypeElement(clazz.getComponentType());
+      ArrayType arrayType = ctx.getTypes().getArrayType(componentType.asType());
+      if (arrayType == null) {
+        return false;
+      }
+      return isSameType(typeMirror, arrayType);
+    }
+
     TypeElement typeElement = ctx.getElements().getTypeElement(clazz);
     if (typeElement == null) {
       return false;
@@ -227,6 +262,10 @@ public boolean isSameType(TypeMirror t1, TypeMirror t2) {
         || erasuredType1.equals(erasuredType2);
   }
 
+  public boolean isArray(TypeMirror typeMirror) {
+    return typeMirror.getKind() == TypeKind.ARRAY;
+  }
+
   public String getTypeName(TypeMirror typeMirror) {
     assertNotNull(typeMirror);
     StringBuilder p = new StringBuilder();
diff --git a/src/main/java/org/seasar/doma/internal/apt/cttype/AbstractCtType.java b/src/main/java/org/seasar/doma/internal/apt/cttype/AbstractCtType.java
@@ -127,6 +127,11 @@ public boolean isWildcard() {
     return type.getKind() == TypeKind.WILDCARD;
   }
 
+  @Override
+  public boolean isArray() {
+    return type.getKind() == TypeKind.ARRAY;
+  }
+
   @Override
   public boolean isTypevar() {
     return type.getKind() == TypeKind.TYPEVAR;
diff --git a/src/main/java/org/seasar/doma/internal/apt/cttype/ArrayCtType.java b/src/main/java/org/seasar/doma/internal/apt/cttype/ArrayCtType.java
@@ -0,0 +1,26 @@
+package org.seasar.doma.internal.apt.cttype;
+
+import static org.seasar.doma.internal.util.AssertionUtil.assertNotNull;
+
+import javax.lang.model.type.TypeMirror;
+import org.seasar.doma.internal.apt.Context;
+
+public class ArrayCtType extends AbstractCtType {
+
+  private final CtType elementCtType;
+
+  ArrayCtType(Context ctx, TypeMirror type, CtType elementCtType) {
+    super(ctx, type);
+    assertNotNull(elementCtType);
+    this.elementCtType = elementCtType;
+  }
+
+  public CtType getElementCtType() {
+    return elementCtType;
+  }
+
+  @Override
+  public <R, P, TH extends Throwable> R accept(CtTypeVisitor<R, P, TH> visitor, P p) throws TH {
+    return visitor.visitArrayCtType(this, p);
+  }
+}
diff --git a/src/main/java/org/seasar/doma/internal/apt/cttype/CtType.java b/src/main/java/org/seasar/doma/internal/apt/cttype/CtType.java
@@ -33,6 +33,8 @@ public interface CtType {
 
   boolean isTypevar();
 
+  boolean isArray();
+
   boolean isSameType(CtType ctType);
 
   <R, P, TH extends Throwable> R accept(CtTypeVisitor<R, P, TH> visitor, P p) throws TH;
diff --git a/src/main/java/org/seasar/doma/internal/apt/cttype/CtTypeVisitor.java b/src/main/java/org/seasar/doma/internal/apt/cttype/CtTypeVisitor.java
@@ -16,6 +16,8 @@ public interface CtTypeVisitor<R, P, TH extends Throwable> {
 
   R visitIterableCtType(IterableCtType ctType, P p) throws TH;
 
+  R visitArrayCtType(ArrayCtType ctType, P p) throws TH;
+
   R visitCollectorCtType(CollectorCtType ctType, P p) throws TH;
 
   R visitReferenceCtType(ReferenceCtType ctType, P p) throws TH;
diff --git a/src/main/java/org/seasar/doma/internal/apt/cttype/CtTypes.java b/src/main/java/org/seasar/doma/internal/apt/cttype/CtTypes.java
@@ -4,12 +4,21 @@
 import static org.seasar.doma.internal.util.AssertionUtil.assertEquals;
 import static org.seasar.doma.internal.util.AssertionUtil.assertNotNull;
 
-import java.util.*;
+import java.util.Arrays;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+import java.util.Optional;
+import java.util.OptionalDouble;
+import java.util.OptionalInt;
+import java.util.OptionalLong;
 import java.util.function.BiFunction;
 import java.util.function.Function;
 import java.util.stream.Collector;
 import java.util.stream.Stream;
 import javax.lang.model.element.TypeElement;
+import javax.lang.model.type.ArrayType;
 import javax.lang.model.type.DeclaredType;
 import javax.lang.model.type.MirroredTypeException;
 import javax.lang.model.type.TypeKind;
@@ -22,7 +31,12 @@
 import org.seasar.doma.internal.apt.AptIllegalStateException;
 import org.seasar.doma.internal.apt.Context;
 import org.seasar.doma.internal.apt.annot.DomainConvertersAnnot;
-import org.seasar.doma.jdbc.*;
+import org.seasar.doma.jdbc.BatchResult;
+import org.seasar.doma.jdbc.Config;
+import org.seasar.doma.jdbc.PreparedSql;
+import org.seasar.doma.jdbc.Reference;
+import org.seasar.doma.jdbc.Result;
+import org.seasar.doma.jdbc.SelectOptions;
 import org.seasar.doma.jdbc.domain.DomainConverter;
 import org.seasar.doma.message.Message;
 import org.seasar.doma.wrapper.EnumWrapper;
@@ -266,6 +280,19 @@ public IterableCtType newIterableCtType(TypeMirror type) {
     return new IterableCtType(ctx, type, elementCtType);
   }
 
+  public ArrayCtType newArrayCtType(TypeMirror type) {
+    assertNotNull(type);
+    if (type.getKind() != TypeKind.ARRAY) {
+      return null;
+    }
+    TypeMirror componentType = ((ArrayType) type).getComponentType();
+    if (componentType.getKind() == TypeKind.BYTE) {
+      return null;
+    }
+    CtType elementCtType = newCtType(componentType);
+    return new ArrayCtType(ctx, type, elementCtType);
+  }
+
   private MapCtType newMapCtType(TypeMirror type) {
     if (!ctx.getTypes().isSameType(type, Map.class)) {
       return null;
@@ -410,6 +437,7 @@ private CtType newCtTypeInternal(
     List<Function<TypeMirror, CtType>> functions =
         Arrays.asList(
             this::newIterableCtType,
+            this::newArrayCtType,
             this::newStreamCtType,
             this::newEntityCtType,
             this::newOptionalCtType,
diff --git a/src/main/java/org/seasar/doma/internal/apt/cttype/SimpleCtTypeVisitor.java b/src/main/java/org/seasar/doma/internal/apt/cttype/SimpleCtTypeVisitor.java
@@ -49,6 +49,11 @@ public R visitIterableCtType(IterableCtType ctType, P p) throws TH {
     return defaultAction(ctType, p);
   }
 
+  @Override
+  public R visitArrayCtType(ArrayCtType ctType, P p) throws TH {
+    return defaultAction(ctType, p);
+  }
+
   @Override
   public R visitCollectorCtType(CollectorCtType ctType, P p) throws TH {
     return defaultAction(ctType, p);
diff --git a/src/main/java/org/seasar/doma/internal/apt/generator/DaoImplMethodGenerator.java b/src/main/java/org/seasar/doma/internal/apt/generator/DaoImplMethodGenerator.java
@@ -5,6 +5,7 @@
 import java.util.Iterator;
 import java.util.List;
 import java.util.function.Function;
+import javax.lang.model.type.TypeKind;
 import org.seasar.doma.DomaNullPointerException;
 import org.seasar.doma.FetchType;
 import org.seasar.doma.MapKeyNamingType;
@@ -756,7 +757,11 @@ private void printEnteringStatements(QueryMeta m) {
     iprint("entering(\"%1$s\", \"%2$s\"", className, m.getName());
     for (Iterator<QueryParameterMeta> it = m.getParameterMetas().iterator(); it.hasNext(); ) {
       QueryParameterMeta parameterMeta = it.next();
-      print(", %1$s", parameterMeta.getName());
+      if (parameterMeta.getType().getKind() != TypeKind.ARRAY) {
+        print(", %1$s", parameterMeta.getName());
+      } else {
+        print(", (Object) %1$s", parameterMeta.getName());
+      }
     }
     print(");%n");
     iprint("try {%n");
diff --git a/src/main/java/org/seasar/doma/internal/apt/meta/query/QueryParameterMeta.java b/src/main/java/org/seasar/doma/internal/apt/meta/query/QueryParameterMeta.java
@@ -8,6 +8,7 @@
 import javax.lang.model.element.VariableElement;
 import javax.lang.model.type.TypeMirror;
 import org.seasar.doma.internal.apt.cttype.AnyCtType;
+import org.seasar.doma.internal.apt.cttype.ArrayCtType;
 import org.seasar.doma.internal.apt.cttype.BasicCtType;
 import org.seasar.doma.internal.apt.cttype.CtType;
 import org.seasar.doma.internal.apt.cttype.DomainCtType;
@@ -164,6 +165,11 @@ public Boolean visitIterableCtType(IterableCtType ctType, Void p) throws Runtime
       return true;
     }
 
+    @Override
+    public Boolean visitArrayCtType(ArrayCtType ctType, Void p) throws RuntimeException {
+      return true;
+    }
+
     @Override
     public Boolean visitReferenceCtType(ReferenceCtType ctType, Void p) throws RuntimeException {
       return true;
diff --git a/src/main/java/org/seasar/doma/internal/apt/validator/SqlValidator.java b/src/main/java/org/seasar/doma/internal/apt/validator/SqlValidator.java
@@ -2,18 +2,21 @@
 
 import static org.seasar.doma.internal.util.AssertionUtil.assertNotNull;
 
+import java.util.Collections;
 import java.util.Iterator;
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Set;
 import javax.lang.model.element.ExecutableElement;
 import javax.lang.model.element.VariableElement;
+import javax.lang.model.type.ArrayType;
 import javax.lang.model.type.DeclaredType;
 import javax.lang.model.type.TypeMirror;
 import javax.tools.Diagnostic.Kind;
 import org.seasar.doma.internal.apt.AptException;
 import org.seasar.doma.internal.apt.AptIllegalStateException;
 import org.seasar.doma.internal.apt.Context;
+import org.seasar.doma.internal.apt.cttype.ArrayCtType;
 import org.seasar.doma.internal.apt.cttype.BasicCtType;
 import org.seasar.doma.internal.apt.cttype.DomainCtType;
 import org.seasar.doma.internal.apt.cttype.IterableCtType;
@@ -127,7 +130,7 @@ protected Void visitValueNode(ValueNode node, Void p) {
             });
       }
     } else {
-      if (!isScalarIterable(typeDeclaration)) {
+      if (!isScalarIterable(typeDeclaration) && !isScalarArray(typeDeclaration)) {
         String sql = getSql(location);
         throw new AptException(
             Message.DOMA4161,
@@ -178,6 +181,32 @@ public Boolean visitDomainCtType(DomainCtType ctType, Void p)
     return false;
   }
 
+  protected boolean isScalarArray(TypeDeclaration typeDeclaration) {
+    TypeMirror typeMirror = typeDeclaration.getType();
+    ArrayCtType arrayCtType = ctx.getCtTypes().newArrayCtType(typeMirror);
+    if (arrayCtType != null) {
+      return arrayCtType
+          .getElementCtType()
+          .accept(
+              new SimpleCtTypeVisitor<Boolean, Void, RuntimeException>(false) {
+
+                @Override
+                public Boolean visitBasicCtType(BasicCtType ctType, Void p)
+                    throws RuntimeException {
+                  return true;
+                }
+
+                @Override
+                public Boolean visitDomainCtType(DomainCtType ctType, Void p)
+                    throws RuntimeException {
+                  return true;
+                }
+              },
+              null);
+    }
+    return false;
+  }
+
   @Override
   public Void visitEmbeddedVariableNode(EmbeddedVariableNode node, Void p) {
     SqlLocation location = node.getLocation();
@@ -240,7 +269,14 @@ public Void visitForNode(ForNode node, Void p) {
     String expression = node.getExpression();
     TypeDeclaration typeDeclaration = validateExpressionVariable(location, expression);
     TypeMirror typeMirror = typeDeclaration.getType();
-    if (!ctx.getTypes().isAssignable(typeMirror, Iterable.class)) {
+    List<? extends TypeMirror> typeArgs;
+    if (ctx.getTypes().isAssignable(typeMirror, Iterable.class)) {
+      DeclaredType declaredType = ctx.getTypes().toDeclaredType(typeMirror);
+      typeArgs = declaredType.getTypeArguments();
+    } else if (ctx.getTypes().isArray(typeMirror)) {
+      ArrayType arrayType = ctx.getTypes().toArrayType(typeMirror);
+      typeArgs = Collections.singletonList(arrayType.getComponentType());
+    } else {
       String sql = getSql(location);
       throw new AptException(
           Message.DOMA4149,
@@ -254,8 +290,6 @@ public Void visitForNode(ForNode node, Void p) {
             typeDeclaration.getBinaryName()
           });
     }
-    DeclaredType declaredType = ctx.getTypes().toDeclaredType(typeMirror);
-    List<? extends TypeMirror> typeArgs = declaredType.getTypeArguments();
     if (typeArgs.isEmpty()) {
       String sql = getSql(location);
       throw new AptException(
diff --git a/src/main/java/org/seasar/doma/internal/jdbc/sql/NodePreparedSqlBuilder.java b/src/main/java/org/seasar/doma/internal/jdbc/sql/NodePreparedSqlBuilder.java
@@ -4,6 +4,7 @@
 import static org.seasar.doma.internal.util.AssertionUtil.assertUnreachable;
 
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Iterator;
 import java.util.List;
 import java.util.StringJoiner;
@@ -453,7 +454,12 @@ public Void visitForBlockNode(ForBlockNode node, Context p) {
     EvaluationResult expressionResult = p.evaluate(location, forNode.getExpression());
     Object expressionValue = expressionResult.getValue();
     Class<?> expressionValueClass = expressionResult.getValueClass();
-    if (!Iterable.class.isAssignableFrom(expressionValueClass)) {
+    Iterable<?> iterable;
+    if (Iterable.class.isAssignableFrom(expressionValueClass)) {
+      iterable = (Iterable<?>) expressionValue;
+    } else if (expressionValueClass.isArray()) {
+      iterable = Arrays.asList((Object[]) expressionValue);
+    } else {
       throw new JdbcException(
           Message.DOMA2129,
           location.getSql(),
@@ -463,7 +469,6 @@ public Void visitForBlockNode(ForBlockNode node, Context p) {
           expressionValueClass);
     }
 
-    Iterable<?> iterable = (Iterable<?>) expressionValue;
     String identifier = forNode.getIdentifier();
     Value originalIdentifierValue = p.removeValue(identifier);
     String hasNextVariable = identifier + ForBlockNode.HAS_NEXT_SUFFIX;
diff --git a/src/main/java/org/seasar/doma/message/Message.java b/src/main/java/org/seasar/doma/message/Message.java
@@ -141,7 +141,7 @@ public enum Message implements MessageResource {
   DOMA2126(
       "Failed to parse the SQL on line [{1}] at column [{2}]. The expression is not found after the tonken \":\" in the block comment \"/*%for ...*/\". SQL[{0}]"),
   DOMA2129(
-      "Failed to build the SQL on line [{1}] at column [{2}]. The object type[{4}] that corresponds to the expression[{3}] that is after the token \":\" in the block comment \"/*%for ...*/\" is not subtype of java.lang.Iterable. SQL[{0}]"),
+      "Failed to build the SQL on line [{1}] at column [{2}]. The object type[{4}] that corresponds to the expression[{3}] that is after the token \":\" in the block comment \"/*%for ...*/\" is not subtype of java.lang.Iterable or Array. SQL[{0}]"),
   DOMA2133(
       "Failed to parse the SQL on line [{1}] at column [{2}]. \"/%if ...*/\" is not closed with \"/*%end*/\". The pair of \"/%if ...*/\" and \"/*%end*/\" must exist in the same clause such as SELECT, FROM, WHERE and so on. SQL[{0}]"),
   DOMA2134(
@@ -411,7 +411,7 @@ public enum Message implements MessageResource {
   DOMA4148(
       "The class[{2}] in the expression[{0}] at column [{1}] does not have the static field[{3}]."),
   DOMA4149(
-      "Failed to verify the SQL template[{0}] on line [{2}] at column [{3}]. While the expression[{4}] in \"/*%for ...*/\" is evaluated as the type[{5}], the type must be the subtype of java.lang.Iterable. SQL[{1}]"),
+      "Failed to verify the SQL template[{0}] on line [{2}] at column [{3}]. While the expression[{4}] in \"/*%for ...*/\" is evaluated as the type[{5}], the type must be the subtype of java.lang.Iterable or Array. SQL[{1}]"),
   DOMA4150(
       "Failed to verify the SQL template[{0}] on line [{2}] at column [{3}]. While the expression[{4}] in \"/*%for ...*/\" is evaluated as the type[{5}], the type argument for the type is obscure. SQL[{1}]"),
   DOMA4153(
@@ -426,7 +426,7 @@ public enum Message implements MessageResource {
   DOMA4159("The type argument is required for the subtype of java.lang.Iterable."),
   DOMA4160("The subtype of java.lang.Iterable must not be wildcard."),
   DOMA4161(
-      "Failed to verify the SQL template[{0}] on line [{2}] at column [{3}]. The parameter type that corresponds to the bind or literal variable[{4}] just before the open parenthesis must be the subtype of the java.lang.Iterable whose element type is the basic or doma type. But the actual type is [{5}]. You may forget to access its field or to invoke its method. SQL[{1}]"),
+      "Failed to verify the SQL template[{0}] on line [{2}] at column [{3}]. The parameter type that corresponds to the bind or literal variable[{4}] just before the open parenthesis must be the subtype of the java.lang.Iterable or Array whose element type is the basic or doma type. But the actual type is [{5}]. You may forget to access its field or to invoke its method. SQL[{1}]"),
   DOMA4163("The user defined Config class must not be abstract. The class[{0}] is abstract."),
   DOMA4164(
       "The user defined Config class must have a no-args and public constructor or have a public static final field that is named \"INSTANCE\".　The type of the field must be the subtype of org.seasar.doma.Config. The class[{0}] does not meet these requirements."),
diff --git a/src/test/java/org/seasar/doma/internal/apt/processor/dao/SqlValidationDao.java b/src/test/java/org/seasar/doma/internal/apt/processor/dao/SqlValidationDao.java
diff --git a/src/test/java/org/seasar/doma/internal/apt/processor/dao/SqlValidatorTest.java b/src/test/java/org/seasar/doma/internal/apt/processor/dao/SqlValidatorTest.java
diff --git a/src/test/java/org/seasar/doma/internal/jdbc/sql/SqlParserTest.java b/src/test/java/org/seasar/doma/internal/jdbc/sql/SqlParserTest.java
