Complete onDelete + streamline config options

Author: jasonmccreary

config/blueprint.php

@@ -64,9 +64,16 @@
     | within the generated migration. This will relate these records
     | together to add structure and integrity to your database.
     |
+    | In addition, you may specify the action to perform `ON DELETE`. By
+    | default Blueprint will use `cascade`. However, you may set this
+    | to 'restrict', 'no_action', or 'null' as well as inline
+    | by defining your `foreign` key column with an `onDelete`.
+    |
     */
     'use_constraints' => false,
 
+    'on_delete' => 'cascade',
+
     /*
     |--------------------------------------------------------------------------
     | Fake Nullables
@@ -95,23 +102,4 @@
 
     'use_guarded' => false,
 
-    /*
-    |--------------------------------------------------------------------------
-    | Foreign Key ON DELETE action
-    |--------------------------------------------------------------------------
-    |
-    | By default, Blueprint will set the `ON DELETE` action to 'cascade'.
-    |
-    | restrict / no action:
-    |   - No action is performed with the child data when the parent data is deleted.
-    | cascade:
-    |   - The child data is either deleted when the parent data is deleted.
-    | set null:
-    |   - The child data is set to NULL when the parent data is deleted.
-    |
-    | Supported: 'cascade', 'set_null', 'restrict', 'no_action'
-    |
-    */
-
-    'on_delete' => 'cascade',
 ];

src/Generators/MigrationGenerator.php

@@ -20,7 +20,7 @@ class MigrationGenerator implements Generator
     const ON_DELETE_CLAUSES = [
         'cascade' => "->onDelete('cascade')",
         'restrict' => "->onDelete('restrict')",
-        'set_null' => "->onDelete('set null')",
+        'null' => "->onDelete('set null')",
         'no_action' => "->onDelete('no action')",
     ];
 
@@ -240,8 +240,8 @@ protected function buildForeignKey(string $column_name, ?string $on, string $typ
             $table = Str::lower(Str::plural($attributes[0]));
         }
 
-        $on_delete_clause = config('blueprint.on_delete', 'cascade');
-
+        $on_delete_clause = collect($modifiers)->firstWhere('onDelete');
+        $on_delete_clause = $on_delete_clause ? $on_delete_clause['onDelete'] : config('blueprint.on_delete', 'cascade');
         $on_delete_suffix = self::ON_DELETE_CLAUSES[$on_delete_clause];
 
         if ($this->isLaravel7orNewer() && $type === 'id') {

tests/Feature/Generator/MigrationGeneratorTest.php

@@ -453,7 +453,7 @@ public function output_also_creates_pivot_table_migration_with_custom_name_larav
      */
     public function output_creates_foreign_keys_with_nullable_chained_correctly()
     {
-        $this->app->config->set('blueprint.on_delete', 'set_null');
+        $this->app->config->set('blueprint.on_delete', 'null');
 
         $this->files->expects('stub')
             ->with('migration.stub')
@@ -479,7 +479,7 @@ public function output_creates_foreign_keys_with_nullable_chained_correctly()
      */
     public function output_creates_foreign_keys_with_nullable_chained_correctly_laravel6()
     {
-        $this->app->config->set('blueprint.on_delete', 'set_null');
+        $this->app->config->set('blueprint.on_delete', 'null');
 
         $app = \Mockery::mock();
         $app->shouldReceive('version')
@@ -506,6 +506,60 @@ public function output_creates_foreign_keys_with_nullable_chained_correctly_lara
         $this->assertEquals(['created' => [$model_migration]], $this->subject->output($tree));
     }
 
+    /**
+     * @test
+     */
+    public function output_creates_foreign_keys_with_on_delete()
+    {
+        $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/foreign-key-on-delete.php'));
+
+        $tokens = $this->blueprint->parse($this->fixture('definitions/foreign-key-on-delete.bp'));
+        $tree = $this->blueprint->analyze($tokens);
+
+        $this->assertEquals(['created' => [$model_migration]], $this->subject->output($tree));
+    }
+
+    /**
+     * @test
+     */
+    public function output_creates_foreign_keys_with_on_delete_laravel6()
+    {
+        $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/foreign-key-on-delete-laravel6.php'));
+
+        $tokens = $this->blueprint->parse($this->fixture('definitions/foreign-key-on-delete.bp'));
+        $tree = $this->blueprint->analyze($tokens);
+
+        $this->assertEquals(['created' => [$model_migration]], $this->subject->output($tree));
+    }
+
     /**
      * @test
      */

tests/fixtures/definitions/foreign-key-on-delete.bp

@@ -0,0 +1,6 @@
+models:
+  Comment:
+    site_id: foreign
+    post_id: foreign onDelete:null
+    author_id: foreign:user ondelete:restrict
+    approver_id: foreign:user ondelete:no_action

tests/fixtures/migrations/foreign-key-on-delete-laravel6.php

@@ -0,0 +1,39 @@
+<?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('site_id');
+            $table->foreign('site_id')->references('id')->on('sites')->onDelete('cascade');
+            $table->unsignedBigInteger('post_id');
+            $table->foreign('post_id')->references('id')->on('posts')->onDelete('set null');
+            $table->unsignedBigInteger('author_id');
+            $table->foreign('author_id')->references('id')->on('users')->onDelete('restrict');
+            $table->unsignedBigInteger('approver_id');
+            $table->foreign('approver_id')->references('id')->on('users')->onDelete('no action');
+            $table->timestamps();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::dropIfExists('comments');
+    }
+}

tests/fixtures/migrations/foreign-key-on-delete.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->id();
+            $table->foreignId('site_id')->constrained()->cascadeOnDelete();
+            $table->foreignId('post_id')->constrained()->onDelete('set null');
+            $table->foreignId('author_id')->constrained('users')->onDelete('restrict');
+            $table->foreignId('approver_id')->constrained('users')->onDelete('no action');
+            $table->timestamps();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::dropIfExists('comments');
+    }
+}