From 72b527d5e4cc8190f7b1c7ac6b089f18ac227f0a Mon Sep 17 00:00:00 2001
From: gabriel-logan <gabrielcoutolima@protonmail.ch>
Date: Sat, 13 Jul 2024 16:27:21 -0300
Subject: [PATCH] chore: update docs

---
 .idea/workspace.xml                 |   8 +-
 docs/SUMMARY.md                     | 148 ----------------
 docs/classes/CnpjValidator.md       |  12 +-
 docs/classes/CreditCardValidator.md |  14 +-
 docs/classes/FileValidator.md       |  79 +++++++--
 docs/classes/Validator.md           | 254 ++++++++++++++++++++++++----
 6 files changed, 319 insertions(+), 196 deletions(-)
 delete mode 100644 docs/SUMMARY.md

diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index b67c0ea..0503b9b 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -4,7 +4,13 @@
     <option name="autoReloadType" value="SELECTIVE" />
   </component>
   <component name="ChangeListManager">
-    <list default="true" id="22c9667a-e00d-49e2-aa6d-da35dd213aa7" name="Changes" comment="" />
+    <list default="true" id="22c9667a-e00d-49e2-aa6d-da35dd213aa7" name="Changes" comment="">
+      <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/docs/SUMMARY.md" beforeDir="false" />
+      <change beforePath="$PROJECT_DIR$/docs/classes/CnpjValidator.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/classes/CnpjValidator.md" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/docs/classes/FileValidator.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/classes/FileValidator.md" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/docs/classes/Validator.md" beforeDir="false" afterPath="$PROJECT_DIR$/docs/classes/Validator.md" afterDir="false" />
+    </list>
     <option name="SHOW_DIALOG" value="false" />
     <option name="HIGHLIGHT_CONFLICTS" value="true" />
     <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
