Realize ColumnBuilder (#320)

CHANGELOG.md

@@ -12,6 +12,7 @@
 - Enh #317: Raise minimum PHP version to `^8.1` with minor refactoring (@Tigrov)
 - Enh #316: Implement `ColumnFactory` class (@Tigrov)
 - Enh #319: Separate column type constants (@Tigrov)
+- Enh #320: Realize `ColumnBuilder` class (@Tigrov)
 
 ## 1.2.0 March 21, 2024
 

src/Column/ColumnBuilder.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Db\Mssql\Column;
+
+use Yiisoft\Db\Constant\ColumnType;
+use Yiisoft\Db\Schema\Column\ColumnSchemaInterface;
+
+final class ColumnBuilder extends \Yiisoft\Db\Schema\Column\ColumnBuilder
+{
+    public static function binary(int|null $size = null): ColumnSchemaInterface
+    {
+        return (new BinaryColumnSchema(ColumnType::BINARY))
+            ->size($size);
+    }
+}

src/Column/ColumnFactory.php

@@ -79,4 +79,9 @@ public function fromType(string $type, array $info = []): ColumnSchemaInterface
 
         return parent::fromType($type, $info);
     }
+
+    protected function isDbType(string $dbType): bool
+    {
+        return isset(self::TYPE_MAP[$dbType]);
+    }
 }

src/Connection.php

@@ -6,9 +6,11 @@
 
 use Yiisoft\Db\Driver\Pdo\AbstractPdoConnection;
 use Yiisoft\Db\Driver\Pdo\PdoCommandInterface;
+use Yiisoft\Db\Mssql\Column\ColumnFactory;
 use Yiisoft\Db\Query\BatchQueryResultInterface;
 use Yiisoft\Db\Query\QueryInterface;
 use Yiisoft\Db\QueryBuilder\QueryBuilderInterface;
+use Yiisoft\Db\Schema\Column\ColumnFactoryInterface;
 use Yiisoft\Db\Schema\QuoterInterface;
 use Yiisoft\Db\Schema\SchemaInterface;
 use Yiisoft\Db\Transaction\TransactionInterface;
@@ -49,6 +51,11 @@ public function createTransaction(): TransactionInterface
         return new Transaction($this);
     }
 
