Merge pull request #10 from arifszn/feat/rule-Hash

feat: rule hash

Author: arifszn

README.md

@@ -52,6 +52,7 @@ public function rules()
 - [`Divisible By`](#divisibleby)
 - [`Ethereum Address`](#ethereumaddress)
 - [`Float Number`](#floatnumber)
+- [`Hash`](#hash)
 - [`Image URL`](#imageurl)
 - [`Phone`](#phone)
 - [`Without Spaces`](#withoutspaces)
@@ -206,6 +207,23 @@ public function rules()
 }
 ```
 
+### `Hash`
+
+The field under validation must be a hash of type algorithm.
+
+Algorithm is one of `'md4', 'md5', 'sha1', 'sha256', 'sha384', 'sha512', 'ripemd128', 'ripemd160', 'tiger128', 'tiger160', 'tiger192', 'crc32', 'crc32b'`.
+
+```php
+use Arifszn\AdvancedValidation\Rules\Hash;
+
+public function rules()
+{
+    return [
+        'foo' => [new Hash()],
+    ];
+}
+```
+
 ### `ImageURL`
 
 The field under validation must be a valid image URL.

resources/lang/en/validation.php

@@ -11,7 +11,8 @@
     'data_uri' => 'The :attribute must have data uri format.',
     'divisible_by' => 'The :attribute must be divisible by :number.',
     'ethereum_address' => 'The :attribute must be an Ethereum address.',
-    'float_number' => 'The :attribute must be a float number',
+    '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.',
     'phone' => 'The :attribute must be a valid phone number.',
     'without_spaces' => 'The :attribute must not contain spaces.',

src/Rules/Hash.php

@@ -0,0 +1,103 @@
+<?php
+
+namespace Arifszn\AdvancedValidation\Rules;
+
+use Illuminate\Contracts\Validation\Rule;
+
+/**
+ * The field under validation must be a hash of type algorithm. Algorithm is one of 
+ * ['md4', 'md5', 'sha1', 'sha256', 'sha384', 'sha512', 'ripemd128', 'ripemd160', 
+ * 'tiger128', 'tiger160', 'tiger192', 'crc32', 'crc32b']
+ *
+ * @package Arifszn\AdvancedValidation\Rules
+ */
+class Hash implements Rule
+{
+    /**
+     * @var string
+     */
+    private $algorithm;
+
+    /**
+     * @var string
+     */
+    private $errorMessage;
+
+    /**
+     * @var string
+     */
+    private $attribute;
+
+    /**
+     * Create a new rule instance.
+     *
+     * @param string $algorithm   'md4' | 'md5' | 'sha1' | 'sha256' | 'sha384' | 'sha512' | 'ripemd128' | 'ripemd160' | 'tiger128' | 'tiger160' | 'tiger192' | 'crc32' | 'crc32b'
+     * @param string|null $errorMessage   Custom error message.
+     * @return void
+     */
+    public function __construct(string $algorithm, string $errorMessage = null)
+    {
+        $this->algorithm = $algorithm;
+        $this->errorMessage = $errorMessage;
+    }
+
+    /**
+     * Determine if the validation rule passes.
+     *
+     * @param string $attribute
+     * @param mixed $value
+     * @return bool
+     */
+    public function passes($attribute, $value)
+    {
+        $this->attribute = $attribute;
+
+        try {
+            $hash = '/^[a-fA-F0-9]{' . $this->getLength($this->algorithm) . '}$/';
+
+            return preg_match($hash, $value);
+        } catch (\Throwable $th) {
+            return false;
+        }
+    }
+
+    /**
+     * Get the validation error message.
+     *
+     * @return string
+     */
+    public function message()
+    {
+        return $this->errorMessage ? $this->errorMessage : trans('advancedValidation::validation.hash', [
+            'attribute' => $this->attribute,
+            'algorithm' => $this->algorithm
+        ]);
+    }
+
+    /**
+     * Get length.
+     *
+     * @param string $algorithm
+     * @return int
+     */
+    private function getLength(string $algorithm)
+    {
+        $lengths = [
+            'md5' => 32,
+            'md4' => 32,
+            'sha1' => 40,
+            'sha256' => 64,
+            'sha384' => 96,
+            'sha512' => 128,
+            'ripemd128' => 32,
+            'ripemd160' => 40,
+            'tiger128' => 32,
+            'tiger160' => 40,
+            'tiger192' => 48,
+            'crc32' => 8,
+            'crc32b' => 8,
+        ];
+
+        return $lengths[$algorithm];
+    }
+}

tests/Rules/HashTest.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Arifszn\AdvancedValidation\Tests\Rules;
+
+use Arifszn\AdvancedValidation\Rules\Hash;
+use Arifszn\AdvancedValidation\Tests\TestCase;
+
+class HashTest extends TestCase
+{
+    /**
+     * @dataProvider provider
+     */
+    public function testValidation($result, $value)
+    {
+        $algorithms = ['md5', 'md4', 'ripemd128', 'tiger128'];
+
+        foreach ($algorithms as $algorithm) {
+            $this->assertEquals($result, (new Hash($algorithm))->passes('foo', $value));
+        }
+    }
+
+    public function provider()
+    {
+        return [
+            [true, 'd94f3f016ae679c3008de268209132f2'],
+            [true, '751adbc511ccbe8edf23d486fa4581cd'],
+            [true, '88dae00e614d8f24cfd5a8b3f8002e93'],
+            [true, '0bf1c35032a71a14c2f719e5a14c1e96'],
+            [true, 'd94f3F016Ae679C3008de268209132F2'],
+            [true, '88DAE00e614d8f24cfd5a8b3f8002E93'],
+
+            [false, 'q94375dj93458w34'],
+            [false, '39485729348'],
+            [false, '%&FHKJFvk'],
+            [false, 'KYT0bf1c35032a71a14c2f719e5a1'],
+        ];
+    }
+}