Merge pull request #12 from arifszn/feat/rule-name

feat: rule name

Author: arifszn

README.md

@@ -54,6 +54,7 @@ public function rules()
 - [`Float Number`](#floatnumber)
 - [`Hash`](#hash)
 - [`Image URL`](#imageurl)
+- [`Name`](#name)
 - [`Phone`](#phone)
 - [`Username`](#username)
 - [`Without Spaces`](#withoutspaces)
@@ -267,6 +268,27 @@ public function rules()
 }
 ```
 
+### `Name`
+
+The field under validation must be a valid name.
+
+- no emoji
+- no number (if $allowNumber flag is true, it will accept numbers, default is false)
+- special characters are allowed
+
+    public Arifszn\AdvancedValidation\Rules\Name::__construct(bool $allowNumber = false, string $errorMessage = null)
+
+```php
+use Arifszn\AdvancedValidation\Rules\Name;
+
+public function rules()
+{
+    return [
+        'name' => [new Name()],
+    ];
+}
+```
+
 ### `Phone`
 
 The field under validation must be a valid phone number.

resources/lang/en/validation.php

@@ -13,6 +13,7 @@
     'float_number' => 'The :attribute must be a float number.',
     'hash' => 'The :attribute must be a hash of :algorithm algorithm.',
     'image_url' => 'The :attribute must be a valid image URL.',
+    'name' => 'The :attribute must be a valid name.',
     '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/Name.php

@@ -0,0 +1,76 @@
+<?php
+
+namespace Arifszn\AdvancedValidation\Rules;
+
+use Illuminate\Contracts\Validation\Rule;
+
+/**
+ * The field under validation must be a valid name.
+ *
+ *  - no emoji
+ *  - no number (if $allowNumber flag is false)
+ *  - special characters are allowed
+ *
+ * @package Arifszn\AdvancedValidation\Rules
+ */
+class Name implements Rule
+{
+    /**
+     * @var bool
+     */
+    private $allowNumber;
+
+    /**
+     * @var string
+     */
+    private $errorMessage;
+
+    /**
+     * Create a new rule instance.
+     *
+     * @param bool $allowNumber   Allow number.
+     * @param string|null $errorMessage   Custom error message.
+     * @return void
+     */
+    public function __construct(bool $allowNumber = false, string $errorMessage = null)
+    {
+        $this->allowNumber = $allowNumber;
+        $this->errorMessage = $errorMessage;
+    }
+
+    /**
+     * Determine if the validation rule passes.
+     *
+     * @param string $attribute
+     * @param mixed $value
+     * @return bool
+     */
+    public function passes($attribute, $value)
+    {
+        // check empty
+        if (!trim($value)) {
+            return false;
+        }
+
+        // check no emoji
+        if (preg_match('/\p{S}/u', $value)) {
+            return false;
+        }
+
+        if (!$this->allowNumber && !preg_match('/^([^0-9]*)$/', $value)) {
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Get the validation error message.
+     *
+     * @return string
+     */
+    public function message()
+    {
+        return $this->errorMessage ? $this->errorMessage : trans('advancedValidation::validation.name');
+    }
+}

tests/Rules/NameTest.php

@@ -0,0 +1,59 @@
+<?php
+
+namespace Arifszn\AdvancedValidation\Tests\Rules;
+
+use Arifszn\AdvancedValidation\Rules\Name;
+use Arifszn\AdvancedValidation\Tests\TestCase;
+
+class NameTest extends TestCase
+{
+    /**
+     * @dataProvider providerWithoutAllowNumber
+     */
+    public function testValidationWithoutAllowNumber($result, $value)
+    {
+        $this->assertEquals($result, (new Name(false))->passes('foo', $value));
+    }
+
+    /**
+     * @dataProvider providerWithAllowNumber
+     */
+    public function testValidationWithAllowNumber($result, $value)
+    {
+        $this->assertEquals($result, (new Name(true))->passes('foo', $value));
+    }
+
+    public function providerWithoutAllowNumber()
+    {
+        return array_merge($this->shared(), [
+            [false, '1234 abc DEF'],
+            [false, '1234abcDEF'],
+            [false, '消极的123'],
+        ]);
+    }
+
+    public function providerWithAllowNumber()
+    {
+        return array_merge($this->shared(), [
+            [true, '1234 abc DEF'],
+            [true, '1234abcDEF'],
+            [true, '消极的123'],
+        ]);
+    }
+
+    private function shared()
+    {
+        return [
+            [true, 'foobar'],
+            [true, 'ｆｏｏbar'],
+            [true, 'a'],
+            [true, '消极的'],
+            [true, '###'],
+            [true, '**'],
+            [false, '😀'],
+            [false, 'john 😀'],
+            [false, ''],
+            [false, '  '],
+        ];
+    }
+}

tests/Rules/UsernameTest.php

@@ -43,6 +43,9 @@ public function provider()
             [false, 'a b c'],
             [false, 'ｆｏｏbar'],
             [false, '😀'],
+            [false, 'john😀'],
+            [false, ''],
+            [false, '  '],
         ];
     }
 }