Add foreignUuid method to replace uuid() and foreign() methods in MigrationGenerator. (#502)

Author: jyrkidn

src/Generators/MigrationGenerator.php

@@ -7,7 +7,6 @@
 use Blueprint\Models\Model;
 use Blueprint\Tree;
 use Carbon\Carbon;
-use Illuminate\Support\Facades\App;
 use Illuminate\Support\Str;
 use Symfony\Component\Finder\SplFileInfo;
 use Illuminate\Filesystem\Filesystem;
@@ -173,7 +172,7 @@ protected function buildDefinition(Model $model)
                 $column_definition .= '$table->' . $dataType . "('{$column->name()}'";
             }
 
-            if (! empty($column->attributes()) && ! in_array($column->dataType(), ['id', 'uuid'])) {
+            if (! empty($column->attributes()) && ! $this->isIdOrUuid($column->dataType())) {
                 $column_definition .= ', ';
                 if (in_array($column->dataType(), ['set', 'enum'])) {
                     $column_definition .= json_encode($column->attributes());
@@ -198,7 +197,7 @@ protected function buildDefinition(Model $model)
                     $column->modifiers()
                 );
 
-                if ($column->dataType() === 'id') {
+                if ($this->isIdOrUuid($column->dataType())) {
                     $column_definition = $foreign;
                     $foreign = '';
                 }
@@ -210,7 +209,7 @@ function ($modifier) use ($column) {
                         || (is_array($modifier) && key($modifier) === 'onDelete')
                         || (is_array($modifier) && key($modifier) === 'onUpdate')
                         || $modifier === 'foreign'
-                        || ($modifier === 'nullable' && $column->dataType() === 'id');
+                        || ($modifier === 'nullable' && $this->isIdOrUuid($column->dataType()));
                     }
                 );
             }
@@ -237,7 +236,6 @@ function ($modifier) use ($column) {
             if (! empty($foreign)) {
                 $column_definition .= $foreign . ';' . PHP_EOL;
             }
-
             $definition .= $column_definition;
         }
 
@@ -301,7 +299,7 @@ protected function buildForeignKey(string $column_name, ?string $on, string $typ
             $column = Str::afterLast($column_name, '_');
         }
 
-        if ($type === 'id' && ! empty($attributes)) {
+        if ($this->isIdOrUuid($type) && ! empty($attributes)) {
             $table = Str::lower(Str::plural($attributes[0]));
         }
 
@@ -318,10 +316,16 @@ protected function buildForeignKey(string $column_name, ?string $on, string $typ
             $on_update_suffix = self::ON_UPDATE_CLAUSES[$on_update_clause];
         }
 
-        if ($type === 'id') {
+        if ($this->isIdOrUuid($type)) {
+            if ($type === 'uuid') {
+                $method = 'foreignUuid';
+            } else {
+                $method = 'foreignId';
+            }
+
             $prefix = in_array('nullable', $modifiers)
-                ? '$table->foreignId' . "('{$column_name}')->nullable()"
-                : '$table->foreignId' . "('{$column_name}')";
+                ? '$table->' . "{$method}('{$column_name}')->nullable()"
+                : '$table->' . "{$method}('{$column_name}')";
 
             if ($on_delete_clause === 'cascade') {
                 $on_delete_suffix = '->cascadeOnDelete()';
@@ -439,7 +443,7 @@ private function shouldAddForeignKeyConstraint(\Blueprint\Models\Column $column)
         }
 
         return config('blueprint.use_constraints')
-            && ($column->dataType() === 'id' || $column->dataType() === 'uuid' && Str::endsWith($column->name(), '_id'));
+            && ($this->isIdOrUuid($column->dataType()) && Str::endsWith($column->name(), '_id'));
     }
 
     protected function isNumericDefault(string $type, string $value): bool
@@ -459,4 +463,9 @@ function ($value) use ($type) {
                 }
             );
     }
+
+    protected function isIdOrUuid(string $dataType)
+    {
+        return in_array($dataType, ['id', 'uuid']);
+    }
 }

tests/fixtures/migrations/model-key-constraints.php

@@ -19,8 +19,7 @@ public function up()
             $table->uuid('id')->primary();
             $table->foreignId('user_id')->constrained();
             $table->string('external_id')->nullable()->index();
-            $table->uuid('sub_id');
-            $table->foreign('sub_id')->references('id')->on('subscriptions');
+            $table->foreignUuid('sub_id')->constrained('subscriptions');
             $table->timestamp('expires_at')->nullable()->index();
             $table->json('meta')->default('[]');
             $table->timestamps();

tests/fixtures/migrations/uuid-shorthand-constraint.php

@@ -17,8 +17,7 @@ public function up()
 
         Schema::create('people', function (Blueprint $table) {
             $table->uuid('id')->primary();
-            $table->uuid('company_id');
-            $table->foreign('company_id')->references('id')->on('companies')->onDelete('cascade')->onUpdate('cascade');
+            $table->foreignUuid('company_id')->constrained()->cascadeOnDelete()->cascadeOnUpdate();
             $table->timestamps();
         });