Merge pull request #45 from afshiney/feature/efficient-uuid-validation

Efficient UUID "Existing" Validation

Author: michaeldyrynda

README.md

@@ -76,6 +76,25 @@ class Post extends Model
 }
 ```
 
+### Validation
+
+Should you wish to use the efficient UUID column as part of your validation strategy, you may use the `EfficientUuidExists` rule as normal.
+
+```php
+use Dyrynda\Database\Rules\EfficientUuidExists;
+
+public function update(Request $request, User $user)
+{
+    $request->validate([
+        // Using the default column name
+        'uuid' => [new EfficientUuidExists(Post::class)],
+
+        // Using a custom column name
+        'custom_uuid' => [new EfficientUuidExists(Post::class, 'custom_uuid')],
+    ]);
+}
+```
+
 ## Support
 
 If you are having general issues with this package, feel free to contact me on [Twitter](https://twitter.com/michaeldyrynda).

composer.json

@@ -12,15 +12,17 @@
   ],
   "require": {
     "php": "^7.3|^8.0",
+    "dyrynda/laravel-model-uuid": "^6.5",
     "illuminate/container": "^8.12",
     "illuminate/contracts": "^8.12",
     "illuminate/database": "^8.12",
     "ramsey/uuid": "^4.1"
   },
   "require-dev": {
-    "phpunit/phpunit": "^9.3",
+    "laravel/legacy-factories": "^1.1",
     "mockery/mockery": "^1.4.2",
-    "orchestra/testbench": "^6.0"
+    "orchestra/testbench": "^6.0",
+    "phpunit/phpunit": "^9.3"
   },
   "autoload": {
     "psr-4": {

phpunit.xml.dist

@@ -22,4 +22,7 @@
       <directory>./tests/</directory>
     </testsuite>
   </testsuites>
+  <php>
+    <env name="DB_CONNECTION" value="testing"/>
+  </php>
 </phpunit>

src/Rules/EfficientUuidExists.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Dyrynda\Database\Rules;
+
+use Ramsey\Uuid\Uuid;
+use Illuminate\Contracts\Validation\Rule;
+
+class EfficientUuidExists implements Rule
+{
+	/** @var \Dyrynda\Database\GeneratesUuid */
+	protected $model;
+
+	/** @var string */
+	protected $column;
+
+	public function __construct(string $model, string $column = 'uuid')
+	{
+		$this->model = new $model;
+
+		$this->column = $column;
+	}
+
+	public function passes($attribute, $value): bool
+	{
+		if (Uuid::isValid($value)) {
+			$binaryUuid = Uuid::fromString(strtolower($value))->getBytes();
+
+			return $this->model->where($this->column, $binaryUuid)->exists();
+		}
+
+		return false;
+	}
+
+	public function message(): string
+	{
+		return trans('validation.exists');
+	}
+}

tests/EfficientUuidExistsRuleTest.php

@@ -0,0 +1,52 @@
+<?php
+
+namespace Tests;
+
+use Dyrynda\Database\Rules\EfficientUuidExists;
+use Ramsey\Uuid\Uuid;
+use Tests\Fixtures\EfficientUuidPost;
+
+class EfficientUuidExistsRuleTest extends TestCase
+{
+    /** @test */
+    public function it_passes_valid_existing_uuid()
+    {
+        /** @var  \Tests\Fixtures\EfficientUuidPost  $post */
+        $post = factory(EfficientUuidPost::class)->create();
+
+        $rule = new EfficientUuidExists(EfficientUuidPost::class);
+
+        $this->assertTrue($rule->passes('uuid', $post->uuid));
+    }
+
+    /** @test */
+    public function it_fails_on_non_existing_uuid()
+    {
+        $uuid = Uuid::uuid4();
+
+        $rule = new EfficientUuidExists(EfficientUuidPost::class);
+
+        $this->assertFalse($rule->passes('post_id', $uuid));
+    }
+
+    /** @test */
+    public function it_fails_on_any_non_uuid_invalid_strings()
+    {
+        $uuid = "1235123564354633";
+
+        $rule = new EfficientUuidExists(EfficientUuidPost::class, 'uuid');
+
+        $this->assertFalse($rule->passes('post_id', $uuid));
+    }
+
+    /** @test */
+    public function it_works_with_custom_uuid_column_name()
+    {
+        /** @var  \Tests\Fixtures\EfficientUuidPost  $post */
+        $post = factory(EfficientUuidPost::class)->create();
+
+        $rule = new EfficientUuidExists(EfficientUuidPost::class, 'custom_uuid');
+
+        $this->assertTrue($rule->passes('custom_uuid', $post->custom_uuid));
+    }
+}

tests/Fixtures/EfficientUuidPost.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Tests\Fixtures;
+
+use Illuminate\Database\Eloquent\Model;
+use Dyrynda\Database\Casts\EfficientUuid;
+use Dyrynda\Database\Support\GeneratesUuid;
+
+class EfficientUuidPost extends Model
+{
+	use GeneratesUuid;
+
+	protected $table = 'posts';
+
+	public $timestamps = false;
+
+	protected $casts = [
+		'uuid' => EfficientUuid::class,
+        'custom_uuid' => EfficientUuid::class,
+	];
+
+	public function uuidColumn(): string
+	{
+		return 'uuid';
+	}
+
+    public function uuidColumns(): array
+    {
+        return ['uuid', 'custom_uuid'];
+    }
+}

tests/TestCase.php

@@ -2,14 +2,37 @@
 
 namespace Tests;
 
+use Illuminate\Support\Facades\Schema;
+use Illuminate\Database\Schema\Blueprint;
 use Dyrynda\Database\LaravelEfficientUuidServiceProvider;
 
 class TestCase extends \Orchestra\Testbench\TestCase
 {
-    protected function getPackageProviders($app)
-    {
-        return [
-            LaravelEfficientUuidServiceProvider::class,
-        ];
-    }
+	protected function setUp(): void
+	{
+		parent::setUp();
+
+		$this->withFactories(realpath(__DIR__ . '/database/factories'));
+
+		$this->setupDatabase($this->app);
+	}
+
+	protected function getPackageProviders($app)
+	{
+		return [
+			LaravelEfficientUuidServiceProvider::class,
+		];
+	}
+
+	protected function setupDatabase($app)
+	{
+		Schema::dropAllTables();
+
+		$app['db']->connection()->getSchemaBuilder()->create('posts', function (Blueprint $table) {
+			$table->increments('id');
+			$table->efficientUuid('uuid');
+			$table->efficientUuid('custom_uuid');
+			$table->string('title');
+		});
+	}
 }

tests/database/factories/PostFactory.php

@@ -0,0 +1,12 @@
+<?php
+
+/** @var \Illuminate\Database\Eloquent\Factory $factory */
+
+use Faker\Generator as Faker;
+use Tests\Fixtures\EfficientUuidPost;
+
+$factory->define(EfficientUuidPost::class, function (Faker $faker) {
+    return [
+        'title' => $faker->sentence,
+    ];
+});