feat: mark all possible classes as readonly (#303)

simPod · web-flow · commit 8eb584f27581 · 2025-08-08T17:38:01.000+02:00
diff --git a/src/Client/Http/RequestFactory.php b/src/Client/Http/RequestFactory.php
@@ -24,7 +24,7 @@
 
 use const PHP_QUERY_RFC3986;
 
-final class RequestFactory
+final readonly class RequestFactory
 {
     private UriInterface|null $uri;
 
diff --git a/src/Client/Http/RequestOptions.php b/src/Client/Http/RequestOptions.php
@@ -4,7 +4,7 @@
 
 namespace SimPod\ClickHouseClient\Client\Http;
 
-final class RequestOptions
+final readonly class RequestOptions
 {
     /** @param array<string, mixed> $params */
     public function __construct(
diff --git a/src/Client/Http/RequestSettings.php b/src/Client/Http/RequestSettings.php
@@ -4,7 +4,7 @@
 
 namespace SimPod\ClickHouseClient\Client\Http;
 
-final class RequestSettings
+final readonly class RequestSettings
 {
     /** @var array<string, float|int|string> */
     public array $settings;
diff --git a/src/Client/PsrClickHouseAsyncClient.php b/src/Client/PsrClickHouseAsyncClient.php
@@ -21,7 +21,7 @@
 
 use function uniqid;
 
-class PsrClickHouseAsyncClient implements ClickHouseAsyncClient
+readonly class PsrClickHouseAsyncClient implements ClickHouseAsyncClient
 {
     private SqlFactory $sqlFactory;
 
diff --git a/src/Client/PsrClickHouseClient.php b/src/Client/PsrClickHouseClient.php
@@ -36,7 +36,7 @@
 use function sprintf;
 use function uniqid;
 
-class PsrClickHouseClient implements ClickHouseClient
+readonly class PsrClickHouseClient implements ClickHouseClient
 {
     private ValueFormatter $valueFormatter;
 
diff --git a/src/Format/Json.php b/src/Format/Json.php
@@ -11,7 +11,7 @@
  * @template T
  * @implements Format<\SimPod\ClickHouseClient\Output\Json<T>>
  */
-final class Json implements Format
+final readonly class Json implements Format
 {
     /** @throws JsonException */
     public static function output(string $contents): Output
diff --git a/src/Format/JsonCompact.php b/src/Format/JsonCompact.php
@@ -11,7 +11,7 @@
  * @template T
  * @implements Format<\SimPod\ClickHouseClient\Output\JsonCompact<T>>
  */
-final class JsonCompact implements Format
+final readonly class JsonCompact implements Format
 {
     /** @throws JsonException */
     public static function output(string $contents): Output
diff --git a/src/Format/JsonEachRow.php b/src/Format/JsonEachRow.php
@@ -11,7 +11,7 @@
  * @template T
  * @implements Format<\SimPod\ClickHouseClient\Output\JsonEachRow<T>>
  */
-final class JsonEachRow implements Format
+final readonly class JsonEachRow implements Format
 {
     /** @throws JsonException */
     public static function output(string $contents): Output
diff --git a/src/Format/Null_.php b/src/Format/Null_.php
@@ -12,7 +12,7 @@
  * @template T
  * @implements Format<\SimPod\ClickHouseClient\Output\Null_<T>>
  */
-final class Null_ implements Format
+final readonly class Null_ implements Format
 {
     public static function output(string $contents): Output
     {
diff --git a/src/Format/Pretty.php b/src/Format/Pretty.php
@@ -11,7 +11,7 @@
  * @template T
  * @implements Format<Basic<T>>
  */
-final class Pretty implements Format
+final readonly class Pretty implements Format
 {
     public static function output(string $contents): Output
     {
diff --git a/src/Format/PrettySpace.php b/src/Format/PrettySpace.php
@@ -11,7 +11,7 @@
  * @template T
  * @implements Format<Basic<T>>
  */
-final class PrettySpace implements Format
+final readonly class PrettySpace implements Format
 {
     public static function output(string $contents): Output
     {
diff --git a/src/Format/RowBinary.php b/src/Format/RowBinary.php
@@ -11,7 +11,7 @@
  * @template T
  * @implements Format<Basic<T>>
  */
-final class RowBinary implements Format
+final readonly class RowBinary implements Format
 {
     public static function output(string $contents): Output
     {
diff --git a/src/Format/TabSeparated.php b/src/Format/TabSeparated.php
@@ -11,7 +11,7 @@
  * @template T
  * @implements Format<Basic<T>>
  */
-final class TabSeparated implements Format
+final readonly class TabSeparated implements Format
 {
     public static function output(string $contents): Output
     {
diff --git a/src/Logger/LoggerChain.php b/src/Logger/LoggerChain.php
@@ -4,7 +4,7 @@
 
 namespace SimPod\ClickHouseClient\Logger;
 
-final class LoggerChain implements SqlLogger
+final readonly class LoggerChain implements SqlLogger
 {
     /** @param SqlLogger[] $loggers */
     public function __construct(private array $loggers = [])
diff --git a/src/Logger/PsrLogger.php b/src/Logger/PsrLogger.php
@@ -6,7 +6,7 @@
 
 use Psr\Log\LoggerInterface;
 
-final class PsrLogger implements SqlLogger
+final readonly class PsrLogger implements SqlLogger
 {
     public function __construct(private LoggerInterface $logger)
     {
diff --git a/src/Output/Basic.php b/src/Output/Basic.php
@@ -9,7 +9,7 @@
  * @template T
  * @implements Output<T>
  */
-final class Basic implements Output
+final readonly class Basic implements Output
 {
     public function __construct(public string $contents)
     {
diff --git a/src/Output/Json.php b/src/Output/Json.php
@@ -15,7 +15,7 @@
  * @template T
  * @implements Output<T>
  */
-final class Json implements Output
+final readonly class Json implements Output
 {
     /** @var list<T> */
     public array $data;
diff --git a/src/Output/JsonCompact.php b/src/Output/JsonCompact.php
@@ -15,7 +15,7 @@
  * @template T
  * @implements Output<T>
  */
-final class JsonCompact implements Output
+final readonly class JsonCompact implements Output
 {
     /** @var list<T> */
     public array $data;
diff --git a/src/Output/JsonEachRow.php b/src/Output/JsonEachRow.php
@@ -17,7 +17,7 @@
  * @template T
  * @implements Output<T>
  */
-final class JsonEachRow implements Output
+final readonly class JsonEachRow implements Output
 {
     /** @var list<T> */
     public array $data;
diff --git a/src/Output/Null_.php b/src/Output/Null_.php
@@ -11,7 +11,7 @@
  * @template T
  * @implements Output<T>
  */
-final class Null_ implements Output
+final readonly class Null_ implements Output
 {
     public function __construct(string $_)
     {
diff --git a/src/Param/ParamValueConverterRegistry.php b/src/Param/ParamValueConverterRegistry.php
@@ -32,9 +32,9 @@
  * @phpstan-type Converter Closure(mixed, Type|string|null, bool):(StreamInterface|string)
  * @phpstan-type ConverterRegistry array<string, Converter>
  */
-final class ParamValueConverterRegistry
+final readonly class ParamValueConverterRegistry
 {
-    private const CaseInsensitiveTypes = [
+    private const array CaseInsensitiveTypes = [
         'bool',
         'date',
         'date32',
diff --git a/src/Snippet/CurrentDatabase.php b/src/Snippet/CurrentDatabase.php
@@ -9,7 +9,7 @@
 use SimPod\ClickHouseClient\Exception\ServerError;
 use SimPod\ClickHouseClient\Format\JsonEachRow;
 
-final class CurrentDatabase
+final readonly class CurrentDatabase
 {
     /**
      * @throws ClientExceptionInterface
diff --git a/src/Snippet/DatabaseSize.php b/src/Snippet/DatabaseSize.php
@@ -12,7 +12,7 @@
 use SimPod\ClickHouseClient\Format\JsonEachRow;
 use SimPod\ClickHouseClient\Sql\Expression;
 
-final class DatabaseSize
+final readonly class DatabaseSize
 {
     /**
      * @throws ClientExceptionInterface
diff --git a/src/Snippet/Parts.php b/src/Snippet/Parts.php
@@ -13,7 +13,7 @@
 
 use function sprintf;
 
-final class Parts
+final readonly class Parts
 {
     /**
      * @return array<array<string, mixed>>
diff --git a/src/Snippet/ShowCreateTable.php b/src/Snippet/ShowCreateTable.php
@@ -9,7 +9,7 @@
 use SimPod\ClickHouseClient\Exception\ServerError;
 use SimPod\ClickHouseClient\Format\JsonEachRow;
 
-final class ShowCreateTable
+final readonly class ShowCreateTable
 {
     /**
      * @throws ClientExceptionInterface
diff --git a/src/Snippet/ShowDatabases.php b/src/Snippet/ShowDatabases.php
@@ -11,7 +11,7 @@
 
 use function array_map;
 
-final class ShowDatabases
+final readonly class ShowDatabases
 {
     /**
      * @return list<string>
diff --git a/src/Snippet/TableSizes.php b/src/Snippet/TableSizes.php
@@ -13,7 +13,7 @@
 use SimPod\ClickHouseClient\Sql\Expression;
 
 /** @phpstan-type Entry array{table: string, database: string, size: string, min_date: string, max_date: string} */
-final class TableSizes
+final readonly class TableSizes
 {
     /**
      * @return array<Entry>
diff --git a/src/Snippet/Version.php b/src/Snippet/Version.php
@@ -9,7 +9,7 @@
 use SimPod\ClickHouseClient\Exception\ServerError;
 use SimPod\ClickHouseClient\Format\JsonEachRow;
 
-final class Version
+final readonly class Version
 {
     /**
      * @throws ClientExceptionInterface
diff --git a/src/Sql/Escaper.php b/src/Sql/Escaper.php
@@ -11,7 +11,7 @@
  *
  * @link https://github.com/ClickHouse/clickhouse-jdbc/blob/8481c1323f5de09bb9dbbf67085e5e1b2585756a/src/main/java/ru/yandex/clickhouse/ClickHouseUtil.java
  */
-final class Escaper
+final readonly class Escaper
 {
     public static function escape(string $s): string
     {
diff --git a/src/Sql/Expression.php b/src/Sql/Expression.php
@@ -4,7 +4,7 @@
 
 namespace SimPod\ClickHouseClient\Sql;
 
-final class Expression
+final readonly class Expression
 {
     public string $innerExpression;
 
diff --git a/src/Sql/SqlFactory.php b/src/Sql/SqlFactory.php
@@ -13,7 +13,7 @@
 use function str_replace;
 
 /** @internal */
-final class SqlFactory
+final readonly class SqlFactory
 {
     public function __construct(private ValueFormatter $valueFormatter)
     {
diff --git a/tests/ClickHouseVersion.php b/tests/ClickHouseVersion.php
@@ -15,9 +15,9 @@
 
 use const STR_PAD_LEFT;
 
-final class ClickHouseVersion
+final readonly class ClickHouseVersion
 {
-    private const EnvName = 'CLICKHOUSE_VERSION';
+    private const string EnvName = 'CLICKHOUSE_VERSION';
 
     /** @throws RuntimeException */
     public static function get(): int

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@`
`24`	`24`
`25`	`25`	`use const PHP_QUERY_RFC3986;`
`26`	`26`
`27`		`-final class RequestFactory`
	`27`	`+final readonly class RequestFactory`
`28`	`28`	`{`
`29`	`29`	`private UriInterface\|null $uri;`
`30`	`30`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`
`5`	`5`	`namespace SimPod\ClickHouseClient\Client\Http;`
`6`	`6`
`7`		`-final class RequestOptions`
	`7`	`+final readonly class RequestOptions`
`8`	`8`	`{`
`9`	`9`	`/** @param array<string, mixed> $params */`
`10`	`10`	`public function __construct(`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`
`5`	`5`	`namespace SimPod\ClickHouseClient\Client\Http;`
`6`	`6`
`7`		`-final class RequestSettings`
	`7`	`+final readonly class RequestSettings`
`8`	`8`	`{`
`9`	`9`	`/** @var array<string, float\|int\|string> */`
`10`	`10`	`public array $settings;`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@`
`21`	`21`
`22`	`22`	`use function uniqid;`
`23`	`23`
`24`		`-class PsrClickHouseAsyncClient implements ClickHouseAsyncClient`
	`24`	`+readonly class PsrClickHouseAsyncClient implements ClickHouseAsyncClient`
`25`	`25`	`{`
`26`	`26`	`private SqlFactory $sqlFactory;`
`27`	`27`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@`
`36`	`36`	`use function sprintf;`
`37`	`37`	`use function uniqid;`
`38`	`38`
`39`		`-class PsrClickHouseClient implements ClickHouseClient`
	`39`	`+readonly class PsrClickHouseClient implements ClickHouseClient`
`40`	`40`	`{`
`41`	`41`	`private ValueFormatter $valueFormatter;`
`42`	`42`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`	`* @template T`
`12`	`12`	`* @implements Format<\SimPod\ClickHouseClient\Output\Json<T>>`
`13`	`13`	`*/`
`14`		`-final class Json implements Format`
	`14`	`+final readonly class Json implements Format`
`15`	`15`	`{`
`16`	`16`	`/** @throws JsonException */`
`17`	`17`	`public static function output(string $contents): Output`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@`
`12`	`12`	`* @template T`
`13`	`13`	`* @implements Format<\SimPod\ClickHouseClient\Output\Null_<T>>`
`14`	`14`	`*/`
`15`		`-final class Null_ implements Format`
	`15`	`+final readonly class Null_ implements Format`
`16`	`16`	`{`
`17`	`17`	`public static function output(string $contents): Output`
`18`	`18`	`{`