add new methods and support writing a custom message

Author: SkyWalkerGhost

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 All notable changes to `shergela/validation-rule` will be documented in this file.
 
+## 1.0.4 | 26 August - 2024
+
+- add new `length()` method.
+- add a custom message support in the methods.
+
 ## 1.0.3 | 23 August - 2024
 
 ## Modified Rule::in() and Rule::notIn() rules.

README.md

@@ -21,6 +21,7 @@ return [
   	<ol>
         <li><a href="#create-rule">Build rule</a></li>
         <li><a href="#writing-messages">Build Messages</a></li>
+        <li><a href="#writing-custom-message">Writing a custom Messages into method</a></li>
   	</ol>
 </div>
 
@@ -93,6 +94,7 @@ return [
 |      ->timezoneAustralia()      |  new TimezoneRegionValidation()   |
 |       ->timezoneIndian()        |  new TimezoneRegionValidation()   |
 |       ->timezonePacific()       |  new TimezoneRegionValidation()   |
+|           ->length()            |               size                |
 </div>
 
 
@@ -135,6 +137,37 @@ public function authorize(): bool
 
 </div>
 
+## Writing a custom message in the methods
+<div id="writing-custom-message">
+
+```php
+    
+    namespace App\Http\Requests;
+    
+    use Illuminate\Foundation\Http\FormRequest;
+    use Shergela\Validations\Validation\Rule;
+    
+    class TestRequest extends FormRequest
+    {
+        /**
+        * @return bool
+          */
+          public function authorize(): bool
+          {
+          return true;
+          }
+        
+          public function rules(): array
+          {
+            return [
+                'name' => Rule::required(message: 'Please enter your name')
+                    ->min(min: 3, message: 'Please enter at least 3 characters'),
+            ];
+          }
+      }
+```
+</div> 
+
 
 # License
 

src/DataManipulation/InNotInRuleManipulation.php

@@ -11,8 +11,11 @@ class InNotInRuleManipulation
     /**
      * @param Arrayable<int, string>|array<string>|string $values
      */
-    public function __construct(protected readonly Arrayable|array|string $values)
-    {
+    public function __construct(
+        protected readonly Arrayable|array|string $values,
+        protected readonly bool $in = false,
+        protected readonly bool $notIn = false,
+    ) {
     }
 
     /**
@@ -21,6 +24,7 @@ public function __construct(protected readonly Arrayable|array|string $values)
     private function manipulation(): string
     {
         $values = $this->values;
+        $rule = $this->in === true ? 'in:' : 'not_in:';
 
         $values = array_map(function ($value) {
             $value = match (true) {
@@ -35,7 +39,7 @@ private function manipulation(): string
             return '"' . str_replace('"', '""', $v) . '"';
         }, (array) $values);
 
-        return implode(',', $values);
+        return $rule . implode(',', $values);
     }
 
     /**

src/Enums/ValidationDateEnum.php

@@ -17,6 +17,6 @@ enum ValidationDateEnum: string
     public const DATE_EQUALS = 'date_equals:';
 
     public const DATE_FORMAT = 'date_format:';
-    public const TIMEZONE = 'timezone:';
+    public const TIMEZONE = 'timezone';
     public const TIMEZONE_ALL = 'timezone:all';
 }

src/Rules/LowercaseFirstLetter.php

@@ -8,6 +8,10 @@
 
 class LowercaseFirstLetter implements ValidationRule
 {
+    public function __construct(protected readonly ?string $message = null)
+    {
+    }
+
     /**
      * @param string $attribute
      * @param mixed $value
@@ -24,7 +28,11 @@ public function validate(string $attribute, mixed $value, Closure $fail): void
         }
 
         if (Str::lcfirst($toString) !== $value) {
-            $fail('The first character of :attribute must be lowercase letter.');
+            $fail(
+                $this->message !== null
+                        ? $this->message
+                        : 'The first character of :attribute must be lowercase letter.'
+            );
         }
     }
 }

src/Rules/SeparateIntegersByComma.php

@@ -8,6 +8,10 @@
 
 class SeparateIntegersByComma implements ValidationRule
 {
+    public function __construct(protected readonly ?string $message = null)
+    {
+    }
+
     /**
      * @param string $attribute
      * @param mixed $value
@@ -20,7 +24,11 @@ public function validate(string $attribute, mixed $value, Closure $fail): void
         $toString = $value;
 
         if (! preg_match(pattern: Regex::SEPARATE_INTEGERS_BY_COMMA, subject: $toString)) {
-            $fail("Please separate (:attribute) integer values by comma. Entered value: {$toString}");
+            $fail(
+                $this->message == null
+                    ? "Please separate (:attribute) integer values by comma. Entered value: {$toString}"
+                    : $this->message
+            );
         }
     }
 }

src/Rules/SeparateStringsByComma.php

@@ -8,6 +8,10 @@
 
 class SeparateStringsByComma implements ValidationRule
 {
+    public function __construct(protected readonly ?string $message = null)
+    {
+    }
+
     /**
      * @param string $attribute
      * @param mixed $value
@@ -20,7 +24,11 @@ public function validate(string $attribute, mixed $value, Closure $fail): void
         $toString = $value;
 
         if (! preg_match(pattern: Regex::SEPARATE_STRINGS_BY_COMMA, subject: $toString)) {
-            $fail("Please separate (:attribute) values by comma. Entered value: {$toString}");
+            $fail(
+                $this->message == null
+                    ? "Please separate (:attribute) values by comma. Entered value: {$toString}"
+                    : $this->message
+            );
         }
     }
 }

src/Rules/SeparateStringsByUnderscore.php

@@ -8,6 +8,10 @@
 
 class SeparateStringsByUnderscore implements ValidationRule
 {
+    public function __construct(protected readonly ?string $message = null)
+    {
+    }
+
     /**
      * @param string $attribute
      * @param mixed $value
@@ -20,7 +24,11 @@ public function validate(string $attribute, mixed $value, Closure $fail): void
         $toString = $value;
 
         if (! preg_match(pattern: Regex::SEPARATE_STRINGS_BY_UNDERSCORE, subject: $toString)) {
-            $fail("Please separate (:attribute) values by underscore. Entered value: {$toString}");
+            $fail(
+                $this->message == null
+                    ? "Please separate (:attribute) values by underscore. Entered value: {$toString}"
+                    : $this->message
+            );
         }
     }
 }

src/Rules/TimezoneRegionValidation.php

@@ -18,6 +18,7 @@ public function __construct(
         protected readonly array $cities,
         protected readonly int $timezoneGroupNumber,
         protected readonly string $timezoneGroup,
+        protected readonly string|null $customMessage,
     ) {
     }
 
@@ -40,7 +41,7 @@ public function validate(string $attribute, mixed $value, Closure $fail): void
          * Validate provided cities
          */
         if ($this->validateProvidedValues() === false) {
-            $fail($this->message);
+            $fail($this->customMessage == null ? $this->message : $this->customMessage);
             return;
         };
 

src/Rules/TimezoneValidation.php

@@ -4,13 +4,14 @@
 
 use Closure;
 use Illuminate\Contracts\Validation\ValidationRule;
+use Illuminate\Support\Str;
 
 class TimezoneValidation implements ValidationRule
 {
     /**
      * @param array<string> $timezones
      */
-    public function __construct(protected readonly array $timezones)
+    public function __construct(protected readonly array $timezones, protected readonly ?string $message = null)
     {
     }
 
@@ -33,10 +34,14 @@ public function validate(string $attribute, mixed $value, Closure $fail): void
 
         if (! in_array($toString, $timezones)) {
             $implode = implode(', ', $this->timezones);
-            $fail("
-                The [:attribute] value does not match the given timezones list: [{$implode}].
-                Please provide correct timezone.
-            ");
+            if ($this->message !== null) {
+                $fail($this->message);
+            } else {
+                $fail(sprintf("
+                The :attribute value (%s) does not match the given timezones list: [%s].
+                    Please provide correct timezone.
+                ", $toString, $implode));
+            }
         }
     }
 }