release: 2.3.0 (#8)

* Update readme and test

* [maven-release-plugin] prepare release v2.3.0

* [maven-release-plugin] prepare for next development iteration

Author: ditschedev

README.md

@@ -14,6 +14,7 @@ A rule based validator developed for easy use with the Spring Boot framework.
     - [`number` rules](#number-rules)
     - [`object` rules](#object-rules)
     - [`array` rules](#array-rules)
+    - [`temporal` rules](#temporal-rules)
 - [Use with Spring Boot](#use-with-spring-boot)
 - [Custom rules](#custom-rules)
 
@@ -27,7 +28,7 @@ To use the validator add the following dependency to your `pom.xml`.
 <dependency>
     <groupId>dev.ditsche</groupId>
     <artifactId>validator</artifactId>
-    <version>2.2.0</version>
+    <version>2.3.0</version>
 </dependency>
 ```
 
@@ -48,7 +49,8 @@ Validator validator = Validator.fromRules(
     string("gender").optional().defaultValue("m").max(1),
     number("age").required().min(18),
     object("tickets").fields(
-        string("event").required().trim()
+        string("event").required().trim(),
+        temporal("date").required().future()
     )
 );
 ```
@@ -256,7 +258,40 @@ an array of elements you have to use the `elements` method which returns an `Arr
 - ##### `elements()`
     Returns an `ArrayElementRuleBuilder` which has access to nearly every rule from above as
     the type of the arrays elements is unknown.
-    
+
+
+---
+
+### `temporal` rules
+
+#### Usage
+The following snippet returns an instance of the `TemporalRuleBuilder` class.
+```java
+temporal(field)
+```
+
+#### Available rules
+
+- ##### `required()`
+  Marks the field as *required* meaning it cannot be null or empty.
+
+- ##### `optional()`
+  Marks the field as *optional*. All rules behind this rule can fail.
+
+- ##### `past()`
+  Checks if the *value* is before the current timestamp.
+
+- ##### `future()`
+  Checks if the *value* is after the current timestamp.
+
+- ##### `before(temporal)`
+  Takes a temporal object, for example `LocalDateTime`, `LocalDate` or `Date` and compares this to the value. Returns `true`, if the objects value is smaller than the given parameter.
+
+- ##### `after(temporal)`
+  Takes a temporal object, for example `LocalDateTime`, `LocalDate` or `Date` and compares this to the value. Returns `true`, if the objects value is greater than the given parameter.
+
+- ##### `custom(Rule)`
+  Registers a custom defined rule.
 
 ---
 

pom.xml

@@ -4,7 +4,7 @@
 
     <groupId>dev.ditsche</groupId>
     <artifactId>validator</artifactId>
-    <version>2.2.1-SNAPSHOT</version>
+    <version>2.3.1-SNAPSHOT</version>
 
     <packaging>jar</packaging>
 

src/test/java/dev/ditsche/validator/ValidatorTest.java

@@ -5,6 +5,8 @@
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
+import java.time.LocalDateTime;
+
 import static dev.ditsche.validator.rule.builder.Rules.*;
 import static org.assertj.core.api.Assertions.assertThat;
 
@@ -20,16 +22,17 @@ public void setUp() {
     @Test
     public void shouldValidateExample() {
         final String email = "[email protected]  ";
-        TestEntity testEntity = new TestEntity("Mr", email, "Tobias", 4, new NestedEntity("Max"), true, new int[2], null);
+        TestEntity testEntity = new TestEntity("Mr", email, "Tobias", 4, new NestedEntity("Max", LocalDateTime.now().minusDays(2)), true, new int[2], null);
         assertThat(email).isEqualTo(testEntity.getEmail());
         validator = Validator.fromRules(
                 array("elements").required().max(2),
                 string("title").required().trim().max(3),
                 string("email").required().trim().email(),
                 string("firstName").defaultValue("").trim().alphanum().max(80),
                 number("count").max(5),
-                object("nestedEntity").child(
-                        string("name").required().trim().min(1)
+                object("nestedEntity").fields(
+                        string("name").required().trim().min(1),
+                        temporal("created").required().past()
                 ),
                 bool("active").isTrue()
         );
@@ -41,7 +44,7 @@ public void shouldValidateExample() {
     @Test
     public void shouldValidateNestedArray() {
         final String email = "[email protected]  ";
-        TestEntity testEntity = new TestEntity("Mr", email, "Tobias", 4, new NestedEntity("Max"), true, null, null);
+        TestEntity testEntity = new TestEntity("Mr", email, "Tobias", 4, new NestedEntity("Max", LocalDateTime.now().plusDays(2)), true, null, null);
         assertThat(email).isEqualTo(testEntity.getEmail());
         validator = Validator.fromRules(
                 array("elements").optional().elements().max(10),
@@ -52,8 +55,9 @@ public void shouldValidateNestedArray() {
                 string("email").required().trim().email(),
                 string("firstName").defaultValue("").trim().alphanum().max(80),
                 number("count").max(5),
-                object("nestedEntity").child(
-                        string("name").required().trim().min(1)
+                object("nestedEntity").fields(
+                        string("name").required().trim().min(1),
+                        temporal("created").required().future()
                 ),
                 bool("active").isTrue()
         );
@@ -107,14 +111,15 @@ public void shouldSkipOptionalNestedPropertyIfNotSet() {
     @Test
     public void shouldValidateOptionalNestedPropertyIfSet() {
         final String name = "  Test   ";
-        TestEntity testEntity = new TestEntity("Mr", "[email protected]", null, 3, new NestedEntity(name), true, null, null);
+        TestEntity testEntity = new TestEntity("Mr", "[email protected]", null, 3, new NestedEntity(name, null), true, null, null);
         validator = Validator.fromRules(
                 string("title").required().trim().max(3),
                 string("email").required().trim().email(),
                 string("firstName").optional().trim().alphanum().max(80),
                 number("count").max(5),
                 object("nestedEntity").optional().fields(
-                        string("name").required().trim().min(1)
+                        string("name").required().trim().min(1),
+                        temporal("created").optional().past()
                 )
         );
         testEntity = validator.validate(testEntity);

src/test/java/dev/ditsche/validator/dto/NestedEntity.java

@@ -3,6 +3,8 @@
 import lombok.AllArgsConstructor;
 import lombok.Data;
 
+import java.time.LocalDateTime;
+
 /**
  * @author Tobias Dittmann
  */
@@ -12,4 +14,6 @@ public class NestedEntity {
 
     public String name;
 
+    public LocalDateTime created;
+
 }