├── cross-field-validation.iml
├── .gitignore
├── src
    ├── test
    │   └── java
    │   │   └── io
    │   │       └── github
    │   │           └── maharramoff
    │   │               └── crossfieldvalidation
    │   │                   ├── CrossFieldConstraintViolationTest.java
    │   │                   ├── BaseCrossFieldValidatorTest.java
    │   │                   └── CrossFieldValidationProcessorTest.java
    └── main
    │   └── java
    │       └── io
    │           └── github
    │               └── maharramoff
    │                   └── crossfieldvalidation
    │                       ├── CrossFieldConstraintViolation.java
    │                       ├── CrossFieldConstraintValidator.java
    │                       ├── EnableCrossFieldConstraints.java
    │                       ├── CrossFieldConstraint.java
    │                       ├── BaseCrossFieldValidator.java
    │                       └── CrossFieldValidationProcessor.java
├── CHANGELOG.md
├── README.md
├── pom.xml
└── LICENSE


/cross-field-validation.iml:
--------------------------------------------------------------------------------
1 | <?xml version="1.0" encoding="UTF-8"?>
2 | <module version="4">
3 |   <component name="AdditionalModuleElements">
4 |     <content url="file://$MODULE_DIR$" dumb="true">
5 |       <sourceFolder url="file://$MODULE_DIR$/src/test" isTestSource="true" />
6 |     </content>
7 |   </component>
8 | </module>


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | target/
 2 | !.mvn/wrapper/maven-wrapper.jar
 3 | !**/src/main/**/target/
 4 | !**/src/test/**/target/
 5 | 
 6 | ### IntelliJ IDEA ###
 7 | .idea
 8 | 
 9 | ### Eclipse ###
10 | .apt_generated
11 | .classpath
12 | .factorypath
13 | .project
14 | .settings
15 | .springBeans
16 | .sts4-cache
17 | 
18 | ### NetBeans ###
19 | /nbproject/private/
20 | /nbbuild/
21 | /dist/
22 | /nbdist/
23 | /.nb-gradle/
24 | build/
25 | !**/src/main/**/build/
26 | !**/src/test/**/build/
27 | 
28 | ### VS Code ###
29 | .vscode/
30 | 
31 | ### Mac OS ###
32 | .DS_Store


--------------------------------------------------------------------------------
/src/test/java/io/github/maharramoff/crossfieldvalidation/CrossFieldConstraintViolationTest.java:
--------------------------------------------------------------------------------
 1 | package io.github.maharramoff.crossfieldvalidation;
 2 | 
 3 | import org.junit.jupiter.api.Test;
 4 | 
 5 | import static org.junit.jupiter.api.Assertions.assertEquals;
 6 | 
 7 | class CrossFieldConstraintViolationTest
 8 | {
 9 | 
10 |     @Test
11 |     void shouldCreateConstraintViolation()
12 |     {
13 |         CrossFieldConstraintViolation violation = new CrossFieldConstraintViolation("fieldName", "Error message");
14 |         assertEquals("fieldName", violation.getFieldName());
15 |         assertEquals("Error message", violation.getMessage());
16 |     }
17 | }


--------------------------------------------------------------------------------
/src/main/java/io/github/maharramoff/crossfieldvalidation/CrossFieldConstraintViolation.java:
--------------------------------------------------------------------------------
 1 | package io.github.maharramoff.crossfieldvalidation;
 2 | 
 3 | import lombok.Getter;
 4 | 
 5 | /**
 6 |  * Represents a constraint violation encountered during cross-field validation.
 7 |  *
 8 |  * @author Shamkhal Maharramov
 9 |  * @since 1.0.0
10 |  */
11 | @Getter
12 | public class CrossFieldConstraintViolation
13 | {
14 | 
15 |     private final String fieldName;
16 |     private final String message;
17 | 
18 |     /**
19 |      * Constructs a new `ConstraintViolation` with the specified field name and message.
20 |      *
21 |      * @param fieldName The name of the field where the violation occurred.
22 |      * @param message   The violation message.
23 |      */
24 |     public CrossFieldConstraintViolation(String fieldName, String message)
25 |     {
26 |         this.fieldName = fieldName;
27 |         this.message = message;
28 |     }
29 | }
30 | 


--------------------------------------------------------------------------------
/src/main/java/io/github/maharramoff/crossfieldvalidation/CrossFieldConstraintValidator.java:
--------------------------------------------------------------------------------
 1 | package io.github.maharramoff.crossfieldvalidation;
 2 | 
 3 | import java.lang.reflect.Field;
 4 | import java.util.List;
 5 | import java.util.Map;
 6 | 
 7 | /**
 8 |  * Interface for performing cross-field validation.
 9 |  * <p>
10 |  * Implementations of this interface can perform validation checks that depend on multiple fields within an object.
11 |  * </p>
12 |  *
13 |  * @author Shamkhal Maharramov
14 |  * @see CrossFieldConstraintViolation
15 |  * @since 1.0.0
16 |  */
17 | public interface CrossFieldConstraintValidator
18 | {
19 |     /**
20 |      * Validates the object based on custom cross-field constraints.
21 |      *
22 |      * @param obj        The object to validate.
23 |      * @param fields     A mapping from each class to its list of fields.
24 |      * @param violations The list to populate with any constraint violations.
25 |      * @return True if the object is valid according to custom cross-field constraints; false otherwise.
26 |      * @throws Exception If an error occurs during validation.
27 |      */
28 |     boolean isValid(Object obj, Map<Class<?>, List<Field>> fields, List<CrossFieldConstraintViolation> violations) throws Exception;
29 | }
30 | 
31 | 


--------------------------------------------------------------------------------
/src/main/java/io/github/maharramoff/crossfieldvalidation/EnableCrossFieldConstraints.java:
--------------------------------------------------------------------------------
 1 | package io.github.maharramoff.crossfieldvalidation;
 2 | 
 3 | import jakarta.validation.Constraint;
 4 | import jakarta.validation.Payload;
 5 | 
 6 | import java.lang.annotation.ElementType;
 7 | import java.lang.annotation.Retention;
 8 | import java.lang.annotation.RetentionPolicy;
 9 | import java.lang.annotation.Target;
10 | 
11 | /**
12 |  * Enables cross-field constraints validation on the annotated class type.
13 |  *
14 |  * <h2>Usage Example:</h2>
15 |  * <pre>
16 |  * &#64;EnableCrossFieldConstraints
17 |  * public class UserProfileDTO {
18 |  *     private String username;
19 |  *     private String password;
20 |  *
21 |  *     &#64;MatchWith("password")
22 |  *     private String confirmPassword;
23 |  * }
24 |  * </pre>
25 |  *
26 |  * @author Shamkhal Maharramov
27 |  * @see CrossFieldValidationProcessor
28 |  * @since 1.0.0
29 |  */
30 | @Target(ElementType.TYPE)
31 | @Retention(RetentionPolicy.RUNTIME)
32 | @Constraint(validatedBy = CrossFieldValidationProcessor.class)
33 | public @interface EnableCrossFieldConstraints
34 | {
35 |     String message() default "";
36 | 
37 |     Class<?>[] groups() default {};
38 | 
39 |     Class<? extends Payload>[] payload() default {};
40 | }
41 | 
42 | 


--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
 1 | # Changelog
 2 | 
 3 | ## 1.3.0 (2024-11-02)
 4 | 
 5 | ### Changes
 6 | 
 7 | * Improved validation performance and test coverage.
 8 | 
 9 | ## 1.2.1 (2024-10-27)
