Refactor ColumnDefinitionParser

CHANGELOG.md

@@ -177,6 +177,8 @@
 - Bug #1103: Fix view names' cache refreshing after "drop table" command execution (@vjik)
 - Chg #1103: Remove `AbstractCommand::refreshTableSchema()` method (@vjik)
 - Chg #1106: Remove parameters from `PdoConnectionInterface::getActivePdo()` method (@vjik)
+- Chg #1108: Refactor `ColumnDefinitionParser` and rename to `AbstractColumnDefinitionParser`,
+  add `ColumnDefinitionParserInterface` (@vjik)
 
 ## 1.3.0 March 21, 2024
 

UPGRADE.md

@@ -97,6 +97,12 @@ and the following changes were made:
 - added `DEFAULT_TYPE` constant to `AbstractColumn` class;
 - added method chaining.
 
+### `ColumnDefinitionParser` changes
+
+- Rename to `AbstractColumnDefinitionParser`;
+- Make class abstract and add abstract method `parseTypeParams()`;
+- Rename method `sizeInfo()` to `parseSizeInfo()`.
+
 ### Changes in constraint classes
 
 - Remove `Constraint` class;
@@ -293,3 +299,4 @@ Each table column has its own class in the `Yiisoft\Db\Schema\Column` namespace
 - Change `QueryPartsInterface::withQueries()` parameter to variadic with type `WithQuery`;
 - In `DQLQueryBuilderInterface::buildWithQueries()` method change first parameter type form `array[]` to `WithQuery[]`;
 - Remove `AbstractCommand::refreshTableSchema()` method;
+- Make method `AbstractColumnFactory::columnDefinitionParser()` abstract;

src/Schema/Column/AbstractColumnFactory.php

@@ -8,7 +8,7 @@
 use Yiisoft\Db\Constant\ColumnType;
 use Yiisoft\Db\Constant\PseudoType;
 use Yiisoft\Db\Expression\Expression;
-use Yiisoft\Db\Syntax\ColumnDefinitionParser;
+use Yiisoft\Db\Syntax\ColumnDefinitionParserInterface;
 
 use function array_diff_key;
 use function array_key_exists;
@@ -221,10 +221,7 @@ public function fromType(string $type, array $info = []): ColumnInterface
     /**
      * Returns the column definition parser.
      */
-    protected function columnDefinitionParser(): ColumnDefinitionParser
-    {
-        return new ColumnDefinitionParser();
-    }
+    abstract protected function columnDefinitionParser(): ColumnDefinitionParserInterface;
 
     /**
      * @psalm-param ColumnInfo $info

src/Syntax/ColumnDefinitionParser.php → src/Syntax/AbstractColumnDefinitionParser.php

@@ -6,7 +6,6 @@
 
 use function explode;
 use function preg_match;
-use function preg_match_all;
 use function preg_replace;
 use function str_replace;
 use function strlen;
@@ -29,7 +28,7 @@
  *     unsigned?: bool
  * }
  */
