Add ENUM column

CHANGELOG.md

@@ -53,6 +53,7 @@
 - Enh #387: Refactor `DMLQueryBuilder::upsert()` method (@Tigrov)
 - Chg #391: Update expression namespaces according to changes in `yiisoft/db` package (@Tigrov)
 - Chg #402: Throw exception on "unsigned" column usage (@vjik)
+- New #404: Add enumeration column type support (@vjik)
 
 ## 1.2.0 March 21, 2024
 

src/Column/ColumnDefinitionBuilder.php

@@ -104,6 +104,7 @@ protected function getDbType(ColumnInterface $column): string
             ColumnType::ARRAY => 'json',
             ColumnType::STRUCTURED => 'json',
             ColumnType::JSON => 'json',
+            ColumnType::ENUM => 'varchar',
             default => 'varchar',
         };
     }

src/Column/ColumnFactory.php

@@ -36,7 +36,6 @@ final class ColumnFactory extends AbstractColumnFactory
         'numeric' => ColumnType::DECIMAL,
         'char' => ColumnType::CHAR,
         'varchar' => ColumnType::STRING,
-        'enum' => ColumnType::STRING,
         'tinytext' => ColumnType::TEXT,
         'mediumtext' => ColumnType::TEXT,
         'longtext' => ColumnType::TEXT,

src/Schema.php

@@ -21,6 +21,7 @@
 use function array_column;
 use function array_map;
 use function count;
+use function in_array;
 use function strncasecmp;
 
 /**
@@ -241,18 +242,20 @@ protected function loadTableDefaultValues(string $tableName): array
      */
     protected function findColumns(TableSchemaInterface $table): bool
     {
-        $columns = $this->loadTableColumnsInfo($table->getName());
+        $tableName = $table->getName();
+        $columns = $this->loadTableColumnsInfo($tableName);
         $jsonColumns = $this->getJsonColumns($table);
+        $checks = $this->getTableChecks($tableName);
 
         foreach ($columns as $info) {
             if (in_array($info['name'], $jsonColumns, true)) {
                 $info['type'] = ColumnType::JSON;
             }
 
             $info['schema'] = $table->getSchemaName();
-            $info['table'] = $table->getName();
+            $info['table'] = $tableName;
 
-            $column = $this->loadColumn($info);
+            $column = $this->loadColumn($info, $checks);
             $table->column($info['name'], $column);
         }
 
@@ -314,12 +317,13 @@ protected function findViewNames(string $schema = ''): array
      * Loads the column information into a {@see ColumnInterface} object.
      *
      * @param array $info The column information.
+     * @param Check[] $checks
      *
      * @return ColumnInterface The column object.
      *
      * @psalm-param ColumnInfo $info
      */
-    private function loadColumn(array $info): ColumnInterface
+    private function loadColumn(array $info, array $checks): ColumnInterface
     {
         return $this->db->getColumnFactory()->fromDefinition($info['type'], [
             'defaultValueRaw' => $info['dflt_value'],
@@ -328,6 +332,7 @@ private function loadColumn(array $info): ColumnInterface
             'primaryKey' => (bool) $info['pk'],
             'schema' => $info['schema'],
             'table' => $info['table'],
+            'values' => $this->tryGetEnumValuesFromCheck($info['name'], $checks),
         ]);
     }
 
@@ -397,4 +402,47 @@ private function getJsonColumns(TableSchemaInterface $table): array
 
         return $result;
     }
+
+    /**
+     * @param Check[] $checks
+     *
+     * @psalm-return list<string>|null
+     */
+    private function tryGetEnumValuesFromCheck(string $name, array $checks): ?array
+    {
+        if (empty($checks)) {
+            return null;
+        }
+
+        foreach ($checks as $check) {
+            if ($this->isCheckNotStartsFromColumnName($check->expression, $name)) {
+                continue;
+            }
+
+            preg_match_all(
+                "~(?<!\sNOT)\s+IN\s*\(\s*('(?:''|[^'])*')(?:,\s*(?1))*~i",
+                $check->expression,
+                $block,
+            );
+
+            if (empty($block[0][0])) {
+                continue;
+            }
+
+            preg_match_all("~'((?:''|[^'])*)'~", $block[0][0], $matches);
+
+            return array_map(
+                static fn($v) => str_replace("''", "'", $v),
+                $matches[1] ?? [],
+            );
+        }
+
+        return null;
+    }
+
+    private function isCheckNotStartsFromColumnName(string $check, string $columnName): bool
+    {
+        $quotedColumnName = preg_quote($columnName, '~');
+        return preg_match("~^(?:(?i:$quotedColumnName)|[\"`\[]{$quotedColumnName}[\"`\]])\s~", $check) !== 1;
+    }
 }

tests/Column/EnumColumnTest.php

