Fix enum related issues + add more tests for it for all 3 DBs

src/lib/migrations/BaseMigrationBuilder.php

@@ -204,20 +204,6 @@ function (string $unknownColumn) {
                 // do not adjust existing primary keys
                 continue;
             }
-            // TODO this section is not concretely correct
-            // type can be one of: char, string, text, boolean, smallint, integer, bigint, float, decimal, datetime,
-            // timestamp, time, date, binary, and money.
-            // `enum` is not a part of it
-            // also real DB type required enum values in MySQL and new `TYPE` in PgSQL
-            if (!empty($current->enumValues)) {
-                $current->type = 'enum';
-                $current->dbType = 'enum';
-            }
-            if (!empty($desired->enumValues)) {
-                $desired->type = 'enum';
-                $desired->dbType = 'enum';
-            }
-            // section end
             $changedAttributes = $this->compareColumns($current, $desired);
             if (empty($changedAttributes)) {
                 continue;
@@ -440,9 +426,11 @@ public function tmpSaveNewCol(\cebe\yii2openapi\db\ColumnSchema $columnSchema):
         }
 
         // create enum if relevant
-        if (ApiGenerator::isPostgres() && !empty($columnSchema->enumValues)) {
+        if (ApiGenerator::isPostgres() && static::isEnum($columnSchema)) {
             $allEnumValues = $columnSchema->enumValues;
-            $allEnumValues = array_map(function ($aValue) {return "'$aValue'";}, $allEnumValues);
+            $allEnumValues = array_map(function ($aValue) {
+                return "'$aValue'";
+            }, $allEnumValues);
             Yii::$app->db->createCommand(
                 'CREATE TYPE enum_'.$columnSchema->name.' AS ENUM('.implode(', ', $allEnumValues).')'
             )->execute();
@@ -466,4 +454,24 @@ public function newColStr(\cebe\yii2openapi\db\ColumnSchema $columnSchema): stri
         $ctc = new ColumnToCode(\Yii::$app->db->schema, $columnSchema, false, false, true);
         return ColumnToCode::undoEscapeQuotes($ctc->getCode());
     }
+
+    public static function isEnum(\yii\db\ColumnSchema $columnSchema): bool
+    {
+        if (!empty($columnSchema->enumValues) && is_array($columnSchema->enumValues)) {
+            return true;
+        }
+        return false;
+    }
+
+    public static function isEnumValuesChanged(
+        \yii\db\ColumnSchema $current,
+        \yii\db\ColumnSchema $desired
+    ): bool
+    {
+        if (static::isEnum($current) && static::isEnum($desired) &&
+            $current->enumValues !== $desired->enumValues) {
+            return true;
+        }
+        return false;
+    }
 }

src/lib/migrations/MysqlMigrationBuilder.php

@@ -29,8 +29,8 @@ protected function buildColumnChanges(ColumnSchema $current, ColumnSchema $desir
         foreach ($changed as $attr) {
             $newColumn->$attr = $desired->$attr;
         }
-        if (!empty($newColumn->enumValues)) {
-            $newColumn->dbType = 'enum';
+        if (static::isEnum($newColumn)) {
+            $newColumn->dbType = 'enum'; // TODO this is concretely not correct
         }
         $this->migration->addUpCode($this->recordBuilder->alterColumn($this->model->getTableAlias(), $newColumn))
                         ->addDownCode($this->recordBuilder->alterColumn($this->model->getTableAlias(), $current));
@@ -119,12 +119,6 @@ public function modifyCurrent(ColumnSchema $current): void
         if ($current->phpType === 'integer' && $current->defaultValue !== null) {
             $current->defaultValue = (int)$current->defaultValue;
         }
-
-        // TODO this is not concretely correct, reason is in BaseMigrationBuilder
-        if (!empty($current->enumValues)) {
-            $current->type = 'enum';
-            $current->dbType = 'enum';
-        }
     }
 
     public function modifyDesired(ColumnSchema $desired): void
@@ -138,12 +132,6 @@ public function modifyDesired(ColumnSchema $desired): void
             $desired->precision = $decimalAttributes['precision'];
             $desired->scale = $decimalAttributes['scale'];
         }
-
-        // TODO this is not concretely correct, reason is in BaseMigrationBuilder
-        if (!empty($desired->enumValues)) {
-            $desired->type = 'enum';
-            $desired->dbType = 'enum';
-        }
     }
 
     public function modifyDesiredInContextOfCurrent(ColumnSchema $current, ColumnSchema $desired): void

src/lib/migrations/PostgresMigrationBuilder.php

