Merge pull request #5 from ditschedev/feature/temporal_fields

ditschedev · web-flow · commit 4f80e9a11190 · 2020-12-30T21:12:08.000+01:00
feature: temporal fields
diff --git a/.DS_Store b/.DS_Store
diff --git a/src/main/java/dev/ditsche/validator/rule/builder/ArrayElementRuleBuilder.java b/src/main/java/dev/ditsche/validator/rule/builder/ArrayElementRuleBuilder.java
@@ -67,7 +67,7 @@ public ArrayElementRuleBuilder size(int min, int max) {
     }
 
     @Override
-    public RuleBuilder custom(Rule rule) {
+    public ArrayElementRuleBuilder custom(Rule rule) {
         this.children.add(rule);
         return this;
     }
diff --git a/src/main/java/dev/ditsche/validator/rule/builder/ArrayRuleBuilder.java b/src/main/java/dev/ditsche/validator/rule/builder/ArrayRuleBuilder.java
@@ -71,7 +71,7 @@ public ArrayRuleBuilder optional() {
     }
 
     @Override
-    public RuleBuilder custom(Rule rule) {
+    public ArrayRuleBuilder custom(Rule rule) {
         this.rules.add(rule);
         return this;
     }
diff --git a/src/main/java/dev/ditsche/validator/rule/builder/BooleanRuleBuilder.java b/src/main/java/dev/ditsche/validator/rule/builder/BooleanRuleBuilder.java
@@ -33,7 +33,7 @@ public BooleanRuleBuilder isFalse() {
     }
 
     @Override
-    public RuleBuilder custom(Rule rule) {
+    public BooleanRuleBuilder custom(Rule rule) {
         this.rules.add(rule);
         return this;
     }
diff --git a/src/main/java/dev/ditsche/validator/rule/builder/NumberRuleBuilder.java b/src/main/java/dev/ditsche/validator/rule/builder/NumberRuleBuilder.java
@@ -46,7 +46,7 @@ public NumberRuleBuilder defaultValue(Number number) {
     }
 
     @Override
-    public RuleBuilder custom(Rule rule) {
+    public NumberRuleBuilder custom(Rule rule) {
         this.rules.add(rule);
         return this;
     }
diff --git a/src/main/java/dev/ditsche/validator/rule/builder/Rules.java b/src/main/java/dev/ditsche/validator/rule/builder/Rules.java
@@ -25,4 +25,8 @@ public static ArrayRuleBuilder array(String field) {
         return new ArrayRuleBuilder(field);
     }
 
+    public static TemporalRuleBuilder temporal(String field) {
+        return new TemporalRuleBuilder(field);
+    }
+
 }
diff --git a/src/main/java/dev/ditsche/validator/rule/builder/StringRuleBuilder.java b/src/main/java/dev/ditsche/validator/rule/builder/StringRuleBuilder.java
@@ -92,7 +92,7 @@ public StringRuleBuilder optional() {
     }
 
     @Override
-    public RuleBuilder custom(Rule rule) {
+    public StringRuleBuilder custom(Rule rule) {
         this.rules.add(rule);
         return this;
     }
diff --git a/src/main/java/dev/ditsche/validator/rule/builder/TemporalRuleBuilder.java b/src/main/java/dev/ditsche/validator/rule/builder/TemporalRuleBuilder.java
@@ -0,0 +1,110 @@
+package dev.ditsche.validator.rule.builder;
+
+import dev.ditsche.validator.rule.Rule;
+import dev.ditsche.validator.rule.ruleset.AfterRule;
+import dev.ditsche.validator.rule.ruleset.BeforeRule;
+import dev.ditsche.validator.rule.ruleset.RequiredRule;
+import dev.ditsche.validator.rule.ruleset.TemporalRule;
+import dev.ditsche.validator.validation.Validatable;
+import dev.ditsche.validator.validation.ValidationField;
+
+import java.sql.Timestamp;
+import java.time.LocalDate;
+import java.time.LocalDateTime;
+import java.time.LocalTime;
+import java.util.Date;
+import java.util.LinkedList;
+
+public class TemporalRuleBuilder extends RuleBuilder {
+
+    private final String field;
+
+    private boolean optional = false;
+
+    TemporalRuleBuilder(String field) {
+        this.field = field;
+        this.rules = new LinkedList<>();
+        this.rules.add(new TemporalRule());
+    }
+
+    public TemporalRuleBuilder optional() {
+        this.optional = true;
+        return this;
+    }
+
+    public TemporalRuleBuilder future() {
+        this.rules.add(new AfterRule());
+        return this;
+    }
+
+    public TemporalRuleBuilder past() {
+        this.rules.add(new BeforeRule());
+        return this;
+    }
+
+    public TemporalRuleBuilder after(LocalDateTime now) {
+        this.rules.add(new AfterRule(now));
+        return this;
+    }
+
+    public TemporalRuleBuilder after(LocalDate now) {
+        this.rules.add(new AfterRule(now));
+        return this;
+    }
+
+    public TemporalRuleBuilder after(LocalTime now) {
+        this.rules.add(new AfterRule(now));
+        return this;
+    }
+
+    public TemporalRuleBuilder after(Timestamp now) {
+        this.rules.add(new AfterRule(now));
+        return this;
+    }
+
+    public TemporalRuleBuilder after(Date now) {
+        this.rules.add(new AfterRule(now));
+        return this;
+    }
+
+    public TemporalRuleBuilder before(LocalDateTime now) {
+        this.rules.add(new BeforeRule(now));
+        return this;
+    }
+
+    public TemporalRuleBuilder before(LocalDate now) {
+        this.rules.add(new BeforeRule(now));
+        return this;
+    }
+
+    public TemporalRuleBuilder before(LocalTime now) {
+        this.rules.add(new BeforeRule(now));
+        return this;
+    }
+
+    public TemporalRuleBuilder before(Timestamp now) {
+        this.rules.add(new BeforeRule(now));
+        return this;
+    }
+
+    public TemporalRuleBuilder before(Date now) {
+        this.rules.add(new BeforeRule(now));
+        return this;
+    }
+
+    public TemporalRuleBuilder required() {
+        this.rules.add(new RequiredRule());
+        return this;
+    }
+
+    @Override
+    public TemporalRuleBuilder custom(Rule rule) {
+        this.rules.add(rule);
+        return this;
+    }
+
+    @Override
+    public Validatable build() {
+        return new ValidationField(this.field, this.rules, this.optional);
+    }
+}
diff --git a/src/main/java/dev/ditsche/validator/rule/ruleset/AfterRule.java b/src/main/java/dev/ditsche/validator/rule/ruleset/AfterRule.java
@@ -0,0 +1,73 @@
+package dev.ditsche.validator.rule.ruleset;
+
+import dev.ditsche.validator.rule.Rule;
+import dev.ditsche.validator.rule.RuleResult;
+
+import java.sql.Timestamp;
+import java.time.LocalDate;
+import java.time.LocalDateTime;
+import java.time.LocalTime;
+import java.time.format.DateTimeFormatter;
+import java.util.Date;
+
+public class AfterRule implements Rule {
+
+    private final LocalDateTime relative;
+
+    public AfterRule() {
+        this(LocalDateTime.now());
+    }
+
+    public AfterRule(Date date) {
+        this(new Timestamp(date.getTime()));
+    }
+
+    public AfterRule(Timestamp date) {
+        this(date.toLocalDateTime());
+    }
+
+    public AfterRule(LocalDate now) {
+        this(LocalDateTime.of(now, LocalTime.MIN));
+    }
+
+    public AfterRule(LocalTime now) {
+        this(LocalDateTime.of(LocalDate.MIN, now));
+    }
+
+    public AfterRule(LocalDateTime now) {
+        relative = now;
+    }
+
+    @Override
+    public RuleResult test(Object value) {
+
+        if(value instanceof Date) {
+            return RuleResult.passes(((Date) value).after(Timestamp.valueOf(relative)));
+        }
+
+        if(value instanceof LocalDateTime) {
+            LocalDateTime dt = (LocalDateTime) value;
+            return RuleResult.passes(dt.isAfter(relative));
+        }
+        if(value instanceof LocalDate) {
+            LocalDate dt = (LocalDate) value;
+            return RuleResult.passes(dt.isAfter(relative.toLocalDate()));
+        }
+        if(value instanceof LocalTime) {
+            LocalTime dt = (LocalTime) value;
+            return RuleResult.passes(dt.isAfter(relative.toLocalTime()));
+        }
+
+        return RuleResult.reject();
+    }
+
+    @Override
+    public String message(String field) {
+        return String.format("The field \"%s\" needs to be after %s", field, relative.format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")));
+    }
+
+    @Override
+    public String getType() {
+        return RULE_TYPE_PREFIX + "temporal.future";
+    }
+}
diff --git a/src/main/java/dev/ditsche/validator/rule/ruleset/BeforeRule.java b/src/main/java/dev/ditsche/validator/rule/ruleset/BeforeRule.java
@@ -0,0 +1,73 @@
+package dev.ditsche.validator.rule.ruleset;
+
+import dev.ditsche.validator.rule.Rule;
+import dev.ditsche.validator.rule.RuleResult;
+
+import java.sql.Timestamp;
+import java.time.LocalDate;
+import java.time.LocalDateTime;
+import java.time.LocalTime;
+import java.time.format.DateTimeFormatter;
+import java.util.Date;
+
+public class BeforeRule implements Rule {
+
+    private final LocalDateTime relative;
+
+    public BeforeRule() {
+        this(LocalDateTime.now());
+    }
+
+    public BeforeRule(Date date) {
+        this(new Timestamp(date.getTime()));
+    }
+
+    public BeforeRule(Timestamp date) {
+        this(date.toLocalDateTime());
+    }
+
+    public BeforeRule(LocalDate now) {
+        this(LocalDateTime.of(now, LocalTime.MIN));
+    }
+
+    public BeforeRule(LocalTime now) {
+        this(LocalDateTime.of(LocalDate.MIN, now));
+    }
+
+    public BeforeRule(LocalDateTime now) {
+        relative = now;
+    }
+
+    @Override
+    public RuleResult test(Object value) {
+
+        if(value instanceof Date) {
+            return RuleResult.passes(((Date) value).before(Timestamp.valueOf(relative)));
+        }
+
+        if(value instanceof LocalDateTime) {
+            LocalDateTime dt = (LocalDateTime) value;
+            return RuleResult.passes(dt.isBefore(relative));
+        }
+        if(value instanceof LocalDate) {
+            LocalDate dt = (LocalDate) value;
+            return RuleResult.passes(dt.isBefore(relative.toLocalDate()));
+        }
+        if(value instanceof LocalTime) {
+            LocalTime dt = (LocalTime) value;
+            return RuleResult.passes(dt.isBefore(relative.toLocalTime()));
+        }
+
+        return RuleResult.reject();
+    }
+
+    @Override
+    public String message(String field) {
+        return String.format("The field \"%s\" needs to be before %s", field, relative.format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")));
+    }
+
+    @Override
+    public String getType() {
+        return RULE_TYPE_PREFIX + "temporal.past";
+    }
+}
diff --git a/src/main/java/dev/ditsche/validator/rule/ruleset/TemporalRule.java b/src/main/java/dev/ditsche/validator/rule/ruleset/TemporalRule.java
@@ -0,0 +1,40 @@
+package dev.ditsche.validator.rule.ruleset;
+
+import dev.ditsche.validator.rule.Rule;
+import dev.ditsche.validator.rule.RuleResult;
+
+import java.time.LocalDate;
+import java.time.LocalDateTime;
+import java.time.LocalTime;
+import java.util.Date;
+
+public class TemporalRule implements Rule {
+
+    @Override
+    public RuleResult test(Object value) {
+
+        if(value instanceof LocalDateTime)
+            return RuleResult.resolve();
+
+        if(value instanceof LocalDate)
+            return RuleResult.resolve();
+
+        if(value instanceof LocalTime)
+            return RuleResult.resolve();
+
+        if(value instanceof Date)
+            return RuleResult.resolve();
+
+        return RuleResult.reject();
+    }
+
+    @Override
+    public String message(String field) {
+        return String.format("The field \"%s\" needs to be a date or timestamp", field);
+    }
+
+    @Override
+    public String getType() {
+        return RULE_TYPE_PREFIX + "type.temporal";
+    }
+}
diff --git a/src/test/java/dev/ditsche/validator/rule/ruleset/AfterRuleTest.java b/src/test/java/dev/ditsche/validator/rule/ruleset/AfterRuleTest.java
@@ -0,0 +1,44 @@
+package dev.ditsche.validator.rule.ruleset;
+
+import org.junit.jupiter.api.Test;
+
+import java.sql.Timestamp;
+import java.time.LocalDate;
+import java.time.LocalDateTime;
+import java.time.LocalTime;
+import java.util.Date;
+import java.util.LinkedList;
+import java.util.stream.Stream;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class AfterRuleTest {
+
+    private final AfterRule afterRule = new AfterRule();
+
+    @Test
+    public void shouldFailIfNoDateIsProvided() {
+        Stream.of(null, 1, new LinkedList<>(), 2.00f, false).forEach(value -> assertThat(afterRule.test(value).isPassed()).isFalse());
+    }
+
+    @Test
+    public void shouldPassWithValidInput() {
+        Stream.of(LocalDate.now(), LocalDateTime.now(), LocalTime.now(), new Date(), new Timestamp(new Date().getTime())).forEach(value -> assertThat(new AfterRule().test(value).isPassed()).isFalse());
+    }
+
+    @Test
+    public void shouldReturnValidErrorMessage() {
+        assertThat(afterRule.message("test")).startsWith("The field \"test\" needs to be after");
+    }
+
+    @Test
+    public void shouldFailIfGivenDateIsBefore() {
+        assertThat(afterRule.test(LocalDateTime.now().plusDays(-1)).isPassed()).isFalse();
+    }
+
+    @Test
+    public void shouldPassIfGivenDateIsAfter() {
+        assertThat(afterRule.test(LocalDateTime.now().plusDays(1)).isPassed()).isTrue();
+    }
+
+}
diff --git a/src/test/java/dev/ditsche/validator/rule/ruleset/BeforeRuleTest.java b/src/test/java/dev/ditsche/validator/rule/ruleset/BeforeRuleTest.java
diff --git a/src/test/java/dev/ditsche/validator/rule/ruleset/TemporalRuleTest.java b/src/test/java/dev/ditsche/validator/rule/ruleset/TemporalRuleTest.java

Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ public ArrayElementRuleBuilder size(int min, int max) {`
`67`	`67`	`}`
`68`	`68`
`69`	`69`	`@Override`
`70`		`- public RuleBuilder custom(Rule rule) {`
	`70`	`+ public ArrayElementRuleBuilder custom(Rule rule) {`
`71`	`71`	`this.children.add(rule);`
`72`	`72`	`return this;`
`73`	`73`	`}`
Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ public ArrayRuleBuilder optional() {`
`71`	`71`	`}`
`72`	`72`
`73`	`73`	`@Override`
`74`		`- public RuleBuilder custom(Rule rule) {`
	`74`	`+ public ArrayRuleBuilder custom(Rule rule) {`
`75`	`75`	`this.rules.add(rule);`
`76`	`76`	`return this;`
`77`	`77`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ public BooleanRuleBuilder isFalse() {`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`@Override`
`36`		`- public RuleBuilder custom(Rule rule) {`
	`36`	`+ public BooleanRuleBuilder custom(Rule rule) {`
`37`	`37`	`this.rules.add(rule);`
`38`	`38`	`return this;`
`39`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ public NumberRuleBuilder defaultValue(Number number) {`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`@Override`
`49`		`- public RuleBuilder custom(Rule rule) {`
	`49`	`+ public NumberRuleBuilder custom(Rule rule) {`
`50`	`50`	`this.rules.add(rule);`
`51`	`51`	`return this;`
`52`	`52`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,4 +25,8 @@ public static ArrayRuleBuilder array(String field) {`
`25`	`25`	`return new ArrayRuleBuilder(field);`
`26`	`26`	`}`
`27`	`27`
	`28`	`+ public static TemporalRuleBuilder temporal(String field) {`
	`29`	`+ return new TemporalRuleBuilder(field);`
	`30`	`+ }`
	`31`	`+`
`28`	`32`	`}`
Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,7 @@ public StringRuleBuilder optional() {`
`92`	`92`	`}`
`93`	`93`
`94`	`94`	`@Override`
`95`		`- public RuleBuilder custom(Rule rule) {`
	`95`	`+ public StringRuleBuilder custom(Rule rule) {`
`96`	`96`	`this.rules.add(rule);`
`97`	`97`	`return this;`
`98`	`98`	`}`