add username rule

Author: iamfarhad

README.md

@@ -4,7 +4,10 @@
 
 # Laravel Persian Validation
 
-Laravel Persian Validation provides validation for Persian alphabet, number and etc.
+The Laravel Persian Validation package offers comprehensive validation for the Persian language, including validation for Persian alphabets, numbers, and other Persian-specific elements. This package allows developers to ensure that their Persian language input data meets the necessary validation criteria, enhancing the reliability and accuracy of their applications. With Laravel Persian Validation, developers can easily incorporate Persian language validation into their Laravel projects, providing a more inclusive and user-friendly experience for Persian-speaking users.
+
+
+
 
 ## Requirement
 
@@ -19,11 +22,19 @@ Via Composer
 $ composer require iamfarhad/validation
 ```
 
-The package will automatically register itself.
+This package is designed to automatically register itself without requiring any additional configuration.
+
 
 ### Translations
 
-If you wish to edit the package translations, you can run the following command to publish them into your `resources/lang` (or `/lang` in Laravel 9.x) folder
+If you would like to customize the translations for the Laravel Persian Validation package, you can use the following command to publish them into your project's resources/lang directory:
+
+```bash
+php artisan vendor:publish --provider="Iamfarhad\Validation\ValidationRulesServiceProvider" --tag="translations"
+
+```
+If you are using Laravel 9.x or later, the translations will be published to the /lang directory instead. Once the translations are published, you can modify them as needed to suit your project's requirements.
+
 
 ```bash
 php artisan vendor:publish --provider="Iamfarhad\Validation\ValidationRulesServiceProvider"
@@ -54,6 +65,7 @@ You can access to validation rules by passing the rules key according blew follo
 | new CardNumber()    | Payment card numbers                                                                              |
 | new Address()       | Accept Persian, English and ... alphabet, Persian and English numbers and some special characters |
 | new PostalCode()    | Iran postal code                                                                                  |
+| new Username()      | Username format                                                                                   |
 
 ### Persian Alphabet
 Accept Persian language alphabet according to standard Persian, this is the way you can use this validation rule:
@@ -139,14 +151,20 @@ public function rules()
 ## Team
 This component is developed by the following person(s)
 
