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

Author: SOHELAHMED7

src/lib/migrations/BaseMigrationBuilder.php

@@ -161,6 +161,8 @@ public function buildFresh():MigrationModel
             }
         }
 
+        $this->addCommentsMigration();
+
         return $this->migration;
     }
 
@@ -275,6 +277,8 @@ abstract public static function getColumnSchemaBuilderClass(): string;
      */
     abstract protected function findTableIndexes():array;
 
+    abstract public function addCommentsMigration();
+
     protected function buildIndexChanges():void
     {
         $haveIndexes = $this->findTableIndexes();

src/lib/migrations/MysqlMigrationBuilder.php

@@ -159,4 +159,10 @@ public function modifyDesiredInContextOfCurrent(ColumnSchema $current, ColumnSch
             $desired->size = $current->size;
         }
     }
+
+    public function addCommentsMigration()
+    {
+        // nothing to do here as comments can be defined in same statement as of alter/add column in MySQL
+        // this method is only for PgSQL
+    }
 }

src/lib/migrations/PostgresMigrationBuilder.php

@@ -256,4 +256,16 @@ public function modifyDesiredInContextOfCurrent(ColumnSchema $current, ColumnSch
             $desired->size = $current->size;
         }
     }
+
+    public function addCommentsMigration()
+    {
+        $tableAlias = $this->model->getTableAlias();
+        foreach ($this->newColumns as $column) {
+            if($column->comment) {
+                $this->migration
+                    ->addUpCode($this->recordBuilder->pgsqlCommentOnColumn($tableAlias, $column->name, $column->comment))
+                ;
+            }
+        }
+    }
 }

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

@@ -14,13 +14,13 @@ 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
+          type: number
+          x-db-type: double precision
           description: desc 2
     Animal:
       type: object

tests/unit/IssueFixTest.php

@@ -364,8 +364,9 @@ public function test158BugGiiapiGeneratedRulesEnumWithTrim()
     // https://github.com/php-openapi/yii2-openapi/issues/60
     public function test60DescriptionOfAPropertyInSpecMustCorrespondToDbTableColumnComment()
     {
-        $this->deleteTableFor60DescriptionOfAPropertyInSpecMustCorrespondToDbTableColumnComment();
-        $this->createTableFor60DescriptionOfAPropertyInSpecMustCorrespondToDbTableColumnComment();
+        // MySQL
+        $this->deleteTableFor60DescriptionOfAProperty();
+        $this->createTableFor60DescriptionOfAProperty();
         $testFile = Yii::getAlias("@specs/issue_fix/60_description_of_a_property_in_spec_must_correspond_to_db_table_column_comment/index.php");
         $this->runGenerator($testFile);
         // $actualFiles = FileHelper::findFiles(Yii::getAlias('@app'), [
@@ -375,13 +376,13 @@ public function test60DescriptionOfAPropertyInSpecMustCorrespondToDbTableColumnC
         //     'recursive' => true,
         // ]);
         // $this->checkFiles($actualFiles, $expectedFiles);
-
-        $this->deleteTableFor60DescriptionOfAPropertyInSpecMustCorrespondToDbTableColumnComment();
+        $this->deleteTableFor60DescriptionOfAProperty();
 
 
+        // PgSQL
         $this->changeDbToPgsql();
-        $this->deleteTableFor60DescriptionOfAPropertyInSpecMustCorrespondToDbTableColumnComment();
-        $this->createTableFor60DescriptionOfAPropertyInSpecMustCorrespondToDbTableColumnComment();
+        $this->deleteTableFor60DescriptionOfAProperty();
+        $this->createTableFor60DescriptionOfAProperty();
         $this->runGenerator($testFile, 'pgsql');
         // $actualFiles = FileHelper::findFiles(Yii::getAlias('@app'), [
         //     'recursive' => true,
@@ -390,11 +391,10 @@ public function test60DescriptionOfAPropertyInSpecMustCorrespondToDbTableColumnC
         //     'recursive' => true,
         // ]);
         // $this->checkFiles($actualFiles, $expectedFiles);
-
-        $this->deleteTableFor60DescriptionOfAPropertyInSpecMustCorrespondToDbTableColumnComment();
+        $this->deleteTableFor60DescriptionOfAProperty();
     }
 
-    private function createTableFor60DescriptionOfAPropertyInSpecMustCorrespondToDbTableColumnComment()
+    private function createTableFor60DescriptionOfAProperty()
     {
         Yii::$app->db->createCommand()->createTable('{{%animals}}', [
             'id' => 'pk',
@@ -403,7 +403,7 @@ private function createTableFor60DescriptionOfAPropertyInSpecMustCorrespondToDbT
         ])->execute();
     }
 
-    private function deleteTableFor60DescriptionOfAPropertyInSpecMustCorrespondToDbTableColumnComment()
+    private function deleteTableFor60DescriptionOfAProperty()
     {
         Yii::$app->db->createCommand('DROP TABLE IF EXISTS {{%animals}}')->execute();
     }