#15 Create Validation Hashed Exist (#19)

* Create Validation Hashed Exist * Apply fixes from StyleCI (#18) Co-authored-by: Emad Rashdan <[email protected]> * Update readme.md Co-authored-by: Emad Rashdan <[email protected]>
erashdan · Jan 5, 2021 · 975dfe4 · 975dfe4
1 parent fac129a
commit 975dfe4
Show file tree

Hide file tree

Showing 10 changed files with 145 additions and 17 deletions.
diff --git a/readme.md b/readme.md
@@ -75,6 +75,14 @@ $post = \App\Post::FindOrFailHashed('x7LR5oQJleJX60yPpNWV');
 $post->id; //1
 ```
 
+## Validation
+You can validate if hashed id is existed in model or not
+```php
+    request()->validate([
+        'post_id' => 'hashed_exists:' . \App\Post::class
+    ]);
+```
+
 ### Testing
 
 ``` bash

diff --git a/src/Exceptions/UndefinedKey.php b/src/Exceptions/UndefinedKey.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace Erashdan\Hashid\Exceptions;
+
+use Exception;
+
+class UndefinedKey extends Exception
+{
+    protected $message = 'Unable to define hashing key';
+}
diff --git a/src/Exceptions/UndefinedLength.php b/src/Exceptions/UndefinedLength.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace Erashdan\Hashid\Exceptions;
+
+use Exception;
+
+class UndefinedLength extends Exception
+{
+    protected $message = 'Unable to define hashing length';
+}
diff --git a/src/HashData.php b/src/HashData.php
@@ -2,6 +2,7 @@
 
 namespace Erashdan\Hashid;
 
+use Erashdan\Hashid\Exceptions\UndefinedLength;
 use Hashids\Hashids;
 
 class HashData
@@ -53,7 +54,7 @@ private static function getLength(): int
             (config('hashid.hash_data.length') == '') ||
             ! is_int(config('hashid.hash_data.length'))
         ) {
-            throw new \Exception('Unable to define hashing length');
+            throw new UndefinedLength();
         }
 
         return config('hashid.hash_data.length');

diff --git a/src/HashedIdValidator.php b/src/HashedIdValidator.php
@@ -0,0 +1,15 @@
+<?php
+
+namespace Erashdan\Hashid;
+
+class HashedIdValidator
+{
+    public function validate($attribute, $value, $parameters, $validator)
+    {
+        if (! isset($parameters[0])) {
+            return false;
+        }
+
+        return $parameters[0]::FindHashed($value) !== null;
+    }
+}
diff --git a/src/HashidServiceProvider.php b/src/HashidServiceProvider.php
@@ -2,6 +2,7 @@
 
 namespace Erashdan\Hashid;
 
+use Illuminate\Support\Facades\Validator;
 use Illuminate\Support\ServiceProvider;
 
 class HashidServiceProvider extends ServiceProvider
@@ -13,9 +14,14 @@ class HashidServiceProvider extends ServiceProvider
      */
     public function boot()
     {
-        $this->publishes([
-            __DIR__.'/../config/hashid.php' => config_path('hashid.php'),
-        ], 'config');
+        if ($this->app->runningInConsole()) {
+            $this->bootForConsole();
+        }
+
+        Validator::extend('hashed_exists',
+            HashedIdValidator::class.'@validate',
+            trans('The selected :attribute is invalid.')
+        );
     }
 
     /**
@@ -25,5 +31,13 @@ public function boot()
      */
     public function register()
     {
+        //
+    }
+
+    protected function bootForConsole()
+    {
+        $this->publishes([
+            __DIR__.'/../config/hashid.php' => config_path('hashid.php'),
+        ], 'config');
     }
 }
diff --git a/src/Traits/Hashid.php b/src/Traits/Hashid.php
@@ -2,7 +2,9 @@
 
 namespace Erashdan\Hashid\Traits;
 
+use Erashdan\Hashid\Exceptions\UndefinedKey;
 use Erashdan\Hashid\HashData;
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\ModelNotFoundException;
 
 trait Hashid
@@ -36,6 +38,16 @@ public static function DecodeId($id)
         }
     }
 
