Merge pull request #36 from slashequip/master

Allow for Route Model Binding

Author: brendt

README.md

@@ -50,19 +50,21 @@ class TestModel extends Model
 }
 ```
 
-If don't like the primary key named `uuid` you can leave off the `HasUuidPrimaryKey` trait and manually specify `$primaryKey`. Don't forget set `$incrementing` to false.
+If don't like the primary key named `uuid` you can overwrite the `getKeyName` method to manually specify the primary key name.
 
 ```php
 use Illuminate\Database\Eloquent\Model;
 use Spatie\BinaryUuid\HasBinaryUuid;
 
 class TestModel extends Model
 {
-    use HasBinaryUuid;
+    use HasBinaryUuid,
+        HasUuidPrimaryKey;
 
-    public $incrementing = false;
-    
-    public $primaryKey = 'uuid';
+    public function getKeyName()
+    {
+        return 'uuid';
+    }
 }
 ```
 

src/HasUuidPrimaryKey.php

@@ -13,4 +13,9 @@ public function getIncrementing()
     {
         return false;
     }
+
+    public function resolveRouteBinding($value)
+    {
+        return $this->withUuid($value)->first();
+    }
 }

tests/Feature/CreatesModel.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Spatie\BinaryUuid\Test\Feature;
+
+use Spatie\BinaryUuid\Test\TestModel;
+
+trait CreatesModel
+{
+    private function createModel(string $uuid, $relationUuid = null): TestModel
+    {
+        $model = new TestModel();
+
+        $model->uuid_text = $uuid;
+
+        if ($relationUuid) {
+            $model->relation_uuid = TestModel::encodeUuid($relationUuid);
+        }
+
+        $model->save();
+
+        return $model;
+    }
+}

tests/Feature/HasBinaryUuidTest.php

@@ -1,13 +1,15 @@
 <?php
 
-namespace Spatie\BinaryUuid\Test\Unit;
+namespace Spatie\BinaryUuid\Test\Feature;
 
 use Ramsey\Uuid\Uuid;
 use Spatie\BinaryUuid\Test\TestCase;
 use Spatie\BinaryUuid\Test\TestModel;
 
 class HasBinaryUuidTest extends TestCase
 {
+    use CreatesModel;
+
     /** @test */
     public function it_generates_the_uuid_on_save()
     {
@@ -153,19 +155,4 @@ public function it_serialises_the_model_correctly_with_json_encode()
         $this->assertContains($model->uuid_text, $json);
         $this->assertNotContains($model->uuid, $json);
     }
-
-    private function createModel(string $uuid, $relationUuid = null): TestModel
-    {
-        $model = new TestModel();
-
-        $model->uuid_text = $uuid;
-
-        if ($relationUuid) {
-            $model->relation_uuid = TestModel::encodeUuid($relationUuid);
-        }
-
-        $model->save();
-
-        return $model;
-    }
 }

tests/Feature/HasUuidPrimaryKeyTest.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace Spatie\BinaryUuid\Test\Feature;
+
+use Ramsey\Uuid\Uuid;
+use Spatie\BinaryUuid\Test\TestCase;
+use Spatie\BinaryUuid\Test\TestModel;
+use Illuminate\Routing\Middleware\SubstituteBindings;
+
+class HasUuidPrimaryKeyTest extends TestCase
+{
+    use CreatesModel;
+
+    /** @test */
+    public function it_resolves_route_binding()
+    {
+        $uuid = Uuid::uuid1();
+        $this->createModel($uuid);
+
+        $resolvedModel = (new TestModel())->resolveRouteBinding($uuid);
+
+        $this->assertEquals((string) $uuid, $resolvedModel->uuid_text);
+    }
+
+    /** @test */
+    public function laravel_resolves_route_binding_correctly()
+    {
+        $uuid = Uuid::uuid1();
+        $this->createModel($uuid);
+
+        app('router')
+            ->middleware(SubstituteBindings::class)
+            ->group(function () {
+                app('router')->get('uuid-test/{model}', function (TestModel $model) {
+                    return $model;
+                });
+            });
+
+        $this->get("uuid-test/{$uuid->toString()}")
+            ->assertJson([
+                'uuid' => $uuid,
+            ]);
+    }
+}