Infer foreign table reference from id attribute (#191)

Author: jasonmccreary

src/Generators/MigrationGenerator.php

@@ -131,7 +131,7 @@ protected function buildDefinition(Model $model)
             $foreign_modifier = $column->isForeignKey();
 
             if ($this->shouldAddForeignKeyConstraint($column)) {
-                $foreign = $this->buildForeignKey($column->name(), $foreign_modifier === 'foreign' ? null : $foreign_modifier, $column->dataType());
+                $foreign = $this->buildForeignKey($column->name(), $foreign_modifier === 'foreign' ? null : $foreign_modifier, $column->dataType(), $column->attributes());
                 if ($column->dataType() === 'id' && $this->isLaravel7orNewer()) {
                     $column_definition = $foreign;
                     $foreign = '';
@@ -198,7 +198,7 @@ protected function buildPivotTableDefinition(array $segments)
         return trim($definition);
     }
 
-    protected function buildForeignKey(string $column_name, ?string $on, string $type)
+    protected function buildForeignKey(string $column_name, ?string $on, string $type, array $attributes = [])
     {
         if (is_null($on)) {
             $table = Str::plural(Str::beforeLast($column_name, '_'));
@@ -211,6 +211,10 @@ protected function buildForeignKey(string $column_name, ?string $on, string $typ
             $column = Str::afterLast($column_name, '_');
         }
 
+        if ($type === 'id' && !empty($attributes)) {
+            $table = Str::lower(Str::plural($attributes[0]));
+        }
+
         if ($this->isLaravel7orNewer() && $type === 'id') {
             if ($column_name === Str::singular($table) . '_' . $column) {
                 return self::INDENT . '$table->foreignId' . "('{$column_name}')->constrained()->cascadeOnDelete()";

tests/Feature/Generator/MigrationGeneratorTest.php

@@ -125,6 +125,62 @@ public function output_uses_proper_data_type_for_id_columns_in_laravel6()
         $this->assertEquals(['created' => [$timestamp_path]], $this->subject->output($tree));
     }
 
+    /**
+     * @test
+     */
+    public function output_creates_constraints_for_unconventional_foreign_reference_migration()
+    {
+        $this->app->config->set('blueprint.use_constraints', true);
+
+        $this->files->expects('stub')
+            ->with('migration.stub')
+            ->andReturn(file_get_contents('stubs/migration.stub'));
+
+        $now = Carbon::now();
+        Carbon::setTestNow($now);
+
+        $model_migration = str_replace('timestamp', $now->format('Y_m_d_His'), 'database/migrations/timestamp_create_comments_table.php');
+
+        $this->files->expects('put')
+            ->with($model_migration, $this->fixture('migrations/relationships-constraints.php'));
+
+        $tokens = $this->blueprint->parse($this->fixture('definitions/relationships.bp'));
+        $tree = $this->blueprint->analyze($tokens);
+
+        $this->assertEquals(['created' => [$model_migration]], $this->subject->output($tree));
+    }
+
+    /**
+     * @test
+     */
+    public function output_creates_constraints_for_unconventional_foreign_reference_migration_laravel6()
+    {
+        $this->app->config->set('blueprint.use_constraints', true);
+
+        $app = \Mockery::mock();
+        $app->shouldReceive('version')
+            ->withNoArgs()
+            ->andReturn('6.0.0');
+        App::swap($app);
+
+        $this->files->expects('stub')
+            ->with('migration.stub')
+            ->andReturn(file_get_contents('stubs/migration.stub'));
+
+        $now = Carbon::now();
+        Carbon::setTestNow($now);
+
+        $model_migration = str_replace('timestamp', $now->format('Y_m_d_His'), 'database/migrations/timestamp_create_comments_table.php');
+
+        $this->files->expects('put')
+            ->with($model_migration, $this->fixture('migrations/relationships-constraints-laravel6.php'));
+
+        $tokens = $this->blueprint->parse($this->fixture('definitions/relationships.bp'));
+        $tree = $this->blueprint->analyze($tokens);
+
+        $this->assertEquals(['created' => [$model_migration]], $this->subject->output($tree));
+    }
+
     /**
      * @test
      */

tests/fixtures/definitions/relationships.bp

@@ -1,4 +1,4 @@
 models:
   Comment:
     post_id: id
-    author_id: id:user
+    author_id: id:user

tests/fixtures/migrations/relationships-constraints-laravel6.php

@@ -0,0 +1,35 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class CreateCommentsTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::create('comments', function (Blueprint $table) {
+            $table->bigIncrements('id');
+            $table->unsignedBigInteger('post_id');
+            $table->foreign('post_id')->references('id')->on('posts')->onDelete('cascade');
+            $table->unsignedBigInteger('author_id');
+            $table->foreign('author_id')->references('id')->on('users')->onDelete('cascade');
+            $table->timestamps();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::dropIfExists('comments');
+    }
+}

tests/fixtures/migrations/relationships-constraints.php

@@ -0,0 +1,33 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class CreateCommentsTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::create('comments', function (Blueprint $table) {
+            $table->id();
+            $table->foreignId('post_id')->constrained()->cascadeOnDelete();
+            $table->foreignId('author_id')->constrained('users')->cascadeOnDelete();
+            $table->timestamps();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::dropIfExists('comments');
+    }
+}