Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AbstractConstraintAdapter #84

Merged
merged 9 commits into from
Jul 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ public record Address(
) {}
```

For types we cannot annotate with `@Valid` we can place `@Valid.Import(TypeToimport.class)` on any class/package-info to generate the adapters.
For types we cannot annotate with `@Valid` we can place `@ImportValidPojo` on any class/package-info to generate the adapters.

## Step 3 - Use

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ Collection<String> allImports() {
packageImports.add(Util.packageOf(adapterFullName) + ".*");
packageImports.add(Util.baseTypeOfAdapter(adapterFullName));

ConstraintValidatorPrism.getInstanceOn(adapter)
ConstraintAdapterPrism.getInstanceOn(adapter)
.value()
.toString()
.transform(packageImports::add);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ final class ContraintReader implements BeanReader {
importTypes.add("java.util.List");
importTypes.add("java.util.Set");
importTypes.add("java.util.Map");
importTypes.add("io.avaje.validation.adapter.ConstraintValidator");
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");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ private void writeClassEnd() {
private void writeClassStart() {
writer.append("@Generated").eol();
if (isContraint) {
writer.append("@ConstraintValidator(%s.class)", beanReader.contraintTarget()).eol();
writer.append("@ConstraintAdapter(%s.class)", beanReader.contraintTarget()).eol();
}

writer.append("public final class %sValidationAdapter implements ValidationAdapter<%s> ", adapterShortName, beanReader.shortName());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ private void writeRegister() {
.transform(this::typeShortName);

final var target =
ConstraintValidatorPrism.getInstanceOn(adapter)
ConstraintAdapterPrism.getInstanceOn(adapter)
.value()
.toString()
.transform(Util::shortType)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
Expand Down Expand Up @@ -264,25 +265,26 @@ static String initLower(String name) {
return sb.toString();
}

/**
* Return the base type given the JsonAdapter type. Remove the "jsonb" sub-package and the
* "JsonAdapter" suffix.
*/
/** Return the base type given the ValidationAdapter type. */
static String baseTypeOfAdapter(String adapterFullName) {
final var element = element(adapterFullName);

return element(adapterFullName).getInterfaces().stream()
.filter(t -> t.toString().contains("io.avaje.validation.adapter.ValidationAdapter"))
.findFirst()
return Optional.of(element.getSuperclass())
.filter(t -> t.toString().contains("io.avaje.validation.adapter.AbstractConstraintAdapter"))
.or(
() ->
element.getInterfaces().stream()
.filter(
t -> t.toString().contains("io.avaje.validation.adapter.ValidationAdapter"))
.findFirst())
.map(Object::toString)
.map(GenericType::parse)
.map(GenericType::firstParamType)
.map(Util::extractTypeWithNest)
.orElseThrow(
() ->
new IllegalStateException(
"Adapter: "
+ adapterFullName
+ " does not directly implement ValidationAdapter"));
"Adapter: " + adapterFullName + " does not implement ValidationAdapter"));
}

static String extractTypeWithNest(String fullType) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
HttpValidPrism.PRISM_TYPE,
JavaxValidPrism.PRISM_TYPE,
JakartaValidPrism.PRISM_TYPE,
ConstraintValidatorPrism.PRISM_TYPE,
ConstraintAdapterPrism.PRISM_TYPE,
AvajeConstraintPrism.PRISM_TYPE,
JakartaConstraintPrism.PRISM_TYPE,
JavaxConstraintPrism.PRISM_TYPE,
Expand Down Expand Up @@ -87,7 +87,7 @@ public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment
.ifPresent(this::writeContraintAdapters);

registerCustomAdapters(
round.getElementsAnnotatedWith(element(ConstraintValidatorPrism.PRISM_TYPE)));
round.getElementsAnnotatedWith(element(ConstraintAdapterPrism.PRISM_TYPE)));

Optional.ofNullable(element(AvajeValidPrism.PRISM_TYPE))
.map(round::getElementsAnnotatedWith)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
name = "AvajeValidPrism",
superInterfaces = ValidPrism.class)
@GeneratePrism(io.avaje.validation.ImportValidPojo.class)
@GeneratePrism(io.avaje.validation.adapter.ConstraintValidator.class)
@GeneratePrism(io.avaje.validation.adapter.ConstraintAdapter.class)
@GeneratePrism(
value = javax.validation.Valid.class,
name = "JavaxValidPrism",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
package io.avaje.validation.generator.models.valid;

import io.avaje.validation.constraints.Constraint;

@Constraint
public @interface CheckCase {

String message() default "{io.avaje.validator.CheckCase}"; // default error message

Class<?>[] groups() default {}; // groups

CaseMode value(); // specify case mode

public enum CaseMode {
UPPER,
LOWER;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,31 @@
import java.util.Map;
import java.util.Set;

import io.avaje.lang.Nullable;
import io.avaje.validation.adapter.ConstraintValidator;
import io.avaje.validation.adapter.ValidationAdapter;
import io.avaje.validation.adapter.AbstractConstraintAdapter;
import io.avaje.validation.adapter.ConstraintAdapter;
import io.avaje.validation.adapter.ValidationContext;
import io.avaje.validation.adapter.ValidationRequest;
import io.avaje.validation.generator.models.valid.CheckCase.CaseMode;

@ConstraintValidator(Nullable.class)
public final class CustomAnnotationAdapter implements ValidationAdapter<Object> {
@ConstraintAdapter(CheckCase.class)
public final class CustomAnnotationAdapter extends AbstractConstraintAdapter<String> {

public CustomAnnotationAdapter(ValidationContext ctx, Set<Class<?>> groups, Map<String, Object> attributes) {}
private final CaseMode caseMode;

@Override
public boolean validate(Object value, ValidationRequest req, String propertyName) {
public CustomAnnotationAdapter(
ValidationContext ctx, Set<Class<?>> groups, Map<String, Object> attributes) {
super(ctx.message(attributes), groups);
caseMode = (CaseMode) attributes.get("caseMode");
}

return true;
@Override
public boolean isValid(String object) {
if (object == null) {
return true;
}
if (caseMode == CaseMode.UPPER) {
return object.equals(object.toUpperCase());
} else {
return object.equals(object.toLowerCase());
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
package io.avaje.validation.adapter;

import java.util.Set;

/** Abstract Adapter that validates objects based on Constraint Annotations. */
public abstract class AbstractConstraintAdapter<T> implements ValidationAdapter<T> {

protected final ValidationContext.Message message;
protected final Set<Class<?>> groups;

/** @param initialAdapter initial adapter that can be used to validate the container itself */
protected AbstractConstraintAdapter(ValidationContext.Message message, Set<Class<?>> groups) {
this.message = message;
this.groups = groups;
}

/**
* Execute Constraint validations for the given object.
*
* @param value the object to validate
* @return false if a violation error should be added
*/
protected abstract boolean isValid(T value);

@Override
public final boolean validate(T value, ValidationRequest req, String propertyName) {
if (!checkGroups(groups, req)) {
return true;
}

if (!isValid(value)) {
req.addViolation(message, propertyName);
return false;
}
return true;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -7,44 +7,39 @@

/**
*
* Marks a type as a Constraint Validator to be registered automatically.
* Marks a type as a Constraint Adapter to be registered automatically.
*
* <p> A custom adapter registered using this annotation must have a public constructor accepting a ValidationContext instance, and must directly implement the ValidationAdapter Interface.
* <p> A custom adapter registered using this annotation must have a public constructor accepting a ValidationContext instance, and must extend the AbstractConstraintAdapter class.
*
* <h3>Example:</h3>
*
* <pre>{@code
* @ConstraintValidator(SomeAnnotation.class)
* public final class CustomAnnotationAdapter implements ValidationAdapter<Object> {
* @ConstraintAdapter(SomeAnnotation.class)
* public final class CustomAnnotationAdapter extends AbstractConstraintAdapter<Object> {
*
* private final Message message;
* String value;
*
* public CustomAnnotationAdapter(ValidationContext ctx, Set<Class<?>> groups, Map<String, Object> attributes) {
* //create a message object for error interpolation
* message = ctx.message("{message.property}");
* //create a message object for error interpolation and set groups
* super(ctx.message(attributes), groups);
*
* //use the attributes to extract the annotation values
*
* value = (String) attributes.get("value");
* }
*
*
* @Override
* public boolean validate(Object value, ValidationRequest req, String propertyName) {
* public boolean isValid(Object value) {
*
* var isValid = ...custom validation based on the attributes;
*
* if (!isValid) {
* req.addViolation(message, propertyName);
* return false;
* }
*
* return true;
* return isValid;
* }
*
* }</pre>
*/
@Target(TYPE)
public @interface ConstraintValidator {
public @interface ConstraintAdapter {

/** The Annotation this validator targets */
Class<? extends Annotation> value();
Expand Down
Loading