Refactor Util.validImportType() and add unit tests (#230)

* Refactor Util.validImportType() and add unit tests

* Format only ProcessingContext and add package-info

Author: rbygrave

validator-constraints/src/main/java/io/avaje/validation/constraints/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * Constraint annotations for Avaje Validation.
+ */
+package io.avaje.validation.constraints;

validator-generator/src/main/java/io/avaje/validation/generator/ComponentMetaData.java

@@ -87,13 +87,12 @@ Collection<String> allImports() {
     for (final var adapter : annotationAdapters) {
       final var adapterFullName = adapter.getQualifiedName().toString();
       packageImports.add(adapterFullName);
-      packageImports.add(
-          ProcessorUtils.extractEnclosingFQN(Util.baseTypeOfAdapter(adapterFullName)));
+      packageImports.add(ProcessorUtils.extractEnclosingFQN(Util.baseTypeOfAdapter(adapterFullName)));
 
       ConstraintAdapterPrism.getInstanceOn(adapter)
-          .value()
-          .toString()
-          .transform(packageImports::add);
+        .value()
+        .toString()
+        .transform(packageImports::add);
     }
 
     return packageImports;

validator-generator/src/main/java/io/avaje/validation/generator/ProcessingContext.java

@@ -9,8 +9,6 @@
 import java.io.BufferedReader;
 import java.io.IOException;
 import java.io.InputStreamReader;
-import java.net.URI;
-import java.net.URISyntaxException;
 import java.util.Set;
 import java.util.TreeSet;
 
@@ -33,7 +31,6 @@ private static final class Ctx {
 
     Ctx(ProcessingEnvironment env) {
       var elements = env.getElementUtils();
-
       this.injectPresent = elements.getTypeElement(Constants.COMPONENT) != null;
       this.warnHttp = elements.getTypeElement("io.avaje.http.api.Controller") != null;
 
@@ -78,22 +75,22 @@ static void validateModule() {
 
         var buildPluginAvailable = buildPluginAvailable();
         var requireSet =
-            moduleInfo.requires().stream()
-                .map(Requires::getDependency)
-                .map(m -> m.getQualifiedName().toString())
-                .collect(toSet());
+          moduleInfo.requires().stream()
+            .map(Requires::getDependency)
+            .map(m -> m.getQualifiedName().toString())
+            .collect(toSet());
 
         boolean noHttpPlugin =
-            injectPresent
-                && (!buildPluginAvailable || !requireSet.contains("io.avaje.http.api"))
-                && warnHttp
-                && !moduleInfo.containsOnModulePath("io.avaje.validation.http");
+          injectPresent
+            && (!buildPluginAvailable || !requireSet.contains("io.avaje.http.api"))
+            && warnHttp
+            && !moduleInfo.containsOnModulePath("io.avaje.validation.http");
 
         boolean noInjectPlugin =
-            noHttpPlugin
-                && injectPresent
-                && (!buildPluginAvailable || !requireSet.contains("io.avaje.validation"))
-                && !moduleInfo.containsOnModulePath("io.avaje.validation.plugin");
+          noHttpPlugin
+            && injectPresent
+            && (!buildPluginAvailable || !requireSet.contains("io.avaje.validation"))
+            && !moduleInfo.containsOnModulePath("io.avaje.validation.plugin");
 
         if (noHttpPlugin) {
           logWarn(module, "`requires io.avaje.validation.http` must be explicity added or else avaje-inject may fail to detect the default http validator, validator, and method AOP validator");

validator-generator/src/main/java/io/avaje/validation/generator/Util.java

@@ -1,19 +1,16 @@
 package io.avaje.validation.generator;
 
-import static io.avaje.validation.generator.APContext.logError;
-import static io.avaje.validation.generator.APContext.typeElement;
-
-import java.util.Optional;
-import java.util.Set;
-import java.util.function.Supplier;
-import java.util.regex.Pattern;
-
 import javax.lang.model.element.AnnotationMirror;
 import javax.lang.model.element.Element;
 import javax.lang.model.element.Modifier;
 import javax.lang.model.element.TypeElement;
-import javax.lang.model.element.VariableElement;
 import javax.lang.model.type.TypeMirror;
+import java.util.Optional;
+import java.util.Set;
+import java.util.function.Supplier;
+
+import static io.avaje.validation.generator.APContext.logError;
+import static io.avaje.validation.generator.APContext.typeElement;
 
 final class Util {
 
@@ -27,7 +24,9 @@ static boolean isValid(Element e) {
       || JakartaValidPrism.isPresent(e);
   }
 
-  /** Return true if the element has a Nullable annotation. */
+  /**
+   * Return true if the element has a Nullable annotation.
+   */
   public static boolean isNullable(Element p) {
     for (final AnnotationMirror mirror : p.getAnnotationMirrors()) {
       if ("Nullable".equalsIgnoreCase(shortName(mirror.getAnnotationType().toString()))) {
@@ -37,12 +36,19 @@ public static boolean isNullable(Element p) {
     return false;
   }
 
-  static boolean validImportType(String type, String adapterPackage) {
+  static boolean validImportType(String type, String packageName) {
     return type.indexOf('.') > -1
-            && !type.startsWith("java.lang.")
-            && type.replace(adapterPackage + ".", "").transform(s -> s.contains("."))
-        || (type.startsWith("java.lang.")
-            && type.replace("java.lang.", "").transform(s -> s.contains(".")));
+      && !type.startsWith("java.lang.")
+      && importDifferentPackage(type, packageName)
+      || importJavaLangSubpackage(type);
+  }
+
+  private static boolean importDifferentPackage(String type, String packageName) {
+    return type.replace(packageName + '.', "").indexOf('.') > 0;
+  }
+
+  private static boolean importJavaLangSubpackage(String type) {
+    return type.startsWith("java.lang.") && importDifferentPackage(type, "java.lang");
   }
 
   static String shortName(String fullType) {
@@ -78,7 +84,9 @@ static String initLower(String name) {
     return sb.toString();
   }
 
-  /** Return the base type given the ValidationAdapter type. */
+  /**
+   * Return the base type given the ValidationAdapter type.
+   */
   static String baseTypeOfAdapter(String adapterFullName) {
     final var element = typeElement(adapterFullName);
     if (element == null) {

validator-generator/src/test/java/io/avaje/validation/generator/UtilTest.java

@@ -31,4 +31,18 @@ void initLower() {
     assertEquals("url", Util.initLower("URL"));
     assertEquals("initCap", Util.initLower("InitCap"));
   }
+
+  @Test
+  void validImportType_expect_false() {
+    assertFalse(Util.validImportType("int", "org.foo"));
+    assertFalse(Util.validImportType("java.lang.Integer", "org.foo"));
+    assertFalse(Util.validImportType("org.foo.Bar", "org.foo"));
+  }
+
+  @Test
+  void validImportType_expect_true() {
+    assertTrue(Util.validImportType("java.lang.something.Foo", "org.foo"));
+    assertTrue(Util.validImportType("org.foo.some.Bar", "org.foo"));
+    assertTrue(Util.validImportType("org.other.Bar", "org.foo"));
+  }
 }