-class ColumnDefinitionParser
+abstract class AbstractColumnDefinitionParser implements ColumnDefinitionParserInterface
 {
     /**
      * Parses column definition string.
@@ -56,39 +55,50 @@
      */
     public function parse(string $definition): array
     {
-        preg_match('/^(\w*)(?:\(([^)]+)\))?(\[[\d\[\]]*\])?\s*/', $definition, $matches);
+        [$type, $typeParams, $dimension, $extraInfo] = $this->parseDefinition($definition);
 
-        $type = strtolower($matches[1]);
+        $type = strtolower($type);
         $info = ['type' => $type];
 
-        if (isset($matches[2]) && $matches[2] !== '') {
-            if ($type === 'enum') {
-                $info += $this->enumInfo($matches[2]);
-            } else {
-                $info += $this->sizeInfo($matches[2]);
-            }
+        if ($typeParams !== '' && $typeParams !== null) {
+            $info += $this->parseTypeParams($type, $typeParams);
         }
 
-        if (isset($matches[3])) {
+        if (isset($dimension)) {
             /** @psalm-var positive-int */
-            $info['dimension'] = substr_count($matches[3], '[');
+            $info['dimension'] = substr_count($dimension, '[');
         }
 
-        $extra = substr($definition, strlen($matches[0]));
-
-        return $info + $this->extraInfo($extra);
+        return $info + $this->extraInfo($extraInfo);
     }
 
     /**
-     * @psalm-return array{enumValues: list<string>}
+     * Parse the column definition into its components:
+     *  - type
+     *  - type parameters
+     *  - dimension
+     *  - extra information
+     *
+     * @psalm-return list{string, string|null, string|null, string|null}
      */
-    protected function enumInfo(string $values): array
+    protected function parseDefinition(string $definition): array
     {
-        preg_match_all("/'([^']*)'/", $values, $matches);
+        preg_match('/^(\w*)(?:\(([^)]+)\))?(\[[\d\[\]]*\])?\s*/', $definition, $matches);
 
-        return ['enumValues' => $matches[1]];
+        return [
+            $matches[1],
+            $matches[2] ?? null,
+            $matches[3] ?? null,
+            substr($definition, strlen($matches[0])),
+        ];
     }
 
+    /**
+     * @psalm-param non-empty-string $params
+     * @psalm-return array{enumValues?: list<string>, size?: int, scale?: int}
+     */
+    abstract protected function parseTypeParams(string $type, string $params): array;
+
     /**
      * @psalm-return ExtraInfo
      */
@@ -169,9 +179,9 @@
     /**
      * @psalm-return array{size: int, scale?: int}
      */
-    protected function sizeInfo(string $size): array
+    protected function parseSizeInfo(string $params): array
     {
-        $values = explode(',', $size);
+        $values = explode(',', $params);
 
         $info = [
             'size' => (int) $values[0],

src/Syntax/ColumnDefinitionParserInterface.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Db\Syntax;
+
+/**
+ * Parses column definition string. For example, `string(255)` or `int unsigned`.
+ */
+interface ColumnDefinitionParserInterface
+{
+    /**
+     * Parses column definition string.
+     *
+     * @param string $definition The column definition string. For example, `string(255)` or `int unsigned`.
+     *
+     * @return array The column information.
+     *
+     * @psalm-return array{
+     *     check?: string,
+     *     collation?: string,
+     *     comment?: string,
+     *     defaultValueRaw?: string,
+     *     dimension?: positive-int,
+     *     enumValues?: list<string>,
+     *     extra?: string,
+     *     notNull?: bool,
+     *     scale?: int,
+     *     size?: int,
+     *     type: lowercase-string,
+     *     unique?: bool,
+     *     unsigned?: bool,
+     * }
+     */
+    public function parse(string $definition): array;
+}

tests/Common/CommonColumnDefinitionParserTest.php

@@ -6,12 +6,9 @@
 
 use PHPUnit\Framework\Attributes\DataProviderExternal;
 use PHPUnit\Framework\TestCase;
-use Yiisoft\Db\Syntax\ColumnDefinitionParser;
+use Yiisoft\Db\Syntax\ColumnDefinitionParserInterface;
 use Yiisoft\Db\Tests\Provider\ColumnDefinitionParserProvider;
 
-/**
- * @group db
- */
 abstract class CommonColumnDefinitionParserTest extends TestCase
 {
     #[DataProviderExternal(ColumnDefinitionParserProvider::class, 'parse')]
@@ -22,8 +19,5 @@ public function testParse(string $definition, array $expected): void
         $this->assertSame($expected, $parser->parse($definition));
     }
 
-    protected function createColumnDefinitionParser(): ColumnDefinitionParser
-    {
-        return new ColumnDefinitionParser();
-    }
+    abstract protected function createColumnDefinitionParser(): ColumnDefinitionParserInterface;
 }

tests/Common/CommonColumnTest.php

@@ -215,7 +215,10 @@ public function testDateTimeColumn(float|int|string $value, array $expected): vo
 
         $values = array_fill_keys(array_keys($expected), $value);
 
-        $expected = array_map(static fn(string $value) => new DateTimeImmutable($value, new DateTimeZone('UTC')), $expected);
+        $expected = array_map(
+            static fn(string $value) => new DateTimeImmutable($value, new DateTimeZone('UTC')),
+            $expected,
+        );
 
         $command->insert(static::DATETIME_COLUMN_TABLE, $values)->execute();
 

tests/Db/Schema/Column/ColumnFactoryTest.php

@@ -4,13 +4,17 @@
 
 namespace Yiisoft\Db\Tests\Db\Schema\Column;
 
+use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\DataProviderExternal;
 use PHPUnit\Framework\TestCase;
 use Yiisoft\Db\Constant\ColumnType;
 use Yiisoft\Db\Schema\Column\AbstractArrayColumn;
+use Yiisoft\Db\Schema\Column\ArrayColumn;
 use Yiisoft\Db\Schema\Column\ArrayLazyColumn;
+use Yiisoft\Db\Schema\Column\BigIntColumn;
 use Yiisoft\Db\Schema\Column\ColumnInterface;
 use Yiisoft\Db\Schema\Column\DateTimeColumn;
+use Yiisoft\Db\Schema\Column\DoubleColumn;
 use Yiisoft\Db\Schema\Column\IntegerColumn;
 use Yiisoft\Db\Schema\Column\JsonLazyColumn;
 use Yiisoft\Db\Schema\Column\StringColumn;
@@ -76,7 +80,22 @@ public function testFromDbType(string $dbType, string $expectedType, string $exp
         $this->assertSame($dbType, $column->getDbType());
     }
 
-    #[DataProviderExternal(ColumnFactoryProvider::class, 'definitions')]
+    public static function dataFromDefinition(): array
+    {
+        return [
+            // definition, expected type, expected instance of, expected column method results
+            '' => ['', new StringColumn(dbType: '')],
+            'text' => ['text', new StringColumn(ColumnType::TEXT, dbType: 'text')],
+            'text NOT NULL' => ['text NOT NULL', new StringColumn(ColumnType::TEXT, dbType: 'text', notNull: true)],
+            'char(1)' => ['char(1)', new StringColumn(ColumnType::CHAR, dbType: 'char')],
+            'decimal(10,2)' => ['decimal(10,2)', new DoubleColumn(ColumnType::DECIMAL, dbType: 'decimal')],
+            'bigint UNSIGNED' => ['bigint UNSIGNED', new BigIntColumn(dbType: 'bigint', unsigned: true)],
+            'integer[]' => ['integer[]', new ArrayColumn(dbType: 'integer', column: new IntegerColumn(dbType: 'integer'))],
+            'string(126)[][]' => ['string(126)[][]', new ArrayColumn(dimension: 2, column: new StringColumn())],
+        ];
+    }
+
+    #[DataProvider('dataFromDefinition')]
     public function testFromDefinition(string $definition, ColumnInterface $expected): void
     {
         $columnFactory = new StubColumnFactory();
@@ -115,7 +134,6 @@ public function testFromDefinitionWithExtra(): void
 
         $this->assertInstanceOf(StringColumn::class, $column);
         $this->assertSame('char', $column->getType());
-        $this->assertSame(1, $column->getSize());
         $this->assertSame('INVISIBLE COLLATE utf8mb4', $column->getExtra());
     }
 

tests/Provider/ColumnDefinitionParserProvider.php

@@ -28,8 +28,6 @@ public static function parse(): array
             ['int DEFAULT (1 + 2)', ['type' => 'int', 'defaultValueRaw' => '(1 + 2)']],
             ["int COMMENT '''Quoted'' comment'", ['type' => 'int', 'comment' => "'Quoted' comment"]],
             ['int CHECK (value > (1 + 5))', ['type' => 'int', 'check' => 'value > (1 + 5)']],
-            ["enum('a','b','c')", ['type' => 'enum', 'enumValues' => ['a', 'b', 'c']]],
-            ["enum('a','b','c') NOT NULL", ['type' => 'enum', 'enumValues' => ['a', 'b', 'c'], 'notNull' => true]],
             ['int[]', ['type' => 'int', 'dimension' => 1]],
             ['string(126)[][]', ['type' => 'string', 'size' => 126, 'dimension' => 2]],
         ];

tests/Support/Stub/StubColumnDefinitionParser.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Db\Tests\Support\Stub;
+
+use Yiisoft\Db\Syntax\AbstractColumnDefinitionParser;
+
+final class StubColumnDefinitionParser extends AbstractColumnDefinitionParser
+{
+    protected function parseTypeParams(string $type, string $params): array
+    {
+        return [];
+    }
+}

tests/Support/Stub/StubColumnFactory.php

@@ -6,6 +6,7 @@
 
 use Yiisoft\Db\Constant\ColumnType;
 use Yiisoft\Db\Schema\Column\AbstractColumnFactory;
+use Yiisoft\Db\Syntax\ColumnDefinitionParserInterface;
 
 class StubColumnFactory extends AbstractColumnFactory
 {
@@ -26,4 +27,9 @@ protected function isDbType(string $dbType): bool
             default => $this->isType($dbType),
         };
     }
+
+    protected function columnDefinitionParser(): ColumnDefinitionParserInterface
+    {
+        return new StubColumnDefinitionParser();
+    }
 }