Do not generate ENUM types on postgres if x-db-type is specified for the enum column

fixes cebe#173

Author: cebe

src/lib/ColumnToCode.php

@@ -226,7 +226,7 @@ public function isJson():bool
 
     public function isEnum():bool
     {
-        return !empty($this->column->enumValues);
+        return !empty($this->column->enumValues) && empty($this->column->xDbType);
     }
 
     public function isDecimal()

src/lib/migrations/BaseMigrationBuilder.php

@@ -479,7 +479,7 @@ public function newColStr(string $tableAlias, \cebe\yii2openapi\db\ColumnSchema
 
     public static function isEnum(\yii\db\ColumnSchema $columnSchema): bool
     {
-        if (!empty($columnSchema->enumValues) && is_array($columnSchema->enumValues)) {
+        if (!empty($columnSchema->enumValues) && is_array($columnSchema->enumValues) && empty($columnSchema->xDbType)) {
             return true;
         }
         return false;

src/lib/migrations/PostgresMigrationBuilder.php

@@ -147,6 +147,10 @@ protected function createEnumMigrations():void
         $tableAlias = $this->model->getTableAlias();
         $enums = $this->model->getEnumAttributes();
         foreach ($enums as $attr) {
+            if (!empty($attr->xDbType)) {
+                // do not generate enum types when custom x-db-type is used
+                continue;
+            }
             $this->migration
                 ->addUpCode($this->recordBuilder->createEnum($tableAlias, $attr->columnName, $attr->enumValues), true)
                 ->addDownCode($this->recordBuilder->dropEnum($tableAlias, $attr->columnName), true);

tests/migrations/m100000_000000_pgsql.php

@@ -103,6 +103,7 @@ public function safeUp()
                 'json3' => $this->json()->defaultValue(Json::encode(['foo' => 'bar', 'bar' => 'baz'])),
                 'json4' => "json DEFAULT '" . new Expression(Json::encode(['ffo' => 'bar'])) . "'",
                 'status' => '"'.$enumTypeName.'"',
+                'status_x' => 'varchar(10)',
                 'search' => 'tsvector'
             ]);
         $columns = [

tests/specs/enum/change/maria/app/migrations_maria_db/m200000_000001_create_table_newcolumns.php

@@ -10,6 +10,7 @@ public function up()
         $this->createTable('{{%newcolumns}}', [
             'id' => $this->primaryKey(),
             'new_column' => 'enum("ONE", "TWO", "THREE") NOT NULL DEFAULT \'ONE\'',
+            0 => 'new_column_x varchar(10) NOT NULL DEFAULT \'ONE\'',
         ]);
     }
 

tests/specs/enum/change/mysql/app/migrations_mysql_db/m200000_000001_create_table_newcolumns.php

@@ -10,6 +10,7 @@ public function up()
         $this->createTable('{{%newcolumns}}', [
             'id' => $this->primaryKey(),
             'new_column' => 'enum("ONE", "TWO", "THREE") NOT NULL DEFAULT \'ONE\'',
+            0 => 'new_column_x varchar(10) NOT NULL DEFAULT \'ONE\'',
         ]);
     }
 

tests/specs/enum/change/pgsql/app/migrations_pgsql_db/m200000_000001_create_table_newcolumns.php

@@ -11,6 +11,7 @@ public function safeUp()
         $this->createTable('{{%newcolumns}}', [
             'id' => $this->primaryKey(),
             'new_column' => '"enum_itt_newcolumns_new_column" NOT NULL DEFAULT \'ONE\'',
+            0 => '"new_column_x" varchar(10) NOT NULL DEFAULT \'ONE\'',
         ]);
     }
 

tests/specs/enum/fresh/maria/app/migrations_maria_db/m200000_000001_create_table_newcolumns.php

@@ -10,6 +10,7 @@ public function up()
         $this->createTable('{{%newcolumns}}', [
             'id' => $this->primaryKey(),
             'new_column' => 'enum("ONE", "TWO", "THREE") NOT NULL DEFAULT \'ONE\'',
+            0 => 'new_column_x varchar(10) NOT NULL DEFAULT \'ONE\'',
         ]);
     }
 

tests/specs/enum/fresh/mysql/app/migrations_mysql_db/m200000_000001_create_table_newcolumns.php

@@ -10,6 +10,7 @@ public function up()
         $this->createTable('{{%newcolumns}}', [
             'id' => $this->primaryKey(),
             'new_column' => 'enum("ONE", "TWO", "THREE") NOT NULL DEFAULT \'ONE\'',
+            0 => 'new_column_x varchar(10) NOT NULL DEFAULT \'ONE\'',
         ]);
     }
 

tests/specs/enum/fresh/mysql/enum.yaml

@@ -59,6 +59,16 @@ components:
           default:
             ONE
           nullable: false
+        new_column_x:
+          type: string
+          enum:
+            - ONE
+            - TWO
+            - THREE
+          default:
+            ONE
+          x-db-type: varchar(10)
+          nullable: false
 
     Editcolumn:
       type: object