Merge pull request #11 from arifszn/feat/rule-username

feat: rule username

Author: arifszn

README.md

@@ -55,6 +55,7 @@ public function rules()
 - [`Hash`](#hash)
 - [`Image URL`](#imageurl)
 - [`Phone`](#phone)
+- [`Username`](#username)
 - [`Without Spaces`](#withoutspaces)
 
 
@@ -262,6 +263,26 @@ public function rules()
 }
 ```
 
+### `Username`
+
+The field under validation must be a valid username.
+
+- starts with a letter (alpha)
+- only alpha-numeric (a-z, A-Z, 0-9), underscore, minus and dot
+- multiple underscores, minus and are not allowed (-- or __ or ..)
+- underscores, minus and dot are not allowed at the beginning or end
+
+```php
+use Arifszn\AdvancedValidation\Rules\Username;
+
+public function rules()
+{
+    return [
+        'username' => [new Username()],
+    ];
+}
+```
+
 ### `WithoutSpaces`
 
 The field under validation must not contain spaces.

resources/lang/en/validation.php

@@ -15,5 +15,6 @@
     'hash' => 'The :attribute must be a hash of :algorithm algorithm.',
     'image_url' => 'The :attribute must be a valid image URL.',
     'phone' => 'The :attribute must be a valid phone number.',
+    'username' => 'The :attribute must be a valid username.',
     'without_spaces' => 'The :attribute must not contain spaces.',
 ];

src/Rules/Username.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace Arifszn\AdvancedValidation\Rules;
+
+use Illuminate\Contracts\Validation\Rule;
+
+/**
+ * The field under validation must be a valid username.
+ *
+ *  - starts with a letter (alpha)
+ *  - only alpha-numeric (a-z, A-Z, 0-9), underscore, minus and dot
+ *  - multiple underscores, minus and are not allowed (-- or __ or ..)
+ *  - underscores, minus and dot are not allowed at the beginning or end
+ *
+ * @package Arifszn\AdvancedValidation\Rules
+ */
+class Username implements Rule
+{
+    /**
+     * @var string
+     */
+    private $errorMessage;
+
+    /**
+     * Create a new rule instance.
+     *
+     * @param string|null $errorMessage   Custom error message.
+     * @return void
+     */
+    public function __construct(string $errorMessage = null)
+    {
+        $this->errorMessage = $errorMessage;
+    }
+
+    /**
+     * Determine if the validation rule passes.
+     *
+     * @param string $attribute
+     * @param mixed $value
+     * @return bool
+     */
+    public function passes($attribute, $value)
+    {
+        return preg_match('/^[a-z][a-z0-9]*(?:[_\-\.][a-z0-9]+)*$/i', $value);
+    }
+
+    /**
+     * Get the validation error message.
+     *
+     * @return string
+     */
+    public function message()
+    {
+        return $this->errorMessage ? $this->errorMessage : trans('advancedValidation::validation.username');
+    }
+}

tests/Rules/UsernameTest.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace Arifszn\AdvancedValidation\Tests\Rules;
+
+use Arifszn\AdvancedValidation\Rules\Username;
+use Arifszn\AdvancedValidation\Tests\TestCase;
+
+class UsernameTest extends TestCase
+{
+    /**
+     * @dataProvider provider
+     */
+    public function testValidation($result, $value)
+    {
+        $this->assertEquals($result, (new Username())->passes('foo', $value));
+    }
+
+    public function provider()
+    {
+        return [
+            [true, 'john'],
+            [true, 'john.doe'],
+            [true, 'john_doe'],
+            [true, 'john-doe'],
+            [true, 'john.doe.123'],
+            [true, 'john123'],
+            [true, 'john_123'],
+            [true, 'john-123'],
+
+            [false, '_john'],
+            [false, '-john'],
+            [false, '.john'],
+            [false, 'john_'],
+            [false, 'john-'],
+            [false, 'john.'],
+            [false, '_john_'],
+            [false, 'john__doe'],
+            [false, 'john--doe'],
+            [false, 'john..doe'],
+            [false, '123'],
+            [false, '123.john'],
+            [false, '&nbsp;'],
+            [false, 'a b c'],
+            [false, 'ｆｏｏbar'],
+            [false, '😀'],
+        ];
+    }
+}