Merge branch 'release/2.0.0'

Author: ditschedev

.travis.yml

@@ -0,0 +1,3 @@
+language: java
+after_success:
+  - bash <(curl -s https://codecov.io/bash)

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>dev.ditsche</groupId>
     <artifactId>validator</artifactId>
-    <version>1.1.3</version>
+    <version>2.0.0-NIGHTLY</version>
 
     <packaging>jar</packaging>
 
@@ -43,17 +43,17 @@
             <artifactId>lombok</artifactId>
             <version>1.18.12</version>
         </dependency>
-        <dependency>
-            <groupId>com.sun.mail</groupId>
-            <artifactId>javax.mail</artifactId>
-            <version>1.6.2</version>
-        </dependency>
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter</artifactId>
             <version>5.6.2</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.apache.commons</groupId>
+            <artifactId>commons-lang3</artifactId>
+            <version>3.10</version>
+        </dependency>
         <dependency>
             <groupId>org.assertj</groupId>
             <artifactId>assertj-core</artifactId>
@@ -82,6 +82,16 @@
 
     <build>
         <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-surefire-plugin</artifactId>
+                <version>2.22.0</version>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-failsafe-plugin</artifactId>
+                <version>2.22.0</version>
+            </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-source-plugin</artifactId>

src/main/java/dev/ditsche/validator/Validator.java

@@ -1,23 +1,24 @@
 package dev.ditsche.validator;
 
 import dev.ditsche.validator.error.ErrorBag;
+import dev.ditsche.validator.error.FieldNotAccessibleException;
+import dev.ditsche.validator.error.ValidationError;
 import dev.ditsche.validator.error.ValidationException;
 import dev.ditsche.validator.rule.*;
+import dev.ditsche.validator.rule.builder.Builder;
+import dev.ditsche.validator.validation.Validatable;
+import dev.ditsche.validator.validation.ValidationResult;
+import org.apache.commons.lang3.reflect.FieldUtils;
 
 import java.lang.reflect.Field;
-import java.lang.reflect.InvocationTargetException;
-import java.lang.reflect.Method;
 import java.util.ArrayList;
 import java.util.Arrays;
-import java.util.LinkedList;
 import java.util.List;
 
 /**
  * Validates an object against a defined schema.
- *
- * @param <T> The type of the validated object.
  */
-public class Validator<T> {
+public class Validator {
 
     /**
      * The error bag for the
@@ -28,7 +29,7 @@ public class Validator<T> {
     /**
      * All registered fields.
      */
-    private List<? extends Validatable> fields;
+    private List<Validatable> fields;
 
     /**
      * Parses a pattern and creates a Rule instance dynamically if it
@@ -39,121 +40,51 @@ public class Validator<T> {
     /**
      * Create a new validator instance based on a given type.
      */
-    public Validator() {
+    private Validator() {
         this.errorBag = new ErrorBag();
         this.ruleParser = new RuleParser();
         this.fields = new ArrayList<>();
     }
 
-    /**
-     * Adds a field to the schema.
-     * You can add any amount of rules for a field.
-     * <p>
-     * When a field is already existing the rules will be added to the fields rules.
-     * Already existing rules will be overwritten.
-     * <p>
-     * The given fields need to have a getter method starting with {@code get} or {@code is}.
-     *
-     * @param field The name of the field.
-     * @param rules The assigned rules.
-     * @return The instance of the validator.
-     */
-    public Validator<T> addField(String field, Rule...rules) {
-        ValidationField vf = fields.stream().filter(f -> f.getField().equals(field))
-                .findFirst().orElse(null);
-        if(vf == null) {
-            fields.add(new ValidationField(field, rules));
-            return this;
-        } else {
-            fields.remove(vf);
-            for(Rule rule : rules) {
-                vf.addRule(rule);
-            }
+    public static Validator fromRules(Builder ...builders) {
+        Validator validator = new Validator();
+        for(Builder builder : builders) {
+            validator.add(builder);
         }
-        fields.add(vf);
-        return this;
+        return validator;
     }
 
-    /**
-     * Adds a field and rules based on a string representation. Divide rule using a
-     * {@code |} symbol. Parameters can be passed using a {@code :} syntax.
-     * E.g: "required|max:50|length:10:50"
-     * <p>
-     * The given fields need to have a getter method starting with {@code get} or {@code is}.
-     *
-     * @param field The name of the field.
-     * @param rulesString he assigned rules in string representation.
-     * @return The instance of the validator.
-     */
-    public Validator<T> addField(String field, String rulesString) {
-        String[] rules = rulesString.split("\\|");
-        Rule[] parsed = new Rule[rules.length];
-        for(int i = 0; i < rules.length; i++) {
-            int finalI = i;
-            ruleParser.parse(rules[i]).ifPresent(rule -> parsed[finalI] = rule);
+    public static Validator fromRules(Validatable ...rules) {
+        Validator validator = new Validator();
+        for(Validatable validatable : rules) {
+            validator.add(validatable);
         }
-        return addField(field, parsed);
+        return validator;
     }
 
-    /**
-     * Adds a field using the ValidationField class.
-     *
-     * @param validationField
-     * @return
-     */
-    public Validator<T> addField(ValidationField validationField) {
-        return addField(validationField.getField(), (Rule[]) validationField.getRules().toArray());
+    public static Validator empty() {
+        return new Validator();
     }
 
-    /**
-     * Adds a field using the ValidationObject class.
-     *
-     * @param validationField
-     * @return
-     */
-    public Validator<T> addField(ValidationObject validationObject) {
-        return null;
+    public Validator add(Builder builder) {
+        return add(builder.build());
     }
 
-    public T validate(T object) throws ValidationException, IllegalAccessException {
-        return validate(object, false);
+    public Validator add(Validatable validatable) {
+        this.fields.add(validatable);
+        return this;
     }
 
-    /**
-     * Validates an object against a schema and returns an error bag.
-     *
-     * @param object The object that need to be validated.
-     * @throws ValidationException Thrown when at least one rule fails.
-     * @throws IllegalAccessException Thrown when the field is not public.
-     */
-    public T validate(T object, boolean abortEarly) throws ValidationException, IllegalAccessException {
-        errorBag.clear();
-        List<Field> fieldSet = new ArrayList<>();
-        for (Class<?> c = object.getClass(); c != null; c = c.getSuperclass())
-        {
-            Field[] fields = c.getDeclaredFields();
-            fieldSet.addAll(Arrays.asList(fields));
-        }
-        for(Validatable validatable : this.fields) {
-            Field field = fieldSet.stream().filter(f -> f.getName().equals(validatable.getField())).findFirst().orElse(null);
-            if(field == null) continue;
-            Object value = getValue(field, object);
-            errorBag.merge(validatable.validate(value, abortEarly));
-        }
-        if(!errorBag.isEmpty())
-            throw new ValidationException(errorBag);
-
-        return object;
+    public <T> T validate(T object) {
+        return validate(object, false);
     }
 
     /**
      * Validates an object against a schema and returns an error bag.
      *
      * @param object The object that need to be validated.
-     * @throws ValidationException Thrown when at least one rule fails.
-     * @throws IllegalAccessException Thrown when the field is not public.
      */
-    public void tryValidate(T object) throws ValidationException, IllegalAccessException {
+    public <T> T validate(T object, boolean abortEarly) {
         errorBag.clear();
         List<Field> fieldSet = new ArrayList<>();
         for (Class<?> c = object.getClass(); c != null; c = c.getSuperclass())
@@ -162,39 +93,22 @@ public void tryValidate(T object) throws ValidationException, IllegalAccessExcep
             fieldSet.addAll(Arrays.asList(fields));
         }
         for(Validatable validatable : this.fields) {
-            Field field = fieldSet.stream().filter(f -> f.getName().equals(validatable.getField())).findFirst().orElse(null);
-            if(field == null) continue;
-            Object value = getValue(field, object);
-            errorBag.merge(validatable.validate(value, abortEarly));
+            try {
+                Field field = fieldSet.stream().filter(f -> f.getName().equals(validatable.getField())).findFirst().orElse(null);
+                if(field == null) continue;
+                Object value = FieldUtils.readField(field, object, true);
+                ValidationResult result = validatable.validate("", value, abortEarly);
+                if(result.isChanged())
+                    FieldUtils.writeField(field, object, result.getValue(), true);
+                errorBag.merge(result.getErrorBag());
+            } catch (IllegalAccessException ex) {
+                throw new FieldNotAccessibleException();
+            }
         }
         if(!errorBag.isEmpty())
             throw new ValidationException(errorBag);
-    }
 
-    /**
-     * Uses reflection to invoke a getter of the validation target.
-     * Falls back to the fields default getter. Will fail if the variable
-     * is not publicly accessible.
-     *
-     * @param field The field name whose value should be received.
-     * @param object The validation target object.
-     * @return {@code null} if the field cannot be resolved, or the value.
-     */
-    private Object getValue(Field field, Object object) throws IllegalAccessException {
-        for (Method method : object.getClass().getMethods()) {
-            if ((method.getName().startsWith("get")) && (method.getName().length() == (field.getName().length() + 3)) ||
-                    (method.getName().startsWith("is")) && (method.getName().length() == (field.getName().length() + 2))) {
-                if (method.getName().toLowerCase().endsWith(field.getName().toLowerCase())) {
-                    try {
-                        return method.invoke(object);
-                    }
-                    catch (IllegalAccessException | InvocationTargetException e) {
-                        e.printStackTrace();
-                    }
-                }
-            }
-        }
-        return field.get(object);
+        return object;
     }
 
     /**

src/main/java/dev/ditsche/validator/error/ErrorBag.java

@@ -3,9 +3,7 @@
 import lombok.Getter;
 
 import java.util.HashMap;
-import java.util.LinkedList;
 import java.util.List;
-import java.util.Map;
 
 /**
  * The error bag holds the fields for which at least one rule has not passed.

src/main/java/dev/ditsche/validator/error/ValueNotAccessibleException.java renamed to src/main/java/dev/ditsche/validator/error/FieldNotAccessibleException.java

@@ -3,5 +3,5 @@
 /**
  * @author Tobias Dittmann
  */
-public class ValueNotAccessibleException extends RuntimeException {
+public class FieldNotAccessibleException extends RuntimeException {
 }

src/main/java/dev/ditsche/validator/error/ValidationError.java

@@ -4,7 +4,6 @@
 import lombok.Data;
 import lombok.NoArgsConstructor;
 
-import java.util.ArrayList;
 import java.util.LinkedList;
 import java.util.List;
 

src/main/java/dev/ditsche/validator/error/ValidationException.java

@@ -1,9 +1,6 @@
 package dev.ditsche.validator.error;
 
 import java.util.Collection;
-import java.util.HashMap;
-import java.util.HashSet;
-import java.util.List;
 
 /**
  * Thrown when the validation of an object fails.

src/main/java/dev/ditsche/validator/rule/Rule.java

@@ -12,7 +12,7 @@ public interface Rule {
      * @param value The value that will be tested.
      * @return {@code true} if the test passes, {@code false} if not.
      */
-    boolean passes(Object value);
+    RuleResult passes(Object value);
 
     /**
      * The error message, when the test does not pass.

src/main/java/dev/ditsche/validator/rule/RuleMap.java

@@ -1,7 +1,6 @@
 package dev.ditsche.validator.rule;
 
-import dev.ditsche.validator.rule.builder.StringRuleBuilder;
-import dev.ditsche.validator.ruleset.*;
+import dev.ditsche.validator.rule.ruleset.*;
 
 import java.util.HashMap;
 import java.util.Optional;
@@ -37,6 +36,12 @@ private void init() {
         add("email", new RuleInfo(EmailRule.class));
         add("size", new RuleInfo(SizeRule.class, long.class, long.class));
         add("pattern", new RuleInfo(PatternRule.class, String.class));
+        add("ip", new RuleInfo(IpAddressRule.class));
+        add("creditCard", new RuleInfo(CreditCardRule.class));
+        add("length", new RuleInfo(LengthRule.class, long.class));
+        add("number", new RuleInfo(NumberRule.class));
+        add("string", new RuleInfo(StringRule.class));
+        add("default", new RuleInfo(DefaultRule.class, Object.class));
     }
 
     /**

src/main/java/dev/ditsche/validator/rule/RuleResult.java

@@ -0,0 +1,37 @@
+package dev.ditsche.validator.rule;
+
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+/**
+ * @author Tobias Dittmann
+ */
+@Data
+@NoArgsConstructor
+@AllArgsConstructor
+public class RuleResult {
+
+    private boolean passed;
+
+    private Object value;
+
+    private boolean changed;
+
+    public static RuleResult passes(boolean passes) {
+        return new RuleResult(passes, null, false);
+    }
+
+    public static RuleResult resolve() {
+        return new RuleResult(true, null, false);
+    }
+
+    public static RuleResult resolve(Object object) {
+        return new RuleResult(true, object, true);
+    }
+
+    public static RuleResult reject() {
+        return new RuleResult(false, null, false);
+    }
+
+}