fix: scoped route model binding (#13)

Co-authored-by: Ben Sherred <[email protected]>

Author: bencarr

src/Concerns/HasSqids.php

@@ -53,7 +53,7 @@ public function resolveRouteBindingQuery($query, $value, $field = null): Builder
             return parent::resolveRouteBindingQuery(query: $query, value: $value, field: $field);
         }
 
-        return $this->whereSqid(sqid: $value);
+        return $query->whereSqid(sqid: $value);
     }
 
     public static function keyFromSqid(string $sqid): ?int

tests/RouteModelBindingTest.php

@@ -2,6 +2,7 @@
 
 declare(strict_types=1);
 
+use Workbench\Database\Factories\ChargeFactory;
 use Workbench\Database\Factories\CustomerFactory;
 use Workbench\Database\Factories\PostFactory;
 
@@ -44,3 +45,21 @@
         ->get(uri: "/posts/{$post->slug}")
         ->assertContent(value: $post->title);
 });
+
+it('can scope route model bindings', function (): void {
+    $customer = CustomerFactory::new()->create();
+    $charge = ChargeFactory::new()->for($customer)->create();
+
+    $this
+        ->get(uri: "/customers/{$customer->sqid}/{$charge->sqid}")
+        ->assertContent(value: $charge->sqid);
+});
+
+it('returns a 404 if the child isn’t scoped to the parent', function (): void {
+    $customer = CustomerFactory::new()->create();
+    $charge = ChargeFactory::new()->create();
+
+    $this
+        ->get(uri: "/customers/{$customer->sqid}/{$charge->sqid}")
+        ->assertNotFound();
+});

workbench/app/Models/Charge.php

@@ -5,11 +5,20 @@
 namespace Workbench\App\Models;
 
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use RedExplosion\Sqids\Concerns\HasSqids;
 
 class Charge extends Model
 {
     use HasSqids;
 
     protected string $sqidPrefix = 'ch';
+
+    /**
+     * @return BelongsTo<Customer,$this>
+     */
+    public function customer(): BelongsTo
+    {
+        return $this->belongsTo(Customer::class);
+    }
 }

workbench/app/Models/Customer.php

@@ -5,9 +5,18 @@
 namespace Workbench\App\Models;
 
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\HasMany;
 use RedExplosion\Sqids\Concerns\HasSqids;
 
 class Customer extends Model
 {
     use HasSqids;
+
+    /**
+     * @return HasMany<Charge,$this>
+     */
+    public function charges(): HasMany
+    {
+        return $this->hasMany(Charge::class);
+    }
 }

workbench/routes/web.php

@@ -3,10 +3,12 @@
 declare(strict_types=1);
 
 use Illuminate\Support\Facades\Route;
+use Workbench\App\Models\Charge;
 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: 'customers/{customer}/{charge}', action: fn (Customer $customer, Charge $charge) => $charge->sqid)->scopeBindings();
 
 Route::get(uri: 'posts/{post}', action: fn (Post $post) => $post->title);