+    //  ----------    Scope    ----------
+
+    /**
+     * Find or fail by hash ID.
+     *
+     * @param $query
+     * @param $id
+     * @return mixed
+     * @throws \Exception
+     */
     public function scopeFindOrFailHashed($query, $id)
     {
         if (empty($decoded = self::DecodeId($id))) {
@@ -45,18 +57,34 @@ public function scopeFindOrFailHashed($query, $id)
         return $query->findOrFail(self::DecodeId($id));
     }
 
-    public function scopeFindHashed($query, $id)
+    /**
+     * Find resource by hashed id.
+     *
+     * @param $id
+     * @return null|Model
+     * @throws \Exception
+     */
+    public static function FindHashed($id)
     {
         if (empty($decoded = self::DecodeId($id))) {
-            return;
+            return null;
         }
 
-        return $query->find(self::DecodeId($id));
+        return self::find(self::DecodeId($id));
     }
 
-    public function scopeWhereInHashed($query, $values)
+    /**
+     * Find multiple resources by hash ids.
+     *
+     * @param $query
+     * @param array $values
+     * @return mixed
+     * @throws \Exception
+     */
+    public function scopeWhereInHashed($query, array $values)
     {
         $hash = [];
+
         foreach ($values as $value) {
             $hash[] = self::DecodeId($value);
         }
@@ -70,7 +98,7 @@ private static function setHashKey($class)
             (config('hashid.hash_data.key') == null) ||
             (config('hashid.hash_data.key') == '')
         ) {
-            throw new \Exception('Unable to define hashing key');
+            throw new UndefinedKey();
         }
 
         return config('hashid.hash_data.key').$class;

diff --git a/tests/HashingTest.php b/tests/HashingTest.php
@@ -2,32 +2,34 @@
 
 namespace Erashdan\Hashid\Test;
 
+use Erashdan\Hashid\Exceptions\UndefinedKey;
+use Erashdan\Hashid\Exceptions\UndefinedLength;
 use Illuminate\Database\Eloquent\ModelNotFoundException;
 
 class HashingTest extends TestCase
 {
-    /** @test * */
+    /** @test **/
     public function hashid_can_hash_primary_key()
     {
         $this->assertEquals('N5zQE4', $this->testModel->hashed_id);
     }
 
-    /** @test * */
+    /** @test **/
     public function get_correct_element_by_hashed_id()
     {
         $element = TestModel::FindOrFailHashed('N5zQE4');
         $this->assertEquals(1, $element->id);
         $this->assertEquals(2, $element->another_key);
     }
 
-    /** @test * */
+    /** @test **/
     public function throw_exception_if_element_not_exist()
     {
         $this->expectException(ModelNotFoundException::class);
         TestModel::FindOrFailHashed('FAKE_HASH');
     }
 
-    /** @test * */
+    /** @test **/
     public function hashing_id_length_is_changeable()
     {
         config(['hashid.hash_data.length' => 10]);
@@ -37,23 +39,25 @@ public function hashing_id_length_is_changeable()
         );
     }
 
-    /** @test * */
+    /** @test **/
     public function throw_exception_if_hash_key_not_exist()
     {
         config(['hashid.hash_data.key' => null]);
+        $this->expectException(UndefinedKey::class);
         $this->expectExceptionMessage('Unable to define hashing key');
         $this->assertNotNull($this->testModel->hashed_id);
     }
 
-    /** @test * */
+    /** @test **/
     public function throw_exception_if_hash_length_not_exist()
     {
         config(['hashid.hash_data.length' => null]);
+        $this->expectException(UndefinedLength::class);
         $this->expectExceptionMessage('Unable to define hashing length');
         $this->assertNotNull($this->testModel->hashed_id);
     }
 
-    /** @test * */
+    /** @test **/
     public function throw_exception_if_hash_length_not_integer()
     {
         config(['hashid.hash_data.length' => 'STRING']);

diff --git a/tests/TestCase.php b/tests/TestCase.php
@@ -7,7 +7,7 @@
 
 abstract class TestCase extends Orchestra
 {
-    /** @var \Erashdan\Hashid\Test\TestModel */
+    /** @var TestModel */
     protected $testModel;
 
     public function setUp(): void

diff --git a/tests/ValidationTest.php b/tests/ValidationTest.php
@@ -0,0 +1,38 @@
+<?php
+
+namespace Erashdan\Hashid\Test;
+
+use Erashdan\Hashid\HashedIdValidator;
+use Illuminate\Support\Facades\Validator;
+
+class ValidationTest extends TestCase
+{
+    /** @test * */
+    public function it_can_validate_if_hashed_id_exist_on_database_using_model_base()
+    {
+        $this->registerValidator();
+
+        $rules = [
+            'key' => 'hashed_exists:'.TestModel::class,
+        ];
+
+        $invalid_data = [
+            'key' => 'ANY KEY',
+        ];
+
+        $valid_data = [
+            'key' => 'N5zQE4',
+        ];
+
+        $failed_validation = $this->app['validator']->make($invalid_data, $rules);
+        $this->assertFalse($failed_validation->passes());
+
+        $success_validation = $this->app['validator']->make($valid_data, $rules);
+        $this->assertTrue($success_validation->passes());
+    }
+
+    protected function registerValidator()
+    {
+        Validator::extend('hashed_exists', HashedIdValidator::class.'@validate', trans('The selected :attribute is invalid.'));
+    }
+}