Laravel 11 support + include soft deletes

.github/workflows/lint.yml

@@ -14,7 +14,7 @@ jobs:
         with:
           command: install
           only_args: -q --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist --ignore-platform-reqs
-          php_version: 8.1
+          php_version: 8.3
 
       - name: Run PHP-CS-Fixer
         run: vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.php --diff --dry-run
@@ -30,7 +30,7 @@ jobs:
         with:
           command: install
           only_args: -q --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist --ignore-platform-reqs
-          php_version: 8.1
+          php_version: 8.3
 
       - name: Run PHP CodeSniffer
         run: vendor/bin/phpcs --extensions=php

.github/workflows/unittests.yml

@@ -16,6 +16,10 @@ jobs:
                 laravel: 10.*
                 testbench: 8.*
                 composer-flag: '--prefer-stable'
+            -   php: 8.3
+                laravel: 10.*
+                testbench: 8.*
+                composer-flag: '--prefer-stable'
             -   php: 8.1
                 laravel: 10.*
                 testbench: 8.*
@@ -24,7 +28,10 @@ jobs:
                 laravel: 10.*
                 testbench: 8.*
                 composer-flag: '--prefer-lowest'
-
+            -   php: 8.3
+                laravel: 10.*
+                testbench: 8.*
+                composer-flag: '--prefer-lowest'
     runs-on: ubuntu-latest
 
     steps:

composer.json

@@ -1,7 +1,14 @@
 {
     "name": "korridor/laravel-model-validation-rules",
     "description": "A laravel validation rule that uses eloquent to validate if a model exists",
-    "keywords": ["validation", "laravel", "rule", "model", "exist", "eloquent"],
+    "keywords": [
+        "validation",
+        "laravel",
+        "rule",
+        "model",
+        "exist",
+        "eloquent"
+    ],
     "homepage": "https://github.com/korridor/laravel-model-validation-rules",
     "authors": [
         {
@@ -12,11 +19,11 @@
     "license": "MIT",
     "require": {
         "php": ">=8.1",
-        "illuminate/support": "^10",
-        "illuminate/database": "^10"
+        "illuminate/support": "^10|^11",
+        "illuminate/database": "^10|^11"
     },
     "require-dev": {
-        "orchestra/testbench": "^8.0",
+        "orchestra/testbench": "^8.0|^9.0",
         "phpunit/phpunit": "^10",
         "friendsofphp/php-cs-fixer": "^3.6",
         "squizlabs/php_codesniffer": "^3.5"

docker/Dockerfile

@@ -1,4 +1,4 @@
-FROM php:8.1-cli
+FROM php:8.3-cli
 
 ADD https://github.com/mlocati/docker-php-extension-installer/releases/latest/download/install-php-extensions /usr/local/bin/
 

readme.md

@@ -33,7 +33,8 @@ composer require korridor/laravel-model-validation-rules "^2.1"
 
 This package is tested for the following Laravel and PHP versions:
 
- - 10.* (PHP 8.1, 8.2)
+ - 10.* (PHP 8.1, 8.2, 8.3)
+ - 11.* (PHP 8.2, 8.3)
 
 ## Usage examples
 

src/Rules/ExistsEloquent.php

@@ -46,6 +46,13 @@ class ExistsEloquent implements ValidationRule
      */
     private ?string $customMessageTranslationKey = null;
 
+    /**
+     * Include soft deleted models in the query.
+     *
+     * @var bool
+     */
+    private bool $includeSoftDeleted = false;
+
     /**
      * Create a new rule instance.
      *
@@ -110,6 +117,10 @@ public function validate(string $attribute, mixed $value, Closure $fail): void
             $builder = $builderClosure($builder);
         }
 
+        if ($this->includeSoftDeleted) {
+            $builder = $builder->withTrashed();
+        }
+
         if ($builder->doesntExist()) {
             if ($this->customMessage !== null) {
                 $fail($this->customMessage);
@@ -141,4 +152,26 @@ public function query(Closure $builderClosure): self
 
         return $this;
     }
+
+    /**
+     * Activate or deactivate including soft deleted models in the query.
+     *
+     * @param bool $includeSoftDeleted
+     * @return void
+     */
+    public function setIncludeSoftDeleted(bool $includeSoftDeleted): void
+    {
+        $this->includeSoftDeleted = $includeSoftDeleted;
+    }
+
+    /**
+     *  Activate including soft deleted models in the query.
+     *  @return $this
+     */
+    public function includeSoftDeleted(): self
+    {
+        $this->setIncludeSoftDeleted(true);
+
+        return $this;
+    }
 }

src/Rules/UniqueEloquent.php

@@ -56,6 +56,13 @@ class UniqueEloquent implements ValidationRule
      */
     private ?string $customMessageTranslationKey = null;
 
+    /**
+     * Include soft deleted models in the query.
+     *
+     * @var bool
+     */
+    private bool $includeSoftDeleted = false;
+
     /**
      * UniqueEloquent constructor.
      *
@@ -97,6 +104,10 @@ public function validate(string $attribute, mixed $value, Closure $fail): void
             );
         }
 
+        if ($this->includeSoftDeleted) {
+            $builder = $builder->withTrashed();
+        }
+
         if ($builder->exists()) {
             if ($this->customMessage !== null) {
                 $fail($this->customMessage);
@@ -178,4 +189,27 @@ public function ignore(mixed $id, ?string $column = null): self
 
         return $this;
     }
+
+    /**
+     * Activate or deactivate including soft deleted models in the query.
+     *
+     * @param bool $includeSoftDeleted
+     * @return void
+     */
+    public function setIncludeSoftDeleted(bool $includeSoftDeleted): void
+    {
+        $this->includeSoftDeleted = $includeSoftDeleted;
+    }
+
+    /**
+     * Activate including soft deleted models in the query.
+     *
+     * @return $this
+     */
+    public function includeSoftDeleted(): self
+    {
+        $this->setIncludeSoftDeleted(true);
+
+        return $this;
+    }
 }

tests/Feature/ExistsEloquentTest.php

@@ -255,6 +255,79 @@ public function testValidationPassesIfRuleChecksThatFactExistsAndBelongsToUserUs
         $this->assertCount(1, Fact::all());
     }
 
+    /*
+     * Tests for includeSoftDeleted
+     */
+
+    public function testValidationSucceedsIfSoftDeletedEntryExistInDatabaseAndIncludeSoftDeletedFlagIsActive(): void
+    {
+        // Arrange
+        User::create([
+            'id' => 6,
+            'other_id' => null,
+            'name' => 'Testname',
+            'email' => 'name@test.com',
+            'password' => bcrypt('secret'),
+            'remember_token' => Str::random(10),
+        ]);
+        $fact = Fact::create([
+            'id' => 1,
+            'user_id' => 6,
+            'type' => 'type1',
+            'description' => 'Long desc',
+        ]);
+        $fact->delete();
+
+        $validator = Validator::make([
+            'id' => 1,
+        ], [
+            'id' => [(new ExistsEloquent(Fact::class))->includeSoftDeleted()]
+        ]);
+
+        // Act
+        $isValid = $validator->passes();
+        $messages = $validator->messages()->toArray();
+
+        // Assert
+        $this->assertTrue($isValid);
+        $this->assertArrayNotHasKey('id', $messages);
+        $this->assertCount(1, User::withTrashed()->get());
+        $this->assertCount(1, User::all());
+        $this->assertCount(1, Fact::withTrashed()->get());
+        $this->assertCount(0, Fact::all());
+    }
+
+    public function testValidationFailsIfSoftDeletedEntryDoesNotExistInDatabaseAndIncludeSoftDeletedFlagIsActive(): void
+    {
+        // Arrange
+        User::create([
+            'id' => 6,
+            'other_id' => null,
+            'name' => 'Testname',
+            'email' => 'name@test.com',
+            'password' => bcrypt('secret'),
+            'remember_token' => Str::random(10),
+        ]);
+
+        $validator = Validator::make([
+            'id' => 1,
+        ], [
+            'id' => [(new ExistsEloquent(Fact::class))->includeSoftDeleted()]
+        ]);
+
+        // Act
+        $isValid = $validator->passes();
+        $messages = $validator->messages()->toArray();
+
+        // Assert
+        $this->assertFalse($isValid);
+        $this->assertEquals('The resource does not exist.', $messages['id'][0]);
+        $this->assertCount(1, User::withTrashed()->get());
+        $this->assertCount(1, User::all());
+        $this->assertCount(0, Fact::withTrashed()->get());
+        $this->assertCount(0, Fact::all());
+    }
+
     /*
      * Test language support
      */

tests/Feature/UniqueEloquentTest.php

@@ -257,6 +257,79 @@ public function testValidationFailsIfRuleChecksThatFactExistsAndBelongsToUserUsi
         $this->assertCount(1, Fact::all());
     }
 