@@ -0,0 +1,124 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Db\Sqlite\Tests\Column;
+
+use PHPUnit\Framework\Attributes\TestWith;
+use Yiisoft\Db\Schema\Column\EnumColumn;
+use Yiisoft\Db\Sqlite\Tests\Support\IntegrationTestTrait;
+use Yiisoft\Db\Tests\Common\CommonEnumColumnTest;
+
+final class EnumColumnTest extends CommonEnumColumnTest
+{
+    use IntegrationTestTrait;
+
+    #[TestWith(['INTEGER CHECK (status IN (1, 2, 3))'])]
+    #[TestWith(["TEXT CHECK (status != 'abc')"])]
+    #[TestWith(["TEXT CHECK (status NOT IN ('a', 'b', 'c'))"])]
+    #[TestWith(["TEXT CHECK ('status' not IN ('a', 'b', 'c'))"])]
+    #[TestWith(["TEXT CHECK (\"Status\" IN ('a', 'b', 'c'))"])]
+    #[TestWith(["TEXT CHECK ('Status' IN ('a', 'b', 'c'))"])]
+    #[TestWith(["TEXT CHECK ([Status] IN ('a', 'b', 'c'))"])]
+    public function testNonEnumCheck(string $columnDefinition): void
+    {
+        $this->dropTable('test_enum_table');
+        $this->executeStatements(
+            <<<SQL
+            CREATE TABLE test_enum_table (
+                id INTEGER,
+                status $columnDefinition
+            )
+            SQL,
+        );
+
+        $db = $this->getSharedConnection();
+        $column = $db->getTableSchema('test_enum_table')->getColumn('status');
+
+        $this->assertNotInstanceOf(EnumColumn::class, $column);
+
+        $this->dropTable('test_enum_table');
+    }
+
+    #[TestWith([
+        'knot',
+        "TEXT CHECK (knot IN ('a', 'b'))",
+        ['a', 'b'],
+    ])]
+    #[TestWith([
+        'status',
+        "TEXT CHECK (status in ('a', 'b'))",
+        ['a', 'b'],
+    ])]
+    #[TestWith([
+        'letter',
+        "TEXT CHECK (letter IN ('a', 'b'))",
+        ['a', 'b'],
+    ])]
+    #[TestWith([
+        'letter',
+        "TEXT CHECK (LETTER IN ('a', 'b'))",
+        ['a', 'b'],
+    ])]
+    #[TestWith([
+        'letter',
+        "TEXT CHECK (`letter` IN ('a', 'b'))",
+        ['a', 'b'],
+    ])]
+    #[TestWith([
+        'letter',
+        "TEXT CHECK ([letter] IN ('a', 'b'))",
+        ['a', 'b'],
+    ])]
+    #[TestWith([
+        'letter',
+        "TEXT CHECK (\"letter\" IN ('a', 'b'))",
+        ['a', 'b'],
+    ])]
+    #[TestWith([
+        'status',
+        "TEXT CHECK (status IN\n(\n'a',\n'b'\n))",
+        ['a', 'b'],
+    ])]
+    public function testEnumCheck(string $columnName, string $columnDefinition, array $expectedValues): void
+    {
+        $this->dropTable('test_enum_table');
+
+        $quotedColumnName = $this->getSharedConnection()->getQuoter()->quoteColumnName($columnName);
+        $this->executeStatements(
+            <<<SQL
+            CREATE TABLE test_enum_table (
+                id INTEGER,
+                $quotedColumnName $columnDefinition
+            )
+            SQL,
+        );
+
+        $db = $this->getSharedConnection();
+        $column = $db->getTableSchema('test_enum_table')->getColumn($columnName);
+
+        $this->assertInstanceOf(EnumColumn::class, $column, $column::class);
+        $this->assertEqualsCanonicalizing($expectedValues, $column->getValues());
+
+        $this->dropTable('test_enum_table');
+    }
+
+    protected function createDatabaseObjectsStatements(): array
+    {
+        return [
+            <<<SQL
+            CREATE TABLE tbl_enum (
+                id INTEGER,
+                status TEXT CHECK(status IN ('active', 'unactive', 'pending'))
+            )
+            SQL,
+        ];
+    }
+
+    protected function dropDatabaseObjectsStatements(): array
+    {
+        return [
+            'DROP TABLE IF EXISTS tbl_enum',
+        ];
+    }
+}

tests/Provider/ColumnFactoryProvider.php

@@ -38,7 +38,6 @@ public static function dbTypes(): array
             ['char', ColumnType::CHAR, StringColumn::class],
             ['varchar', ColumnType::STRING, StringColumn::class],
             ['string', ColumnType::STRING, StringColumn::class],
-            ['enum', ColumnType::STRING, StringColumn::class],
             ['tinytext', ColumnType::TEXT, StringColumn::class],
             ['mediumtext', ColumnType::TEXT, StringColumn::class],
             ['longtext', ColumnType::TEXT, StringColumn::class],