Skip to content

Added support for inheritance hierarchies validation #369

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

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open
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
83 changes: 40 additions & 43 deletions src/main/java/am/ik/yavi/builder/ValidatorBuilder.java
Original file line number Diff line number Diff line change
Expand Up @@ -15,29 +15,6 @@
*/
package am.ik.yavi.builder;

import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.Instant;
import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.LocalTime;
import java.time.OffsetDateTime;
import java.time.Year;
import java.time.YearMonth;
import java.time.ZonedDateTime;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Deque;
import java.util.LinkedHashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.function.Predicate;
import java.util.function.Supplier;

import am.ik.yavi.constraint.BigDecimalConstraint;
import am.ik.yavi.constraint.BigIntegerConstraint;
import am.ik.yavi.constraint.BooleanConstraint;
Expand Down Expand Up @@ -77,6 +54,7 @@
import am.ik.yavi.core.ConstraintPredicate;
import am.ik.yavi.core.ConstraintPredicates;
import am.ik.yavi.core.CustomConstraint;
import am.ik.yavi.core.InheritanceValidator;
import am.ik.yavi.core.NestedCollectionValidator;
import am.ik.yavi.core.NestedConstraintCondition;
import am.ik.yavi.core.NestedConstraintPredicates;
Expand All @@ -90,26 +68,16 @@
import am.ik.yavi.fn.Pair;
import am.ik.yavi.message.MessageFormatter;
import am.ik.yavi.message.SimpleMessageFormatter;
import am.ik.yavi.meta.BigDecimalConstraintMeta;
import am.ik.yavi.meta.BigIntegerConstraintMeta;
import am.ik.yavi.meta.BooleanConstraintMeta;
import am.ik.yavi.meta.ByteConstraintMeta;
import am.ik.yavi.meta.CharacterConstraintMeta;
import am.ik.yavi.meta.DoubleConstraintMeta;
import am.ik.yavi.meta.FloatConstraintMeta;
import am.ik.yavi.meta.InstantConstraintMeta;
import am.ik.yavi.meta.IntegerConstraintMeta;
import am.ik.yavi.meta.LocalDateConstraintMeta;
import am.ik.yavi.meta.LocalDateTimeConstraintMeta;
import am.ik.yavi.meta.LocalTimeConstraintMeta;
import am.ik.yavi.meta.LongConstraintMeta;
import am.ik.yavi.meta.ObjectConstraintMeta;
import am.ik.yavi.meta.OffsetDateTimeConstraintMeta;
import am.ik.yavi.meta.ShortConstraintMeta;
import am.ik.yavi.meta.StringConstraintMeta;
import am.ik.yavi.meta.YearConstraintMeta;
import am.ik.yavi.meta.YearMonthConstraintMeta;
import am.ik.yavi.meta.ZonedDateTimeConstraintMeta;
import am.ik.yavi.meta.*;

import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.*;
import java.util.*;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.function.Predicate;
import java.util.function.Supplier;