10 | 
11 | ### Bug Fixes
12 | 
13 | - Fixed HV000033 validation exception when using standard Jakarta validation annotations (@NotEmpty, @Email, etc.)
14 |   alongside cross-field constraints
15 | 
16 | ### Upgrading from 1.2.0
17 | 
18 | This is a patch release that fixes a bug in validation handling. No changes to your code are required.
19 | 
20 | To upgrade, update your dependency version:
21 | 
22 | Maven:
23 | 
24 | ```xml
25 | 
26 | <dependency>
27 |     <groupId>io.github.maharramoff</groupId>
28 |     <artifactId>cross-field-validation</artifactId>
29 |     <version>1.2.1</version>
30 | </dependency>
31 | ```
32 | 
33 | Gradle:
34 | 
35 | ```groovy
36 | implementation 'io.github.maharramoff:cross-field-validation:1.2.1'
37 | ```
38 | 
39 | ## 1.2.0 (2024-10-22)
40 | 
41 | ### Changes
42 | 
43 | * Replace BeanUtils with Java Introspector for accessing properties in BaseCrossFieldValidator.
44 | 
45 | ## 1.1.0 (2024-10-22)
46 | 
47 | ### Bug Fixes
48 | 
49 | * Resolve issue with manual validator registration (#1)
50 | 
51 | ### Changes
52 | 
53 | * Migrate from `javax` to `jakarta` packages
54 | 
55 | ## 1.0.0 (2024-10-21)
56 | 
57 | ### Features
58 | 
59 | * Initial release


--------------------------------------------------------------------------------
/src/main/java/io/github/maharramoff/crossfieldvalidation/CrossFieldConstraint.java:
--------------------------------------------------------------------------------
 1 | package io.github.maharramoff.crossfieldvalidation;
 2 | 
 3 | import java.lang.annotation.ElementType;
 4 | import java.lang.annotation.Retention;
 5 | import java.lang.annotation.RetentionPolicy;
 6 | import java.lang.annotation.Target;
 7 | 
 8 | /**
 9 |  * Marker annotation that associates a cross-field constraint annotation with its validator implementation.
10 |  * This annotation should be applied to custom constraint annotations to specify their validator class.
11 |  *
12 |  * <h2>Usage Example:</h2>
13 |  * <pre>
14 |  * &#64;Target(ElementType.FIELD)
15 |  * &#64;Retention(RetentionPolicy.RUNTIME)
16 |  * &#64;CrossFieldConstraint(validatedBy = MatchWithValidator.class)
17 |  * public @interface MatchWith {
18 |  *     String field();
19 |  *     String message() default "Fields do not match.";
20 |  * }
21 |  * </pre>
22 |  *
23 |  * @author Shamkhal Maharramov
24 |  * @see CrossFieldConstraintValidator
25 |  * @since 1.1.0
26 |  */
27 | @Target(ElementType.ANNOTATION_TYPE)
28 | @Retention(RetentionPolicy.RUNTIME)
29 | public @interface CrossFieldConstraint
30 | {
31 |     /**
32 |      * Interface method that returns the class type of a CrossFieldConstraintValidator.
33 |      *
34 |      * @return the class object representing the type of CrossFieldConstraintValidator
35 |      * that this constraint is validated by.
36 |      */
37 |     Class<? extends CrossFieldConstraintValidator> validatedBy();
38 | }
39 | 


--------------------------------------------------------------------------------
/src/test/java/io/github/maharramoff/crossfieldvalidation/BaseCrossFieldValidatorTest.java:
--------------------------------------------------------------------------------
  1 | package io.github.maharramoff.crossfieldvalidation;
  2 | 
  3 | import lombok.Getter;
  4 | import org.junit.jupiter.api.BeforeEach;
  5 | import org.junit.jupiter.api.Test;
  6 | 
  7 | import java.beans.IntrospectionException;
  8 | import java.lang.reflect.Field;
  9 | import java.lang.reflect.Method;
 10 | import java.util.List;
 11 | import java.util.Map;
 12 | 
 13 | import static org.junit.jupiter.api.Assertions.assertEquals;
 14 | import static org.junit.jupiter.api.Assertions.assertNull;
 15 | 
 16 | class BaseCrossFieldValidatorTest
 17 | {
 18 | 
 19 |     private BaseCrossFieldValidator validator;
 20 | 
 21 |     @BeforeEach
 22 |     void setUp()
 23 |     {
 24 |         validator = new BaseCrossFieldValidator()
 25 |         {
 26 |             @Override
 27 |             public boolean isValid(Object obj, Map<Class<?>, List<Field>> fields, List<CrossFieldConstraintViolation> violations)
 28 |             {
 29 |                 return false;
 30 |             }
 31 |         };
 32 |     }
 33 | 
 34 |     @Test
 35 |     void shouldReturnCorrectValue()
 36 |     {
 37 |         TestObject testObject = new TestObject("testValue");
 38 |         Object     value      = validator.getProperty(testObject, "property");
 39 |         assertEquals("testValue", value);
 40 |     }
 41 | 
 42 |     @Test
 43 |     void shouldReturnNullForInvalidProperty()
 44 |     {
 45 |         TestObject testObject = new TestObject("testValue");
 46 |         Object     value      = validator.getProperty(testObject, "nonExistentProperty");
 47 |         assertNull(value);
 48 |     }
 49 | 
 50 |     @Test
 51 |     void shouldReturnNullForIntrospectionException()
 52 |     {
 53 |         class InvalidBean
 54 |         {
 55 |             @SuppressWarnings("unused")
 56 |             public String getInvalid() throws IntrospectionException
 57 |             {
 58 |                 throw new IntrospectionException("Simulated exception");
 59 |             }
 60 |         }
 61 | 
 62 |         Object value = validator.getProperty(new InvalidBean(), "invalid");
 63 |         assertNull(value);
 64 |     }
 65 | 
 66 |     @Test
 67 |     void shouldReturnNullForReflectiveOperationException()
 68 |     {
 69 |         class PrivateMethodClass
 70 |         {
 71 |             private String secret()
 72 |             {
 73 |                 return "secret";
 74 |             }
 75 |         }
 76 | 
 77 |         try
 78 |         {
 79 |             Method method = PrivateMethodClass.class.getDeclaredMethod("secret");
 80 |             method.setAccessible(false);
 81 |             Object value = validator.getProperty(new PrivateMethodClass(), "secret");
 82 |             assertNull(value);
 83 |         }
 84 |         catch (NoSuchMethodException ignored)
 85 |         {
 86 |         }
 87 |     }
 88 | 
 89 |     @Getter
 90 |     private static class TestObject
 91 |     {
 92 |         private final String property;
 93 | 
 94 |         public TestObject(String property)
 95 |         {
 96 |             this.property = property;
 97 |         }
 98 |     }
 99 | }
100 | 


--------------------------------------------------------------------------------
/src/main/java/io/github/maharramoff/crossfieldvalidation/BaseCrossFieldValidator.java:
--------------------------------------------------------------------------------
  1 | package io.github.maharramoff.crossfieldvalidation;
  2 | 
  3 | import java.beans.IntrospectionException;
  4 | import java.beans.Introspector;
  5 | import java.beans.PropertyDescriptor;
  6 | import java.lang.annotation.Annotation;
  7 | import java.lang.reflect.Field;
  8 | import java.util.Collections;
  9 | import java.util.List;
 10 | import java.util.Map;
 11 | import java.util.function.BiConsumer;
 12 | 
 13 | /**
 14 |  * An abstract base class for implementing cross-field validation logic.
 15 |  * <h2>Example Usage:</h2>
 16 |  * <pre>
 17 |  * <code>
 18 |  * public class ExampleValidator extends BaseCrossFieldValidator {
 19 |  *     {@literal @}Override
 20 |  *     public boolean isValid(Object obj, Map&lt;Class&lt;?&gt;, List&lt;Field&gt;&gt; fieldMapping, List&lt;ConstraintViolation&gt; violations) {
 21 |  *         processFields(obj, fieldMapping, Example.class, (field, annotation) -&gt; {
 22 |  *             // ... your validation logic ...
 23 |  *         });
 24 |  *         return violations.isEmpty();
 25 |  *     }
 26 |  * }
 27 |  * </code>
 28 |  * </pre>
 29 |  *
 30 |  * @author Shamkhal Maharramov
 31 |  * @see CrossFieldConstraintValidator
 32 |  * @see CrossFieldConstraintViolation
 33 |  * @since 1.0.0
 34 |  */
 35 | public abstract class BaseCrossFieldValidator implements CrossFieldConstraintValidator
 36 | {
 37 |     /**
 38 |      * Default constructor for the `AbstractCrossFieldConstraintValidator`.
 39 |      */
 40 |     public BaseCrossFieldValidator()
 41 |     {
 42 |         // This constructor is intentionally left blank.
 43 |     }
 44 | 
 45 |     /**
 46 |      * Retrieves the value of a given property field from an object.
 47 |      *
 48 |      * @param object    The object instance from which to fetch the property value.
 49 |      * @param fieldName The name of the field whose value needs to be fetched.
 50 |      * @return The value of the field if it exists, or null otherwise.
 51 |      */
 52 |     protected Object getProperty(Object object, String fieldName)
 53 |     {
 54 |         try
 55 |         {
 56 |             PropertyDescriptor[] propertyDescriptors = Introspector.getBeanInfo(object.getClass()).getPropertyDescriptors();
 57 |             for (PropertyDescriptor propertyDescriptor : propertyDescriptors)
 58 |             {
 59 |                 if (propertyDescriptor.getName().equals(fieldName))
 60 |                 {
 61 |                     return propertyDescriptor.getReadMethod().invoke(object);
 62 |                 }
 63 |             }
 64 |         }
 65 |         catch (IntrospectionException | ReflectiveOperationException e)
 66 |         {
 67 |             return null;
 68 |         }
 69 |         return null;
 70 |     }
 71 | 
 72 |     /**
 73 |      * Processes each annotated field of a given object, applying the specified {@code fieldProcessor} function.
 74 |      *
 75 |      * <p>This method iterates through all fields in the object that are annotated with the given annotation type.
 76 |      * For each annotated field, the {@code fieldProcessor} function is invoked with the field and its annotation as arguments.</p>
 77 |      *
 78 |      * @param <T>             The type of annotation to look for on the fields.
 79 |      * @param obj             The object instance containing the fields to be processed.
 80 |      * @param fieldMapping    A map containing field information for each class type, used to look up fields in the object.
 81 |      * @param annotationClass The class type of the annotation to look for on the fields.
 82 |      * @param fieldProcessor  A {@code BiConsumer} that takes a field and its annotation as arguments and processes them.
 83 |      *                        This consumer function is responsible for the actual work to be done on each field.
 84 |      */
 85 |     protected <T extends Annotation> void processFields(Object obj,
 86 |                                                         Map<Class<?>, List<Field>> fieldMapping,
 87 |                                                         Class<T> annotationClass,
 88 |                                                         BiConsumer<Field, T> fieldProcessor)
 89 |     {
 90 |         List<Field> fields = fieldMapping.getOrDefault(obj.getClass(), Collections.emptyList());
 91 |         for (Field field : fields)
 92 |         {
 93 |             T annotation = field.getAnnotation(annotationClass);
 94 |             if (annotation != null)
 95 |             {
 96 |                 fieldProcessor.accept(field, annotation);
 97 |             }
 98 |         }
 99 |     }
100 | }


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # Cross-Field Validation Library
  2 | 
  3 | ## Unleash the Power of Cross-Field Validation in Java
  4 | 
  5 | This library unlocks powerful cross-field validation for your Java applications, enabling you to define complex
  6 | constraints that span multiple fields within an object.
  7 | 
  8 | ### Why You Need This
  9 | 
 10 | Jakarta Bean Validation is great for single-field validation, but it falls short when you need to enforce rules that
 11 | involve relationships between different fields. This library bridges that gap, providing a flexible and intuitive way to
 12 | define and apply cross-field validation.
 13 | 
 14 | This solution overcomes the limitations of `ConstraintValidatorContext`, which doesn't allow interference with the
 15 | object context when writing field-level validators. There are long-standing open issues on this topic:
 16 | 
 17 | - [BVAL-237](https://hibernate.atlassian.net/browse/BVAL-237)
 18 | - [BVAL-240](https://hibernate.atlassian.net/browse/BVAL-240)
 19 | 
 20 | **Advantages of this library:**
 21 | 
 22 | 1. **More flexible validations:**  Define complex validation logic involving multiple fields.
 23 | 2. **Improved readability:** Create custom annotations that resemble built-in constraints like `@NotNull`
 24 |    and `@NotEmpty`.
 25 | 3. **Simplified validation:** Use a single `@EnableCrossFieldConstraints` annotation to enable all custom validators for
 26 |    a class.
 27 | 
 28 | ### Getting Started
 29 | 
 30 | **1. Add the Dependency**
 31 | 
 32 | ```xml
 33 | 
 34 | <dependency>
 35 |     <groupId>io.github.maharramoff</groupId>
 36 |     <artifactId>cross-field-validation</artifactId>
 37 |     <version>1.3.0</version>
 38 | </dependency>
 39 | ```
 40 | 
 41 | **2. Annotate your class with `@EnableCrossFieldConstraints`**
 42 | 
 43 | ```java
 44 | @EnableCrossFieldConstraints
 45 | public class SignupRequestDTO
 46 | {
 47 |     private String username;
 48 |     private String password;
 49 | 
 50 |     @MatchWith("password")
 51 |     private String confirmPassword;
 52 | }
 53 | ```
 54 | 
 55 | **3. Implement a custom validator**
 56 | 
 57 | ```java
 58 | @Target(ElementType.FIELD)
 59 | @Retention(RetentionPolicy.RUNTIME)
 60 | @CrossFieldConstraint(validatedBy = MatchWithValidator.class)
 61 | public @interface MatchWith
 62 | {
 63 |     String field();
 64 | 
 65 |     String message() default "Fields do not match.";
 66 | }
 67 | 
 68 | public class MatchWithValidator extends BaseCrossFieldValidator
 69 | {
 70 |     @Override
 71 |     public boolean isValid(Object obj, Map<Class<?>, List<Field>> fieldMapping, List<CrossFieldConstraintViolation> violations)
 72 |     {
 73 |         processFields(obj, fieldMapping, MatchWith.class, (field, annotation) ->
 74 |         {
 75 |             Object fieldValue      = getProperty(obj, field.getName());
 76 |             Object otherFieldValue = getProperty(obj, annotation.field());
 77 |             if (fieldValue == null && otherFieldValue == null)
 78 |             {
 79 |                 return; // Both null is considered valid
 80 |             }
 81 |             if (fieldValue == null || !fieldValue.equals(otherFieldValue))
 82 |             {
 83 |                 violations.add(new CrossFieldConstraintViolation(field.getName(), annotation.message()));
 84 |             }
 85 |         });
 86 |         return violations.isEmpty();
 87 |     }
 88 | }
 89 | ```
 90 | 
 91 | ### How It Works
 92 | 
 93 | This library utilizes a ConstraintValidator to manage cross-field validation. Custom validators implement the
 94 | CrossFieldConstraintValidator interface, providing the logic for your specific constraints.
 95 | 
 96 | **1. Annotation Processing:** When the validation framework encounters the `@EnableCrossFieldConstraints` annotation on
 97 | a class, it triggers the `CrossFieldValidationProcessor`.
 98 | 
 99 | **2. Validator Execution:** The `CrossFieldValidationProcessor` iterates through
100 | registered `CrossFieldConstraintValidator` implementations.
101 | 
102 | **3. Field Analysis:** Each validator analyzes the fields of the object, looking for its corresponding annotation (
103 | e.g., `@MatchWith`).
104 | 
105 | **4. Validation Logic:** If the annotation is present, the validator executes its custom validation logic, comparing
106 | field values as needed.
107 | 
108 | **5. Violation Reporting:** If a constraint is violated, the validator adds a `CrossFieldConstraintViolation` to the
109 | list, which
110 | is then handled by the validation framework.
111 | 
112 | ### Contributing
113 | 
114 | Contributions are welcome! Please fork the repository and submit a pull request with your changes. Ensure your code
115 | follows the existing code style and includes appropriate unit tests.


--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="UTF-8"?>
  2 | <project xmlns="http://maven.apache.org/POM/4.0.0"
  3 |          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4 |          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5 |     <modelVersion>4.0.0</modelVersion>
  6 | 
  7 |     <groupId>io.github.maharramoff</groupId>
  8 |     <artifactId>cross-field-validation</artifactId>
  9 |     <version>1.3.0</version>
 10 |     <packaging>jar</packaging>
 11 | 
 12 |     <name>${project.groupId}:${project.artifactId}</name>
 13 |     <description>A Java library that extends Jakarta Bean Validation capabilities to enable cross-field validation, so
 14 |         developers can define constraints that span multiple fields within an object.
 15 |     </description>
 16 |     <url>https://github.com/Maharramoff/cross-field-validation</url>
 17 |     <licenses>
 18 |         <license>
 19 |             <name>The Apache Software License, Version 2.0</name>
 20 |             <url>https://www.apache.org/licenses/LICENSE-2.0.txt</url>
 21 |             <distribution>repo</distribution>
 22 |         </license>
 23 |     </licenses>
 24 |     <developers>
 25 |         <developer>
 26 |             <id>author</id>
 27 |             <name>Shamkhal Maharramov</name>
 28 |             <email>sh.maharramov@gmail.com</email>
 29 |         </developer>
 30 |     </developers>
 31 |     <scm>
 32 |         <url>https://github.com/Maharramoff/cross-field-validation</url>
 33 |         <connection>scm:git:https://github.com/Maharramoff/cross-field-validation.git</connection>
 34 |         <developerConnection>scm:git:git@github.com:maharramoff/cross-field-validation.git</developerConnection>
 35 |     </scm>
 36 | 
 37 |     <distributionManagement>
 38 |         <snapshotRepository>
 39 |             <id>ossrh</id>
 40 |             <url>https://s01.oss.sonatype.org/content/repositories/snapshots</url>
 41 |         </snapshotRepository>
 42 |         <repository>
 43 |             <id>ossrh</id>
 44 |             <url>https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/</url>
 45 |         </repository>
 46 |     </distributionManagement>
 47 | 
 48 |     <dependencies>
 49 |         <dependency>
 50 |             <groupId>org.projectlombok</groupId>
 51 |             <artifactId>lombok</artifactId>
 52 |             <version>1.18.34</version>
 53 |         </dependency>
 54 |         <dependency>
 55 |             <groupId>org.junit.jupiter</groupId>
 56 |             <artifactId>junit-jupiter-api</artifactId>
 57 |             <version>5.9.3</version>
 58 |             <scope>test</scope>
 59 |         </dependency>
 60 |         <dependency>
 61 |             <groupId>org.mockito</groupId>
 62 |             <artifactId>mockito-core</artifactId>
 63 |             <version>4.5.1</version>
 64 |             <scope>test</scope>
 65 |         </dependency>
 66 |         <dependency>
 67 |             <groupId>org.hibernate.validator</groupId>
 68 |             <artifactId>hibernate-validator</artifactId>
 69 |             <version>7.0.5.Final</version>
 70 |             <scope>test</scope>
 71 |         </dependency>
 72 |         <dependency>
 73 |             <groupId>org.glassfish</groupId>
 74 |             <artifactId>jakarta.el</artifactId>
 75 |             <version>4.0.2</version>
 76 |             <scope>test</scope>
 77 |         </dependency>
 78 |         <dependency>
 79 |             <groupId>jakarta.validation</groupId>
 80 |             <artifactId>jakarta.validation-api</artifactId>
 81 |             <version>3.1.0</version>
 82 |         </dependency>
 83 |         <dependency>
 84 |             <groupId>org.slf4j</groupId>
 85 |             <artifactId>slf4j-api</artifactId>
 86 |             <version>2.0.16</version>
 87 |         </dependency>
 88 |         <dependency>
 89 |             <groupId>org.slf4j</groupId>
 90 |             <artifactId>slf4j-simple</artifactId>
 91 |             <version>2.0.13</version>
 92 |             <scope>runtime</scope>
 93 |         </dependency>
 94 | 
 95 |     </dependencies>
 96 | 
 97 |     <build>
 98 |         <plugins>
 99 |             <plugin>
100 |                 <groupId>org.apache.maven.plugins</groupId>
101 |                 <artifactId>maven-source-plugin</artifactId>
102 |                 <version>3.3.1</version>
103 |                 <executions>
104 |                     <execution>
105 |                         <id>attach-sources</id>
106 |                         <goals>
107 |                             <goal>jar-no-fork</goal>
108 |                         </goals>
109 |                     </execution>
110 |                 </executions>
111 |             </plugin>
112 |             <plugin>
113 |                 <groupId>org.apache.maven.plugins</groupId>
114 |                 <artifactId>maven-javadoc-plugin</artifactId>
115 |                 <version>3.10.1</version>
116 |                 <executions>
117 |                     <execution>
118 |                         <id>attach-javadocs</id>
119 |                         <goals>
120 |                             <goal>jar</goal>
121 |                         </goals>
122 |                     </execution>
123 |                 </executions>
124 |             </plugin>
125 |             <plugin>
126 |                 <groupId>org.apache.maven.plugins</groupId>
127 |                 <artifactId>maven-gpg-plugin</artifactId>
128 |                 <version>3.2.7</version>
129 |                 <executions>
130 |                     <execution>
131 |                         <id>sign-artifacts</id>
132 |                         <phase>verify</phase>
133 |                         <goals>
134 |                             <goal>sign</goal>
135 |                         </goals>
136 |                     </execution>
137 |                 </executions>
138 |             </plugin>
139 |             <plugin>
140 |                 <groupId>net.nicoulaj.maven.plugins</groupId>
141 |                 <artifactId>checksum-maven-plugin</artifactId>
142 |                 <version>1.11</version>
143 |                 <executions>
144 |                     <execution>
145 |                         <id>create-checksums</id>
146 |                         <phase>verify</phase>
147 |                         <goals>
148 |                             <goal>files</goal>
149 |                         </goals>
150 |                         <configuration>
151 |                             <fileSets>
152 |                                 <fileSet>
153 |                                     <directory>${project.build.directory}</directory>
154 |                                     <includes>
155 |                                         <include>${project.build.finalName}.jar</include>
156 |                                         <include>${project.build.finalName}-javadoc.jar</include>
157 |                                         <include>${project.build.finalName}-sources.jar</include>
158 |                                         <include>${project.build.finalName}.pom</include>
159 |                                     </includes>
160 |                                 </fileSet>
161 |                             </fileSets>
162 |                         </configuration>
163 |                     </execution>
164 |                 </executions>
165 |             </plugin>
166 |             <plugin>
167 |                 <groupId>org.sonatype.central</groupId>
168 |                 <artifactId>central-publishing-maven-plugin</artifactId>
169 |                 <version>0.6.0</version>
170 |                 <extensions>true</extensions>
171 |                 <configuration>
172 |                     <publishingServerId>central</publishingServerId>
173 |                     <autoPublish>true</autoPublish>
174 |                     <checksums>required</checksums>
175 |                     <deploymentName>${project.artifactId}-${project.version}</deploymentName>
176 |                 </configuration>
177 |             </plugin>
178 |             <plugin>
179 |                 <groupId>org.jacoco</groupId>
180 |                 <artifactId>jacoco-maven-plugin</artifactId>
181 |                 <version>0.8.12</version>
182 |                 <executions>
183 |                     <execution>
184 |                         <goals>
185 |                             <goal>prepare-agent</goal>
186 |                         </goals>
187 |                     </execution>
188 |                     <execution>
189 |                         <id>report</id>
190 |                         <phase>prepare-package</phase>
191 |                         <goals>
192 |                             <goal>report</goal>
193 |                         </goals>
194 |                     </execution>
195 |                 </executions>
196 |             </plugin>
197 | 
198 |         </plugins>
199 |     </build>
200 | 
201 | 
202 |     <properties>
203 |         <maven.compiler.source>8</maven.compiler.source>
204 |         <maven.compiler.target>8</maven.compiler.target>
205 |         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
206 |     </properties>
207 | 
208 | </project>


--------------------------------------------------------------------------------
/src/main/java/io/github/maharramoff/crossfieldvalidation/CrossFieldValidationProcessor.java:
--------------------------------------------------------------------------------
  1 | package io.github.maharramoff.crossfieldvalidation;
  2 | 
  3 | import jakarta.validation.ConstraintValidator;
  4 | import jakarta.validation.ConstraintValidatorContext;
  5 | import org.slf4j.Logger;
  6 | import org.slf4j.LoggerFactory;
  7 | 
  8 | import java.lang.annotation.Annotation;
  9 | import java.lang.reflect.Field;
 10 | import java.util.ArrayList;
 11 | import java.util.Arrays;
 12 | import java.util.List;
 13 | import java.util.Map;
 14 | import java.util.concurrent.ConcurrentHashMap;
 15 | import java.util.function.Function;
 16 | import java.util.stream.Collectors;
 17 | 
 18 | /**
 19 |  * A {@code ConstraintValidator} implementation that enables cross-field validation for objects.
 20 |  * This implementation automatically discovers and caches validators for fields annotated with
 21 |  * cross-field constraint annotations.
 22 |  *
 23 |  * <h2>Key Components:</h2>
 24 |  * <ul>
 25 |  *   <li>{@code fieldMapping}: A mapping from each class to its list of fields for efficient field access.</li>
 26 |  *   <li>{@code validatorCache}: A cache of validator instances for each constraint annotation type.</li>
 27 |  * </ul>
 28 |  *
 29 |  * <h2>Usage Example:</h2>
 30 |  * <pre>
 31 |  * &#64;EnableCrossFieldConstraints
 32 |  * public class UserProfileDTO {
 33 |  *     private String password;
 34 |  *
 35 |  *     &#64;MatchWith(field = "password")
 36 |  *     private String confirmPassword;
 37 |  * }
 38 |  * </pre>
 39 |  *
 40 |  * <h2>Creating Custom Constraints:</h2>
 41 |  * <ol>
 42 |  *   <li>Create a validator class that extends {@link CrossFieldConstraintValidator}</li>
 43 |  *   <li>Create a constraint annotation marked with {@link CrossFieldConstraint}</li>
 44 |  *   <li>Apply the constraint annotation to fields requiring validation</li>
 45 |  * </ol>
 46 |  *
 47 |  * @author Shamkhal Maharramov
 48 |  * @see CrossFieldConstraintValidator
 49 |  * @see CrossFieldConstraint
 50 |  * @see CrossFieldConstraintViolation
 51 |  * @since 1.0.0
 52 |  */
 53 | public class CrossFieldValidationProcessor implements ConstraintValidator<EnableCrossFieldConstraints, Object>
 54 | {
 55 |     private static final Logger logger = LoggerFactory.getLogger(CrossFieldValidationProcessor.class);
 56 |     private final Map<Class<?>, List<Field>> fieldMapping = new ConcurrentHashMap<>();
 57 |     private final Map<Class<?>, Map<Field, Annotation[]>> fieldAnnotationsCache = new ConcurrentHashMap<>();
 58 |     private final Map<Class<? extends Annotation>, CrossFieldConstraintValidator> validatorCache = new ConcurrentHashMap<>();
 59 | 
 60 |     /**
 61 |      * Default constructor for the `CrossFieldValidationProcessor`.
 62 |      */
 63 |     public CrossFieldValidationProcessor()
 64 |     {
 65 |         // This constructor is intentionally left blank.
 66 |     }
 67 | 
 68 |     /**
 69 |      * Validates the given object by discovering and applying all relevant cross-field validators.
 70 |      * The method scans all fields for annotations marked with {@link CrossFieldConstraint},
 71 |      * creates or retrieves the corresponding validator instances, and applies them.
 72 |      *
 73 |      * @param obj     The object to validate
 74 |      * @param context The constraint validator context
 75 |      * @return {@code true} if all validations pass, {@code false} otherwise
 76 |      */
 77 |     @Override
 78 |     public boolean isValid(final Object obj, final ConstraintValidatorContext context)
 79 |     {
 80 |         logger.debug("Starting validation for object: {}", obj.getClass().getName());
 81 | 
 82 |         List<CrossFieldConstraintViolation> violations = new ArrayList<>();
 83 |         boolean                             isValid    = processFields(obj, violations);
 84 | 
 85 |         if (!isValid)
 86 |         {
 87 |             addViolationsToContext(context, violations);
 88 |         }
 89 | 
 90 |         return isValid;
 91 |     }
 92 | 
 93 |     /**
 94 |      * Processes all fields of the given object to perform cross-field validation.
 95 |      *
 96 |      * @param obj        The object to validate
 97 |      * @param violations A list to store any constraint violations encountered during validation
 98 |      * @return {@code true} if all validations pass, {@code false} otherwise
 99 |      */
100 |     private boolean processFields(Object obj, List<CrossFieldConstraintViolation> violations)
101 |     {
102 |         Class<?>                 clazz            = obj.getClass();
103 |         List<Field>              fields           = fieldMapping.computeIfAbsent(clazz, this::getAllDeclaredFields);
104 |         Map<Field, Annotation[]> fieldAnnotations = fieldAnnotationsCache.computeIfAbsent(clazz, this::getFieldAnnotations);
105 | 
106 |         boolean isValid = true;
107 | 
108 |         logger.debug("Processing {} fields for class: {}", fields.size(), clazz.getName());
109 | 
110 |         for (Field field : fields)
111 |         {
112 |             Annotation[] annotations = fieldAnnotations.get(field);
113 |             for (Annotation annotation : annotations)
114 |             {
115 |                 logger.debug("Processing annotation: {}", annotation.annotationType().getName());
116 | 
117 |                 CrossFieldConstraintValidator validator = getValidatorForAnnotation(annotation.annotationType());
118 | 
119 |                 logger.debug("Validator obtained: {}", (validator != null ? validator.getClass().getName() : "null"));
120 | 
121 |                 if (validator != null)
122 |                 {
123 |                     isValid = applyValidator(obj, violations, isValid, validator);
124 |                 }
125 |             }
126 |         }
127 |         return isValid;
128 |     }
129 | 
130 |     /**
131 |      * Retrieves all declared fields of the specified class.
132 |      *
133 |      * @param clazz The class whose declared fields are to be retrieved.
134 |      * @return A list containing all declared fields of the class.
135 |      */
136 |     private List<Field> getAllDeclaredFields(Class<?> clazz)
137 |     {
138 |         return Arrays.asList(clazz.getDeclaredFields());
139 |     }
140 | 
141 |     /**
142 |      * Retrieves annotations for all fields of the specified class and maps them accordingly.
143 |      *
144 |      * @param clazz The class whose field annotations are to be retrieved.
145 |      * @return A map where each field is associated with its array of annotations.
146 |      */
147 |     private Map<Field, Annotation[]> getFieldAnnotations(Class<?> clazz)
148 |     {
149 |         List<Field> fields = fieldMapping.get(clazz);
150 |         return fields.stream()
151 |                 .collect(Collectors.toMap(Function.identity(), Field::getAnnotations));
152 |     }
153 | 
154 |     /**
155 |      * Retrieves a cached validator instance for the given annotation type,
156 |      * creating a new instance if none exists.
157 |      *
158 |      * @param annotationType The type of the constraint annotation
159 |      * @return The validator instance, or null if the annotation is not a cross-field constraint
160 |      * @since 1.1.0
161 |      */
162 |     CrossFieldConstraintValidator getValidatorForAnnotation(Class<? extends Annotation> annotationType)
163 |     {
164 |         logger.debug("Getting validator for annotation type: {}", annotationType.getName());
165 | 
166 |         return validatorCache.computeIfAbsent(annotationType, this::registerValidator);
167 |     }
168 | 
169 |     /**
170 |      * Creates a new validator instance for the given annotation type.
171 |      *
172 |      * @param annotationType The type of the constraint annotation
173 |      * @return A new validator instance, or null if the annotation is not marked with {@link CrossFieldConstraint}
174 |      * @throws IllegalStateException if validator instantiation fails
175 |      * @since 1.1.0
176 |      */
177 |     private CrossFieldConstraintValidator registerValidator(Class<? extends Annotation> annotationType)
178 |     {
179 |         logger.debug("Attempting to register validator for: {}", annotationType.getName());
180 | 
181 |         CrossFieldConstraint crossFieldConstraint = annotationType.getAnnotation(CrossFieldConstraint.class);
182 | 
183 |         logger.debug("CrossFieldConstraint annotation present: {}", (crossFieldConstraint != null));
184 | 
185 |         if (crossFieldConstraint == null)
186 |         {
187 |             logger.debug("No @CrossFieldConstraint found on {}", annotationType.getName());
188 | 
189 |             return null;
190 |         }
191 | 
192 |         try
193 |         {
194 |             Class<? extends CrossFieldConstraintValidator> validatorClass = crossFieldConstraint.validatedBy();
195 | 
196 |             logger.debug("Validator class to instantiate: {}", validatorClass.getName());
197 | 
198 |             CrossFieldConstraintValidator validator = validatorClass.getDeclaredConstructor().newInstance();
199 | 
200 |             logger.debug("Successfully created validator instance: {}", validator.getClass().getName());
201 | 
202 |             return validator;
203 |         }
204 |         catch (Exception e)
205 |         {
206 |             logger.debug("Failed to instantiate validator: {}", e.getMessage());
207 | 
208 |             throw new IllegalStateException("Failed to instantiate validator for " + annotationType, e);
209 |         }
210 |     }
211 | 
212 |     /**
213 |      * Applies the given validator to the object and updates the list of violations.
214 |      *
215 |      * @param obj        The object to validate.
216 |      * @param violations The list to store any constraint violations encountered during validation.
217 |      * @param isValid    The current validity status before applying the validator.
218 |      * @param validator  The validator to apply to the object.
219 |      * @return {@code true} if the object passes validation after applying the validator; {@code false} otherwise.
220 |      */
221 |     private boolean applyValidator(Object obj, List<CrossFieldConstraintViolation> violations, boolean isValid, CrossFieldConstraintValidator validator)
222 |     {
223 |         try
224 |         {
225 |             isValid &= validator.isValid(obj, fieldMapping, violations);
226 |             logger.debug("Validation result: {}", isValid);
227 |         }
228 |         catch (Exception e)
229 |         {
230 |             logger.debug("Validation error: {}", e.getMessage());
231 |             isValid = false;
232 |         }
233 |         return isValid;
234 |     }
235 | 
236 |     /**
237 |      * Adds constraint violations to the provided ConstraintValidatorContext.
238 |      * This method disables the default constraint violation and adds custom violations
239 |      * based on the provided list of CrossFieldConstraintViolation objects.
240 |      *
241 |      * @param context    The ConstraintValidatorContext to which violations will be added
242 |      * @param violations A list of CrossFieldConstraintViolation objects representing the violations to be added
243 |      */
244 |     private void addViolationsToContext(ConstraintValidatorContext context, List<CrossFieldConstraintViolation> violations)
245 |     {
246 |         context.disableDefaultConstraintViolation();
247 |         for (CrossFieldConstraintViolation violation : violations)
248 |         {
249 |             context.buildConstraintViolationWithTemplate(violation.getMessage()).addPropertyNode(violation.getFieldName()).addConstraintViolation();
250 |         }
251 |     }
252 | }
253 | 
254 | 
255 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                                  Apache License
  2 |                            Version 2.0, January 2004
  3 |                         http://www.apache.org/licenses/
  4 | 
  5 |    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
  6 | 
  7 |    1. Definitions.
  8 | 
  9 |       "License" shall mean the terms and conditions for use, reproduction,
 10 |       and distribution as defined by Sections 1 through 9 of this document.
 11 | 
 12 |       "Licensor" shall mean the copyright owner or entity authorized by
 13 |       the copyright owner that is granting the License.
 14 | 
 15 |       "Legal Entity" shall mean the union of the acting entity and all
 16 |       other entities that control, are controlled by, or are under common
 17 |       control with that entity. For the purposes of this definition,
 18 |       "control" means (i) the power, direct or indirect, to cause the
 19 |       direction or management of such entity, whether by contract or
 20 |       otherwise, or (ii) ownership of fifty percent (50%) or more of the
 21 |       outstanding shares, or (iii) beneficial ownership of such entity.
 22 | 
 23 |       "You" (or "Your") shall mean an individual or Legal Entity
 24 |       exercising permissions granted by this License.
 25 | 
 26 |       "Source" form shall mean the preferred form for making modifications,
 27 |       including but not limited to software source code, documentation
 28 |       source, and configuration files.
 29 | 
 30 |       "Object" form shall mean any form resulting from mechanical
 31 |       transformation or translation of a Source form, including but
 32 |       not limited to compiled object code, generated documentation,
 33 |       and conversions to other media types.
 34 | 
 35 |       "Work" shall mean the work of authorship, whether in Source or
 36 |       Object form, made available under the License, as indicated by a
 37 |       copyright notice that is included in or attached to the work
 38 |       (an example is provided in the Appendix below).
 39 | 
 40 |       "Derivative Works" shall mean any work, whether in Source or Object
 41 |       form, that is based on (or derived from) the Work and for which the
 42 |       editorial revisions, annotations, elaborations, or other modifications
 43 |       represent, as a whole, an original work of authorship. For the purposes
 44 |       of this License, Derivative Works shall not include works that remain
 45 |       separable from, or merely link (or bind by name) to the interfaces of,
 46 |       the Work and Derivative Works thereof.
 47 | 
 48 |       "Contribution" shall mean any work of authorship, including
 49 |       the original version of the Work and any modifications or additions
 50 |       to that Work or Derivative Works thereof, that is intentionally
 51 |       submitted to Licensor for inclusion in the Work by the copyright owner
 52 |       or by an individual or Legal Entity authorized to submit on behalf of
 53 |       the copyright owner. For the purposes of this definition, "submitted"
 54 |       means any form of electronic, verbal, or written communication sent
 55 |       to the Licensor or its representatives, including but not limited to
 56 |       communication on electronic mailing lists, source code control systems,
 57 |       and issue tracking systems that are managed by, or on behalf of, the
 58 |       Licensor for the purpose of discussing and improving the Work, but
 59 |       excluding communication that is conspicuously marked or otherwise
 60 |       designated in writing by the copyright owner as "Not a Contribution."
 61 | 
 62 |       "Contributor" shall mean Licensor and any individual or Legal Entity
 63 |       on behalf of whom a Contribution has been received by Licensor and
 64 |       subsequently incorporated within the Work.
 65 | 
 66 |    2. Grant of Copyright License. Subject to the terms and conditions of
 67 |       this License, each Contributor hereby grants to You a perpetual,
 68 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 69 |       copyright license to reproduce, prepare Derivative Works of,
 70 |       publicly display, publicly perform, sublicense, and distribute the
 71 |       Work and such Derivative Works in Source or Object form.
 72 | 
 73 |    3. Grant of Patent License. Subject to the terms and conditions of
 74 |       this License, each Contributor hereby grants to You a perpetual,
 75 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 76 |       (except as stated in this section) patent license to make, have made,
 77 |       use, offer to sell, sell, import, and otherwise transfer the Work,
 78 |       where such license applies only to those patent claims licensable
 79 |       by such Contributor that are necessarily infringed by their
 80 |       Contribution(s) alone or by combination of their Contribution(s)
 81 |       with the Work to which such Contribution(s) was submitted. If You
 82 |       institute patent litigation against any entity (including a
 83 |       cross-claim or counterclaim in a lawsuit) alleging that the Work
 84 |       or a Contribution incorporated within the Work constitutes direct
 85 |       or contributory patent infringement, then any patent licenses
 86 |       granted to You under this License for that Work shall terminate
 87 |       as of the date such litigation is filed.
 88 | 
 89 |    4. Redistribution. You may reproduce and distribute copies of the
 90 |       Work or Derivative Works thereof in any medium, with or without
 91 |       modifications, and in Source or Object form, provided that You
 92 |       meet the following conditions:
 93 | 
 94 |       (a) You must give any other recipients of the Work or
 95 |           Derivative Works a copy of this License; and
 96 | 
 97 |       (b) You must cause any modified files to carry prominent notices
 98 |           stating that You changed the files; and
 99 | 
100 |       (c) You must retain, in the Source form of any Derivative Works
101 |           that You distribute, all copyright, patent, trademark, and
102 |           attribution notices from the Source form of the Work,
103 |           excluding those notices that do not pertain to any part of
104 |           the Derivative Works; and
105 | 
106 |       (d) If the Work includes a "NOTICE" text file as part of its
107 |           distribution, then any Derivative Works that You distribute must
108 |           include a readable copy of the attribution notices contained
109 |           within such NOTICE file, excluding those notices that do not
110 |           pertain to any part of the Derivative Works, in at least one
111 |           of the following places: within a NOTICE text file distributed
112 |           as part of the Derivative Works; within the Source form or
113 |           documentation, if provided along with the Derivative Works; or,
114 |           within a display generated by the Derivative Works, if and
115 |           wherever such third-party notices normally appear. The contents
116 |           of the NOTICE file are for informational purposes only and
117 |           do not modify the License. You may add Your own attribution
118 |           notices within Derivative Works that You distribute, alongside
119 |           or as an addendum to the NOTICE text from the Work, provided
120 |           that such additional attribution notices cannot be construed
121 |           as modifying the License.
122 | 
123 |       You may add Your own copyright statement to Your modifications and
124 |       may provide additional or different license terms and conditions
125 |       for use, reproduction, or distribution of Your modifications, or
126 |       for any such Derivative Works as a whole, provided Your use,
127 |       reproduction, and distribution of the Work otherwise complies with
128 |       the conditions stated in this License.
129 | 
130 |    5. Submission of Contributions. Unless You explicitly state otherwise,
131 |       any Contribution intentionally submitted for inclusion in the Work
132 |       by You to the Licensor shall be under the terms and conditions of
133 |       this License, without any additional terms or conditions.
134 |       Notwithstanding the above, nothing herein shall supersede or modify
135 |       the terms of any separate license agreement you may have executed
136 |       with Licensor regarding such Contributions.
137 | 
138 |    6. Trademarks. This License does not grant permission to use the trade
139 |       names, trademarks, service marks, or product names of the Licensor,
140 |       except as required for reasonable and customary use in describing the
141 |       origin of the Work and reproducing the content of the NOTICE file.
142 | 
143 |    7. Disclaimer of Warranty. Unless required by applicable law or
144 |       agreed to in writing, Licensor provides the Work (and each
145 |       Contributor provides its Contributions) on an "AS IS" BASIS,
146 |       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 |       implied, including, without limitation, any warranties or conditions
148 |       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 |       PARTICULAR PURPOSE. You are solely responsible for determining the
150 |       appropriateness of using or redistributing the Work and assume any
151 |       risks associated with Your exercise of permissions under this License.
152 | 
153 |    8. Limitation of Liability. In no event and under no legal theory,
154 |       whether in tort (including negligence), contract, or otherwise,
155 |       unless required by applicable law (such as deliberate and grossly
156 |       negligent acts) or agreed to in writing, shall any Contributor be
157 |       liable to You for damages, including any direct, indirect, special,
158 |       incidental, or consequential damages of any character arising as a
159 |       result of this License or out of the use or inability to use the
160 |       Work (including but not limited to damages for loss of goodwill,
161 |       work stoppage, computer failure or malfunction, or any and all
162 |       other commercial damages or losses), even if such Contributor
163 |       has been advised of the possibility of such damages.
164 | 
165 |    9. Accepting Warranty or Additional Liability. While redistributing
166 |       the Work or Derivative Works thereof, You may choose to offer,
167 |       and charge a fee for, acceptance of support, warranty, indemnity,
168 |       or other liability obligations and/or rights consistent with this
169 |       License. However, in accepting such obligations, You may act only
170 |       on Your own behalf and on Your sole responsibility, not on behalf
171 |       of any other Contributor, and only if You agree to indemnify,
172 |       defend, and hold each Contributor harmless for any liability
173 |       incurred by, or claims asserted against, such Contributor by reason
174 |       of your accepting any such warranty or additional liability.
175 | 
176 |    END OF TERMS AND CONDITIONS
177 | 
178 |    APPENDIX: How to apply the Apache License to your work.
179 | 
180 |       To apply the Apache License to your work, attach the following
181 |       boilerplate notice, with the fields enclosed by brackets "[]"
182 |       replaced with your own identifying information. (Don't include
183 |       the brackets!)  The text should be enclosed in the appropriate
184 |       comment syntax for the file format. We also recommend that a
185 |       file or class name and description of purpose be included on the
186 |       same "printed page" as the copyright notice for easier
187 |       identification within third-party archives.
188 | 
189 |    Copyright [2023-2024] [Shamkhal Maharramov]
190 | 
191 |    Licensed under the Apache License, Version 2.0 (the "License");
192 |    you may not use this file except in compliance with the License.
193 |    You may obtain a copy of the License at
194 | 
195 |        http://www.apache.org/licenses/LICENSE-2.0
196 | 
197 |    Unless required by applicable law or agreed to in writing, software
198 |    distributed under the License is distributed on an "AS IS" BASIS,
199 |    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 |    See the License for the specific language governing permissions and
201 |    limitations under the License.
202 | 


--------------------------------------------------------------------------------
/src/test/java/io/github/maharramoff/crossfieldvalidation/CrossFieldValidationProcessorTest.java:
--------------------------------------------------------------------------------
  1 | package io.github.maharramoff.crossfieldvalidation;
  2 | 
  3 | import jakarta.validation.*;
  4 | import jakarta.validation.constraints.Email;
  5 | import jakarta.validation.constraints.NotNull;
  6 | import jakarta.validation.constraints.Size;
  7 | import lombok.Getter;
  8 | import org.junit.jupiter.api.*;
  9 | 
 10 | import java.lang.annotation.ElementType;
 11 | import java.lang.annotation.Retention;
 12 | import java.lang.annotation.RetentionPolicy;
 13 | import java.lang.annotation.Target;
 14 | import java.lang.reflect.Field;
 15 | import java.util.List;
 16 | import java.util.Map;
 17 | import java.util.Set;
 18 | 
 19 | import static org.junit.jupiter.api.Assertions.*;
 20 | import static org.mockito.ArgumentMatchers.anyString;
 21 | import static org.mockito.Mockito.*;
 22 | 
 23 | @SuppressWarnings({"FieldCanBeLocal", "unused", "unchecked"})
 24 | class CrossFieldValidationProcessorTest
 25 | {
 26 | 
 27 |     private CrossFieldValidationProcessor validationProcessor;
 28 |     private ConstraintValidatorContext mockContext;
 29 |     private Validator standardValidator;
 30 |     private ValidatorFactory validatorFactory;
 31 | 
 32 |     @BeforeEach
 33 |     void setUp()
 34 |     {
 35 |         validationProcessor = new CrossFieldValidationProcessor();
 36 |         mockContext = createMockContext();
 37 |         validatorFactory = Validation.buildDefaultValidatorFactory();
 38 |         standardValidator = validatorFactory.getValidator();
 39 |     }
 40 | 
 41 |     private ConstraintValidatorContext createMockContext()
 42 |     {
 43 |         ConstraintValidatorContext                                                           context          = mock(ConstraintValidatorContext.class);
 44 |         ConstraintValidatorContext.ConstraintViolationBuilder                                violationBuilder = mock(ConstraintValidatorContext.ConstraintViolationBuilder.class);
 45 |         ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderCustomizableContext nodeBuilder      = mock(ConstraintValidatorContext.ConstraintViolationBuilder.NodeBuilderCustomizableContext.class);
 46 | 
 47 |         when(context.buildConstraintViolationWithTemplate(anyString())).thenReturn(violationBuilder);
 48 |         when(violationBuilder.addPropertyNode(anyString())).thenReturn(nodeBuilder);
 49 |         when(nodeBuilder.addConstraintViolation()).thenReturn(context);
 50 | 
 51 |         return context;
 52 |     }
 53 | 
 54 |     @Nested
 55 |     @DisplayName("Validation Success Cases")
 56 |     class ValidationSuccessTests
 57 |     {
 58 | 
 59 |         @Test
 60 |         void shouldReturnTrueWhenConstraintsSatisfied()
 61 |         {
 62 |             TestObject testObject = new TestObject("password123", "password123");
 63 |             boolean    result     = validationProcessor.isValid(testObject, mockContext);
 64 |             assertTrue(result);
 65 |             verifyNoInteractions(mockContext);
 66 |         }
 67 | 
 68 |         @Test
 69 |         void shouldHandleEmptyObjectGracefully()
 70 |         {
 71 |             EmptyTestObject emptyTestObject = new EmptyTestObject();
 72 |             boolean         result          = validationProcessor.isValid(emptyTestObject, mockContext);
 73 |             assertTrue(result);
 74 |             verifyNoInteractions(mockContext);
 75 |         }
 76 | 
 77 |         @Test
 78 |         void shouldIgnoreNonAnnotatedFields()
 79 |         {
 80 |             TestObjectWithoutAnnotations testObject = new TestObjectWithoutAnnotations("value1", "value2");
 81 |             boolean                      result     = validationProcessor.isValid(testObject, mockContext);
 82 |             assertTrue(result);
 83 |             verifyNoInteractions(mockContext);
 84 |         }
 85 |     }
 86 | 
 87 |     @Nested
 88 |     @DisplayName("Validator Caching and Instantiation")
 89 |     class ValidatorCachingTests
 90 |     {
 91 | 
 92 |         @Test
 93 |         void shouldCacheValidatorInstances()
 94 |         {
 95 |             TestObject testObject = new TestObject("password123", "password123");
 96 |             validationProcessor.isValid(testObject, mockContext);
 97 |             validationProcessor.isValid(testObject, mockContext); // Second call to trigger caching
 98 | 
 99 |             CrossFieldConstraintValidator cachedValidator = validationProcessor.getValidatorForAnnotation(MatchWith.class);
100 |             assertNotNull(cachedValidator);
101 |         }
102 | 
103 |         @Test
104 |         void shouldReturnNullForNonCrossFieldConstraint()
105 |         {
106 |             CrossFieldConstraintValidator validator = validationProcessor.getValidatorForAnnotation(NonCrossFieldConstraint.class);
107 |             assertNull(validator);
108 |         }
109 | 
110 |         @Test
111 |         void shouldThrowExceptionWhenValidatorInstantiationFails()
112 |         {
113 |             IllegalStateException exception = assertThrows(IllegalStateException.class, () ->
114 |                     validationProcessor.getValidatorForAnnotation(InvalidValidatorAnnotation.class));
115 | 
116 |             assertTrue(exception.getMessage().contains("Failed to instantiate validator for"));
117 |         }
118 |     }
119 | 
120 |     @Nested
121 |     @DisplayName("Edge Cases and Special Conditions")
122 |     class EdgeCaseTests
123 |     {
124 | 
125 |         @Test
126 |         @DisplayName("Should fail validation when one field is null and the other is not")
127 |         void shouldFailWhenOneFieldIsNull()
128 |         {
129 |             TestObject testObject = new TestObject(null, "value");
130 |             boolean    result     = validationProcessor.isValid(testObject, mockContext);
131 |             assertFalse(result);
132 |             verify(mockContext).disableDefaultConstraintViolation();
133 |             verify(mockContext).buildConstraintViolationWithTemplate("Fields do not match.");
134 |         }
135 | 
136 |         @Test
137 |         @DisplayName("Should handle objects with inherited fields")
138 |         void shouldHandleInheritedFields()
139 |         {
140 |             SubTestObject testObject = new SubTestObject("password123", "password123", "extraField");
141 |             boolean       result     = validationProcessor.isValid(testObject, mockContext);
142 |             assertTrue(result);
143 |             verifyNoInteractions(mockContext);
144 |         }
145 | 
146 |         @Test
147 |         @DisplayName("Should validate objects with multiple cross-field constraints")
148 |         void shouldValidateMultipleCrossFieldConstraints()
149 |         {
150 |             MultiConstraintTestObject2 testObject = new MultiConstraintTestObject2("value", "value", 5, 5);
151 |             boolean                    result     = validationProcessor.isValid(testObject, mockContext);
152 |             assertTrue(result);
153 |             verifyNoInteractions(mockContext);
154 |         }
155 |     }
156 | 
157 |     @Nested
158 |     @DisplayName("Multiple CrossFieldConstraints Tests")
159 |     class MultipleConstraintsTests
160 |     {
161 | 
162 |         @Test
163 |         void shouldCollectAllViolationsWhenMultipleConstraintsViolated()
164 |         {
165 |             MultiConstraintTestObject testObject = new MultiConstraintTestObject(
166 |                     10, 100, 5, "secret123", "different");
167 |             boolean result = validationProcessor.isValid(testObject, mockContext);
168 |             assertFalse(result);
169 |             verify(mockContext).disableDefaultConstraintViolation();
170 |             verify(mockContext, times(2)).buildConstraintViolationWithTemplate(anyString());
171 |         }
172 |     }
173 | 
174 |     @Nested
175 |     @DisplayName("Combined Constraints Tests")
176 |     class CombinedConstraintsTests
177 |     {
178 | 
179 |         private ValidatorFactory validatorFactory;
180 |         private Validator standardValidator;
181 | 
182 |         @BeforeEach
183 |         void setUpValidators()
184 |         {
185 |             validatorFactory = Validation.buildDefaultValidatorFactory();
186 |             standardValidator = validatorFactory.getValidator();
187 |         }
188 | 
189 |         @AfterEach
190 |         void tearDownValidators()
191 |         {
192 |             validatorFactory.close();
193 |         }
194 | 
195 |         @Test
196 |         void shouldFailWhenStandardConstraintsViolated()
197 |         {
198 |             CombinedConstraintsTestObject testObject = new CombinedConstraintsTestObject(
199 |                     "usr", "pass", "pass", "invalid-email");
200 |             Set<ConstraintViolation<CombinedConstraintsTestObject>> violations = standardValidator.validate(testObject);
201 |             assertFalse(violations.isEmpty());
202 |         }
203 | 
204 |         @Test
205 |         void shouldCollectViolationsFromBothStandardAndCrossFieldConstraints()
206 |         {
207 |             CombinedConstraintsTestObject testObject = new CombinedConstraintsTestObject(
208 |                     "usr", "pass", "different", "invalid-email");
209 |             Set<ConstraintViolation<CombinedConstraintsTestObject>> violations = standardValidator.validate(testObject);
210 |             assertFalse(violations.isEmpty());
211 | 
212 |             boolean crossFieldResult = validationProcessor.isValid(testObject, mockContext);
213 |             assertFalse(crossFieldResult);
214 |             verify(mockContext).disableDefaultConstraintViolation();
215 |             verify(mockContext).buildConstraintViolationWithTemplate("Fields do not match.");
216 | 
217 |             assertFalse(violations.isEmpty());
218 |         }
219 |     }
220 | 
221 | 
222 |     // Test helper methods and classes
223 | 
224 |     @Retention(RetentionPolicy.RUNTIME) @interface NonCrossFieldConstraint
225 |     {
226 |     }
227 | 
228 |     @Retention(RetentionPolicy.RUNTIME)
229 |     @CrossFieldConstraint(validatedBy = NonInstantiableValidator.class) @interface InvalidValidatorAnnotation
230 |     {
231 |     }
232 | 
233 |     static class NonInstantiableValidator implements CrossFieldConstraintValidator
234 |     {
235 |         public NonInstantiableValidator(String arg)
236 |         {
237 |         }
238 | 
239 |         @Override
240 |         public boolean isValid(Object obj, Map<Class<?>, List<Field>> fields, List<CrossFieldConstraintViolation> violations)
241 |         {
242 |             return false;
243 |         }
244 |     }
245 | 
246 |     static class EmptyTestObject
247 |     {
248 |     }
249 | 
250 |     static class TestObjectWithoutAnnotations
251 |     {
252 |         private final String value;
253 |         private final String other;
254 | 
255 |         TestObjectWithoutAnnotations(String value, String other)
256 |         {
257 |             this.value = value;
258 |             this.other = other;
259 |         }
260 |     }
261 | 
262 |     @Target(ElementType.FIELD)
263 |     @Retention(RetentionPolicy.RUNTIME)
264 |     @CrossFieldConstraint(validatedBy = MatchWithValidator.class) @interface MatchWith
265 |     {
266 |         String field();
267 | 
268 |         String message() default "Fields do not match.";
269 |     }
270 | 
271 |     static class MatchWithValidator extends BaseCrossFieldValidator
272 |     {
273 |         @Override
274 |         public boolean isValid(Object obj, Map<Class<?>, List<Field>> fieldMapping, List<CrossFieldConstraintViolation> violations)
275 |         {
276 |             processFields(obj, fieldMapping, MatchWith.class, (field, annotation) ->
277 |             {
278 |                 Object fieldValue      = getProperty(obj, field.getName());
279 |                 Object otherFieldValue = getProperty(obj, annotation.field());
280 | 
281 |                 if (fieldValue == null || !fieldValue.equals(otherFieldValue))
282 |                 {
283 |                     violations.add(new CrossFieldConstraintViolation(field.getName(), annotation.message()));
284 |                 }
285 |             });
286 |             return violations.isEmpty();
287 |         }
288 |     }
289 | 
290 |     @Getter
291 |     @EnableCrossFieldConstraints
292 |     static class TestObject
293 |     {
294 |         private final String value;
295 | 
296 |         @MatchWith(field = "value")
297 |         private final String other;
298 | 
299 |         TestObject(String value, String other)
300 |         {
301 |             this.value = value;
302 |             this.other = other;
303 |         }
304 |     }
305 | 
306 |     @Getter
307 |     @EnableCrossFieldConstraints
308 |     static class MultiConstraintTestObject
309 |     {
310 |         private final Integer minValue;
311 |         private final Integer maxValue;
312 | 
313 |         @GreaterThan(field = "minValue")
314 |         private final Integer currentValue;
315 | 
316 |         @MatchWith(field = "password")
317 |         private final String confirmPassword;
318 | 
319 |         private final String password;
320 | 
321 |         MultiConstraintTestObject(Integer minValue, Integer maxValue, Integer currentValue, String password, String confirmPassword)
322 |         {
323 |             this.minValue = minValue;
324 |             this.maxValue = maxValue;
325 |             this.currentValue = currentValue;
326 |             this.password = password;
327 |             this.confirmPassword = confirmPassword;
328 |         }
329 |     }
330 | 
331 |     @Target(ElementType.FIELD)
332 |     @Retention(RetentionPolicy.RUNTIME)
333 |     @CrossFieldConstraint(validatedBy = GreaterThanValidator.class) @interface GreaterThan
334 |     {
335 |         String field();
336 | 
337 |         String message() default "Field must be greater than {field}.";
338 |     }
339 | 
340 |     static class GreaterThanValidator extends BaseCrossFieldValidator
341 |     {
342 |         @Override
343 |         public boolean isValid(Object obj, Map<Class<?>, List<Field>> fieldMapping, List<CrossFieldConstraintViolation> violations)
344 |         {
345 |             processFields(obj, fieldMapping, GreaterThan.class, (field, annotation) ->
346 |             {
347 |                 Comparable<Object> fieldValue      = (Comparable<Object>) getProperty(obj, field.getName());
348 |                 Object             otherFieldValue = getProperty(obj, annotation.field());
349 |                 if (fieldValue == null || otherFieldValue == null || fieldValue.compareTo(otherFieldValue) <= 0)
350 |                 {
351 |                     String message = annotation.message().replace("{field}", annotation.field());
352 |                     violations.add(new CrossFieldConstraintViolation(field.getName(), message));
353 |                 }
354 |             });
355 |             return violations.isEmpty();
356 |         }
357 |     }
358 | 
359 |     @Getter
360 |     @EnableCrossFieldConstraints
361 |     static class CombinedConstraintsTestObject
362 |     {
363 |         @NotNull
364 |         @Size(min = 5)
365 |         private final String username;
366 | 
367 |         @NotNull
368 |         @Size(min = 8)
369 |         private final String password;
370 | 
371 |         @MatchWith(field = "password")
372 |         private final String confirmPassword;
373 | 
374 |         @NotNull
375 |         @Email
376 |         private final String email;
377 | 
378 |         CombinedConstraintsTestObject(String username, String password, String confirmPassword, String email)
379 |         {
380 |             this.username = username;
381 |             this.password = password;
382 |             this.confirmPassword = confirmPassword;
383 |             this.email = email;
384 |         }
385 |     }
386 | 
387 |     @Getter
388 |     @EnableCrossFieldConstraints
389 |     static class SubTestObject extends TestObject
390 |     {
391 |         private final String extraField;
392 | 
393 |         SubTestObject(String value, String other, String extraField)
394 |         {
395 |             super(value, other);
396 |             this.extraField = extraField;
397 |         }
398 |     }
399 | 
400 |     @Getter
401 |     @EnableCrossFieldConstraints
402 |     static class MultiConstraintTestObject2
403 |     {
404 |         @MatchWith(field = "field2")
405 |         private final String field1;
406 | 
407 |         private final String field2;
408 | 
409 |         @MatchWith(field = "number2")
410 |         private final Integer number1;
411 | 
412 |         private final Integer number2;
413 | 
414 |         MultiConstraintTestObject2(String field1, String field2, Integer number1, Integer number2)
415 |         {
416 |             this.field1 = field1;
417 |             this.field2 = field2;
418 |             this.number1 = number1;
419 |             this.number2 = number2;
420 |         }
421 |     }
422 | 
423 |     @Getter
424 |     @EnableCrossFieldConstraints
425 |     static class NumericTestObject
426 |     {
427 |         @MatchWith(field = "number2")
428 |         private final Integer number1;
429 | 
430 |         private final Integer number2;
431 | 
432 |         NumericTestObject(Integer number1, Integer number2)
433 |         {
434 |             this.number1 = number1;
435 |             this.number2 = number2;
436 |         }
437 |     }
438 | 
439 |     @Getter
440 |     @EnableCrossFieldConstraints
441 |     static class CollectionTestObject
442 |     {
443 |         @MatchWith(field = "list2")
444 |         private final List<String> list1;
445 | 
446 |         private final List<String> list2;
447 | 
448 |         CollectionTestObject(List<String> list1, List<String> list2)
449 |         {
450 |             this.list1 = list1;
451 |             this.list2 = list2;
452 |         }
453 |     }
454 | 
455 |     @Getter
456 |     @EnableCrossFieldConstraints
457 |     static class DefaultValuesTestObject
458 |     {
459 |         @MatchWith(field = "defaultField")
460 |         private final String defaultField = "defaultValue";
461 | 
462 |         private final String anotherField = "defaultValue";
463 |     }
464 | }


--------------------------------------------------------------------------------