+    public function getColumnFactory(): ColumnFactoryInterface
+    {
+        return new ColumnFactory();
+    }
+
     public function getQueryBuilder(): QueryBuilderInterface
     {
         if ($this->queryBuilder === null) {

src/Schema.php

@@ -14,9 +14,7 @@
 use Yiisoft\Db\Exception\Exception;
 use Yiisoft\Db\Exception\InvalidConfigException;
 use Yiisoft\Db\Helper\DbArrayHelper;
-use Yiisoft\Db\Mssql\Column\ColumnFactory;
 use Yiisoft\Db\Schema\Builder\ColumnInterface;
-use Yiisoft\Db\Schema\Column\ColumnFactoryInterface;
 use Yiisoft\Db\Schema\Column\ColumnSchemaInterface;
 use Yiisoft\Db\Schema\TableSchemaInterface;
 
@@ -72,11 +70,6 @@ public function createColumn(string $type, array|int|string|null $length = null)
         return new Column($type, $length);
     }
 
-    public function getColumnFactory(): ColumnFactoryInterface
-    {
-        return new ColumnFactory();
-    }
-
     /**
      * Resolves the table name and schema name (if any).
      *
@@ -366,9 +359,11 @@ protected function loadTableDefaultValues(string $tableName): array
      */
     private function loadColumnSchema(array $info): ColumnSchemaInterface
     {
+        $columnFactory = $this->db->getColumnFactory();
+
         $dbType = $info['data_type'];
         /** @psalm-var ColumnArray $info */
-        $column = $this->getColumnFactory()->fromDefinition($dbType);
+        $column = $columnFactory->fromDefinition($dbType);
         $column->name($info['column_name']);
         $column->allowNull($info['is_nullable'] === 'YES');
         $column->dbType($dbType);

tests/ColumnBuilderTest.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Db\Mssql\Tests;
+
+use Yiisoft\Db\Mssql\Column\ColumnBuilder;
+use Yiisoft\Db\Mssql\Tests\Support\TestTrait;
+use Yiisoft\Db\Tests\AbstractColumnBuilderTest;
+
+/**
+ * @group mssql
+ */
+class ColumnBuilderTest extends AbstractColumnBuilderTest
+{
+    use TestTrait;
+
+    public function getColumnBuilderClass(): string
+    {
+        return ColumnBuilder::class;
+    }
+
+    /**
+     * @dataProvider \Yiisoft\Db\Mssql\Tests\Provider\ColumnBuilderProvider::buildingMethods
+     */
+    public function testBuildingMethods(
+        string $buildingMethod,
+        array $args,
+        string $expectedInstanceOf,
+        string $expectedType,
+        array $expectedMethodResults = [],
+    ): void {
+        parent::testBuildingMethods($buildingMethod, $args, $expectedInstanceOf, $expectedType, $expectedMethodResults);
+    }
+}

tests/ColumnFactoryTest.php

@@ -21,9 +21,23 @@ public function testFromDbType(string $dbType, string $expectedType, string $exp
     }
 
     /** @dataProvider \Yiisoft\Db\Mssql\Tests\Provider\ColumnFactoryProvider::definitions */
-    public function testFromDefinition(string $definition, string $expectedType, string $expectedInstanceOf, array $expectedInfo = []): void
-    {
-        parent::testFromDefinition($definition, $expectedType, $expectedInstanceOf, $expectedInfo);
+    public function testFromDefinition(
+        string $definition,
+        string $expectedType,
+        string $expectedInstanceOf,
+        array $expectedMethodResults = []
+    ): void {
+        parent::testFromDefinition($definition, $expectedType, $expectedInstanceOf, $expectedMethodResults);
+    }
+
+    /** @dataProvider \Yiisoft\Db\Mssql\Tests\Provider\ColumnFactoryProvider::pseudoTypes */
+    public function testFromPseudoType(
+        string $pseudoType,
+        string $expectedType,
+        string $expectedInstanceOf,
+        array $expectedMethodResults = []
+    ): void {
+        parent::testFromPseudoType($pseudoType, $expectedType, $expectedInstanceOf, $expectedMethodResults);
     }
 
     /** @dataProvider \Yiisoft\Db\Mssql\Tests\Provider\ColumnFactoryProvider::types */

tests/ConnectionTest.php

@@ -10,6 +10,7 @@
 use Yiisoft\Db\Exception\Exception;
 use Yiisoft\Db\Exception\InvalidConfigException;
 use Yiisoft\Db\Exception\NotSupportedException;
+use Yiisoft\Db\Mssql\Column\ColumnFactory;
 use Yiisoft\Db\Mssql\Tests\Support\TestTrait;
 use Yiisoft\Db\Tests\Common\CommonConnectionTest;
 use Yiisoft\Db\Transaction\TransactionInterface;
@@ -87,4 +88,11 @@ public function testSettingDefaultAttributes(): void
 
         $this->assertSame(PDO::ERRMODE_EXCEPTION, $db->getActivePDO()?->getAttribute(PDO::ATTR_ERRMODE));
     }
+
+    public function testGetColumnFactory(): void
+    {
+        $db = $this->getConnection();
+
+        $this->assertInstanceOf(ColumnFactory::class, $db->getColumnFactory());
+    }
 }

tests/Provider/ColumnBuilderProvider.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Db\Mssql\Tests\Provider;
+
+use Yiisoft\Db\Constant\ColumnType;
+use Yiisoft\Db\Mssql\Column\BinaryColumnSchema;
+
+class ColumnBuilderProvider extends \Yiisoft\Db\Tests\Provider\ColumnBuilderProvider
+{
+    public static function buildingMethods(): array
+    {
+        return [
+            // building method, args, expected instance of, expected type, expected column method results
+            ...parent::buildingMethods(),
+            ['binary', [], BinaryColumnSchema::class, ColumnType::BINARY],
+            ['binary', [8], BinaryColumnSchema::class, ColumnType::BINARY, ['getSize' => 8]],
+        ];
+    }
+}

tests/SchemaTest.php

@@ -11,7 +11,6 @@
 use Yiisoft\Db\Exception\Exception;
 use Yiisoft\Db\Exception\InvalidConfigException;
 use Yiisoft\Db\Exception\NotSupportedException;
-use Yiisoft\Db\Mssql\Column\ColumnFactory;
 use Yiisoft\Db\Mssql\Schema;
 use Yiisoft\Db\Mssql\Tests\Support\TestTrait;
 use Yiisoft\Db\Schema\SchemaInterface;
@@ -198,12 +197,4 @@ public function testNegativeDefaultValues(): void
 
         $db->close();
     }
-
-    public function testGetColumnFactory(): void
-    {
-        $db = $this->getConnection();
-        $factory = $db->getSchema()->getColumnFactory();
-
-        $this->assertInstanceOf(ColumnFactory::class, $factory);
-    }
 }