Add complementary tests for route model binding

Author: ivanvermeyen

README.md

@@ -543,7 +543,24 @@ for alternative ways to enable route model binding.
 public function resolveRouteBinding($value)
 {
     // Perform the logic to find the given slug in the database...
-    return $this->where('slug->'.app()->getLocale(), $value)->firstOrFail();
+    return $this->where($this->getRouteKeyName().'->'.app()->getLocale(), $value)->firstOrFail();
+}
+```
+
+Laravel 7 and newer has an optional `$field` parameter that allows you to override the route key on specific routes:
+
+```php
+// Use the post slug as the route parameter instead of the default ID
+Route::get('posts/{post:slug}', ...);
+```
+
+The new method would then look like this:
+
+```php
+public function resolveRouteBinding($value, $field = null)
+{
+    // Perform the logic to find the given slug in the database...
+    return $this->where($field ?? $this->getRouteKeyName().'->'.app()->getLocale(), $value)->firstOrFail();
 }
 ```
 

tests/Stubs/Model.php

@@ -41,15 +41,17 @@ public function getSlug($locale = null)
      */
     public function resolveRouteBinding($parameter, $field = null)
     {
+        $field = $field ?: $this->getRouteKeyName();
+
         // Bypass the database for testing purpose and return
         // the current model as if it was found in the database.
-        if ($this->getRouteKeyName() === 'id') {
+        if ($this->getRouteKeyName() === 'id' && $field === 'id') {
             return $this;
         }
 
         // If the parameter is a slug, check if it is in the right language
         // and return the current model as if it was found in the database.
-        $validSlug = $this->attributes['slug'][App::getLocale()];
+        $validSlug = $this->attributes[$field][App::getLocale()];
 
         if ($validSlug !== $parameter) {
             abort(404);

tests/Unit/Middleware/SetLocaleTest.php

@@ -98,32 +98,6 @@ public function it_sets_the_locale_for_localized_routes_within_route_groups()
         $this->assertEquals('nl', $response->original);
     }
 
-    /** @test */
-    public function it_allows_for_route_model_binding_using_a_localized_route_key()
-    {
-        $this->setSupportedLocales(['en', 'nl']);
-        $this->setUseLocaleMiddleware(true);
-
-        $model = (new Model([
-            'slug' => [
-                'en' => 'en-slug',
-                'nl' => 'nl-slug',
-            ],
-        ]))->setKeyName('slug');
-
-        App::instance(Model::class, $model);
-
-        Route::localized(function () {
-            Route::get('route/{model}', function (Model $model) {})
-                ->middleware(['web']);
-        });
-
-        $this->call('GET', '/en/route/en-slug')->assertOk();
-        $this->call('GET', '/nl/route/nl-slug')->assertOk();
-        $this->call('GET', '/en/route/nl-slug')->assertNotFound();
-        $this->call('GET', '/nl/route/en-slug')->assertNotFound();
-    }
-
     /** @test */
     public function it_detects_the_locale_with_localizer_for_non_localized_routes()
     {

tests/Unit/RouteModelBindingTest.php

@@ -0,0 +1,77 @@
+<?php
+
+namespace CodeZero\LocalizedRoutes\Tests\Unit;
+
+use CodeZero\LocalizedRoutes\Tests\Stubs\Model;
+use CodeZero\LocalizedRoutes\Tests\TestCase;
+use Illuminate\Support\Facades\App;
+use Illuminate\Support\Facades\Route;
+
+class RouteModelBindingTest extends TestCase
+{
+    /** @test */
+    public function it_loads_a_route_with_a_localized_route_key_based_on_the_active_locale()
+    {
+        $this->setSupportedLocales(['en', 'nl']);
+        $this->setUseLocaleMiddleware(true);
+
+        $model = (new Model([
+            'slug' => [
+                'en' => 'en-slug',
+                'nl' => 'nl-slug',
+            ],
+        ]))->setKeyName('slug');
+
+        App::instance(Model::class, $model);
+
+        Route::middleware(['web'])->get('test/{model}', function (Model $model) {});
+
+        Route::localized(function () {
+            Route::middleware(['web'])->get('test/{model}', function (Model $model) {});
+        });
+
+        $this->setAppLocale('nl');
+
+        $this->get('test/nl-slug')->assertOk();
+        $this->get('test/en-slug')->assertNotFound();
+
+        $this->get('nl/test/nl-slug')->assertOk();
+        $this->get('nl/test/en-slug')->assertNotFound();
+
+        $this->get('en/test/en-slug')->assertOk();
+        $this->get('en/test/nl-slug')->assertNotFound();
+    }
+
+    /** @test */
+    public function it_loads_a_route_with_a_custom_localized_route_key_based_on_the_active_locale()
+    {
+        $this->setSupportedLocales(['en', 'nl']);
+        $this->setUseLocaleMiddleware(true);
+
+        $model = (new Model([
+            'slug' => [
+                'en' => 'en-slug',
+                'nl' => 'nl-slug',
+            ],
+        ]))->setKeyName('id');
+
+        App::instance(Model::class, $model);
+
+        Route::middleware(['web'])->get('test/{model:slug}', function (Model $model) {});
+
+        Route::localized(function () {
+            Route::middleware(['web'])->get('test/{model:slug}', function (Model $model) {});
+        });
+
+        $this->setAppLocale('nl');
+
+        $this->get('test/nl-slug')->assertOk();
+        $this->get('test/en-slug')->assertNotFound();
+
+        $this->get('nl/test/nl-slug')->assertOk();
+        $this->get('nl/test/en-slug')->assertNotFound();
+
+        $this->get('en/test/en-slug')->assertOk();
+        $this->get('en/test/nl-slug')->assertNotFound();
+    }
+}

tests/Unit/UrlGeneratorTest.php

@@ -163,7 +163,7 @@ public function it_throws_if_you_do_not_specify_a_name_for_a_localized_route()
     }
 
     /** @test */
-    public function it_temporarily_changes_the_app_locale_when_generating_a_route_url()
+    public function it_generates_a_url_for_a_route_with_a_default_localized_route_key()
     {
         $this->setSupportedLocales(['en', 'nl']);
         $this->setAppLocale('en');
@@ -185,6 +185,29 @@ public function it_temporarily_changes_the_app_locale_when_generating_a_route_ur
         $this->assertEquals(url('nl/route/nl-slug'), route('route.name', [$model], true, 'nl'));
     }
 
+    /** @test */
+    public function it_generates_a_url_for_a_route_with_a_custom_localized_route_key()
+    {
+        $this->setSupportedLocales(['en', 'nl']);
+        $this->setAppLocale('en');
+
+        $model = (new Model([
+            'slug' => [
+                'en' => 'en-slug',
+                'nl' => 'nl-slug',
+            ],
+        ]))->setKeyName('id');
+
+        App::instance(Model::class, $model);
+
+        $this->registerRoute('en/route/{model:slug}', 'en.route.name');
+        $this->registerRoute('nl/route/{model:slug}', 'nl.route.name');
+
+        $this->assertEquals(url('en/route/en-slug'), route('route.name', [$model]));
+        $this->assertEquals(url('en/route/en-slug'), route('route.name', [$model], true, 'en'));
+        $this->assertEquals(url('nl/route/nl-slug'), route('route.name', [$model], true, 'nl'));
+    }
+
     /** @test */
     public function it_generates_a_signed_route_url_for_the_current_locale()
     {