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

Composable Constraints #63

Merged
merged 19 commits into from
Jul 7, 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
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
package example.avaje.composable;

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;
import io.avaje.validation.constraints.Digits;
import io.avaje.validation.constraints.Negative;
import io.avaje.validation.constraints.Positive;

@Digits(integer = 2)
@Constraint
@Retention(SOURCE)
@Target(TYPE)
public @interface DigitsContraint {

String message() default "";

Class<?>[] groups() default {};
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
package example.avaje.composable;

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;
import io.avaje.validation.constraints.Positive;

@Positive
@Constraint
@Target(TYPE)
@Retention(SOURCE)
@DigitsContraint
public @interface PositiveContraint {

String message() default "";

Class<?>[] groups() default {};
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
package example.avaje.composable;

import jakarta.validation.Valid;

@Valid
public record Sans(
@SansPositiveContraint(message = "must have positive double digit amount of puns") int puns) {}
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
package example.avaje.composable;

import static java.lang.annotation.ElementType.FIELD;
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 jakarta.validation.Constraint;

@Retention(SOURCE)
@Target(FIELD)
@Constraint(validatedBy = {})
@PositiveContraint(message = "ignored message")
public @interface SansPositiveContraint {

String message();

Class<?>[] groups() default {};
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
package example.avaje.composable;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.fail;

import java.util.Set;

import org.junit.jupiter.api.Test;

import io.avaje.validation.ConstraintViolation;
import io.avaje.validation.ConstraintViolationException;
import io.avaje.validation.Validator;

class SansComposableTest {

final Validator validator = Validator.builder().build();

@Test
void valid() {
final var undertale = new Sans(10);
validator.validate(undertale);
}

@Test
void invalid() {
var violations = violations(new Sans(-10));

violations.forEach(
v -> assertThat(v.message()).isEqualTo("must have positive double digit amount of puns"));

violations = violations(new Sans(-420));

violations.forEach(
v -> assertThat(v.message()).isEqualTo("must have positive double digit amount of puns"));
}

Set<ConstraintViolation> violations(Object any) {
try {
validator.validate(any);
fail("not expected");
return null;
} catch (final ConstraintViolationException e) {
return e.violations();
}
}
}
27 changes: 17 additions & 10 deletions validator-constraints/pom.xml
Original file line number Diff line number Diff line change
@@ -1,13 +1,20 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>io.avaje</groupId>
<artifactId>avaje-validator-parent</artifactId>
<version>0.1-SNAPSHOT</version>
</parent>
<artifactId>validator-constraints</artifactId>

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>io.avaje</groupId>
<artifactId>avaje-validator-parent</artifactId>
<version>0.1-SNAPSHOT</version>
</parent>
<artifactId>validator-constraints</artifactId>
<dependencies>
<dependency>
<groupId>io.avaje</groupId>
<artifactId>avaje-validator</artifactId>
<version>${project.version}</version>
<optional>true</optional>
</dependency>
</dependencies>
</project>
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
package io.avaje.validation.constraints;

import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.ElementType.TYPE_USE;

import java.lang.annotation.Documented;
Expand All @@ -11,18 +13,19 @@
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({METHOD, FIELD, TYPE_USE})
@Constraint
@Target({METHOD, FIELD, ANNOTATION_TYPE, PARAMETER, TYPE_USE})
@Retention(RetentionPolicy.RUNTIME)
@Repeatable(AssertFalse.List.class)
public @interface AssertFalse {
String message() default "{avaje.AssertFalse.message}";
String message() default "{avaje.AssertFalse.message}";

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

@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@interface List {
AssertFalse[] value();
}
@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@interface List {
AssertFalse[] value();
}
}
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
package io.avaje.validation.constraints;

import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.ElementType.TYPE_USE;

import java.lang.annotation.Documented;
Expand All @@ -11,18 +13,19 @@
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({METHOD, FIELD, TYPE_USE})
@Constraint
@Target({METHOD, FIELD, ANNOTATION_TYPE, PARAMETER, TYPE_USE})
@Retention(RetentionPolicy.RUNTIME)
@Repeatable(AssertTrue.List.class)
public @interface AssertTrue {
String message() default "{avaje.AssertTrue.message}";
String message() default "{avaje.AssertTrue.message}";

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

@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@interface List {
AssertTrue[] value();
}
@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@interface List {
AssertTrue[] value();
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
package io.avaje.validation.constraints;

import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
import static java.lang.annotation.RetentionPolicy.CLASS;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

/** Marks an annotation class as a Constraint. */
@Retention(CLASS)
@Target({ANNOTATION_TYPE})
public @interface Constraint {}
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
package io.avaje.validation.constraints;

import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.ElementType.TYPE_USE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

Expand All @@ -11,7 +13,8 @@

import io.avaje.validation.constraints.DecimalMax.List;

@Target({METHOD, FIELD, TYPE_USE})
@Constraint
@Target({METHOD, FIELD, ANNOTATION_TYPE, PARAMETER, TYPE_USE})
@Retention(RUNTIME)
@Repeatable(List.class)
public @interface DecimalMax {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,11 @@
*/
package io.avaje.validation.constraints;

import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.ElementType.TYPE_USE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Repeatable;
Expand Down Expand Up @@ -36,7 +39,8 @@
*
* @author Emmanuel Bernard
*/
@Target({METHOD, FIELD})
@Constraint
@Target({METHOD, FIELD, ANNOTATION_TYPE, PARAMETER, TYPE_USE})
@Retention(RUNTIME)
@Repeatable(List.class)
public @interface DecimalMin {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
package io.avaje.validation.constraints;

import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.ElementType.TYPE_USE;

import java.lang.annotation.Documented;
Expand All @@ -11,7 +13,8 @@
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({METHOD, FIELD, TYPE_USE})
@Constraint
@Target({METHOD, FIELD, ANNOTATION_TYPE, PARAMETER, TYPE_USE})
@Retention(RetentionPolicy.RUNTIME)
@Repeatable(Digits.List.class)
public @interface Digits {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
package io.avaje.validation.constraints;

import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.ElementType.TYPE_USE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

Expand All @@ -18,7 +20,8 @@
*
* <p>Accepts {@code CharSequence}. {@code null} elements are considered valid.
*/
@Target({METHOD, FIELD, TYPE_USE})
@Constraint
@Target({METHOD, FIELD, ANNOTATION_TYPE, PARAMETER, TYPE_USE})
@Retention(RUNTIME)
@Repeatable(List.class)
@Documented
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
package io.avaje.validation.constraints;

import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.ElementType.TYPE_USE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

Expand All @@ -10,8 +12,9 @@
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

@Constraint
@Documented
@Target({METHOD, FIELD, TYPE_USE})
@Target({METHOD, FIELD, ANNOTATION_TYPE, PARAMETER, TYPE_USE})
@Retention(RUNTIME)
@Repeatable(Future.List.class)
public @interface Future {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
package io.avaje.validation.constraints;

import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.ElementType.TYPE_USE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

Expand All @@ -10,8 +12,9 @@
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

@Constraint
@Documented
@Target({METHOD, FIELD, TYPE_USE})
@Target({METHOD, FIELD, ANNOTATION_TYPE, PARAMETER, TYPE_USE})
@Retention(RUNTIME)
@Repeatable(FutureOrPresent.List.class)
public @interface FutureOrPresent {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
package io.avaje.validation.constraints;

import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.ElementType.TYPE_USE;

import java.lang.annotation.Documented;
Expand All @@ -11,7 +13,8 @@
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({METHOD, FIELD, TYPE_USE})
@Constraint
@Target({METHOD, FIELD, ANNOTATION_TYPE, PARAMETER, TYPE_USE})
@Retention(RetentionPolicy.RUNTIME)
@Repeatable(Max.List.class)
public @interface Max {
Expand Down
Loading