Merge pull request #31 from omaratpxt/feat-add-with-archived-route-instruction

feat: add withArchived route instruction

Author: joelbutcher

README.md

@@ -76,6 +76,17 @@ $onlyArchivedUsers = User::query()->onlyArchived();
 
 By default, the global scope of this trait uses the `withoutArchived` extension when the trait is added to a model.
 
+#### Archived models in route implicit binding
+Typically, implicit model binding will not retrieve models that have been archived. However, you may instruct the implicit binding to retrieve these models by chaining the withArchived method onto your route's definition:
+
+```php
+use App\Models\User;
+ 
+Route::get('/users/{user}', function (User $user) {
+    return $user->email;
+})->withArchived();
+```
+
 ### Testing
 
 ```composer test```

src/Archivable.php

@@ -206,4 +206,22 @@ public function getQualifiedArchivedAtColumn()
     {
         return $this->qualifyColumn($this->getArchivedAtColumn());
     }
+
+    /**
+     * Resolve the bindings for a given route.
+     * @see \Illuminate\Database\Eloquente\Model::resolveRouteBinding
+     * 
+     * @return \Illuminate\Database\Eloquent\Model
+     */
+    public function resolveRouteBinding($value, $field = null)
+    {
+        if (
+            request()->route()->allowsArchivedBindings()
+        ) {
+            return $this->resolveRouteBindingQuery($this, $value, $field)
+                ->withoutGlobalScopes([ArchivableScope::class])->first();
+        }
+
+        return parent::resolveRouteBinding($value, $field);
+    }
 }

src/LaravelArchivableServiceProvider.php

@@ -4,6 +4,7 @@
 
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\ServiceProvider;
+use Illuminate\Routing\Route;
 
 class LaravelArchivableServiceProvider extends ServiceProvider
 {
@@ -31,6 +32,16 @@ protected function configureMacros()
         Blueprint::macro('dropArchivedAt', function ($column = 'archived_at') {
             return $this->dropColumn($column);
         });
+
+        Route::macro('withArchived', function (bool $withArchived = true) {
+            $this->withArchivedBindings = $withArchived;
+
+            return $this;
+        });
+
+        Route::macro('allowsArchivedBindings', function () {
+            return $this->withArchivedBindings ?? false;
+        });
     }
 
     /**

tests/ArchivableRouteTest.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace LaravelArchivable\Tests;
+
+use LaravelArchivable\Tests\TestClasses\ArchivableModel;
+use Illuminate\Support\Facades\Route;
+
+class ArchivableRouteTest extends TestCase
+{
+    /** @test */
+    public function fail_if_archived_model_is_found()
+    {
+
+        Route::get('/archivable-models/{archivableModel}', function (ArchivableModel $archivableModel) {
+            return $archivableModel;
+        })->middleware(\Illuminate\Routing\Middleware\SubstituteBindings::class);
+
+        $model = ArchivableModel::factory()->archived()->create();
+
+
+        $this->get('/archivable-models/'.$model->getKey())
+            ->assertNotFound();
+    }
+
+
+    /** @test */
+    public function it_finds_archived_model_when_withArchived_is_used()
+    {
+        Route::get('/archivable-models/{archivableModel}', function (ArchivableModel $archivableModel) {
+            return $archivableModel;
+        })->middleware(\Illuminate\Routing\Middleware\SubstituteBindings::class)->withArchived();
+
+        $model = ArchivableModel::factory()->archived()->create();
+
+
+        $this->get('/archivable-models/'.$model->getKey())
+            ->assertOk();
+    }
+}