deleted file mode 100644
index 79631f4..0000000
--- a/docs/SUMMARY.md
+++ /dev/null
@@ -1,148 +0,0 @@
-> [!NOTE]
-> I accept help to make the version of the other programming languages.
-
-# Multiform-validator
-
-## JAVA >=8
-
-## Official Website
-
-- [Multiform Validator - Website](https://multiformvalidator.netlify.app/documentation)
-
-## Source code
-
-- [Multiform-Validator](https://github.com/Multiform-Validator/java/)
-
-## 📦 Download / Installation
-
-follow the steps below to use the library in your project.
-
-- [jitpack.io](https://jitpack.io/#Multiform-Validator/java) - Multiform Validator
-
-<details>
-  <summary>Gradle</summary>
-
-Step 1. Add the JitPack repository to your build file
-
-Add it in your root build.gradle at the end of repositories:
-
-```gradle
-dependencyResolutionManagement {
-    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
-    repositories {
-        mavenCentral()
-        maven { url 'https://jitpack.io' }
-    }
-}
-```
-
-Step 2. Add the dependency
-
-```gradle
-dependencies {
-        implementation 'com.github.Multiform-Validator:java:0.0.4'
-}
-```
-
-</details>
-
-<details>
-  <summary>Maven</summary>
-
-Step 1. Add the JitPack repository to your build file
-
-```xml
-
-<repositories>
-    <repository>
-        <id>jitpack.io</id>
-        <url>https://jitpack.io</url>
-    </repository>
-</repositories>
-```
-
-Step 2. Add the dependency
-
-```xml
-
-<dependency>
-    <groupId>com.github.Multiform-Validator</groupId>
-    <artifactId>java</artifactId>
-    <version>0.0.4</version>
-</dependency>
-```
-
-</details>
-
-<details>
-  <summary>Sbt</summary>
-
-Step 1. Add the JitPack repository to your build file
-
-Add it in your build.sbt at the end of resolvers:
-
-```sbt
-resolvers += "jitpack" at "https://jitpack.io"
-```
-
-Step 2. Add the dependency
-
-```sbt
-libraryDependencies += "com.github.Multiform-Validator" % "java" % "0.0.4"
-```
-
-</details>
-
-<details>
-  <summary>Leiningen</summary>
-
-Step 1. Add the JitPack repository to your build file
-
-Add it in your project.clj at the end of repositories:
-
-```clojure
-:repositories [["jitpack" "https://jitpack.io"]]
-```
-
-Step 2. Add the dependency
-
-```clojure
-:dependencies [[com.github.Multiform-Validator/java "0.0.4"]]
-```
-
-</details>
-
-## Available methods - JAVA (0.0.4)v
-
-- [CnpjValidator](https://multiform-validator.github.io/java/classes/CnpjValidator)
-
-- [CpfValidator](https://multiform-validator.github.io/java/classes/CpfValidator)
-
-- [CreditCardValidator](https://multiform-validator.github.io/java/classes/CreditCardValidator)
-
-- [FileValidator](https://multiform-validator.github.io/java/classes/FileValidator)
-
-- [Utils](https://multiform-validator.github.io/java/classes/Utils)
-
-- [Validate](https://multiform-validator.github.io/java/classes/Validate)
-
-- [Validator](https://multiform-validator.github.io/java/classes/Validator)
-
-## Example how to use
-
-### CnpjValidator
-
-```java
-// You can import the class or use the full path
-
-import io.github.multiform_validator.CnpjValidator;
-
-public class Main {
-    public static void main(String[] args) {
-        String cnpjTrue = "69.807.668/0001-41";
-        String cnpjFalse = "61.807.661/0001-48";
-        System.out.println(CnpjValidator.cnpjIsValid(cnpjTrue)); // true
-        System.out.println(CnpjValidator.cnpjIsValid(cnpjFalse)); // false
-    }
-}
-```
diff --git a/docs/classes/CnpjValidator.md b/docs/classes/CnpjValidator.md
index 7a0a99a..828d38a 100644
--- a/docs/classes/CnpjValidator.md
+++ b/docs/classes/CnpjValidator.md
@@ -12,10 +12,18 @@ import io.github.multiform_validator.CnpjValidator;
 
 public class Main {
     public static void main(String[] args) {
+        System.out.println(cnpjIsTrue()); // true
+        System.out.println(cnpjIsFalse()); // false
+    }
+    
+    public static boolean cnpjIsTrue() {
         String cnpjTrue = "69.807.668/0001-41";
+        return CnpjValidator.cnpjIsValid(cnpjTrue);
+    }
+    
+    public static boolean cnpjIsFalse() {
         String cnpjFalse = "61.807.661/0001-48";
-        System.out.println(CnpjValidator.cnpjIsValid(cnpjTrue)); // true
-        System.out.println(CnpjValidator.cnpjIsValid(cnpjFalse)); // false
+        return CnpjValidator.cnpjIsValid(cnpjFalse);
     }
 }
 ```
diff --git a/docs/classes/CreditCardValidator.md b/docs/classes/CreditCardValidator.md
index 72d3c3f..1656208 100644
--- a/docs/classes/CreditCardValidator.md
+++ b/docs/classes/CreditCardValidator.md
@@ -12,10 +12,16 @@ import io.github.multiform_validator.CreditCardValidator;
 
 public class Main {
     public static void main(String[] args) {
-        String creditCardTrue = "4532 8770 0040 4166";
-        String creditCardFalse = "4532 8770 0040 4167";
-        System.out.println(CreditCardValidator.isCreditCardValid(creditCardTrue)); // true
-        System.out.println(CreditCardValidator.isCreditCardValid(creditCardFalse)); // false
+        valid();
+        invalid();
+    }
+    
+    private static void valid() {
+        System.out.println(CreditCardValidator.isCreditCardValid("4532 8770 0040 4166")); // true
+    }
+    
+    private static void invalid() {
+        System.out.println(CreditCardValidator.isCreditCardValid("4532 8770 0040 4167")); // false
     }
 }
 ```
diff --git a/docs/classes/FileValidator.md b/docs/classes/FileValidator.md
index 3829b63..64f5658 100644
--- a/docs/classes/FileValidator.md
+++ b/docs/classes/FileValidator.md
@@ -21,28 +21,85 @@ The `FileValidator` class is used to validate files. It has the following method
 
 ## How to use
 
+### isValidAudio
+
 ```java
-import io.github.multiform_validator.FileValidator;
+import static io.github.multiform_validator.FileValidator.isValidAudio;
 
 import java.io.File;
 
 public class Main {
     public static void main(String[] args) {
-        File file = new File("path/to/file");
-        System.out.println(FileValidator.isValidAudio(file)); // true | false
-        System.out.println(FileValidator.isValidImage(file)); // true | false
-        System.out.println(FileValidator.isValidPdf(file)); // true | false
-        System.out.println(FileValidator.isValidTxt(file)); // true | false
-
+        File file = new File("src/main/resources/audio.mp3");
+        System.out.println(isValidAudio(file)); // true | false
+        
         exampleExcludingExtensions();
     }
-
+    
     public static void exampleExcludingExtensions() {
-        File file = new File("path/to/file");
+        File file = new File("src/main/resources/audio.mp3");
         String[] audioExtensions = {"mp3"};
+        System.out.println(isValidAudio(file, audioExtensions)); // false
+    }
+}
+```
+
+### isValidImage
+
+```java
+import static io.github.multiform_validator.FileValidator.isValidImage;
+
+import java.io.File;
+
+public class Main {
+    public static void main(String[] args) {
+        File file = new File("src/main/resources/image.png");
+        System.out.println(isValidImage(file)); // true | false
+        
+        exampleExcludingExtensions();
+        example2ExcludingExtensions();
+    }
+    
+    public static void exampleExcludingExtensions() {
+        File file = new File("src/main/resources/image.png");
         String[] imageExtensions = {"ico", "jpeg", "png"};
-        System.out.println(FileValidator.isValidAudio(file, audioExtensions)); // true | false
-        System.out.println(FileValidator.isValidImage(file, imageExtensions)); // false | true
+        System.out.println(isValidImage(file, imageExtensions)); // false
+    }
+    
+    public static void example2ExcludingExtensions() {
+        File file = new File("src/main/resources/image.png");
+        String[] imageExtensions = {"ico", "jpeg"};
+        System.out.println(isValidImage(file, imageExtensions)); // true | false
+    }
+}
+```
+
+### isValidPdf
+
+```java
+import static io.github.multiform_validator.FileValidator.isValidPdf;
+
+import java.io.File;
+
+public class Main {
+    public static void main(String[] args) {
+        File file = new File("src/main/resources/file.pdf");
+        System.out.println(isValidPdf(file)); // true | false
+    }
+}
+```
+
+### isValidTxt
+
+```java
+import static io.github.multiform_validator.FileValidator.isValidTxt;
+
+import java.io.File;
+
+public class Main {
+    public static void main(String[] args) {
+        File file = new File("src/main/resources/file.txt");
+        System.out.println(isValidTxt(file)); // true | false
     }
 }
 ```
diff --git a/docs/classes/Validator.md b/docs/classes/Validator.md
index 24c34a4..0cd1e01 100644
--- a/docs/classes/Validator.md
+++ b/docs/classes/Validator.md
@@ -25,41 +25,235 @@ The `Validator` class is used to validate some common data types. It has the fol
 
 ## How to use
 
-### General example
+### isAscii
 
 ```java
-import io.github.multiform_validator.Validator;
+import static io.github.multiform_validator.Validator.isAscii;
 
 public class Main {
     public static void main(String[] args) {
-        validMethods();
-        invalidMethods();
-    }
-
-    public void validMethods() {
-        System.out.println(Validator.isAscii("foo")); // true
-        System.out.println(Validator.isCEP("12345-678")); // true
-        System.out.println(Validator.isDate("2021-01-01")); // true
-        System.out.println(Validator.isDecimal("1.5")); // true
-        System.out.println(Validator.isMACAddress("00:00:00:00:00:00")); // true
-        System.out.println(Validator.isNumber("123")); // true
-        System.out.println(Validator.isPort("8080")); // true
-        System.out.println(Validator.isPostalCode("12345-678")); // true
-        System.out.println(Validator.isTime("12:00")); // true
-        System.out.println(Validator.isEmail("foo@bar.com")); // true
-    }
-
-    public void invalidMethods() {
-        System.out.println(Validator.isAscii("こんにちは")); // false
-        System.out.println(Validator.isCEP("12345678")); // false
-        System.out.println(Validator.isDate("2021-01-32")); // false
-        System.out.println(Validator.isDecimal("1.5.5")); // false
-        System.out.println(Validator.isMACAddress("00:00:00:00:00:00:00")); // false
-        System.out.println(Validator.isNumber("123a")); // false
-        System.out.println(Validator.isPort("8080a")); // false
-        System.out.println(Validator.isPostalCode("12345678")); // false
-        System.out.println(Validator.isTime("12:00:00")); // false
-        System.out.println(Validator.isEmail("foo@bar")); // false
+        valid();
+        invalid();
+    }
+
+    private static void valid() {
+        System.out.println(isAscii("foo")); // true
+        System.out.println(isAscii("bar")); // true
+    }
+
+    private static void invalid() {
+        System.out.println(isAscii("こんにちは")); // false
+        System.out.println(isAscii("안녕하세요")); // false
+    }
+}
+```
+
+### isCEP
+
+```java
+import static io.github.multiform_validator.Validator.isCEP;
+
+public class Main {
+    public static void main(String[] args) {
+        valid();
+        invalid();
+    }
+
+    private static void valid() {
+        System.out.println(isCEP("12345-678")); // true
+        System.out.println(isCEP("12345678")); // true
+    }
+
+    private static void invalid() {
+        System.out.println(isCEP("1234567844466")); // false
+        System.out.println(isCEP("12345-6789")); // false
+        System.out.println(isCEP("bcdedit")); // false
+    }
+}
+```
+
+### isDate
+
+```java
+import static io.github.multiform_validator.Validator.isDate;
+
+public class Main {
+    public static void main(String[] args) {
+        valid();
+        invalid();
+    }
+
+    private static void valid() {
+        System.out.println(isDate("2021-12-31")); // true
+        System.out.println(isDate("2021-12-31 12:00:00")); // true
+    }
+
+    private static void invalid() {
+        System.out.println(isDate("2021-12-32")); // false
+    }
+}
+```
+
+### isDecimal
+
+```java
+import static io.github.multiform_validator.Validator.isDecimal;
+
+public class Main {
+    public static void main(String[] args) {
+        valid();
+        invalid();
+    }
+
+    private static void valid() {
+        System.out.println(isDecimal("1.5")); // true
+    }
+
+    private static void invalid() {
+        System.out.println(isDecimal("1.5.5")); // false
+        System.out.println(isDecimal("1,5")); // false
+        System.out.println(isDecimal("1")); // false
+    }
+}
+```
+
+### isEmail
+
+```java
+import static io.github.multiform_validator.Validator.isEmail;
+
+public class Main {
+    public static void main(String[] args) {
+        valid();
+        invalid();
+    }
+
+    private static void valid() {
+        System.out.println(isEmail("foo@bar.com")); // true
+    }
+
+    private static void invalid() {
+        System.out.println(isEmail("foo@bar")); // false
+        System.out.println(isEmail("foo@bar.")); // false
+        System.out.println(isEmail("1foo@bar.com")); // false
+    }
+}
+```
+
+### isMACAddress
+
+```java
+import static io.github.multiform_validator.Validator.isMACAddress;
+
+public class Main {
+    public static void main(String[] args) {
+        valid();
+        invalid();
+    }
+
+    private static void valid() {
+        System.out.println(isMACAddress("00:00:00:00:00:00")); // true
+    }
+
+    private static void invalid() {
+        System.out.println(isMACAddress("00:00:00:00:00:00:00")); // false
+        System.out.println(isMACAddress("00:00:00:00:00:00:00:00")); // false
+    }
+}
+```
+
+### isNumber
+
+```java
+import static io.github.multiform_validator.Validator.isNumber;
+
+public class Main {
+    public static void main(String[] args) {
+        valid();
+        invalid();
+    }
+
+    private static void valid() {
+        System.out.println(isNumber("123")); // true
+    }
+
+    private static void invalid() {
+        System.out.println(isNumber("123a")); // false
+    }
+}
+```
+
+### isPort
+
+```java
+import static io.github.multiform_validator.Validator.isPort;
+
+public class Main {
+    public static void main(String[] args) {
+        valid();
+        invalid();
+    }
+
+    private static void valid() {
+        System.out.println(isPort("8080")); // true
+        System.out.println(isPort("80")); // true 
+        System.out.println(isPort("65535")); // true
+        System.out.println(isPort(80)); // true
+        System.out.println(isPort(65535)); // true
+    }
+
+    private static void invalid() {
+        System.out.println(isPort("8080a")); // false
+        System.out.println(isPort("0")); // false
+        System.out.println(isPort("65536")); // false
+        System.out.println(isPort(0)); // false
+        System.out.println(isPort(65536)); // false
+    }
+}
+```
+
+### isPostalCode
+
+```java
+import static io.github.multiform_validator.Validator.isPostalCode;
+
+public class Main {
+    public static void main(String[] args) {
+        valid();
+        invalid();
+    }
+
+    private static void valid() {
+        System.out.println(isPostalCode("12345-678")); // true
+        System.out.println(isPostalCode("12345678")); // true
+    }
+
+    private static void invalid() {
+        System.out.println(isPostalCode("1234567844466")); // false
+        System.out.println(isPostalCode("12345-6789")); // false
+        System.out.println(isPostalCode("bcdedit")); // false
+    }
+}
+```
+
+### isTime
+
+```java
+import static io.github.multiform_validator.Validator.isTime;
+
+public class Main {
+    public static void main(String[] args) {
+        valid();
+        invalid();
+    }
+
+    private static void valid() {
+        System.out.println(isTime("12:00")); // true
+    }
+
+    private static void invalid() {
+        System.out.println(isTime("12:00:00")); // false
+        System.out.println(isTime("12:00:00:00")); // false
     }
 }
 ```