From e9b68d9931fb530e2a1dd333e7395b271c75bce9 Mon Sep 17 00:00:00 2001
From: Thibault Meyer <meyer.thibault@gmail.com>
Date: Fri, 24 Feb 2023 07:19:36 +0100
Subject: [PATCH] Add Unit tests "isValid" and update README

Resolves: #5
Signed-off-by: Thibault Meyer <meyer.thibault@gmail.com>
---
 README.md                                     |  5 ++++
 .../io/github/thibaultmeyer/cuid/CUID.java    |  2 +-
 .../github/thibaultmeyer/cuid/CUIDv1Test.java | 26 +++++++++++++++++++
 .../github/thibaultmeyer/cuid/CUIDv2Test.java | 26 +++++++++++++++++++
 4 files changed, 58 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 1480c93..09031d2 100644
--- a/README.md
+++ b/README.md
@@ -51,6 +51,11 @@ final CUID cuid = CUID.fromString("cl9gts1kw00393647w1z4v2tc");
 System.out.println("CUID: " + cuid);
 ```
 
+```java
+final boolean isValid = CUID.isValid("cl9gts1kw00393647w1z4v2tc");
+System.out.println("Is 'cl9gts1kw00393647w1z4v2tc' a valid CUID ? " + isValid);
+```
+
 
 ## License
 This project is released under terms of the [MIT license](https://raw.githubusercontent.com/thibaultmeyer/cuid-java/master/LICENSE).
diff --git a/src/main/java/io/github/thibaultmeyer/cuid/CUID.java b/src/main/java/io/github/thibaultmeyer/cuid/CUID.java
index 1ea3c2a..9db680c 100644
--- a/src/main/java/io/github/thibaultmeyer/cuid/CUID.java
+++ b/src/main/java/io/github/thibaultmeyer/cuid/CUID.java
@@ -108,7 +108,7 @@ public static CUID fromString(final String cuidAsString) {
      * Checks the {@code CUID} from the string standard representation.
      *
      * @param cuidAsString A string that specifies a {@code CUID} (Version 1 or 2)
-     * @return {@code true} If the string is not conform, otherwise, {@code false}
+     * @return {@code true} If the string is conforms, otherwise, {@code false}
      * @since 1.0.0
      */
     public static boolean isValid(final String cuidAsString) {
diff --git a/src/test/java/io/github/thibaultmeyer/cuid/CUIDv1Test.java b/src/test/java/io/github/thibaultmeyer/cuid/CUIDv1Test.java
index d6b3208..d7cd0d5 100644
--- a/src/test/java/io/github/thibaultmeyer/cuid/CUIDv1Test.java
+++ b/src/test/java/io/github/thibaultmeyer/cuid/CUIDv1Test.java
@@ -42,6 +42,32 @@ void fromStringInvalid() {
         Assertions.assertEquals("CUID string is invalid: 'invalid-cuid'", exception.getMessage());
     }
 
+    @Test
+    void isValid() {
+
+        // Arrange
+        final String cuidAsString = "cl9gts1kw00393647w1z4v2tc";
+
+        // Act
+        final boolean isValid = CUID.isValid(cuidAsString);
+
+        // Assert
+        Assertions.assertTrue(isValid);
+    }
+
+    @Test
+    void isValidInvalid() {
+
+        // Arrange
+        final String cuidAsString = "not-a-cuid";
+
+        // Act
+        final boolean isValid = CUID.isValid(cuidAsString);
+
+        // Assert
+        Assertions.assertFalse(isValid);
+    }
+
     @Test
     void randomCUID() {
 
diff --git a/src/test/java/io/github/thibaultmeyer/cuid/CUIDv2Test.java b/src/test/java/io/github/thibaultmeyer/cuid/CUIDv2Test.java
index 08e533b..042b624 100644
--- a/src/test/java/io/github/thibaultmeyer/cuid/CUIDv2Test.java
+++ b/src/test/java/io/github/thibaultmeyer/cuid/CUIDv2Test.java
@@ -43,6 +43,32 @@ void fromStringInvalid() {
         Assertions.assertEquals("CUID string is invalid: 'invalid-cuid'", exception.getMessage());
     }
 
+    @Test
+    void isValid() {
+
+        // Arrange
+        final String cuidAsString = "n1ht3jch1r23dy9ramd6ts16";
+
+        // Act
+        final boolean isValid = CUID.isValid(cuidAsString);
+
+        // Assert
+        Assertions.assertTrue(isValid);
+    }
+
+    @Test
+    void isValidInvalid() {
+
+        // Arrange
+        final String cuidAsString = "not-a-cuid";
+
+        // Act
+        final boolean isValid = CUID.isValid(cuidAsString);
+
+        // Assert
+        Assertions.assertFalse(isValid);
+    }
+
     @Test
     void randomCUIDv2() {