+    /*
+     * Tests for includeSoftDeleted
+     */
+
+    public function testValidationSucceedsIfSoftDeletedEntryDoesNotExistInDatabaseAndIncludeSoftDeletedFlagIsActive(): void
+    {
+        // Arrange
+        User::create([
+            'id' => 6,
+            'other_id' => null,
+            'name' => 'Testname',
+            'email' => 'name@test.com',
+            'password' => bcrypt('secret'),
+            'remember_token' => Str::random(10),
+        ]);
+
+        $validator = Validator::make([
+            'id' => 1,
+        ], [
+            'id' => [(new UniqueEloquent(Fact::class))->includeSoftDeleted()]
+        ]);
+
+        // Act
+        $isValid = $validator->passes();
+        $messages = $validator->messages()->toArray();
+
+        // Assert
+        $this->assertTrue($isValid);
+        $this->assertArrayNotHasKey('id', $messages);
+        $this->assertCount(1, User::withTrashed()->get());
+        $this->assertCount(1, User::all());
+        $this->assertCount(0, Fact::withTrashed()->get());
+        $this->assertCount(0, Fact::all());
+    }
+
+    public function testValidationFailsIfSoftDeletedEntryDoesExistInDatabaseAndIncludeSoftDeletedFlagIsActive(): void
+    {
+        // Arrange
+        User::create([
+            'id' => 6,
+            'other_id' => null,
+            'name' => 'Testname',
+            'email' => 'name@test.com',
+            'password' => bcrypt('secret'),
+            'remember_token' => Str::random(10),
+        ]);
+        $fact = Fact::create([
+            'id' => 1,
+            'user_id' => 6,
+            'type' => 'type1',
+            'description' => 'Long desc',
+        ]);
+        $fact->delete();
+
+        $validator = Validator::make([
+            'id' => 1,
+        ], [
+            'id' => [(new UniqueEloquent(Fact::class))->includeSoftDeleted()]
+        ]);
+
+        // Act
+        $isValid = $validator->passes();
+        $messages = $validator->messages()->toArray();
+
+        // Assert
+        $this->assertFalse($isValid);
+        $this->assertEquals('The resource already exists.', $messages['id'][0]);
+        $this->assertCount(1, User::withTrashed()->get());
+        $this->assertCount(1, User::all());
+        $this->assertCount(1, Fact::withTrashed()->get());
+        $this->assertCount(0, Fact::all());
+    }
+
     /*
      * Test language support
      */