@@ -22,7 +22,7 @@ protected function buildColumnsCreation(array $columns):void
     {
         foreach ($columns as $column) {
             $tableName = $this->model->getTableAlias();
-            if ($column->dbType === 'enum') {
+            if (static::isEnum($column)) {
                 $this->migration->addUpCode($this->recordBuilder->createEnum($column->name, $column->enumValues))
                                 ->addDownCode($this->recordBuilder->dropEnum($column->name), true);
             }
@@ -41,8 +41,8 @@ protected function buildColumnsDrop(array $columns):void
             $tableName = $this->model->getTableAlias();
             $this->migration->addDownCode($this->recordBuilder->addDbColumn($tableName, $column))
                             ->addUpCode($this->recordBuilder->dropColumn($tableName, $column->name));
-            if ($column->dbType === 'enum') {
-                $this->migration->addDownCode($this->recordBuilder->createEnum($column->name, $column->enumValues), true)
+            if (static::isEnum($column)) {
+                $this->migration->addDownCode($this->recordBuilder->createEnum($column->name, $column->enumValues))
                                 ->addUpCode($this->recordBuilder->dropEnum($column->name));
             }
         }
@@ -54,9 +54,9 @@ protected function buildColumnsDrop(array $columns):void
     protected function buildColumnChanges(ColumnSchema $current, ColumnSchema $desired, array $changed):void
     {
         $tableName = $this->model->getTableAlias();
-        $isChangeToEnum = $current->type !== $desired->type && !empty($desired->enumValues);
-        $isChangeFromEnum = $current->type !== $desired->type && !empty($current->enumValues);
-        $isChangedEnum = $current->type === $desired->type && !empty($current->enumValues);
+        $isChangeToEnum = !static::isEnum($current) && static::isEnum($desired);
+        $isChangeFromEnum = static::isEnum($current) && !static::isEnum($desired);
+        $isChangedEnum = static::isEnumValuesChanged($current, $desired);
         if ($isChangedEnum) {
             // Generation for change enum values not supported. Do it manually
             // This action require several steps and can't be applied during single transaction
@@ -210,11 +210,6 @@ public function modifyCurrent(ColumnSchema $current): void
         if ($current->phpType === 'integer' && $current->defaultValue !== null) {
             $current->defaultValue = (int)$current->defaultValue;
         }
-        // TODO this is not concretely correct, reason is in BaseMigrationBuilder
-        if (!empty($current->enumValues)) {
-            $current->type = 'enum';
-            $current->dbType = 'enum';
-        }
     }
 
     public function modifyDesired(ColumnSchema $desired): void
@@ -227,11 +222,6 @@ public function modifyDesired(ColumnSchema $desired): void
             $desired->precision = $decimalAttributes['precision'];
             $desired->scale = $decimalAttributes['scale'];
         }
-        // TODO this is not concretely correct, reason is in BaseMigrationBuilder
-        if (!empty($desired->enumValues)) {
-            $desired->type = 'enum';
-            $desired->dbType = 'enum';
-        }
     }
 
     public function modifyDesiredInContextOfCurrent(ColumnSchema $current, ColumnSchema $desired): void

tests/specs/enum/enum.yaml

@@ -32,6 +32,34 @@ components:
             TV
           nullable: false
 
+    Newcolumn:
+      type: object
+      description: New Fresh table with new enum column for migration code generation
+      required:
+        - id
+      properties:
+        id:
+          type: integer
+        # device:
+        #   type: string
+        #   maxLength: 8
+        #   enum:
+        #     - MOBILE
+        #     - TV
+        #     - COMPUTER
+        #   default:
+        #     TV
+        #   nullable: false
+        new_column:
+          type: string
+          enum:
+            - ONE
+            - TWO
+            - THREE
+          default:
+            ONE
+          nullable: false
+
     Editcolumn:
       type: object
       description: Table with edit enum columns for migration code generation

tests/unit/EnumTest.php

@@ -41,6 +41,26 @@ public function testEnumFresh()
         // $this->compareFiles($actualFiles, $expectedFiles);
     }
 
+    public function testAddNewEnumColumn()
+    {
+        $this->deleteTables();
+        $this->createTableForNewEnumColumn();
+        $testFile = Yii::getAlias("@specs/enum/enum.php");
+        $this->runGenerator($testFile, 'mysql');
+
+        $this->changeDbToMariadb();
+        $this->deleteTables();
+        $this->createTableForNewEnumColumn();
+        $testFile = Yii::getAlias("@specs/enum/enum.php");
+        $this->runGenerator($testFile, 'maria');
+
+        $this->changeDbToPgsql();
+        $this->deleteTables();
+        $this->createTableForNewEnumColumn();
+        $testFile = Yii::getAlias("@specs/enum/enum.php");
+        $this->runGenerator($testFile, 'pgsql');
+    }
+
     public function testEnumToString()
     {
         $this->deleteTables();
@@ -83,6 +103,9 @@ private function deleteTables()
     {
         if (ApiGenerator::isPostgres()) {
             Yii::$app->db->createCommand('DROP TYPE IF EXISTS enum_device CASCADE')->execute();
+            Yii::$app->db->createCommand('DROP TYPE IF EXISTS enum_connection CASCADE')->execute();
+            Yii::$app->db->createCommand('DROP TYPE IF EXISTS enum_new_column CASCADE')->execute();
+            Yii::$app->db->createCommand('DROP TYPE IF EXISTS enum_delete_col CASCADE')->execute();
         }
         Yii::$app->db->createCommand('DROP TABLE IF EXISTS {{%pristines}}')->execute();
         Yii::$app->db->createCommand('DROP TABLE IF EXISTS {{%newcolumns}}')->execute();
@@ -107,4 +130,21 @@ private function createTableForEditEnumToString()
             'connection' => 'string'
         ])->execute();
     }
+
+    private function createTableForNewEnumColumn()
+    {
+        if (ApiGenerator::isPostgres()) {
+            Yii::$app->db->createCommand('CREATE TYPE enum_delete_col AS ENUM(\'FOUR\', \'FIVE\', \'SIX\')')->execute();
+            Yii::$app->db->createCommand()->createTable('{{%newcolumns}}', [
+                'id' => 'pk',
+                'delete_col' => 'enum_delete_col'
+            ])->execute();
+            return;
+        }
+
+        Yii::$app->db->createCommand()->createTable('{{%newcolumns}}', [
+            'id' => 'pk',
+            'delete_col' => 'enum("FOUR", "FIVE", "SIX")'
+        ])->execute();
+    }
 }