Generate table comment (#144)

Generate table comment

Author: kitloong

src/DBAL/Models/DBALTable.php

@@ -34,6 +34,11 @@ abstract class DBALTable implements Table
      */
     protected $name;
 
+    /**
+     * @var string
+     */
+    protected $comment;
+
     /**
      * @var \Illuminate\Support\Collection<\KitLoong\MigrationsGenerator\Schema\Models\Index>
      */
@@ -49,6 +54,7 @@ abstract class DBALTable implements Table
     public function __construct(DoctrineDBALTable $table, array $columns, array $indexes)
     {
         $this->name      = $table->getName();
+        $this->comment   = $table->getComment();
         $this->collation = $table->getOptions()['collation'] ?? null;
 
         $this->columns = (new Collection($columns))->reduce(function (Collection $columns, DoctrineDBALColumn $column) use ($table) {
@@ -116,6 +122,14 @@ public function getName(): string
         return $this->name;
     }
 
+    /**
+     * @inheritDoc
+     */
+    public function getComment(): ?string
+    {
+        return $this->comment;
+    }
+
     /**
      * @inheritDoc
      */

src/Enum/Migrations/Method/TableMethod.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace KitLoong\MigrationsGenerator\Enum\Migrations\Method;
+
+use MyCLabs\Enum\Enum;
+
+/**
+ * Preserved table methods of the framework.
+ *
+ * @see https://laravel.com/docs/master/migrations#tables
+ * @method static self COMMENT()
+ */
+final class TableMethod extends Enum
+{
+    private const COMMENT = 'comment';
+}

src/Migration/TableMigration.php

@@ -7,8 +7,10 @@
 use Illuminate\Support\Str;
 use KitLoong\MigrationsGenerator\Enum\Driver;
 use KitLoong\MigrationsGenerator\Enum\Migrations\Method\SchemaBuilder;
+use KitLoong\MigrationsGenerator\Enum\Migrations\Method\TableMethod;
 use KitLoong\MigrationsGenerator\Enum\Migrations\Property\TableProperty;
 use KitLoong\MigrationsGenerator\Migration\Blueprint\DBStatementBlueprint;
+use KitLoong\MigrationsGenerator\Migration\Blueprint\Method;
 use KitLoong\MigrationsGenerator\Migration\Blueprint\SchemaBlueprint;
 use KitLoong\MigrationsGenerator\Migration\Blueprint\TableBlueprint;
 use KitLoong\MigrationsGenerator\Migration\Enum\MigrationFileType;
@@ -18,11 +20,13 @@
 use KitLoong\MigrationsGenerator\Migration\Writer\SquashWriter;
 use KitLoong\MigrationsGenerator\Schema\Models\Table;
 use KitLoong\MigrationsGenerator\Setting;
+use KitLoong\MigrationsGenerator\Support\CheckMigrationMethod;
 use KitLoong\MigrationsGenerator\Support\MigrationNameHelper;
 use KitLoong\MigrationsGenerator\Support\TableName;
 
 class TableMigration
 {
+    use CheckMigrationMethod;
     use TableName;
 
     private $columnGenerator;
@@ -117,6 +121,10 @@ private function up(Table $table): SchemaBlueprint
             $blueprint->setLineBreak();
         }
 
+        if ($this->hasTableComment() && $table->getComment() !== null) {
+            $blueprint->setMethod(new Method(TableMethod::COMMENT(), $table->getComment()));
+        }
+
         $chainableIndexes    = $this->indexGenerator->getChainableIndexes($table->getName(), $table->getIndexes());
         $notChainableIndexes = $this->indexGenerator->getNotChainableIndexes($table->getIndexes(), $chainableIndexes);
 

src/Schema/Models/Table.php

@@ -13,6 +13,13 @@ interface Table extends Model
      */
     public function getName(): string;
 
+    /**
+     * Get the table comment.
+     *
+     * @return string|null
+     */
+    public function getComment(): ?string;
+
     /**
      * Get a list of columns.
      *

src/Support/CheckMigrationMethod.php

@@ -50,4 +50,15 @@ public function hasAnonymousMigration(): bool
     {
         return method_exists(Migrator::class, 'getMigrationClass');
     }
+
+    /**
+     * Check if support add comment to a table.
+     * This feature is added since Laravel v9.
+     *
+     * @return bool
+     */
+    public function hasTableComment(): bool
+    {
+        return method_exists(Blueprint::class, 'comment');
+    }
 }

tests/resources/database/migrations/general/2020_03_21_000000_expected_create_all_columns_db_table.php

@@ -23,6 +23,10 @@ class ExpectedCreateAllColumns_DB_Table extends TestMigration
     public function up()
     {
         Schema::create('all_columns_[db]', function (Blueprint $table) {
+            if ($this->hasTableComment()) {
+                $table->comment('A table comment.');
+            }
+
             $table->bigInteger('bigInteger');
             $table->bigInteger('bigInteger_default')->default(1080);
             $table->binary('binary');