-| [![Farhad Zand](https://avatars3.githubusercontent.com/u/1936147?v=3&s=130)](https://github.com/iamfarhad) 
---- |
-| [Farhad Zand](https://github.com/iamfarhad)
+| [![Farhad Zand](https://avatars3.githubusercontent.com/u/1936147?v=3&s=130)](https://github.com/iamfarhad) |
+|------------------------------------------------------------------------------------------------------------|
+| [Farhad Zand](https://github.com/iamfarhad)                                                                |
 
 ## Support This Project
 
-Please contribute in package completion. This is the best support.
+Great! It's always helpful to have more contributors to a package. Here are a few ways you can contribute to the package completion:
+
+* Report Issues: If you find any bugs or issues with the package, you can report them on the package's GitHub repository. Be sure to provide detailed steps to reproduce the issue and any relevant code snippets.
+* Submit Pull Requests: If you have a fix for a bug or an improvement to the package, you can submit a pull request on the package's GitHub repository. Be sure to follow the guidelines for contributing and to test your changes thoroughly.
+* Improve Documentation: If you find any gaps in the package's documentation, you can contribute by improving the existing documentation or adding new documentation. You can do this by submitting a pull request on the package's GitHub repository.
+* Spread the Word: You can help the package by spreading the word about it on social media, developer forums, and other channels. This can help attract more contributors and users to the package.
 
+Remember that contributing to open-source projects like this package is a collaborative effort, and every little bit helps. Thank you for considering contributing!
 ## License
 
 The Laravel persian validation Module is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)

composer.json

@@ -35,8 +35,10 @@
         }
     },
     "require-dev": {
-        "orchestra/testbench": "^7.0|^8.0",
-        "phpunit/phpunit": "^9.4"
+        "laravel/pint": "^1.6",
+        "orchestra/testbench": "^7.0|^8.0.4",
+        "phpunit/phpunit": "^9.6.4",
+        "rector/rector": "^0.15.18"
     },
     "extra": {
         "laravel": {

pint.json

@@ -0,0 +1,3 @@
+{
+    "preset": "psr12"
+}

rector.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\CodeQuality\Rector\Class_\InlineConstructorDefaultToPropertyRector;
+use Rector\Config\RectorConfig;
+use Rector\Set\ValueObject\LevelSetList;
+use Rector\Set\ValueObject\SetList;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->paths([
+        __DIR__ . '/resources',
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+    ]);
+
+    // register a single rule
+    $rectorConfig->rule(InlineConstructorDefaultToPropertyRector::class);
+
+    // define sets of rules
+        $rectorConfig->sets([
+            LevelSetList::UP_TO_PHP_80,
+            SetList::CODE_QUALITY,
+            SetList::DEAD_CODE,
+            SetList::EARLY_RETURN,
+            SetList::CODING_STYLE,
+            SetList::NAMING,
+            SetList::PRIVATIZATION
+        ]);
+};

resources/lang/en/messages.php

@@ -1,16 +1,17 @@
 <?php
 
 return [
-    'persianNumber'             => 'must be a persian number.',
-    'persianAlpha'              => 'must be a persian alphabet.',
-    'persian_alphabet_number'   => 'must be a persian alphabet or number.',
-    'mobile'                    => 'must be a iran mobile number.',
-    'shebaNumber'               => 'must be a sheba number.',
-    'nationalCode'              => 'must be a iran melli code.',
-    'isNotPersian'              => 'could not be contain persian alpahbet or number.',
-    'phone'                     => 'must be a iran phone number.',
-    'phoneArea'                 => 'must be a iran phone number with area code.',
-    'cardNumber'                => 'must be a valid payment card number.',
-    'address'                   => 'must be a correct address.',
-    'postalCode'                => 'must be a iran postal code.',
+    'persianNumber' => 'must be a persian number.',
+    'persianAlpha' => 'must be a persian alphabet.',
+    'persian_alphabet_number' => 'must be a persian alphabet or number.',
+    'mobile' => 'must be a iran mobile number.',
+    'shebaNumber' => 'must be a sheba number.',
+    'nationalCode' => 'must be a iran melli code.',
+    'isNotPersian' => 'could not be contain persian alpahbet or number.',
+    'phone' => 'must be a iran phone number.',
+    'phoneArea' => 'must be a iran phone number with area code.',
+    'cardNumber' => 'must be a valid payment card number.',
+    'address' => 'must be a correct address.',
+    'postalCode' => 'must be a iran postal code.',
+    'username' => 'invalid format.',
 ];

resources/lang/fa/messages.php

@@ -1,16 +1,17 @@
 <?php
 
 return [
-    'persianNumber'             => 'عدد وارد شده باید فارسی باشد.',
-    'persianAlpha'              => 'حروف وارد شده باید فارسی باشد.',
-    'persian_alphabet_number'   => 'حروف و عدد وارد شده باید فارسی باشد.',
-    'mobile'                    => 'شماره همراه قابل قبول نیست.',
-    'shebaNumber'               => 'شماره شبا قابل قبول نیست.',
-    'nationalCode'              => 'کد ملی قابل قبول نیست.',
-    'isNotPersian'              => 'حروف غیر لاتین قابل قبول نیست.',
-    'phone'                     => 'شماره تلفن قابل قبول نیست.',
-    'phoneArea'                 => 'شماره تلفن قابل قبول نیست.',
-    'cardNumber'                => 'شماره کارت قابل قبول نیست.',
-    'address'                   => 'آدرس وارد شده قابل قبول نیست.',
-    'postalCode'                => 'کدپستی وارد شده قابل قبول نیست.',
+    'persianNumber' => 'عدد وارد شده باید فارسی باشد.',
+    'persianAlpha' => 'حروف وارد شده باید فارسی باشد.',
+    'persian_alphabet_number' => 'حروف و عدد وارد شده باید فارسی باشد.',
+    'mobile' => 'شماره همراه قابل قبول نیست.',
+    'shebaNumber' => 'شماره شبا قابل قبول نیست.',
+    'nationalCode' => 'کد ملی قابل قبول نیست.',
+    'isNotPersian' => 'حروف غیر لاتین قابل قبول نیست.',
+    'phone' => 'شماره تلفن قابل قبول نیست.',
+    'phoneArea' => 'شماره تلفن قابل قبول نیست.',
+    'cardNumber' => 'شماره کارت قابل قبول نیست.',
+    'address' => 'آدرس وارد شده قابل قبول نیست.',
+    'postalCode' => 'کدپستی وارد شده قابل قبول نیست.',
+    'username' => 'نام کاربری وارد شده قابل قبول نیست.',
 ];

src/Rules/Address.php

@@ -4,19 +4,16 @@
 
 use Illuminate\Contracts\Validation\Rule;
 
-class Address implements Rule
+final class Address implements Rule
 {
-    /**
-     * @var string
-     */
-    protected $attribute;
+    private ?string $attribute = null;
 
     public function passes($attribute, $value): bool
     {
         $this->attribute = $attribute;
 
         return preg_match(
-            "/^[\pL\s\d\-\/\,\،\.\\\\\x{200c}\x{064b}\x{064d}\x{064c}\x{064e}\x{064f}\x{0650}\x{0651}\x{6F0}-\x{6F9}]+$/u",
+            "#^[\pL\s\d\-\/\,\،\.\\\x{200c}\x{064b}\x{064d}\x{064c}\x{064e}\x{064f}\x{0650}\x{0651}\x{6F0}-\x{6F9}]+$#u",
             $value
         );
     }

src/Rules/CardNumber.php

@@ -4,29 +4,27 @@
 
 use Illuminate\Contracts\Validation\Rule;
 
-class CardNumber implements Rule
+final class CardNumber implements Rule
 {
-    /**
-     * @var string
-     */
-    protected $attribute;
+    private ?string $attribute = null;
 
     public function passes($attribute, $value): bool
     {
         $this->attribute = $attribute;
 
-        if (! preg_match('/^\d{16}$/', $value)) {
+        if (! preg_match('#^\d{16}$#', $value)) {
             return false;
         }
+
         $sum = 0;
-        for ($position = 1; $position <= 16; $position++) {
+        for ($position = 1; $position <= 16; ++$position) {
             $temp = $value[$position - 1];
             $temp = $position % 2 === 0 ? $temp : $temp * 2;
             $temp = $temp > 9 ? $temp - 9 : $temp;
             $sum += $temp;
         }
 
-        return (bool) ($sum % 10 === 0);
+        return $sum % 10 === 0;
     }
 
     public function message(): string

src/Rules/IsNotPersian.php

@@ -4,19 +4,16 @@
 
 use Illuminate\Contracts\Validation\Rule;
 
-class IsNotPersian implements Rule
+final class IsNotPersian implements Rule
 {
-    /**
-     * @var string
-     */
-    protected $attribute;
+    private ?string $attribute = null;
 
     public function passes($attribute, $value): bool
     {
         $this->attribute = $attribute;
 
         if (is_string($value)) {
-            return ! preg_match("/[\x{600}-\x{6FF}]/u", $value);
+            return ! preg_match("#[\x{600}-\x{6FF}]#u", $value);
         }
 
         return false;

src/Rules/Mobile.php

@@ -4,18 +4,15 @@
 
 use Illuminate\Contracts\Validation\Rule;
 
-class Mobile implements Rule
+final class Mobile implements Rule
 {
-    /**
-     * @var string
-     */
-    protected $attribute;
+    private ?string $attribute = null;
 
     public function passes($attribute, $value): bool
     {
         $this->attribute = $attribute;
 
-        return preg_match('/^((0)(9){1}[0-9]{9})+$/', $value);
+        return preg_match('#^((0)(9){1}\d{9})+$#', $value);
     }
 
     public function message(): string