Merge pull request spatie#49 from isocroft/dynamic_accessors_mutators

Adding dynamic accessors and mutators from $uuidAttributes and customising uuid text attribute suffix

Author: brendt

README.md

@@ -36,19 +36,21 @@ Schema::create('table_name', function (Blueprint $table) {
 });
 ```
 
-To get your model to work with the encoded UUID, use the `Spatie\BinaryUuid\HasBinaryUuid` trait in your model.
+To get your model to work with the encoded UUID (i.e. to use uuid as a primary key), you must let your model use the `Spatie\BinaryUuid\HasBinaryUuid` and the `Spatie\BinaryUuid\HasUuidPrimaryKey` traits.
 
 ```php
 use Illuminate\Database\Eloquent\Model;
 use Spatie\BinaryUuid\HasBinaryUuid;
+use Spatie\BinaryUuid\HasUuidPrimaryKey;
 
 class TestModel extends Model
 {
-    use HasBinaryUuid;
+    use HasBinaryUuid,
+        HasUuidPrimaryKey;
 }
 ```
 
-If don't like the primary key named `uuid` you can overwrite the `getKeyName` method to manually specify the primary key name.
+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.
 
 ```php
 use Illuminate\Database\Eloquent\Model;
@@ -58,13 +60,43 @@ class TestModel extends Model
 {
     use HasBinaryUuid;
 
-    public function getKeyName()
-    {
-        return 'uuid';
-    }
+    public $incrementing = false;
+    
+    public $primaryKey = 'uuid';
 }
 ```
 
+If you try converting your model to JSON with binary attributes, you will see errors. By declaring your binary attributes in `$uuidAttributes` on your model, you will tell the package to cast those UUID's to text whenever they are converted to array. Also, this adds a dynamic accessor for each of the uuid attributes.
+
+```php
+use Illuminate\Database\Eloquent\Model;
+use Spatie\BinaryUuid\HasBinaryUuid;
+
+class TestModel extends Model
+{
+    use HasBinaryUuid;
+    
+    /**
+     * The suffix for the uuid text attribute 
+     * by default this is '_text'
+     * 
+     * @var
+     */
+    protected $uuidSuffix = '_str';
+    
+    /**
+     * The binary UUID attributes that should be converted to text.
+     *
+     * @var array
+     */
+    protected $uuids = [
+        'country_uuid' // foreign or related key
+    ];
+}
+```
+
+In your JSON you will see `uuid` and `country_uuid` in their textual representation. If you're also making use of composite primary keys, the above works well enough too. Just include your keys in the `$uuids` array or override the `getKeyName()` method on your model and return your composite primary keys as an array of keys. You can also customize the UUID text attribute suffix name. In the code above, instead of '\_text' it's '\_str'.
+
 #### A note on the `uuid` blueprint method
 
 Laravel currently doesn't allow adding new blueprint methods which can be used out of the box.

src/HasBinaryUuid.php

@@ -73,31 +73,106 @@ public static function decodeUuid(string $binaryUuid): string
 
     public function toArray()
     {
-        if (! $this->exists) {
-            return parent::toArray();
+        $uuidAttributes = $this->getUuidAttributes();
+
+        $array = parent::toArray();
+
+        if (! $this->exists || ! is_array($uuidAttributes)) {
+            return $array;
+        }
+
+        foreach ($uuidAttributes as $attributeKey) {
+            if (! array_key_exists($attributeKey, $array)) {
+                continue;
+            }
+            $uuidKey = $this->getRelatedBinaryKeyName($attributeKey);
+            $array[$attributeKey] = $this->{$uuidKey};
+        }
+
+        return $array;
+    }
+
+    public function getRelatedBinaryKeyName($attribute)
+    {
+        $suffix = $this->getUuidSuffix();
+
+        return preg_match('/(?:uu)?id/i', $attribute) ? "{$attribute}{$suffix}" : $attribute;
+    }
+
+    public function getAttribute($key)
+    {
+        $uuidKey = $this->uuidTextAttribute($key);
+
+        if ($uuidKey && $this->{$uuidKey} !== null) {
+            return static::decodeUuid($this->{$uuidKey});
+        }
+
+        return parent::getAttribute($key);
+    }
+
+    public function setAttribute($key, $value)
+    {
+        if ($this->uuidTextAttribute($key)) {
+            $value = static::encodeUuid($value);
         }
 
-        $data = parent::toArray();
+        return parent::setAttribute($key, $value);
+    }
+
+    protected function getUuidSuffix()
+    {
+        return (property_exists($this, 'uuidSuffix')) ? $this->uuidSuffix : '_text';
+    }
+
+    protected function uuidTextAttribute($key)
+    {
+        $uuidAttributes = $this->getUuidAttributes();
+        $suffix = $this->getUuidSuffix();
+        $offset = -(strlen($suffix));
+
+        if (substr($key, $offset) == $suffix && in_array(($uuidKey = substr($key, 0, $offset)), $uuidAttributes)) {
+            return $uuidKey;
+        }
+
+        return false;
+    }
+
+    public function getUuidAttributes()
+    {
+        $uuidAttributes = [];
 
-        if (isset($data[$this->getKeyName()])) {
-            $data[$this->getKeyName()] = $this->uuid_text;
+        if (property_exists($this, 'uuids') && is_array($this->uuids)) {
+            $uuidAttributes = array_merge($uuidAttributes, $this->uuids);
         }
 
-        return $data;
+        // non composite primary keys will return a string so casting required
+        $key = (array) $this->getKeyName();
+
+        $uuidAttributes = array_unique(array_merge($uuidAttributes, $key));
+
+        return $uuidAttributes;
     }
 
     public function getUuidTextAttribute(): ?string
     {
-        if (! $this->exists) {
+        $key = $this->getKeyName();
+
+        if (! $this->exists || is_array($key)) {
             return null;
         }
 
-        return static::decodeUuid($this->{$this->getKeyName()});
+        return static::decodeUuid($this->{$key});
     }
 
     public function setUuidTextAttribute(string $uuid)
     {
-        $this->{$this->getKeyName()} = static::encodeUuid($uuid);
+        $key = $this->getKeyName();
+
+        if (is_array($key)) {
+            return;
+        }
+
+        $this->{$key} = static::encodeUuid($uuid);
     }
 
     public function getQueueableId()
@@ -112,7 +187,9 @@ public function newQueryForRestoration($id)
 
     public function getRouteKeyName()
     {
-        return 'uuid_text';
+        $suffix = $this->getUuidSuffix();
+
+        return "uuid{$suffix}";
     }
 
     public function getKeyName()

tests/Feature/HasBinaryUuidTest.php

@@ -80,6 +80,38 @@ public function it_can_query_a_relation_with_scope()
         $this->assertNotNull($model);
     }
 
+    /** @test */
+    public function it_decodes_columns_besides_primary_uuid_when_turned_to_an_array()
+    {
+        $uuid = Uuid::uuid1();
+        $relationUuid = Uuid::uuid1();
+
+        $model = $this->createModel($uuid, $relationUuid);
+
+        $modelArray = $model->toArray();
+
+        $this->assertNotNull($model);
+        $this->assertCount(4, $modelArray);
+        $this->assertTrue(array_key_exists('relation_uuid', $modelArray));
+        $this->assertEquals($modelArray['relation_uuid'], $model->relation_uuid_text);
+    }
+
+    /** @test */
+    public function it_should_use_custom_suffix_when_specified()
+    {
+        $uuid = Uuid::uuid1();
+
+        $model = $this->createModel($uuid);
+
+        $model->setUuidSuffix('_str');
+
+        $modelArray = $model->toArray();
+
+        $this->assertNotNull($model);
+        $this->assertTrue(array_key_exists('uuid', $modelArray));
+        $this->assertEquals($modelArray['uuid'], $model->uuid_str);
+    }
+
     /** @test */
     public function it_can_query_multiple_relations_with_scope()
     {

tests/TestModel.php

@@ -9,5 +9,16 @@ class TestModel extends Model
 {
     use HasBinaryUuid;
 
+    protected $uuids = [
+        'relation_uuid',
+    ];
+
+    protected $uuidSuffix = '_text';
+
     protected $table = 'test';
+
+    public function setUuidSuffix($suffix = '_text')
+    {
+        $this->uuidSuffix = $suffix;
+    }
 }