Add HasUuids trait when model uses uuid primary key (#655)

Author: rcrosbourne

src/Generators/ModelGenerator.php

@@ -271,14 +271,21 @@ protected function buildRelationships(Model $model): string
 
     protected function addTraits(Model $model, $stub): string
     {
-        if (!$model->usesSoftDeletes()) {
-            return $stub;
+        $traits = ['HasFactory'];
+        
+        if ($model->usesSoftDeletes()) {
+            $this->addImport($model, 'Illuminate\\Database\\Eloquent\\SoftDeletes');
+            $traits[] = 'SoftDeletes';
+        }
+        
+        if ($model->usesUuids()) {
+            $this->addImport($model, 'Illuminate\\Database\\Eloquent\\Concerns\\HasUuids');
+            $traits[] = 'HasUuids';
         }
 
-        $this->addImport($model, 'Illuminate\\Database\\Eloquent\\SoftDeletes');
-        $stub = Str::replaceFirst('use HasFactory', 'use HasFactory, SoftDeletes', $stub);
+        sort($traits);
 
-        return $stub;
+        return Str::replaceFirst('use HasFactory', 'use ' . implode(', ', $traits), $stub);
     }
 
     private function fillableColumns(array $columns): array

src/Models/Model.php

@@ -96,6 +96,11 @@ public function usesPrimaryKey(): bool
         return $this->primaryKey !== false;
     }
 
+    public function usesUuids(): bool
+    {
+        return $this->usesPrimaryKey() && $this->columns[$this->primaryKey]->dataType() === 'uuid';
+    }
+
     public function disablePrimaryKey(): void
     {
         $this->primaryKey = false;

tests/Feature/Generators/ModelGeneratorTest.php

@@ -595,6 +595,38 @@ public function output_generates_models_with_custom_pivot(): void
         $this->assertEquals(['created' => ['app/Models/User.php', 'app/Models/Team.php', 'app/Models/Membership.php']], $this->subject->output($tree));
     }
 
+    #[Test]
+    public function output_generates_models_with_hasuuids_trait_if_uuid_id_is_type_uuid(): void
+    {
+        $this->filesystem->expects('stub')
+            ->with('model.class.stub')
+            ->andReturn($this->stub('model.class.stub'));
+        $this->filesystem->expects('stub')
+            ->times(1)
+            ->with('model.casts.stub')
+            ->andReturn($this->stub('model.casts.stub'));
+        $this->filesystem->expects('stub')
+            ->times(1)
+            ->with('model.fillable.stub')
+            ->andReturn($this->stub('model.fillable.stub'));
+        $this->filesystem->expects('stub')
+            ->times(1)
+            ->with('model.method.stub')
+            ->andReturn($this->stub('model.method.stub'));
+
+        $this->filesystem->expects('exists')
+            ->times(1)
+            ->with('app/Models')
+            ->andReturnTrue();
+
+        $this->filesystem->expects('put')
+            ->with('app/Models/User.php', $this->fixture('models/model-with-uuid-trait.php'));
+        $tokens = $this->blueprint->parse($this->fixture('drafts/model-with-uuid-id.yaml'));
+        $tree = $this->blueprint->analyze($tokens);
+
+        $this->assertEquals(['created' => ['app/Models/User.php']], $this->subject->output($tree));
+    }
+
     public static function modelTreeDataProvider(): array
     {
         return [
@@ -610,6 +642,7 @@ public static function modelTreeDataProvider(): array
             ['drafts/uuid-shorthand-invalid-relationship.yaml', 'app/Models/AgeCohort.php', 'models/uuid-shorthand-invalid-relationship.php'],
             ['drafts/model-with-meta.yaml', 'app/Models/Post.php', 'models/model-with-meta.php'],
             ['drafts/infer-belongsto.yaml', 'app/Models/Conference.php', 'models/infer-belongsto.php'],
+            ['drafts/model-with-uuid-id.yaml', 'app/Models/User.php', 'models/model-with-uuid-trait.php'],
         ];
     }
 

tests/fixtures/drafts/model-with-uuid-id.yaml

@@ -0,0 +1,5 @@
+models:
+  User:
+    id: uuid primary
+    name: string
+    base_pay: decimal:10,2

tests/fixtures/models/model-with-uuid-trait.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace App\Models;
+
+use Illuminate\Database\Eloquent\Concerns\HasUuids;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Model;
+
+class User extends Model
+{
+    use HasFactory, HasUuids;
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = [
+        'name',
+        'base_pay',
+    ];
+
+    /**
+     * The attributes that should be cast to native types.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'base_pay' => 'decimal:2',
+    ];
+}