Merge PRs of SOHELAHMED7/yii2-openapi

Makefile

@@ -33,6 +33,7 @@ up:
 	docker-compose up -d
 	echo "Waiting for mariadb to start up..."
 	docker-compose exec -T mysql timeout 60s sh -c "while ! (mysql -udbuser -pdbpass -h maria --execute 'SELECT 1;' > /dev/null 2>&1); do echo -n '.'; sleep 0.1 ; done; echo 'ok'" || (docker-compose ps; docker-compose logs; exit 1)
+	echo "Create another test DB for PgSQL ..." # created because of enum in PgSQL are different than MySQL
 
 cli:
 	docker-compose exec php bash

README.md

@@ -316,8 +316,8 @@ e.g. attribute = 'my_property'.
         nullable: false
 ```
 
-### Handling of `enum` (#enum, #MariaDb)
-It work on MariaDb.
+### Handling of `enum` (#enum)
+It works on all 3 DB: MySQL, MariaDb and PgSQL.
 
  ```yaml
   test_table:
@@ -329,6 +329,8 @@ It work on MariaDb.
           - three
 ```
 
+Note: Change in enum values are not very simple. For Mysql and Mariadb, migrations will be generated but in many cases custom modification in it are required. For Pgsql migrations for change in enum values will not be generated. It should be handled manually.
+
 ### Handling of `numeric` (#numeric, #MariaDb)
 precision-default = 10
 scale-default = 2
@@ -372,9 +374,10 @@ Generated files:
 
 # Development
 
-There commands are available to develop and check the tests. It can be used inside the Docker container. To enter into bash of container run `make cli` .
+There commands are available to develop and check the tests. It is available inside the Docker container. To enter into bash shell of container, run `make cli` .
 
 ```bash
+cd tests
 ./yii migrate-mysql/up
 ./yii migrate-mysql/down 4
 
@@ -405,4 +408,3 @@ Professional support, consulting as well as software development services are av
 https://www.cebe.cc/en/contact
 
 Development of this library is sponsored by [cebe.:cloud: "Your Professional Deployment Platform"](https://cebe.cloud).
-

src/lib/ColumnToCode.php

@@ -148,8 +148,8 @@ public function getCode(bool $quoted = false):string
         }
 
         $code = $this->rawParts['type'] . ' ' . $this->rawParts['nullable'] . $default;
