allow parameter with a converter that returns list

Author: h908714124

compiler/src/main/java/net/jbock/annotated/AnnotatedMethod.java

@@ -25,7 +25,7 @@ public abstract class AnnotatedMethod {
 
     public abstract boolean isParameter();
 
-    public abstract boolean isParameters();
+    public abstract boolean isVarargsParameter();
 
     public final String enumName() {
         return enumName;

compiler/src/main/java/net/jbock/annotated/AnnotatedOption.java

@@ -60,7 +60,7 @@ public boolean isParameter() {
     }
 
     @Override
-    public boolean isParameters() {
+    public boolean isVarargsParameter() {
         return false;
     }
 

compiler/src/main/java/net/jbock/annotated/AnnotatedParameter.java

@@ -38,7 +38,7 @@ public boolean isParameter() {
     }
 
     @Override
-    public boolean isParameters() {
+    public boolean isVarargsParameter() {
         return false;
     }
 

compiler/src/main/java/net/jbock/annotated/AnnotatedVarargsParameter.java

@@ -37,7 +37,7 @@ public boolean isParameter() {
     }
 
     @Override
-    public boolean isParameters() {
+    public boolean isVarargsParameter() {
         return true;
     }
 }

compiler/src/main/java/net/jbock/convert/match/ListMatcher.java

@@ -29,6 +29,9 @@ public class ListMatcher implements Matcher {
     public <M extends AnnotatedMethod>
     Optional<Match<M>> tryMatch(
             M sourceMethod) {
+        if (sourceMethod.isParameter()) {
+            return Optional.empty(); // Not a VarargsParameter, so definitely not repeatable.
+        }
         TypeMirror returnType = sourceMethod.returnType();
         return elements.getTypeElement("java.util.List")
                 .flatMap(utilList -> tool.getSingleTypeArgument(returnType, utilList))

compiler/src/main/java/net/jbock/convert/match/MatchFinder.java

@@ -2,7 +2,6 @@
 
 import io.jbock.util.Either;
 import jakarta.inject.Inject;
-import net.jbock.Option;
 import net.jbock.VarargsParameter;
 import net.jbock.annotated.AnnotatedMethod;
 import net.jbock.common.SafeTypes;
@@ -43,7 +42,7 @@ public class MatchFinder {
     Either<ValidationFailure, Match<M>> findMatch(
             M sourceMethod) {
         Match<M> match = findMatchInternal(sourceMethod);
-        return validateParameterVsParameters(match)
+        return validateVarargsIsList(match)
                 .<Either<ValidationFailure, Match<M>>>map(Either::left)
                 .orElseGet(() -> right(match));
     }
@@ -54,7 +53,7 @@ Either<ValidationFailure, Match<M>> findMatch(
             M sourceMethod) {
         PrimitiveType bool = types.getPrimitiveType(BOOLEAN);
         Match<M> match = Match.create(bool, OPTIONAL, sourceMethod);
-        return validateParameterVsParameters(match)
+        return validateVarargsIsList(match)
                 .<Either<ValidationFailure, Match<M>>>map(Either::left)
                 .orElseGet(() -> right(match));
     }
@@ -76,19 +75,10 @@ Either<ValidationFailure, Match<M>> findMatch(
     }
 
     private <M extends AnnotatedMethod>
-    Optional<ValidationFailure> validateParameterVsParameters(
+    Optional<ValidationFailure> validateVarargsIsList(
             Match<M> match) {
         M sourceMethod = match.sourceMethod();
-        if (sourceMethod.isParameter()
-                && match.multiplicity() == Multiplicity.REPEATABLE) {
-            return Optional.of(sourceMethod.fail("method '" +
-                    sourceMethod.method().getSimpleName() +
-                    "' returns a list-based type, so it must be annotated with @" +
-                    Option.class.getSimpleName() +
-                    " or @" +
-                    VarargsParameter.class.getSimpleName()));
-        }
-        if (sourceMethod.isParameters()
+        if (sourceMethod.isVarargsParameter()
                 && match.multiplicity() != Multiplicity.REPEATABLE) {
             return Optional.of(sourceMethod.fail("method '" +
                     sourceMethod.method().getSimpleName() +

compiler/src/test/java/net/jbock/processor/ConverterTest.java

@@ -268,6 +268,24 @@ void invalidConverterReturnsOptional() {
                 .withErrorContaining("invalid converter class: should extend StringConverter<Integer> or implement Supplier<StringConverter<Integer>>");
     }
 
+    @Test
+    void validConvertToList() {
+        JavaFileObject javaFile = fromSource(
+                "@Command",
+                "abstract class Arguments {",
+                "",
+                "  @Parameter(converter = MyConverter.class, index = 0)",
+                "  abstract List<Integer> something();",
+                "",
+                "  static class MyConverter extends StringConverter<List<Integer>> {",
+                "    public List<Integer> convert(String token) { return null; }",
+                "  }",
+                "}");
+        assertAbout(javaSources()).that(singletonList(javaFile))
+                .processedWith(Processor.testInstance())
+                .compilesWithoutError();
+    }
+
     @Test
     void parameterInvalidList() {
         JavaFileObject javaFile = fromSource(
@@ -284,7 +302,7 @@ void parameterInvalidList() {
         assertAbout(javaSources()).that(singletonList(javaFile))
                 .processedWith(Processor.testInstance())
                 .failsToCompile()
-                .withErrorContaining("method 'something' returns a list-based type, so it must be annotated with @Option or @VarargsParameter");
+                .withErrorContaining("invalid converter class: should extend StringConverter<List<Integer>> or implement Supplier<StringConverter<List<Integer>>>");
     }
 
     @Test

compiler/src/test/java/net/jbock/processor/PositionalTest.java

@@ -299,6 +299,6 @@ void parameterInvalidList() {
         assertAbout(javaSources()).that(singletonList(javaFile))
                 .processedWith(Processor.testInstance())
                 .failsToCompile()
-                .withErrorContaining("method 'something' returns a list-based type, so it must be annotated with @Option or @VarargsParameter");
+                .withErrorContaining("define a converter class that extends StringConverter<List<Integer>> or implements Supplier<StringConverter<List<Integer>>>");
     }
 }