Add templates into Format and Output

simPod · Aug 26, 2020 · 1ebb099 · 1ebb099
1 parent 7679e5d
commit 1ebb099
Show file tree

Hide file tree

Showing 17 changed files with 93 additions and 64 deletions.
diff --git a/src/Format/Json.php b/src/Format/Json.php
@@ -6,7 +6,10 @@
 
 use SimPod\ClickHouseClient\Output\Output;
 
-/** @implements Format<\SimPod\ClickHouseClient\Output\Json> */
+/**
+ * @template T
+ * @implements Format<\SimPod\ClickHouseClient\Output\Json<T>>
+ */
 final class Json implements Format
 {
     public static function output(string $contents) : Output

diff --git a/src/Format/JsonCompact.php b/src/Format/JsonCompact.php
@@ -6,7 +6,10 @@
 
 use SimPod\ClickHouseClient\Output\Output;
 
-/** @implements Format<\SimPod\ClickHouseClient\Output\JsonCompact> */
+/**
+ * @template T
+ * @implements Format<\SimPod\ClickHouseClient\Output\JsonCompact<T>>
+ */
 final class JsonCompact implements Format
 {
     public static function output(string $contents) : Output

diff --git a/src/Format/JsonEachRow.php b/src/Format/JsonEachRow.php
@@ -6,7 +6,10 @@
 
 use SimPod\ClickHouseClient\Output\Output;
 
-/** @implements Format<\SimPod\ClickHouseClient\Output\JsonEachRow> */
+/**
+ * @template T
+ * @implements Format<\SimPod\ClickHouseClient\Output\JsonEachRow<T>>
+ */
 final class JsonEachRow implements Format
 {
     public static function output(string $contents) : Output

diff --git a/src/Format/TabSeparated.php b/src/Format/TabSeparated.php
@@ -6,7 +6,10 @@
 
 use SimPod\ClickHouseClient\Output\Output;
 
-/** @implements Format<\SimPod\ClickHouseClient\Output\TabSeparated> */
+/**
+ * @template T
+ * @implements Format<\SimPod\ClickHouseClient\Output\TabSeparated<T>>
+ */
 final class TabSeparated implements Format
 {
     public static function output(string $contents) : Output

diff --git a/src/Output/Json.php b/src/Output/Json.php
@@ -6,13 +6,17 @@
 
 use function Safe\json_decode;
 
-/** @psalm-immutable */
+/**
+ * @psalm-immutable
+ * @template T
+ * @implements Output<T>
+ */
 final class Json implements Output
 {
     /** @var array<array<string, mixed>> */
     public array $data;
 
-    /** @var array<mixed> */
+    /** @var array<mixed>  */
     public array $meta;
 
     public int $rows;

diff --git a/src/Output/JsonCompact.php b/src/Output/JsonCompact.php
@@ -6,7 +6,11 @@
 
 use function Safe\json_decode;
 
-/** @psalm-immutable */
+/**
+ * @psalm-immutable
+ * @template T
+ * @implements Output<T>
+ */
 final class JsonCompact implements Output
 {
     /** @var array<array<mixed>> */

diff --git a/src/Output/JsonEachRow.php b/src/Output/JsonEachRow.php
@@ -8,16 +8,20 @@
 use function Safe\sprintf;
 use function str_replace;
 
-/** @psalm-immutable */
+/**
+ * @psalm-immutable
+ * @template T
+ * @implements Output<T>
+ */
 final class JsonEachRow implements Output
 {
-    /** @var array<array<string, mixed>> */
+    /** @var list<T> */
     public array $data;
 
     public function __construct(string $contentsJson)
     {
         /**
-         * @var array<array<string, mixed>> $contents
+         * @var list<T> $contents
          * @psalm-suppress ImpureFunctionCall
          */
         $contents   = json_decode(sprintf('[%s]', str_replace("}\n{", '},{', $contentsJson)), true);

diff --git a/src/Output/Output.php b/src/Output/Output.php
@@ -4,6 +4,7 @@
 
 namespace SimPod\ClickHouseClient\Output;
 
+/** @template T */
 interface Output
 {
     public function __construct(string $contents);

diff --git a/src/Output/TabSeparated.php b/src/Output/TabSeparated.php
@@ -4,7 +4,11 @@
 
 namespace SimPod\ClickHouseClient\Output;
 
-/** @psalm-immutable */
+/**
+ * @psalm-immutable
+ * @template T
+ * @implements Output<T>
+ */
 final class TabSeparated implements Output
 {
     public string $contents;

diff --git a/src/Snippet/CurrentDatabase.php b/src/Snippet/CurrentDatabase.php
@@ -7,23 +7,20 @@
 use SimPod\ClickHouseClient\Client\ClickHouseClient;
 use SimPod\ClickHouseClient\Format\JsonEachRow;
 
-use function assert;
-use function is_string;
-
 final class CurrentDatabase
 {
     public static function run(ClickHouseClient $clickHouseClient) : string
     {
+        /** @var JsonEachRow<array{database: string}> $format */
+        $format = new JsonEachRow();
+
         $currentDatabase = $clickHouseClient->select(
             <<<CLICKHOUSE
 SELECT currentDatabase() AS database
 CLICKHOUSE,
-            new JsonEachRow()
+            $format
         );
 
-        $databaseName = $currentDatabase->data[0]['database'];
-        assert(is_string($databaseName));
-
-        return $databaseName;
+        return $currentDatabase->data[0]['database'];
     }
 }
diff --git a/src/Snippet/DatabaseSize.php b/src/Snippet/DatabaseSize.php
@@ -8,27 +8,23 @@
 use SimPod\ClickHouseClient\Format\JsonEachRow;
 use SimPod\ClickHouseClient\Sql\Expression;
 
-use function assert;
-
 final class DatabaseSize
 {
     public static function run(ClickHouseClient $clickHouseClient, ?string $databaseName = null) : int
     {
+        /** @var JsonEachRow<array{size: string|null}> $format */
+        $format = new JsonEachRow();
+
         $currentDatabase = $clickHouseClient->selectWithParameters(
             <<<CLICKHOUSE
 SELECT sum(bytes) AS size
 FROM system.parts
 WHERE active AND database=:database
 CLICKHOUSE,
             ['database' => $databaseName ?? Expression::new('currentDatabase()')],
-            new JsonEachRow()
+            $format
         );
 
-        /** @psalm-suppress MixedAssignment */
-        $size = $currentDatabase->data[0]['size'];
-
-        assert($size !== null);
-
-        return (int) $size;
+        return (int) $currentDatabase->data[0]['size'];
     }
 }
diff --git a/src/Snippet/Parts.php b/src/Snippet/Parts.php
@@ -16,17 +16,20 @@ public static function run(ClickHouseClient $clickHouseClient, string $table, ?b
     {
         $whereActiveClause = $active === null ? '' : sprintf(' AND active = %s', (int) $active);
 
-        $currentDatabase = $clickHouseClient->selectWithParameters(
+        /** @var JsonEachRow<array<string, mixed>> $format */
+        $format = new JsonEachRow();
+
+        $output = $clickHouseClient->selectWithParameters(
             <<<CLICKHOUSE
 SELECT *
 FROM system.parts
 WHERE table=:table $whereActiveClause
 ORDER BY max_date
 CLICKHOUSE,
             ['table' => $table],
-            new JsonEachRow()
+            $format
         );
 
-        return $currentDatabase->data;
+        return $output->data;
     }
 }
diff --git a/src/Snippet/ShowCreateTable.php b/src/Snippet/ShowCreateTable.php
@@ -6,24 +6,23 @@
 
 use SimPod\ClickHouseClient\Client\ClickHouseClient;
 use SimPod\ClickHouseClient\Format\JsonEachRow;
-use Webmozart\Assert\Assert;
 
 use function trim;
 
 final class ShowCreateTable
 {
     public static function run(ClickHouseClient $clickHouseClient, string $tableName) : string
     {
+        /** @var JsonEachRow<array{statement: string}> $format */
+        $format = new JsonEachRow();
+
         $output = $clickHouseClient->select(
             <<<CLICKHOUSE
 SHOW CREATE TABLE $tableName
 CLICKHOUSE,
-            new JsonEachRow()
+            $format
         );
 
-        $statement = $output->data[0]['statement'];
-        Assert::string($statement);
-
-        return trim($statement);
+        return trim($output->data[0]['statement']);
     }
 }
diff --git a/src/Snippet/ShowDatabases.php b/src/Snippet/ShowDatabases.php
@@ -8,27 +8,25 @@
 use SimPod\ClickHouseClient\Format\JsonEachRow;
 
 use function array_map;
-use function assert;
-use function is_string;
 
 final class ShowDatabases
 {
     /** @return array<string> */
     public static function run(ClickHouseClient $clickHouseClient) : array
     {
+        /** @var JsonEachRow<array{name: string}> $format */
+        $format = new JsonEachRow();
+
         $output = $clickHouseClient->select(
             <<<CLICKHOUSE
 SHOW DATABASES
 CLICKHOUSE,
-            new JsonEachRow()
+            $format
         );
 
         return array_map(
             static function (array $database) : string {
-                $databaseName = $database['name'];
-                assert(is_string($databaseName));
-
-                return $databaseName;
+                return $database['name'];
             },
             $output->data
         );

diff --git a/src/Snippet/TableSizes.php b/src/Snippet/TableSizes.php
@@ -8,12 +8,23 @@
 use SimPod\ClickHouseClient\Format\JsonEachRow;
 use SimPod\ClickHouseClient\Sql\Expression;
 
+/** @psalm-type entry = array{name: string, database: string, size: string, min_date: string, max_date: string} */
 final class TableSizes
 {
-    /** @return array<array<string, mixed>> */
+    /**
+     * @return array<entry>
+     *
+     * @phpstan-return array<array<string, mixed>>
+     */
     public static function run(ClickHouseClient $clickHouseClient, ?string $databaseName = null) : array
     {
-        $currentDatabase = $clickHouseClient->selectWithParameters(
+        /**
+         * @phpstan-var JsonEachRow<array<string, mixed>> $format
+         * @var JsonEachRow<entry> $format
+         */
+        $format = new JsonEachRow();
+
+        return $clickHouseClient->selectWithParameters(
             <<<CLICKHOUSE
 SELECT 
     name AS table,
@@ -37,9 +48,7 @@ public static function run(ClickHouseClient $clickHouseClient, ?string $database
 GROUP BY table, database
 CLICKHOUSE,
             ['database' => $databaseName ?? Expression::new('currentDatabase()')],
-            new JsonEachRow()
-        );
-
-        return $currentDatabase->data;
+            $format
+        )->data;
     }
 }
diff --git a/src/Snippet/Version.php b/src/Snippet/Version.php
@@ -7,24 +7,20 @@
 use SimPod\ClickHouseClient\Client\ClickHouseClient;
 use SimPod\ClickHouseClient\Format\JsonEachRow;
 
-use function assert;
-use function is_string;
-
 final class Version
 {
     public static function run(ClickHouseClient $clickHouseClient) : string
     {
-        $version = $clickHouseClient->select(
+        /** @var JsonEachRow<array{version: string}> $format */
+        $format = new JsonEachRow();
+
+        $output = $clickHouseClient->select(
             <<<CLICKHOUSE
 SELECT version() AS version
 CLICKHOUSE,
-            new JsonEachRow()
+            $format
         );
 
-        /** @psalm-suppress MixedAssignment */
-        $version = $version->data[0]['version'];
-        assert(is_string($version));
-
-        return $version;
+        return $output->data[0]['version'];
     }
 }
diff --git a/tests/Client/SelectAsyncTest.php b/tests/Client/SelectAsyncTest.php
@@ -24,11 +24,13 @@ public function testAsyncSelect() : void
 SELECT number FROM system.numbers LIMIT 2
 CLICKHOUSE;
 
-        $promises   = [];
-        $promises[] = $client->select($sql, new JsonEachRow());
-        $promises[] = $client->select($sql, new JsonEachRow());
+        /** @var JsonEachRow<array{number: string}> $format */
+        $format   = new JsonEachRow();
+        $promises = [
+            $client->select($sql, $format),
+            $client->select($sql, $format),
+        ];
 
-        /** @var array<\SimPod\ClickHouseClient\Output\JsonEachRow> $jsonEachRowOutputs */
         $jsonEachRowOutputs = all($promises)->wait();
 
         $expectedData = [