-        if (ApiGenerator::isMysql() && $this->isEnum()) {
-            return $quoted ? '"' . str_replace("\'", "'", $code) . '"' : $code;
+        if ((ApiGenerator::isMysql() || ApiGenerator::isMariaDb()) && $this->isEnum()) {
+            return $quoted ? "'" . $code . "'" : $code;
         }
         if (ApiGenerator::isPostgres() && $this->alterByXDbType) {
             return $quoted ? "'" . $this->rawParts['type'] . "'" : $this->rawParts['type'];
@@ -160,7 +160,7 @@ public function getCode(bool $quoted = false):string
     public function getAlterExpression(bool $addUsingExpression = false):string
     {
         if ($this->isEnum() && ApiGenerator::isPostgres()) {
-            return "'" . sprintf('enum_%1$s USING %1$s::enum_%1$s', $this->column->name) . "'";
+            return "'" . sprintf('enum_%1$s USING "%1$s"::enum_%1$s', $this->column->name) . "'";
         }
         if ($this->column->dbType === 'tsvector') {
             return "'" . $this->rawParts['type'] . "'";
@@ -270,7 +270,9 @@ public static function enumToString(array $enum):string
 
     public static function mysqlEnumToString(array $enum):string
     {
-        return implode(', ', array_map('self::wrapQuotes', $enum));
+        return implode(', ', array_map(function ($aEnumValue) {
+            return self::wrapQuotes($aEnumValue, '"');
+        }, $enum));
     }
 
     private function defaultValueJson(array $value):string
@@ -329,7 +331,7 @@ private function resolve():void
             $this->rawParts['type'] =
                 $this->column->dbType . (strpos($this->column->dbType, '(') !== false ? '' : $rawSize);
         }
-        
+
         $this->isBuiltinType = $this->raw ? false : $this->getIsBuiltinType($type, $dbType);
 
         $this->resolveDefaultValue();
@@ -346,7 +348,7 @@ private function getIsBuiltinType($type, $dbType)
             return false;
         }
 
-        if ($this->isEnum() && ApiGenerator::isMariaDb()) {
+        if ($this->isEnum()) {
             return false;
         }
         if ($this->fromDb === true) {
@@ -421,16 +423,18 @@ private function resolveDefaultValue():void
                 break;
             default:
                 $isExpression = StringHelper::startsWith($value, 'CURRENT')
+                    || StringHelper::startsWith($value, 'current')
                     || StringHelper::startsWith($value, 'LOCAL')
                     || substr($value, -1, 1) === ')';
                 if ($isExpression) {
                     $this->fluentParts['default'] = 'defaultExpression("' . self::escapeQuotes((string)$value) . '")';
+                    $this->rawParts['default'] = $value;
                 } else {
                     $this->fluentParts['default'] = $expectInteger
                         ? 'defaultValue(' . $value . ')' : 'defaultValue("' . self::escapeQuotes((string)$value) . '")';
+                    $this->rawParts['default'] = $expectInteger ? $value : self::wrapQuotes($value);
                 }
-                $this->rawParts['default'] = $expectInteger ? $value : self::wrapQuotes($value);
-                if (ApiGenerator::isMysql() && $this->isEnum()) {
+                if ((ApiGenerator::isMysql() || ApiGenerator::isMariaDb()) && $this->isEnum()) {
                     $this->rawParts['default'] = self::escapeQuotes($this->rawParts['default']);
                 }
         }

src/lib/ValidationRulesBuilder.php

@@ -63,6 +63,10 @@ public function build():array
             }
         }
         foreach ($this->model->attributes as $attribute) {
+            // column/field/property with name `id` is considered as Primary Key by this library and it is automatically handled by DB/Yii; so remove it from validation `rules()`
+            if ($attribute->columnName === 'id' || $attribute->propertyName === 'id') {
+                continue;
+            }
             $this->resolveAttributeRules($attribute);
         }
 
@@ -181,6 +185,10 @@ private function prepareTypeScope():void
             if ($attribute->isReadOnly()) {
                 continue;
             }
+            // column/field/property with name `id` is considered as Primary Key by this library and it is automatically handled by DB/Yii; so remove it from validation `rules()`
+            if ($attribute->columnName === 'id' || $attribute->propertyName === 'id') {
+                continue;
+            }
             if ($attribute->defaultValue === null && $attribute->isRequired()) {
                 $this->typeScope['required'][$attribute->columnName] = $attribute->columnName;
             }

src/lib/migrations/BaseMigrationBuilder.php

@@ -7,6 +7,7 @@
 
 namespace cebe\yii2openapi\lib\migrations;
 
+use cebe\yii2openapi\generator\ApiGenerator;
 use cebe\yii2openapi\lib\ColumnToCode;
 use cebe\yii2openapi\lib\items\DbModel;
 use cebe\yii2openapi\lib\items\ManyToManyRelation;
@@ -15,6 +16,7 @@
 use yii\db\ColumnSchema;
 use yii\helpers\VarDumper;
 use yii\db\Connection;
+use yii\db\Expression;
 
 abstract class BaseMigrationBuilder
 {
@@ -203,14 +205,6 @@ function (string $unknownColumn) {
                 // do not adjust existing primary keys
                 continue;
             }
-            if (!empty($current->enumValues)) {
-                $current->type = 'enum';
-                $current->dbType = 'enum';
-            }
-            if (!empty($desired->enumValues)) {
-                $desired->type = 'enum';
-                $desired->dbType = 'enum';
-            }
             $changedAttributes = $this->compareColumns($current, $desired);
             if (empty($changedAttributes)) {
                 continue;
@@ -428,8 +422,25 @@ public function tmpSaveNewCol(\cebe\yii2openapi\db\ColumnSchema $columnSchema):
 
         if (is_string($columnSchema->xDbType) && !empty($columnSchema->xDbType)) {
             $column = [$columnSchema->name.' '.$this->newColStr($columnSchema)];
+            if (ApiGenerator::isPostgres() && static::isEnum($columnSchema)) {
+                $column = strtr($column, ['enum_'.$columnSchema->name => 'tmp_enum_'.$columnSchema->name.'_']);
+            }
         } else {
             $column = [$columnSchema->name => $this->newColStr($columnSchema)];
+            if (ApiGenerator::isPostgres() && static::isEnum($columnSchema)) {
+                $column[$columnSchema->name] = strtr($column[$columnSchema->name], ['enum_'.$columnSchema->name => 'tmp_enum_'.$columnSchema->name.'_']);
+            }
+        }
+
+        // create enum if relevant
+        if (ApiGenerator::isPostgres() && static::isEnum($columnSchema)) {
+            $allEnumValues = $columnSchema->enumValues;
+            $allEnumValues = array_map(function ($aValue) {
+                return "'$aValue'";
+            }, $allEnumValues);
+            Yii::$app->db->createCommand(
+                'CREATE TYPE tmp_enum_'.$columnSchema->name.'_ AS ENUM('.implode(', ', $allEnumValues).')'
+            )->execute();
         }
 
         Yii::$app->db->createCommand()->createTable($tableName, $column)->execute();
@@ -438,6 +449,16 @@ public function tmpSaveNewCol(\cebe\yii2openapi\db\ColumnSchema $columnSchema):
 
         Yii::$app->db->createCommand()->dropTable($tableName)->execute();
 
+        if (ApiGenerator::isPostgres() && static::isEnum($columnSchema)) {// drop enum
+            Yii::$app->db->createCommand('DROP TYPE tmp_enum_'.$columnSchema->name.'_')->execute();
+            if ($table->columns[$columnSchema->name]->dbType !== 'tmp_enum_'.$columnSchema->name.'_') {
+                throw new \Exception('Unknown error related to PgSQL enum');
+            }
+            // reset back column enum name to original as we are comparing with current
+            // e.g. we get different enum type name such as `enum_status` and `tmp_enum_status_` even there is no change, so below statement fix this issue
+            $table->columns[$columnSchema->name]->dbType = 'enum_'.$columnSchema->name;
+        }
+
         return $table->columns[$columnSchema->name];
     }
 
@@ -446,4 +467,43 @@ 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;
+    }
+
+    public function isDefaultValueChanged(
+        ColumnSchema $current,
+        ColumnSchema $desired
+    ): bool {
+        // if the default value is object of \yii\db\Expression then default value is expression instead of constant. See https://dev.mysql.com/doc/refman/8.0/en/data-type-defaults.html
+        // in such case instead of comparing two objects, we should compare expression
+
+        if ($current->defaultValue instanceof Expression &&
+            $desired->defaultValue instanceof Expression
+            && $current->defaultValue->expression === $desired->defaultValue->expression
+        ) {
+            return false;
+        }
+
+        if ($current->defaultValue !== $desired->defaultValue) {
+            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));
@@ -53,8 +53,14 @@ protected function compareColumns(ColumnSchema $current, ColumnSchema $desired):
                     , 'dbType', 'phpType'
                     , 'precision', 'scale', 'unsigned'
         ] as $attr) {
-            if ($current->$attr !== $desiredFromDb->$attr) {
-                $changedAttributes[] = $attr;
+            if ($attr === 'defaultValue') {
+                if ($this->isDefaultValueChanged($current, $desiredFromDb)) {
+                    $changedAttributes[] = $attr;
+                }
+            } else {
+                if ($current->$attr !== $desiredFromDb->$attr) {
+                    $changedAttributes[] = $attr;
+                }
             }
         }
         return $changedAttributes;

src/lib/migrations/PostgresMigrationBuilder.php

@@ -22,9 +22,9 @@ 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));
+                                ->addDownCode($this->recordBuilder->dropEnum($column->name), true);
             }
             $this->migration->addUpCode($this->recordBuilder->addColumn($tableName, $column))
                             ->addDownCode($this->recordBuilder->dropColumn($tableName, $column->name));
