Refactor Dsn class (#378)

Author: Tigrov

CHANGELOG.md

@@ -16,7 +16,7 @@
 - New #320: Realize `ColumnBuilder` class (@Tigrov)
 - Enh #321: Update according changes in `ColumnSchemaInterface` (@Tigrov)
 - New #322, #330, #340: Add `ColumnDefinitionBuilder` class (@Tigrov)
-- Enh #323: Refactor `Dsn` class (@Tigrov)
+- Enh #323, #378: Refactor `Dsn` class (@Tigrov)
 - Enh #324: Use constructor to create columns and initialize properties (@Tigrov)
 - Enh #327: Refactor `Schema::findColumns()` method (@Tigrov)
 - Enh #328: Refactor `Schema::normalizeDefaultValue()` method and move it to `ColumnFactory` class (@Tigrov)

src/Dsn.php

@@ -4,65 +4,63 @@
 
 namespace Yiisoft\Db\Mssql;
 
-use Yiisoft\Db\Connection\AbstractDsn;
+use Stringable;
 
 /**
- * Implement a Data Source Name (DSN) for an MSSQL Server.
+ * Represents a Data Source Name (DSN) for a MSSQL Server that's used to configure a {@see Driver} instance.
+ *
+ * To get DSN in string format, use the `(string)` type casting operator.
  *
  * @link https://www.php.net/manual/en/ref.pdo-sqlsrv.connection.php
  */
-final class Dsn extends AbstractDsn
+final class Dsn implements Stringable
 {
     /**
+     * @param string $driver The database driver name.
+     * @param string $host The database host name or IP address.
+     * @param string $databaseName The database name to connect to. Empty string if isn't set.
+     * @param string $port The database port. Empty string if isn't set.
+     * @param string[] $options The database connection options. Default value to an empty array.
+     *
      * @psalm-param array<string,string> $options
      */
     public function __construct(
-        string $driver = 'sqlsrv',
-        string $host = '127.0.0.1',
-        string|null $databaseName = null,
-        string|null $port = '1433',
-        array $options = []
+        public readonly string $driver = 'sqlsrv',
+        public readonly string $host = '127.0.0.1',
+        public readonly string $databaseName = '',
+        public readonly string $port = '1433',
+        public readonly array $options = [],
     ) {
-        parent::__construct($driver, $host, $databaseName, $port, $options);
     }
 
     /**
      * @return string the Data Source Name, or DSN, has the information required to connect to the database.
      * Please refer to the [PHP manual](https://php.net/manual/en/pdo.construct.php) on the format of the DSN string.
      *
-     * The `driver` array key is used as the driver prefix of the DSN, all further key-value pairs are rendered as
-     * `key=value` and concatenated by `;`. For example:
+     * The `driver` property is used as the driver prefix of the DSN. For example:
      *
      * ```php
      * $dsn = new Dsn('sqlsrv', 'localhost', 'yiitest', '1433');
-     * $driver = new Driver($dsn->asString(), 'username', 'password');
+     * $driver = new Driver($dsn, 'username', 'password');
      * $db = new Connection($driver, $schemaCache);
      * ```
      *
      * Will result in the DSN string `sqlsrv:Server=localhost,1433;Database=yiitest`.
      */
-    public function asString(): string
+    public function __toString(): string
     {
-        $driver = $this->getDriver();
-        $host = $this->getHost();
-        $port = $this->getPort();
-        $databaseName = $this->getDatabaseName();
-        $options = $this->getOptions();
-
-        $dsn = "$driver:Server=$host";
+        $dsn = "$this->driver:Server=$this->host";
 
-        if (!empty($port)) {
-            $dsn .= ",$port";
+        if ($this->port !== '') {
+            $dsn .= ",$this->port";
         }
 
-        if (!empty($databaseName)) {
-            $dsn .= ";Database=$databaseName";
+        if ($this->databaseName !== '') {
+            $dsn .= ";Database=$this->databaseName";
         }
 
-        if (!empty($options)) {
-            foreach ($options as $key => $value) {
-                $dsn .= ";$key=$value";
-            }
+        foreach ($this->options as $key => $value) {
+            $dsn .= ";$key=$value";
         }
 
         return $dsn;

tests/DsnTest.php

@@ -14,34 +14,39 @@
  */
 final class DsnTest extends TestCase
 {
-    public function testAsString(): void
+    public function testConstruct(): void
     {
-        $this->assertSame(
-            'sqlsrv:Server=127.0.0.1,1433;Database=yiitest',
-            (new Dsn('sqlsrv', '127.0.0.1', 'yiitest', '1433'))->asString(),
-        );
+        $dsn = new Dsn('sqlsrv', 'localhost', 'yiitest', '1434', ['Encrypt' => 'no']);
+
+        $this->assertSame('sqlsrv', $dsn->driver);
+        $this->assertSame('localhost', $dsn->host);
+        $this->assertSame('yiitest', $dsn->databaseName);
+        $this->assertSame('1434', $dsn->port);
+        $this->assertSame(['Encrypt' => 'no'], $dsn->options);
+        $this->assertSame('sqlsrv:Server=localhost,1434;Database=yiitest;Encrypt=no', (string) $dsn);
     }
 
-    public function testAsStringWithDatabaseName(): void
+    public function testConstructDefaults(): void
     {
-        $this->assertSame('sqlsrv:Server=127.0.0.1,1433', (new Dsn('sqlsrv', '127.0.0.1'))->asString());
+        $dsn = new Dsn();
+
+        $this->assertSame('sqlsrv', $dsn->driver);
+        $this->assertSame('127.0.0.1', $dsn->host);
+        $this->assertSame('', $dsn->databaseName);
+        $this->assertSame('1433', $dsn->port);
+        $this->assertSame([], $dsn->options);
+        $this->assertSame('sqlsrv:Server=127.0.0.1,1433', (string) $dsn);
     }
 
-    public function testAsStringWithDatabaseNameWithEmptyString(): void
+    public function testConstructWithEmptyPort(): void
     {
-        $this->assertSame('sqlsrv:Server=127.0.0.1,1433', (new Dsn('sqlsrv', '127.0.0.1', ''))->asString());
-    }
-
-    public function testAsStringWithDatabaseNameWithNull(): void
-    {
-        $this->assertSame('sqlsrv:Server=127.0.0.1,1433', (new Dsn('sqlsrv', '127.0.0.1', null))->asString());
-    }
-
-    public function testAsStringWithEmptyPort(): void
-    {
-        $this->assertSame(
-            'sqlsrv:Server=127.0.0.1;Database=yiitest',
-            (new Dsn('sqlsrv', '127.0.0.1', 'yiitest', ''))->asString(),
-        );
+        $dsn = new Dsn('sqlsrv', 'localhost', port: '');
+
+        $this->assertSame('sqlsrv', $dsn->driver);
+        $this->assertSame('localhost', $dsn->host);
+        $this->assertSame('', $dsn->databaseName);
+        $this->assertSame('', $dsn->port);
+        $this->assertSame([], $dsn->options);
+        $this->assertSame('sqlsrv:Server=localhost', (string) $dsn);
     }
 }

tests/Support/TestTrait.php

@@ -36,12 +36,12 @@ protected function getConnection(bool $fixture = false): Connection
 
     protected static function getDb(): Connection
     {
-        $dsn = (new Dsn(
+        $dsn = (string) new Dsn(
             host: self::getHost(),
             databaseName: self::getDatabaseName(),
             port: self::getPort(),
             options: ['Encrypt' => 'no']
-        ))->asString();
+        );
 
         return new Connection(
             new Driver($dsn, self::getUsername(), self::getPassword()),
@@ -52,12 +52,12 @@ protected static function getDb(): Connection
     protected function getDsn(): string
     {
         if ($this->dsn === '') {
-            $this->dsn = (new Dsn(
+            $this->dsn = (string) new Dsn(
                 host: self::getHost(),
                 databaseName: self::getDatabaseName(),
                 port: self::getPort(),
                 options: ['Encrypt' => 'no']
-            ))->asString();
+            );
         }
 
         return $this->dsn;