Added functionality to include optional fields

Author: ditschedev

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

@@ -2,7 +2,6 @@
 
 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;

src/main/java/dev/ditsche/validator/rule/builder/ArrayRuleBuilder.java

@@ -0,0 +1,16 @@
+package dev.ditsche.validator.rule.builder;
+
+import dev.ditsche.validator.validation.Validatable;
+
+/**
+ * @author Tobias Dittmann
+ */
+public class ArrayRuleBuilder implements Builder {
+
+
+
+    @Override
+    public Validatable build() {
+        return null;
+    }
+}

src/main/java/dev/ditsche/validator/rule/builder/BooleanRuleBuilder.java

@@ -0,0 +1,39 @@
+package dev.ditsche.validator.rule.builder;
+
+import dev.ditsche.validator.rule.Rule;
+import dev.ditsche.validator.rule.ruleset.BooleanRule;
+import dev.ditsche.validator.validation.Validatable;
+import dev.ditsche.validator.validation.ValidationField;
+
+import java.util.LinkedList;
+import java.util.List;
+
+/**
+ * @author Tobias Dittmann
+ */
+public class BooleanRuleBuilder implements Builder {
+
+    private String field;
+
+    private List<Rule> rules;
+
+    public BooleanRuleBuilder(String field) {
+        this.field = field;
+        this.rules = new LinkedList<>();
+    }
+
+    public BooleanRuleBuilder isTrue() {
+        rules.add(new BooleanRule(true));
+        return this;
+    }
+
+    public BooleanRuleBuilder isFalse() {
+        rules.add(new BooleanRule(false));
+        return this;
+    }
+
+    @Override
+    public Validatable build() {
+        return new ValidationField(field, rules);
+    }
+}

src/main/java/dev/ditsche/validator/rule/builder/ObjectRuleBuilder.java

@@ -13,6 +13,8 @@ public class ObjectRuleBuilder implements Builder {
 
     private final String field;
 
+    private boolean optional;
+
     private List<Validatable> children;
 
     ObjectRuleBuilder(String field) {
@@ -30,8 +32,13 @@ public ObjectRuleBuilder child(Validatable validatable) {
         return this;
     }
 
+    public ObjectRuleBuilder optional() {
+        this.optional = true;
+        return this;
+    }
+
     @Override
     public Validatable build() {
-        return new ValidationObject(field, children);
+        return new ValidationObject(field, children, optional);
     }
 }

src/main/java/dev/ditsche/validator/rule/builder/RuleBuilder.java

@@ -0,0 +1,18 @@
+package dev.ditsche.validator.rule.builder;
+
+import dev.ditsche.validator.rule.Rule;
+
+import java.util.List;
+
+/**
+ * @author Tobias Dittmann
+ */
+public abstract class RuleBuilder implements Builder {
+
+    protected String field;
+
+    protected boolean optional;
+
+    protected List<Rule> rules;
+
+}

src/main/java/dev/ditsche/validator/rule/builder/StringRuleBuilder.java

@@ -14,6 +14,8 @@ public class StringRuleBuilder implements Builder {
 
     private final String field;
 
+    private boolean optional = false;
+
     private List<Rule> rules;
 
     StringRuleBuilder(String field) {
@@ -87,13 +89,18 @@ public StringRuleBuilder trim() {
         return this;
     }
 
+    public StringRuleBuilder optional() {
+        this.optional = true;
+        return this;
+    }
+
     public StringRuleBuilder custom(Rule rule) {
         rules.add(rule);
         return this;
     }
 
     public ValidationField build() {
-        return new ValidationField(field, rules);
+        return new ValidationField(field, rules, optional);
     }
 
 }

src/main/java/dev/ditsche/validator/validation/ValidationField.java

@@ -4,8 +4,11 @@
 import dev.ditsche.validator.error.ValidationException;
 import dev.ditsche.validator.rule.Rule;
 import dev.ditsche.validator.rule.RuleResult;
+import dev.ditsche.validator.rule.ruleset.RequiredRule;
 import lombok.Getter;
+import lombok.Setter;
 
+import java.util.LinkedList;
 import java.util.List;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
@@ -23,6 +26,10 @@ public class ValidationField implements Validatable {
     @Getter
     private String field;
 
+    @Getter
+    @Setter
+    private boolean optional = false;
+
     /**
      * Stores the rules assigned to the field.
      */
@@ -35,7 +42,7 @@ public class ValidationField implements Validatable {
      * @param field The fields name.
      */
     public ValidationField(String field) {
-        this(field, new Rule[0]);
+        this(field, new LinkedList<>(), false);
     }
 
     /**
@@ -44,22 +51,18 @@ public ValidationField(String field) {
      * @param field The fields name.
      * @param rules The rules that will be applied.
      */
-    public ValidationField(String field, Rule ...rules) {
-        if(field == null || field.trim().isEmpty())
-            throw new IllegalArgumentException("Validation field requires a valid field name");
-        if(rules == null)
-            throw new IllegalArgumentException("Validation rules cannot be null");
-        this.field = field;
-        this.rules = Stream.of(rules).collect(Collectors.toList());
+    public ValidationField(String field, List<Rule> rules) {
+        this(field, rules, false);
     }
 
-    public ValidationField(String field, List<Rule> rules) {
+    public ValidationField(String field, List<Rule> rules, boolean optional) {
         if(field == null || field.trim().isEmpty())
             throw new IllegalArgumentException("Validation field requires a valid field name");
         if(rules == null)
             throw new IllegalArgumentException("Validation rules cannot be null");
         this.field = field;
         this.rules = rules;
+        this.optional = optional;
     }
 
     /**
@@ -77,6 +80,8 @@ public void addRule(Rule rule) {
     public ValidationResult validate(String parent, Object object, boolean abortEarly) {
         ErrorBag errorBag = new ErrorBag();
         boolean changed = false;
+        if(optional && new RequiredRule().passes(object).isPassed())
+            return new ValidationResult(errorBag, object, false);
         for(Rule rule : rules) {
             RuleResult ruleResult = rule.passes(object);
             if(!ruleResult.isPassed()) {

src/main/java/dev/ditsche/validator/validation/ValidationObject.java

@@ -2,6 +2,7 @@
 
 import dev.ditsche.validator.error.ErrorBag;
 import dev.ditsche.validator.error.FieldNotAccessibleException;
+import dev.ditsche.validator.rule.ruleset.RequiredRule;
 import lombok.Getter;
 import org.apache.commons.lang3.reflect.FieldUtils;
 
@@ -18,18 +19,27 @@ public class ValidationObject implements Validatable {
     @Getter
     private String field;
 
+    private boolean optional;
+
     @Getter
     private List<Validatable> children;
 
     public ValidationObject(String field, List<Validatable> children) {
+        this(field, children, false);
+    }
+
+    public ValidationObject(String field, List<Validatable> children, boolean optional) {
         this.field = field;
         this.children = children;
+        this.optional = optional;
     }
 
     @Override
     public ValidationResult validate(String parent, Object object, boolean abortEarly) {
         ErrorBag errorBag = new ErrorBag();
         boolean changed = false;
+        if(optional && !(new RequiredRule().passes(object).isPassed()))
+            return new ValidationResult(errorBag, object, false);
         List<Field> fieldSet = new ArrayList<>();
         for (Class<?> c = object.getClass(); c != null; c = c.getSuperclass()) {
             Field[] fields = c.getDeclaredFields();