Merge pull request #108 from SentryMan/class-constraints

Repair Custom Adapters/Class Constraints

Author: rbygrave

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

@@ -27,8 +27,8 @@ final class ContraintReader implements BeanReader {
     importTypes.add("java.util.Map");
     importTypes.add("io.avaje.validation.adapter.ConstraintAdapter");
     importTypes.add("io.avaje.validation.adapter.ValidationAdapter");
-    importTypes.add("io.avaje.validation.adapter.ValidationContext");
     importTypes.add("io.avaje.validation.adapter.ValidationRequest");
+    importTypes.add("io.avaje.validation.adapter.ValidationContext.AdapterCreateRequest");
     importTypes.add("io.avaje.validation.spi.Generated");
 
     this.annotations =
@@ -121,7 +121,9 @@ public void writeConstructor(Append writer) {
 
     writer.append(
         """
-    final var message = ctx.<Object>message(attributes).template();
+    final var message = req.message().template();
+    final var ctx = req.ctx();
+    final var groups = req.groups();
     this.adapter =
 """);
 

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

@@ -49,6 +49,7 @@ static ElementAnnotationContainer create(Element element) {
 
     final var annotations =
         element.getAnnotationMirrors().stream()
+            .filter(m -> !ValidPrism.isInstance(m))
             .collect(
                 toMap(
                     a -> GenericType.parse(a.getAnnotationType().toString()),
@@ -94,4 +95,8 @@ public void addImports(Set<String> importTypes) {
     typeUse1.keySet().forEach(t -> t.addImports(importTypes));
     typeUse2.keySet().forEach(t -> t.addImports(importTypes));
   }
+
+  boolean isEmpty() {
+    return annotations.isEmpty() && typeUse1.isEmpty() && typeUse2.isEmpty();
+  }
 }

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

@@ -5,6 +5,7 @@
 
 import javax.lang.model.element.Element;
 import javax.lang.model.element.Modifier;
+import javax.lang.model.element.TypeElement;
 
 final class FieldReader {
 
@@ -22,8 +23,13 @@ final class FieldReader {
   private final boolean optionalValidation;
   private final Element element;
   private final ElementAnnotationContainer elementAnnotations;
+  private final boolean classLevel;
 
   FieldReader(Element element, List<String> genericTypeParams) {
+    this(element, genericTypeParams, false);
+  }
+
+  FieldReader(Element element, List<String> genericTypeParams, boolean classLevel) {
     this.genericTypeParams = genericTypeParams;
     this.fieldName = element.getSimpleName().toString();
     this.publicField = element.getModifiers().contains(Modifier.PUBLIC);
@@ -34,6 +40,7 @@ final class FieldReader {
     adapterShortType = initAdapterShortType(shortType);
     adapterFieldName = initShortName();
     this.optionalValidation = Util.isNullable(element);
+    this.classLevel = classLevel;
   }
 
   private String initAdapterShortType(String shortType) {
@@ -120,7 +127,9 @@ void writeField(Append writer) {
   }
 
   private void writeGetValue(Append writer, String suffix) {
-    if (getter != null) {
+    if (classLevel) {
+      // don't need a getter
+    } else if (getter != null) {
       writer.append("value.%s()%s", getter.getName(), suffix);
     } else if (publicField) {
       writer.append("value.%s%s", fieldName, suffix);
@@ -131,6 +140,17 @@ private void writeGetValue(Append writer, String suffix) {
   }
 
   void writeValidate(Append writer) {
+    if (classLevel) {
+      writer.append(
+          """
+    		    if (!request.hasViolations()) {
+    		      %s.validate(value, request, field);
+    		    }
+    		""",
+          adapterFieldName);
+      writer.eol().eol();
+      return;
+    }
     writer.append("    var _$%s = ", fieldName);
     writeGetValue(writer, ";");
     writer.eol();
@@ -158,8 +178,20 @@ public void writeConstructor(Append writer) {
     writer.append("    this.%s = ", adapterFieldName).eol();
 
     new AdapterHelper(
-        writer, elementAnnotations, "        ", PrimitiveUtil.wrap(genericType.shortType()), genericType)
-      .write();
+            writer,
+            elementAnnotations,
+            "        ",
+            PrimitiveUtil.wrap(genericType.shortType()),
+            genericType)
+        .write();
     writer.append(";").eol().eol();
   }
+
+  public boolean isClassLvl() {
+    return classLevel;
+  }
+
+  public boolean hasAnnotations() {
+    return !elementAnnotations.isEmpty();
+  }
 }

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

@@ -50,15 +50,15 @@ void write() throws IOException {
   }
 
   private void writeConstructor() {
-    writer.append("  public %sValidationAdapter(ValidationContext ctx", adapterShortName);
-    for (int i = 0; i < genericParamsCount; i++) {
-      writer.append(", Type param%d", i);
-    }
 
-    if (beanReader instanceof ContraintReader) {
-      writer.append(", Set<Class<?>> groups, Map<String, Object> attributes");
+    if (isContraint) {
+      writer.append("  public %sValidationAdapter(AdapterCreateRequest req", adapterShortName);
+    } else {
+      writer.append("  public %sValidationAdapter(ValidationContext ctx", adapterShortName);
+      for (int i = 0; i < genericParamsCount; i++) {
+        writer.append(", Type param%d", i);
+      }
     }
-
     writer.append(") {", adapterShortName).eol();
     beanReader.writeConstructor(writer);
     writer.append("  }").eol();

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

@@ -32,14 +32,14 @@ final class TypeReader {
   private final Map<String, MethodReader> allGetterMethods = new LinkedHashMap<>();
   private final Map<String, MethodReader> maybeGetterMethods = new LinkedHashMap<>();
   private final TypeElement baseType;
-  private final boolean hasJsonAnnotation;
+  private final boolean hasValidAnnotation;
   private final Set<String> seenFields = new HashSet<>();
   private boolean nonAccessibleField;
   private final List<String> genericTypeParams;
 
   TypeReader(TypeElement baseType) {
     this.baseType = baseType;
-    this.hasJsonAnnotation = Util.isValid(baseType);
+    this.hasValidAnnotation = Util.isValid(baseType);
     this.genericTypeParams = initTypeParams(baseType);
   }
 
@@ -58,6 +58,11 @@ void read(TypeElement type) {
       }
     }
 
+    final var classAdapter = new FieldReader(type, genericTypeParams, true);
+    if (classAdapter.hasAnnotations()) {
+      localFields.add(classAdapter);
+    }
+
     for (final FieldReader localField : localFields) {
       allFields.add(localField);
       allFieldMap.put(localField.fieldName(), localField);
@@ -93,10 +98,8 @@ private void readMethod(Element element, TypeElement type, List<FieldReader> loc
       final List<? extends VariableElement> parameters = methodElement.getParameters();
       final String methodKey = methodElement.getSimpleName().toString();
       final MethodReader methodReader = new MethodReader(methodElement, type).read();
-      if (parameters.size() == 0) {
-        if (!maybeGetterMethods.containsKey(methodKey)) {
-          maybeGetterMethods.put(methodKey, methodReader);
-        }
+      if (parameters.isEmpty()) {
+        maybeGetterMethods.putIfAbsent(methodKey, methodReader);
         allGetterMethods.put(methodKey.toLowerCase(), methodReader);
       }
       // for reading methods
@@ -112,6 +115,9 @@ private void readMethod(Element element, TypeElement type, List<FieldReader> loc
 
   private void matchFieldsToGetter() {
     for (final FieldReader field : allFields) {
+      if (field.isClassLvl()) {
+        continue;
+      }
       matchFieldToGetter(field);
     }
   }
@@ -121,8 +127,13 @@ private void matchFieldToGetter(FieldReader field) {
         && !matchFieldToGetter2(field, true)
         && !field.isPublicField()) {
       nonAccessibleField = true;
-      if (hasJsonAnnotation) {
-        logError("Non accessible field " + baseType + " " + field.fieldName() + " with no matching getter?");
+      if (hasValidAnnotation) {
+        logError(
+            "Non accessible field "
+                + baseType
+                + " "
+                + field.fieldName()
+                + " with no matching getter?");
       } else {
         logDebug("Non accessible field " + baseType + " " + field.fieldName());
       }

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

@@ -260,7 +260,9 @@ static String initLower(String name) {
   /** Return the base type given the ValidationAdapter type. */
   static String baseTypeOfAdapter(String adapterFullName) {
     final var element = element(adapterFullName);
-
+    if (element == null) {
+      throw new NullPointerException("Element not found for [" + adapterFullName + "]");
+    }
     return Optional.of(element.getSuperclass())
         .filter(t -> t.toString().contains("io.avaje.validation.adapter.AbstractConstraintAdapter"))
         .or(validationAdapter(element))

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

@@ -1,5 +1,6 @@
 package io.avaje.validation.generator;
 
+import javax.lang.model.element.AnnotationMirror;
 import javax.lang.model.element.Element;
 
 public interface ValidPrism {
@@ -10,4 +11,11 @@ static boolean isPresent(Element e) {
         || JavaxValidPrism.isPresent(e)
         || HttpValidPrism.isPresent(e);
   }
+
+  static boolean isInstance(AnnotationMirror e) {
+    return AvajeValidPrism.getInstance(e) != null
+        || JakartaValidPrism.getInstance(e) != null
+        || JavaxValidPrism.getInstance(e) != null
+        || HttpValidPrism.getInstance(e) != null;
+  }
 }

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

@@ -22,7 +22,6 @@
 import javax.tools.ToolProvider;
 
 import org.junit.jupiter.api.AfterEach;
-import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 
 class ValidatorProcessorTest {
@@ -44,7 +43,6 @@ void deleteGeneratedFiles() throws IOException {
     }
   }
 
-  @Disabled
   @Test
   void testGeneration() throws Exception {
     final String source =

validator-generator/src/test/java/io/avaje/validation/generator/models/valid/CustomAnnotationAdapter.java renamed to validator-generator/src/test/java/io/avaje/validation/generator/models/valid/CheckCaseAdapter.java

@@ -2,15 +2,15 @@
 
 import io.avaje.validation.adapter.AbstractConstraintAdapter;
 import io.avaje.validation.adapter.ConstraintAdapter;
-import io.avaje.validation.adapter.ValidationContext;
+import io.avaje.validation.adapter.ValidationContext.AdapterCreateRequest;
 import io.avaje.validation.generator.models.valid.CheckCase.CaseMode;
 
 @ConstraintAdapter(CheckCase.class)
-public final class CustomAnnotationAdapter extends AbstractConstraintAdapter<String> {
+public final class CheckCaseAdapter extends AbstractConstraintAdapter<String> {
 
   private final CaseMode caseMode;
 
-  public CustomAnnotationAdapter(ValidationContext.AdapterCreateRequest request) {
+  public CheckCaseAdapter(AdapterCreateRequest request) {
     super(request);
     final var attributes = request.attributes();
     caseMode = (CaseMode) attributes.get("caseMode");

validator-generator/src/test/java/io/avaje/validation/generator/models/valid/typeconstraint/PassingSkill.java

@@ -0,0 +1,18 @@
+package io.avaje.validation.generator.models.valid.typeconstraint;
+
+import static java.lang.annotation.ElementType.TYPE;
+import static java.lang.annotation.RetentionPolicy.SOURCE;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+import io.avaje.validation.constraints.Constraint;
+
+@Target(TYPE)
+@Retention(SOURCE)
+@Constraint
+public @interface PassingSkill {
+  String message() default "put these foolish ambitions to rest"; // default error message
+
+  Class<?>[] groups() default {}; // groups
+}

validator-generator/src/test/java/io/avaje/validation/generator/models/valid/typeconstraint/PassingSkillAdapter.java

@@ -0,0 +1,21 @@
+package io.avaje.validation.generator.models.valid.typeconstraint;
+
+import io.avaje.validation.adapter.AbstractConstraintAdapter;
+import io.avaje.validation.adapter.ConstraintAdapter;
+import io.avaje.validation.adapter.ValidationContext.AdapterCreateRequest;
+
+@ConstraintAdapter(PassingSkill.class)
+public final class PassingSkillAdapter extends AbstractConstraintAdapter<Tarnished> {
+
+  public PassingSkillAdapter(AdapterCreateRequest request) {
+    super(request);
+  }
+
+  @Override
+  public boolean isValid(Tarnished lowlyTarnished) {
+    if (lowlyTarnished == null) {
+      return true;
+    }
+    return lowlyTarnished.vigor() >= 50 && lowlyTarnished.endurance() >= 50;
+  }
+}

validator-generator/src/test/java/io/avaje/validation/generator/models/valid/typeconstraint/Tarnished.java

@@ -0,0 +1,7 @@
+package io.avaje.validation.generator.models.valid.typeconstraint;
+
+import io.avaje.validation.constraints.Valid;
+
+@Valid
+@PassingSkill
+public record Tarnished(int vigor, int endurance) {}

validator/src/main/java/io/avaje/validation/Validator.java

@@ -1,21 +1,21 @@
 package io.avaje.validation;
 
-import io.avaje.lang.Nullable;
-import io.avaje.validation.adapter.*;
-import io.avaje.validation.core.DefaultBootstrap;
-import io.avaje.validation.spi.MessageInterpolator;
-import io.avaje.validation.spi.ValidatorCustomizer;
-
 import java.lang.annotation.Annotation;
 import java.lang.reflect.Type;
 import java.time.Clock;
 import java.time.Duration;
 import java.util.Locale;
-import java.util.Map;
 import java.util.ResourceBundle;
-import java.util.Set;
 import java.util.function.Supplier;
 
+import io.avaje.lang.Nullable;
+import io.avaje.validation.adapter.ValidationAdapter;
+import io.avaje.validation.adapter.ValidationContext;
+import io.avaje.validation.adapter.ValidationContext.AdapterCreateRequest;
+import io.avaje.validation.core.DefaultBootstrap;
+import io.avaje.validation.spi.MessageInterpolator;
+import io.avaje.validation.spi.ValidatorCustomizer;
+
 /**
  * Validate plain Java objects that have been annotated with validation constraints.
  *
@@ -145,8 +145,7 @@ interface AdapterBuilder {
   interface AnnotationAdapterBuilder {
 
     /** Create a ValidationAdapter given the Validator instance. */
-    ValidationAdapter<?> build(
-        ValidationContext ctx, Set<Class<?>> groups, Map<String, Object> attributes);
+    ValidationAdapter<?> build(AdapterCreateRequest request);
   }
 
   /** Components register ValidationAdapters Validator.Builder */

validator/src/main/java/io/avaje/validation/adapter/AbstractContainerAdapter.java

@@ -6,9 +6,7 @@
  */
 public abstract class AbstractContainerAdapter<T> implements ValidationAdapter<T> {
 
-	/**
-	 * Adapter placed on the container type
-	 */
+  /** Adapter placed on the container type */
   protected final ValidationAdapter<T> initalAdapter;
 
   protected ValidationAdapter<Object> multiAdapter;

validator/src/main/java/io/avaje/validation/adapter/ConstraintAdapter.java

@@ -19,12 +19,12 @@
  *
  *   String value;
  *
- *   public CustomAnnotationAdapter(ValidationContext ctx, Set<Class<?>> groups, Map<String, Object> attributes) {
+ *   public CustomAnnotationAdapter(AdapterCreateRequest req) {
  *     //create a message object for error interpolation and set groups
- *      super(ctx.message(attributes), groups);
+ *      super(req);
  *
  *      //use the attributes to extract the annotation values
- *      value = (String) attributes.get("value");
+ *      value = (String) req.attribute("value");
  *   }
  *
  *