@@ -41,9 +41,9 @@ 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') {
+            if (static::isEnum($column)) {
                 $this->migration->addDownCode($this->recordBuilder->createEnum($column->name, $column->enumValues))
-                                ->addUpCode($this->recordBuilder->dropEnum($column->name), true);
+                                ->addUpCode($this->recordBuilder->dropEnum($column->name));
             }
         }
     }
@@ -54,22 +54,20 @@ 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
             return;
         }
-        if ($isChangeToEnum) {
-            $this->migration->addUpCode($this->recordBuilder->createEnum($desired->name, $desired->enumValues), true);
-        }
-        if ($isChangeFromEnum) {
-            $this->migration->addUpCode($this->recordBuilder->dropEnum($current->name));
-        }
-        if (!empty(array_intersect(['type', 'size'], $changed))) {
-            $addUsing = $this->isNeedUsingExpression($desired->type, $current->type);
+
+        if (!empty(array_intersect(['type', 'size'
+                    , 'dbType', 'phpType'
+                    , 'precision', 'scale', 'unsigned'
+        ], $changed))) {
+            $addUsing = $this->isNeedUsingExpression($current->type, $desired->type);
             $this->migration->addUpCode($this->recordBuilder->alterColumnType($tableName, $desired));
             $this->migration->addDownCode($this->recordBuilder->alterColumnTypeFromDb($tableName, $current, $addUsing));
         }
@@ -93,9 +91,16 @@ protected function buildColumnChanges(ColumnSchema $current, ColumnSchema $desir
                 $this->migration->addUpCode($upCode)->addDownCode($downCode, true);
             }
         }
