Add 'AFTER column' feature in migrations; resolve #102

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
 

src/lib/ColumnToCode.php

@@ -53,6 +53,12 @@ class ColumnToCode
      */
     private $dbSchema;
 
+    /**
+     * @var string
+     * @example {{%table}}
+     */
+    private $tableAlias;
+
     /**
      * @var bool
      */
@@ -77,9 +83,9 @@ class ColumnToCode
      */
     private $isPk = false;
 
-    private $rawParts = ['type' => null, 'nullable' => null, 'default' => null];
+    private $rawParts = ['type' => null, 'nullable' => null, 'default' => null, 'after' => null];
 
-    private $fluentParts = ['type' => null, 'nullable' => null, 'default' => null];
+    private $fluentParts = ['type' => null, 'nullable' => null, 'default' => null, 'after' => null];
 
     /**
      * @var bool
@@ -96,6 +102,13 @@ class ColumnToCode
      */
     private $alterByXDbType;
 
+    /**
+     * @var null|string
+     * Column name of previous column/field.
+     * Used for `AFTER` in SQL to preserve order as in OpenAPI schema defination
+     */
+    private $previousColumnName;
+
     /**
      * ColumnToCode constructor.
      * @param \yii\db\Schema       $dbSchema
@@ -107,18 +120,22 @@ class ColumnToCode
      */
     public function __construct(
         Schema $dbSchema,
+        string $tableAlias,
         ColumnSchema $column,
         bool $fromDb = false,
         bool $alter = false,
         bool $raw = false,
-        bool $alterByXDbType = false
+        bool $alterByXDbType = false,
+        ?string $previousColumnName = null
     ) {
         $this->dbSchema = $dbSchema;
+        $this->tableAlias = $tableAlias;
         $this->column = $column;
         $this->fromDb = $fromDb;
         $this->alter = $alter;
         $this->raw = $raw;
         $this->alterByXDbType = $alterByXDbType;
+        $this->previousColumnName = $previousColumnName;
 
         // We use `property_exists()` because sometimes we can have instance of \yii\db\mysql\ColumnSchema (or of Maria/Pgsql) or \cebe\yii2openapi\db\ColumnSchema
         if (property_exists($this->column, 'xDbType') && is_string($this->column->xDbType) && !empty($this->column->xDbType)) {
@@ -134,7 +151,7 @@ public function getCode(bool $quoted = false):string
             return '$this->' . $this->fluentParts['type'];
         }
         if ($this->isBuiltinType) {
-            $parts = [$this->fluentParts['type'], $this->fluentParts['nullable'], $this->fluentParts['default']];
+            $parts = [$this->fluentParts['type'], $this->fluentParts['nullable'], $this->fluentParts['default'], $this->fluentParts['after']];
             array_unshift($parts, '$this');
             return implode('->', array_filter(array_map('trim', $parts), 'trim'));
         }
@@ -148,8 +165,11 @@ 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->rawParts['after']) {
+            $code .= ' ' . $this->rawParts['after'];
+        }
+        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,13 +180,18 @@ 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) . "'";
+            $rawTableName = $this->dbSchema->getRawTableName($this->tableAlias);
+            $enumTypeName = 'enum_'.$rawTableName.'_'.$this->column->name;
+            return "'" . sprintf('"'.$enumTypeName.'" USING "%1$s"::"'.$enumTypeName.'"', $this->column->name) . "'";
         }
         if ($this->column->dbType === 'tsvector') {
             return "'" . $this->rawParts['type'] . "'";
         }
         if ($addUsingExpression && ApiGenerator::isPostgres()) {
-            return "'" . $this->rawParts['type'] . " ".$this->rawParts['nullable']
+            return "'" . $this->rawParts['type'] .
+                ($this->alterByXDbType ?
+                    '' :
+                    " ".$this->rawParts['nullable'])
                 .' USING "'.$this->column->name.'"::'.$this->typeWithoutSize($this->rawParts['type'])."'";
         }
 
@@ -270,7 +295,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 +356,13 @@ private function resolve():void
             $this->rawParts['type'] =
                 $this->column->dbType . (strpos($this->column->dbType, '(') !== false ? '' : $rawSize);
         }
-
+
+        if (ApiGenerator::isMysql() || ApiGenerator::isMariaDb()) { // for MySQL `AFTER` is supported for `ALTER table` queries and not supported for `CREATE table` queries
+            if ($this->previousColumnName) {
+                $this->fluentParts['after'] = 'after(\''.$this->previousColumnName.'\')';
+                $this->rawParts['after'] = 'AFTER '.$this->previousColumnName;
+            }
+        }
         $this->isBuiltinType = $this->raw ? false : $this->getIsBuiltinType($type, $dbType);
 
         $this->resolveDefaultValue();
@@ -346,7 +379,7 @@ private function getIsBuiltinType($type, $dbType)
             return false;
         }
 
-        if ($this->isEnum() && ApiGenerator::isMariaDb()) {
+        if ($this->isEnum()) {
             return false;
         }
         if ($this->fromDb === true) {
@@ -363,7 +396,8 @@ private function getIsBuiltinType($type, $dbType)
     private function resolveEnumType():void
     {
         if (ApiGenerator::isPostgres()) {
-            $this->rawParts['type'] = 'enum_' . $this->column->name;
+            $rawTableName = $this->dbSchema->getRawTableName($this->tableAlias);
+            $this->rawParts['type'] = '"enum_'.$rawTableName.'_' . $this->column->name.'"';
             return;
         }
         $this->rawParts['type'] = 'enum(' . self::mysqlEnumToString($this->column->enumValues) . ')';
@@ -421,16 +455,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;
             }