Merge pull request #10 from red-explosion/fix-route-model-binding

Fix route model binding when overriding getRouteKeyName

src/Concerns/HasSqids.php

@@ -45,7 +45,11 @@ public function getRouteKeyName(): string
      */
     public function resolveRouteBindingQuery($query, $value, $field = null): Builder|Relation
     {
-        if ($field && $field !== $this->getRouteKeyName()) {
+        if ($field && $field !== 'sqid') {
+            return parent::resolveRouteBindingQuery(query: $query, value: $value, field: $field);
+        }
+
+        if (! $field && $this->getRouteKeyName() !== 'sqid') {
             return parent::resolveRouteBindingQuery(query: $query, value: $value, field: $field);
         }
 

tests/RouteModelBindingTest.php

@@ -3,6 +3,7 @@
 declare(strict_types=1);
 
 use Workbench\Database\Factories\CustomerFactory;
+use Workbench\Database\Factories\PostFactory;
 
 it('can bind a model from a sqid', function (): void {
     $customer = CustomerFactory::new()->create();
@@ -27,3 +28,19 @@
         ->get(uri: '/customers/invalid-sqid')
         ->assertNotFound();
 });
+
+it('can bind a model with a different key', function (): void {
+    $customer = CustomerFactory::new()->create();
+
+    $this
+        ->get(uri: "/customers/username/{$customer->username}")
+        ->assertContent(value: $customer->username);
+});
+
+it('can bind a model when the route key has been overridden', function (): void {
+    $post = PostFactory::new()->create();
+
+    $this
+        ->get(uri: "/posts/{$post->slug}")
+        ->assertContent(value: $post->title);
+});

workbench/app/Models/Post.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Workbench\App\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use RedExplosion\Sqids\Concerns\HasSqids;
+
+class Post extends Model
+{
+    use HasSqids;
+
+    public function getRouteKeyName(): string
+    {
+        return 'slug';
+    }
+}

workbench/database/factories/CustomerFactory.php

@@ -30,6 +30,7 @@ public function definition(): array
     {
         return [
             'name' => $this->faker->name(),
+            'username' => $this->faker->username(),
         ];
     }
 }

workbench/database/factories/PostFactory.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Workbench\Database\Factories;
+
+use Illuminate\Database\Eloquent\Factories\Factory;
+use Illuminate\Support\Str;
+use Workbench\App\Models\Post;
+
+/**
+ * @phpstan-type TModel \Workbench\App\Models\Post
+ *
+ * @extends \Illuminate\Database\Eloquent\Factories\Factory<TModel>
+ */
+class PostFactory extends Factory
+{
+    /**
+     * The name of the factory's corresponding model.
+     *
+     * @var class-string<\Illuminate\Database\Eloquent\Model|TModel>
+     */
+    protected $model = Post::class;
+
+    /**
+     * Define the model's default state.
+     *
+     * @return array<string, mixed>
+     */
+    public function definition(): array
+    {
+        return [
+            'title' => $title = $this->faker->sentence(),
+            'slug' => Str::slug($title),
+        ];
+    }
+}

workbench/database/migrations/2023_11_27_193203_create_customers_table.php

@@ -16,6 +16,7 @@ public function up(): void
         Schema::create(table: 'customers', callback: function (Blueprint $table): void {
             $table->id();
             $table->string(column: 'name');
+            $table->string(column: 'username');
             $table->timestamps();
         });
     }

workbench/database/migrations/2025_02_21_224439_create_posts_table.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class() extends Migration
+{
+    /**
+     * Run the migrations.
+     */
+    public function up(): void
+    {
+        Schema::create(table: 'posts', callback: function (Blueprint $table): void {
+            $table->id();
+            $table->string('title');
+            $table->string('slug');
+            $table->timestamps();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down(): void
+    {
+        Schema::dropIfExists(table: 'posts');
+    }
+};

workbench/routes/web.php

@@ -4,5 +4,9 @@
 
 use Illuminate\Support\Facades\Route;
 use Workbench\App\Models\Customer;
+use Workbench\App\Models\Post;
 
+Route::get(uri: 'customers/username/{customer:username}', action: fn (Customer $customer) => $customer->username);
 Route::get(uri: 'customers/{customer}', action: fn (Customer $customer) => $customer->name);
+
+Route::get(uri: 'posts/{post}', action: fn (Post $post) => $post->title);