+        if ($isChangeToEnum) {
+            $this->migration->addUpCode($this->recordBuilder->createEnum($desired->name, $desired->enumValues), true);
+        }
+        if ($isChangeFromEnum) {
+            $this->migration->addUpCode($this->recordBuilder->dropEnum($current->name));
+        }
+
         if ($isChangeFromEnum) {
             $this->migration
-                ->addDownCode($this->recordBuilder->createEnum($current->name, $current->enumValues), true);
+                ->addDownCode($this->recordBuilder->createEnum($current->name, $current->enumValues));
         }
         if ($isChangeToEnum) {
             $this->migration->addDownCode($this->recordBuilder->dropEnum($current->name), true);
@@ -119,8 +124,14 @@ protected function compareColumns(ColumnSchema $current, ColumnSchema $desired):
                     , 'dbType', 'phpType'
                     , 'precision', 'scale', 'unsigned'
         ] as $attr) {
-            if ($current->$attr !== $desiredFromDb->$attr) {
-                $changedAttributes[] = $attr;
+            if ($attr === 'defaultValue') {
+                if ($this->isDefaultValueChanged($current, $desiredFromDb)) {
+                    $changedAttributes[] = $attr;
+                }
+            } else {
+                if ($current->$attr !== $desiredFromDb->$attr) {
+                    $changedAttributes[] = $attr;
+                }
             }
         }
         return $changedAttributes;
@@ -132,7 +143,7 @@ protected function createEnumMigrations():void
         foreach ($enums as $attr) {
             $this->migration
                 ->addUpCode($this->recordBuilder->createEnum($attr->columnName, $attr->enumValues), true)
-                ->addDownCode($this->recordBuilder->dropEnum($attr->columnName));
+                ->addDownCode($this->recordBuilder->dropEnum($attr->columnName), true);
         }
     }
 

src/lib/openapi/PropertySchema.php

@@ -530,7 +530,7 @@ public static function findMoreDetailOf(string $xDbType): array
     }
 
     /**
-     * This method is copied from protected method `getColumnPhpType()` of \yii\db\Schema class
+     * This method is copied + enhanced from protected method `getColumnPhpType()` of \yii\db\Schema class
      * Extracts the PHP type from abstract DB type.
      * @param \yii\db\ColumnSchema $column the column schema information
      * @return string PHP type name
@@ -546,6 +546,7 @@ public static function getColumnPhpType(ColumnSchema $column): string
             YiiDbSchema::TYPE_BOOLEAN => 'boolean',
             YiiDbSchema::TYPE_FLOAT => 'double',
             YiiDbSchema::TYPE_DOUBLE => 'double',
+            YiiDbSchema::TYPE_DECIMAL => 'double', # (enhanced)
             YiiDbSchema::TYPE_BINARY => 'resource',
             YiiDbSchema::TYPE_JSON => 'array',
         ];