public class ValidatorBuilder<T> implements Cloneable {
private static final String DEFAULT_SEPARATOR = ".";
Expand Down Expand Up @@ -732,6 +700,34 @@ public ValidatorBuilder<T> _doubleArray(ToDoubleArray<T> f, String name,
return this.constraint(f, name, c, DoubleArrayConstraint::new);
}

/**
* @since 0.14.0
*/
public <C extends T> ValidatorBuilder<T> constraintOnClass(Class<C> clazz,
Validator<C> cValidator) {
Validatable<T> validatable = new InheritanceValidator<>(clazz, cValidator);

this.conditionalValidators
.add(new Pair<>(getClassConstraintCondition(clazz), validatable));

return this;
}

/**
* @since 0.14.0
*/
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These methods are quite advanced. Can you please add to the JavaDoc what use cases it is useful for and some sample code?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

absolutely

public <C extends T> ValidatorBuilder<T> constraintOnClass(Class<C> clazz,
ValidatorBuilderConverter<C> converter) {
Validator<C> cValidator = converter.apply(new ValidatorBuilder<>()).build();

return constraintOnClass(clazz, cValidator);
}

private <C extends T> ConstraintCondition<T> getClassConstraintCondition(
Class<C> classCondition) {
return (t, c) -> classCondition.isInstance(t);
}

/**
* @since 0.11.0
*/
Expand Down Expand Up @@ -998,6 +994,7 @@ protected final <N> ValidatorBuilder<T> nest(Function<T, N> nested, String name,
.forEach(this.appendNestedConditionalValidator(nested, name));
builder.collectionValidators
.forEach(appendNestedCollectionValidator(nested, name));

return this;
}

Expand Down
50 changes: 50 additions & 0 deletions src/main/java/am/ik/yavi/core/InheritanceValidator.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
/*
* Copyright (C) 2018-2023 Toshiaki Maki <makingx@gmail.com>
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package am.ik.yavi.core;

import java.util.Locale;

/**
* @since 0.14.0
*/
public class InheritanceValidator<T, N extends T> implements Validatable<T> {
private final Class<N> nClass;
private final Validatable<N> validator;

public InheritanceValidator(Class<N> nClass, Validatable<N> validator) {
this.nClass = nClass;
this.validator = validator;
}

@Override
public ConstraintViolations validate(T target, Locale locale,
ConstraintContext constraintContext) {
final N n = nClass.cast(target);

return this.validator.validate(n, locale, constraintContext);
}

@Override
public Validatable<T> failFast(boolean failFast) {
final Validatable<N> validatable = this.validator.failFast(failFast);
return new InheritanceValidator<>(nClass, validatable);
}

@Override
public boolean isFailFast() {
return this.validator.isFailFast();
}
}
83 changes: 83 additions & 0 deletions src/test/java/am/ik/yavi/core/ConstraintOnClassTest.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
package am.ik.yavi.core;

import am.ik.yavi.User;
import am.ik.yavi.builder.ValidatorBuilder;
import am.ik.yavi.constraint.CharSequenceConstraint;
import org.junit.jupiter.api.TestInstance;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;

import java.util.function.Function;
import java.util.stream.Stream;

import static com.google.common.truth.Truth.assertThat;

public class ConstraintOnClassTest {

@ParameterizedTest
@MethodSource("provideValidators")
void testConstraintOnConditionClass(Validator<Parent> validator) {
Parent validChild = new Child(23, "drawing");
Parent invalidChild = new Child(6, "drawing");

assertThat(validator.validate(validChild).isValid()).isTrue();
assertThat(validator.validate(invalidChild).isValid()).isFalse();
}

@ParameterizedTest
@MethodSource("provideValidators")
void testConstraintOnNonConditionClass(Validator<Parent> validator) {
Parent validParent = new Parent(35);
Parent invalidParent = new Parent(19);

assertThat(validator.validate(validParent).isValid()).isTrue();
assertThat(validator.validate(invalidParent).isValid()).isFalse();
}

static Stream<Arguments> provideValidators() {
ValidatorBuilder<Parent> userValidatorBuilder = ValidatorBuilder.of(Parent.class)
.constraint(Parent::getAge, "age", c -> c.greaterThan(20));
Function<CharSequenceConstraint<Child, String>, CharSequenceConstraint<Child, String>> equalsToDrawing = (
CharSequenceConstraint<Child, String> c) -> c.equalTo("drawing");

return Stream
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The test case is difficult to understand.

Please add the simple example in the pull request to the test case.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure, no problem.

.of(Arguments.of(new ValidatorBuilder<>(userValidatorBuilder)
.constraintOnClass(Child.class,
ValidatorBuilder.of(Child.class)
.constraint(Child::getHobby, "hobby",
equalsToDrawing)
.build())
.build()), Arguments
.of(new ValidatorBuilder<>(userValidatorBuilder)
.constraintOnClass(Child.class,
b -> b.constraint(Child::getHobby,
"hobby", equalsToDrawing))
.build()));
}

private static class Child extends Parent {
private String hobby;

public Child(int age, String hobby) {
super(age);
this.hobby = hobby;
}

public String getHobby() {
return hobby;
}
}

private static class Parent {
private final int age;

public Parent(int age) {
this.age = age;
}

public int getAge() {
return age;
}
}
}