Add comments handling for PgSQL as it is different from MySQL - WIP

Author: SOHELAHMED7

src/lib/migrations/BaseMigrationBuilder.php

@@ -453,6 +453,9 @@ public function tmpSaveNewCol(string $tableAlias, \cebe\yii2openapi\db\ColumnSch
         }
 
         Yii::$app->db->createCommand()->createTable($tmpTableName, $column)->execute();
+        if (ApiGenerator::isPostgres()) {
+            Yii::$app->db->createCommand("comment on column $tmpTableName.$columnSchema->name is '$columnSchema->comment'")->execute();
+        }
 
         $table = Yii::$app->db->getTableSchema($tmpTableName);
 

src/lib/migrations/MigrationRecordBuilder.php

@@ -46,6 +46,8 @@ final class MigrationRecordBuilder
 
     public const ALTER_COLUMN_RAW_PGSQL = MigrationRecordBuilder::INDENT . "\$this->db->createCommand('ALTER TABLE %s ALTER COLUMN \"%s\" SET DATA TYPE %s')->execute();";
 
+    public const PGSQL_COMMENT_ON_COLUMN = MigrationRecordBuilder::INDENT . "\$this->addCommentOnColumn('%s', '%s', '%s');";
+
     /**
      * @var \yii\db\Schema
      */
@@ -345,4 +347,9 @@ public static function makeString(array $codeColumns): string
         $codeColumns = '['.PHP_EOL.self::INDENT.'    '.$codeColumns.PHP_EOL . self::INDENT.']';
         return $codeColumns;
     }
+
+    public function pgsqlCommentOnColumn($table, string $column, string $comment)
+    {
+        return sprintf(self::PGSQL_COMMENT_ON_COLUMN, $table, $column, $comment);
+    }
 }

src/lib/migrations/PostgresMigrationBuilder.php

@@ -9,7 +9,6 @@
 
 use cebe\yii2openapi\lib\items\DbIndex;
 use yii\db\ColumnSchema;
-use yii\helpers\VarDumper;
 use yii\helpers\ArrayHelper;
 
 final class PostgresMigrationBuilder extends BaseMigrationBuilder
@@ -65,7 +64,7 @@ protected function buildColumnChanges(ColumnSchema $current, ColumnSchema $desir
 
         if (!empty(array_intersect(['type', 'size'
                     , 'dbType', 'phpType'
-                    , 'precision', 'scale', 'unsigned'
+            , 'precision', 'scale', 'unsigned', 'comment'
         ], $changed))) {
             $addUsing = $this->isNeedUsingExpression($current->dbType, $desired->dbType);
             $this->migration->addUpCode($this->recordBuilder->alterColumnType($tableName, $desired, $addUsing));
@@ -91,6 +90,15 @@ protected function buildColumnChanges(ColumnSchema $current, ColumnSchema $desir
                 $this->migration->addUpCode($upCode)->addDownCode($downCode, true);
             }
         }
+
+        if (in_array('comment', $changed, true)) {
+//            if ($desired->comment) {
+            $this->migration->addUpCode($this->recordBuilder->pgsqlCommentOnColumn($tableName, $desired->name, $desired->comment));
+//            } else {
+//
+//            }
+        }
+
         if ($isChangeToEnum) {
             $this->migration->addUpCode($this->recordBuilder->createEnum($tableName, $desired->name, $desired->enumValues), true);
         }
@@ -127,7 +135,7 @@ protected function compareColumns(ColumnSchema $current, ColumnSchema $desired):
 
         foreach (['type', 'size', 'allowNull', 'defaultValue', 'enumValues'
                     , 'dbType', 'phpType'
-                    , 'precision', 'scale', 'unsigned'
+                     , 'precision', 'scale', 'unsigned', 'comment'
         ] as $attr) {
             if ($attr === 'defaultValue') {
                 if ($this->isDefaultValueChanged($current, $desiredFromDb)) {

tests/specs/issue_fix/60_description_of_a_property_in_spec_must_correspond_to_db_table_column_comment/index.yml

@@ -14,8 +14,10 @@ components:
         name:
           type: string
           description: desc
-        # colour:
-        #   type: string
+        colour:
+          type: string
+          # maxLength: 255
+          # x-db-type: varbinary # TODO
         description:
           type: string
           x-db-type: varchar
@@ -28,6 +30,13 @@ components:
         name:
           type: integer
           description: desc
+        #        description:
+        #          type: string
+        #          x-db-type: varchar
+        #          description: desc 2
+        g:
+          type: string
+          description: desc 3
 
 paths:
   '/':

tests/unit/IssueFixTest.php

@@ -377,13 +377,29 @@ public function test60DescriptionOfAPropertyInSpecMustCorrespondToDbTableColumnC
         // $this->checkFiles($actualFiles, $expectedFiles);
 
         $this->deleteTableFor60DescriptionOfAPropertyInSpecMustCorrespondToDbTableColumnComment();
+
+
+        $this->changeDbToPgsql();
+        $this->deleteTableFor60DescriptionOfAPropertyInSpecMustCorrespondToDbTableColumnComment();
+        $this->createTableFor60DescriptionOfAPropertyInSpecMustCorrespondToDbTableColumnComment();
+        $this->runGenerator($testFile, 'pgsql');
+        // $actualFiles = FileHelper::findFiles(Yii::getAlias('@app'), [
+        //     'recursive' => true,
+        // ]);
+        // $expectedFiles = FileHelper::findFiles(Yii::getAlias("@specs/issue_fix/60_description_of_a_property_in_spec_must_correspond_to_db_table_column_comment/mysql"), [
+        //     'recursive' => true,
+        // ]);
+        // $this->checkFiles($actualFiles, $expectedFiles);
+
+        $this->deleteTableFor60DescriptionOfAPropertyInSpecMustCorrespondToDbTableColumnComment();
     }
 
     private function createTableFor60DescriptionOfAPropertyInSpecMustCorrespondToDbTableColumnComment()
     {
         Yii::$app->db->createCommand()->createTable('{{%animals}}', [
             'id' => 'pk',
-            'name' => 'text comment "the name"',
+            'name' => 'text ', # comment "the name"
+            'g' => 'text'
         ])->execute();
     }