Merge pull request #166 from bearsunday/php82-readonly-optimization

koriym · web-flow · commit a03999405f81 · 2025-11-10T14:00:29.000+09:00
Optimize for PHP 8.2 readonly classes
diff --git a/rector.php b/rector.php
@@ -2,23 +2,20 @@
 
 declare(strict_types=1);
 
-use Rector\CodeQuality\Rector\Class_\InlineConstructorDefaultToPropertyRector;
 use Rector\Config\RectorConfig;
-use Rector\Ray\AnnotationBinding\Rector\ClassMethod\AnnotationBindingRector;
-use Rector\Set\ValueObject\LevelSetList;
 
-return static function (RectorConfig $rectorConfig): void {
-    $rectorConfig->paths([
+return RectorConfig::configure()
+    ->withPaths([
+        __DIR__ . '/demo',
         __DIR__ . '/src',
         __DIR__ . '/src-annotation',
-        __DIR__ . '/tests/*/*Test.php',
-    ]);
-
-    // register a single rule
-    $rectorConfig->rule(InlineConstructorDefaultToPropertyRector::class);
-    $rectorConfig->rule(AnnotationBindingRector::class);
-    // define sets of rules
-        $rectorConfig->sets([
-            LevelSetList::UP_TO_PHP_81,
-    ]);
-};
+        __DIR__ . '/src-annotation-deprecated',
+        __DIR__ . '/tests',
+        __DIR__ . '/tests-pecl-ext',
+        __DIR__ . '/tests-php8',
+    ])
+    // uncomment to reach your current PHP version
+     ->withPhpSets()
+    ->withTypeCoverageLevel(0)
+    ->withDeadCodeLevel(0)
+    ->withCodeQualityLevel(0);
diff --git a/src-annotation-deprecated/CacheVersion.php b/src-annotation-deprecated/CacheVersion.php
@@ -15,13 +15,7 @@
 #[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_PARAMETER), Qualifier]
 final class CacheVersion
 {
-    /**
-     * @var string
-     */
-    public $value;
-
-    public function __construct(string $value)
+    public function __construct(public string $value)
     {
-        $this->value = $value;
     }
 }
diff --git a/src-annotation/Commands.php b/src-annotation/Commands.php
@@ -7,8 +7,6 @@
 use Attribute;
 use Ray\Di\Di\Qualifier;
 
-/**
- */
 #[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_PARAMETER)]
 #[Qualifier]
 final class Commands
diff --git a/src-annotation/RefreshCache.php b/src-annotation/RefreshCache.php
@@ -7,9 +7,7 @@
 use Attribute;
 use BEAR\QueryRepository\DonutCommandInterceptor;
 
-/**
- * @see DonutCommandInterceptor
- */
+/** @see DonutCommandInterceptor */
 #[Attribute(Attribute::TARGET_METHOD)]
 final class RefreshCache
 {
diff --git a/src/CacheDependency.php b/src/CacheDependency.php
@@ -10,10 +10,10 @@
 use function assert;
 use function sprintf;
 
-final class CacheDependency implements CacheDependencyInterface
+final readonly class CacheDependency implements CacheDependencyInterface
 {
     public function __construct(
-        private readonly UriTagInterface $uriTag,
+        private UriTagInterface $uriTag,
     ) {
     }
 
diff --git a/src/CacheInterceptor.php b/src/CacheInterceptor.php
@@ -17,10 +17,10 @@
 
 use const E_USER_WARNING;
 
-final class CacheInterceptor implements MethodInterceptor
+final readonly class CacheInterceptor implements MethodInterceptor
 {
     public function __construct(
-        private readonly QueryRepositoryInterface $repository,
+        private QueryRepositoryInterface $repository,
     ) {
     }
 
diff --git a/src/Cdn/FastlyCachePurger.php b/src/Cdn/FastlyCachePurger.php
@@ -8,9 +8,9 @@
 use BEAR\QueryRepository\PurgerInterface;
 use Override;
 
-final class FastlyCachePurger implements PurgerInterface
+final readonly class FastlyCachePurger implements PurgerInterface
 {
-    public function __construct(private readonly FastlyCachePurgerInterface $fastlyCachePurger)
+    public function __construct(private FastlyCachePurgerInterface $fastlyCachePurger)
     {
     }
 
diff --git a/src/CliHttpCache.php b/src/CliHttpCache.php
@@ -16,10 +16,10 @@
 
 use const PHP_EOL;
 
-final class CliHttpCache implements HttpCacheInterface
+final readonly class CliHttpCache implements HttpCacheInterface
 {
     public function __construct(
-        private readonly ResourceStorageInterface $storage,
+        private ResourceStorageInterface $storage,
     ) {
     }
 
diff --git a/src/CommandInterceptor.php b/src/CommandInterceptor.php
@@ -12,12 +12,12 @@
 use Ray\Aop\MethodInterceptor;
 use Ray\Aop\MethodInvocation;
 
-final class CommandInterceptor implements MethodInterceptor
+final readonly class CommandInterceptor implements MethodInterceptor
 {
     /** @param CommandInterface[] $commands */
     public function __construct(
         #[Commands]
-        private readonly array $commands,
+        private array $commands,
     ) {
     }
 
diff --git a/src/CommandsProvider.php b/src/CommandsProvider.php
@@ -8,11 +8,11 @@
 use Ray\Di\ProviderInterface;
 
 /** @implements ProviderInterface<array<CommandInterface>> */
-final class CommandsProvider implements ProviderInterface
+final readonly class CommandsProvider implements ProviderInterface
 {
     public function __construct(
-        private readonly RefreshSameCommand $refreshSameCommand,
-        private readonly RefreshAnnotatedCommand $refreshAnnotatedCommand,
+        private RefreshSameCommand $refreshSameCommand,
+        private RefreshAnnotatedCommand $refreshAnnotatedCommand,
     ) {
     }
 
diff --git a/src/DevEtagSetter.php b/src/DevEtagSetter.php
@@ -12,10 +12,10 @@
 
 use function gmdate;
 
-final class DevEtagSetter implements EtagSetterInterface
+final readonly class DevEtagSetter implements EtagSetterInterface
 {
     public function __construct(
-        private readonly CacheDependencyInterface $cacheDeperency,
+        private CacheDependencyInterface $cacheDeperency,
     ) {
     }
 
diff --git a/src/DonutCommandInterceptor.php b/src/DonutCommandInterceptor.php
@@ -19,11 +19,11 @@
 use function is_callable;
 use function sprintf;
 
-final class DonutCommandInterceptor implements MethodInterceptor
+final readonly class DonutCommandInterceptor implements MethodInterceptor
 {
     public function __construct(
-        private readonly DonutRepositoryInterface $repository,
-        private readonly MatchQueryInterface $matchQuery
+        private DonutRepositoryInterface $repository,
+        private MatchQueryInterface $matchQuery
     ){
     }
 
diff --git a/src/DonutRepository.php b/src/DonutRepository.php
@@ -12,16 +12,16 @@
 use function assert;
 use function explode;
 
-final class DonutRepository implements DonutRepositoryInterface
+final readonly class DonutRepository implements DonutRepositoryInterface
 {
     public function __construct(
-        private readonly QueryRepositoryInterface $queryRepository,
-        private readonly HeaderSetter $headerSetter,
-        private readonly ResourceStorageInterface $resourceStorage,
-        private readonly ResourceInterface $resource,
-        private readonly CdnCacheControlHeaderSetterInterface $cdnCacheControlHeaderSetter,
-        private readonly RepositoryLoggerInterface $logger,
-        private readonly DonutRendererInterface $renderer,
+        private QueryRepositoryInterface $queryRepository,
+        private HeaderSetter $headerSetter,
+        private ResourceStorageInterface $resourceStorage,
+        private ResourceInterface $resource,
+        private CdnCacheControlHeaderSetterInterface $cdnCacheControlHeaderSetter,
+        private RepositoryLoggerInterface $logger,
+        private DonutRendererInterface $renderer,
     ) {
     }
 
diff --git a/src/DonutRequest.php b/src/DonutRequest.php
@@ -10,12 +10,12 @@
 
 use function sprintf;
 
-final class DonutRequest implements Stringable
+final readonly class DonutRequest implements Stringable
 {
     public function __construct(
-        private readonly AbstractRequest $request,
-        private readonly DonutRendererInterface $donutStorage,
-        private readonly SurrogateKeys $etags,
+        private AbstractRequest $request,
+        private DonutRendererInterface $donutStorage,
+        private SurrogateKeys $etags,
     ) {
     }
 
diff --git a/src/EtagSetter.php b/src/EtagSetter.php
@@ -18,10 +18,10 @@
 use function serialize;
 use function time;
 
-final class EtagSetter implements EtagSetterInterface
+final readonly class EtagSetter implements EtagSetterInterface
 {
     public function __construct(
-        private readonly CacheDependencyInterface $cacheDeperency,
+        private CacheDependencyInterface $cacheDeperency,
     ) {
     }
 
diff --git a/src/Expiry.php b/src/Expiry.php
@@ -4,10 +4,10 @@
 
 namespace BEAR\QueryRepository;
 
-final class Expiry
+final readonly class Expiry
 {
     /** @var array<string, int> */
-    private readonly array $time;
+    private array $time;
 
     public function __construct(int $short = 60, int $medium = 3600, int $long = 86400, int $never = 31_536_000)
     {
diff --git a/src/HeaderSetter.php b/src/HeaderSetter.php
@@ -11,10 +11,10 @@
 use function sprintf;
 use function str_contains;
 
-final class HeaderSetter
+final readonly class HeaderSetter
 {
     public function __construct(
-        private readonly EtagSetterInterface $etagSetter,
+        private EtagSetterInterface $etagSetter,
     ) {
     }
 
diff --git a/src/HttpCache.php b/src/HttpCache.php
@@ -11,10 +11,10 @@
 use function http_response_code;
 
 /** @psalm-suppress DeprecatedInterface for BC */
-final class HttpCache implements HttpCacheInterface, DeprecatedHttpCacheInterface
+final readonly class HttpCache implements HttpCacheInterface, DeprecatedHttpCacheInterface
 {
     public function __construct(
-        private readonly ResourceStorageInterface $storage,
+        private ResourceStorageInterface $storage,
     ) {
     }
 
diff --git a/src/MarshallerProvider.php b/src/MarshallerProvider.php
@@ -20,12 +20,12 @@
  *
  * @implements ProviderInterface<MarshallerInterface|null>
  */
-final class MarshallerProvider implements ProviderInterface
+final readonly class MarshallerProvider implements ProviderInterface
 {
     /** @param array{enabled?: bool, type?: string, use_igbinary?: bool} $options Marshalling options */
     public function __construct(
         #[MarshallerOptions]
-        private readonly array $options = [],
+        private array $options = [],
     ) {
     }
 
diff --git a/src/QueryRepository.php b/src/QueryRepository.php
@@ -17,13 +17,13 @@
 use function strtotime;
 use function time;
 
-final class QueryRepository implements QueryRepositoryInterface
+final readonly class QueryRepository implements QueryRepositoryInterface
 {
     public function __construct(
-        private readonly RepositoryLoggerInterface $logger,
-        private readonly HeaderSetter $headerSetter,
-        private readonly ResourceStorageInterface $storage,
-        private readonly Expiry $expiry,
+        private RepositoryLoggerInterface $logger,
+        private HeaderSetter $headerSetter,
+        private ResourceStorageInterface $storage,
+        private Expiry $expiry,
     ) {
     }
 
diff --git a/src/RedisDsnProvider.php b/src/RedisDsnProvider.php
@@ -17,7 +17,7 @@
 use Symfony\Component\Cache\Adapter\RedisAdapter;
 
 /** @implements ProviderInterface<Redis|RedisArray|RedisCluster|ClientInterface|Relay|RelayCluster> */
-final class RedisDsnProvider implements ProviderInterface
+final readonly class RedisDsnProvider implements ProviderInterface
 {
     /**
      * @param string                                                   $dns     Redis DSN
diff --git a/src/RefreshAnnotatedCommand.php b/src/RefreshAnnotatedCommand.php
@@ -16,11 +16,11 @@
 use function is_array;
 use function uri_template;
 
-final class RefreshAnnotatedCommand implements CommandInterface
+final readonly class RefreshAnnotatedCommand implements CommandInterface
 {
     public function __construct(
-        private readonly QueryRepositoryInterface $repository,
-        private readonly ResourceInterface $resource,
+        private QueryRepositoryInterface $repository,
+        private ResourceInterface $resource,
     ) {
     }
 
diff --git a/src/RefreshInterceptor.php b/src/RefreshInterceptor.php
@@ -11,10 +11,10 @@
 use Ray\Aop\MethodInterceptor;
 use Ray\Aop\MethodInvocation;
 
-final class RefreshInterceptor implements MethodInterceptor
+final readonly class RefreshInterceptor implements MethodInterceptor
 {
     public function __construct(
-        private readonly RefreshAnnotatedCommand $command,
+        private RefreshAnnotatedCommand $command,
     ) {
     }
 
diff --git a/src/RefreshSameCommand.php b/src/RefreshSameCommand.php
@@ -11,11 +11,11 @@
 
 // phpcs:ignoreFile SlevomatCodingStandard.TypeHints.DeclareStrictTypes.DeclareStrictTypesMissing -- for call_user_func_array
 
-final class RefreshSameCommand implements CommandInterface
+final readonly class RefreshSameCommand implements CommandInterface
 {
     public function __construct(
-        private readonly QueryRepositoryInterface $repository,
-        private readonly MatchQueryInterface $matchQuery
+        private QueryRepositoryInterface $repository,
+        private MatchQueryInterface $matchQuery
     ){
     }
 
diff --git a/tests-pecl-ext/StorageRedisDsnModuleTest.php b/tests-pecl-ext/StorageRedisDsnModuleTest.php
@@ -55,7 +55,7 @@ public static function tearDownAfterClass(): void
 
     protected function setUp(): void
     {
-        $this->dsn = getenv('REDIS_SERVER') ? getenv('REDIS_SERVER') : 'localhost:6379';
+        $this->dsn = getenv('REDIS_SERVER') ?: 'localhost:6379';
     }
 
     public function testNew(): void
diff --git a/tests/Fake/FakeMobileEtagSetter.php b/tests/Fake/FakeMobileEtagSetter.php
@@ -15,7 +15,7 @@ class FakeMobileEtagSetter implements EtagSetterInterface
     public static $device;
 
     public function __construct(
-        private MobileEtagSetter $mobileEtagSetter
+        private readonly MobileEtagSetter $mobileEtagSetter
     ){
     }
 
diff --git a/tests/Fake/fake-app/src/Resource/Page/Html/BlogPostingCacheControl.php b/tests/Fake/fake-app/src/Resource/Page/Html/BlogPostingCacheControl.php
@@ -17,7 +17,7 @@ class BlogPostingCacheControl extends ResourceObject
     ];
 
     public function __construct(
-        private DonutRepositoryInterface $repository
+        private readonly DonutRepositoryInterface $repository
     ){
     }
 
diff --git a/tests/ResourceRepositoryTest.php b/tests/ResourceRepositoryTest.php
diff --git a/tests/ResourceStorageTest.php b/tests/ResourceStorageTest.php
diff --git a/tests/bootstrap.php b/tests/bootstrap.php

Original file line number	Diff line number	Diff line change
`@@ -15,13 +15,7 @@`
`15`	`15`	`#[Attribute(Attribute::TARGET_METHOD \| Attribute::TARGET_PARAMETER), Qualifier]`
`16`	`16`	`final class CacheVersion`
`17`	`17`	`{`
`18`		`- /**`
`19`		`- * @var string`
`20`		`- */`
`21`		`- public $value;`
`22`		`-`
`23`		`- public function __construct(string $value)`
	`18`	`+ public function __construct(public string $value)`
`24`	`19`	`{`
`25`		`- $this->value = $value;`
`26`	`20`	`}`
`27`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,10 +10,10 @@`
`10`	`10`	`use function assert;`
`11`	`11`	`use function sprintf;`
`12`	`12`
`13`		`-final class CacheDependency implements CacheDependencyInterface`
	`13`	`+final readonly class CacheDependency implements CacheDependencyInterface`
`14`	`14`	`{`
`15`	`15`	`public function __construct(`
`16`		`- private readonly UriTagInterface $uriTag,`
	`16`	`+ private UriTagInterface $uriTag,`
`17`	`17`	`) {`
`18`	`18`	`}`
`19`	`19`
Original file line number	Diff line number	Diff line change
`@@ -17,10 +17,10 @@`
`17`	`17`
`18`	`18`	`use const E_USER_WARNING;`
`19`	`19`
`20`		`-final class CacheInterceptor implements MethodInterceptor`
	`20`	`+final readonly class CacheInterceptor implements MethodInterceptor`
`21`	`21`	`{`
`22`	`22`	`public function __construct(`
`23`		`- private readonly QueryRepositoryInterface $repository,`
	`23`	`+ private QueryRepositoryInterface $repository,`
`24`	`24`	`) {`
`25`	`25`	`}`
`26`	`26`
Original file line number	Diff line number	Diff line change
`@@ -8,9 +8,9 @@`
`8`	`8`	`use BEAR\QueryRepository\PurgerInterface;`
`9`	`9`	`use Override;`
`10`	`10`
`11`		`-final class FastlyCachePurger implements PurgerInterface`
	`11`	`+final readonly class FastlyCachePurger implements PurgerInterface`
`12`	`12`	`{`
`13`		`- public function __construct(private readonly FastlyCachePurgerInterface $fastlyCachePurger)`
	`13`	`+ public function __construct(private FastlyCachePurgerInterface $fastlyCachePurger)`
`14`	`14`	`{`
`15`	`15`	`}`
`16`	`16`
Original file line number	Diff line number	Diff line change
`@@ -16,10 +16,10 @@`
`16`	`16`
`17`	`17`	`use const PHP_EOL;`
`18`	`18`
`19`		`-final class CliHttpCache implements HttpCacheInterface`
	`19`	`+final readonly class CliHttpCache implements HttpCacheInterface`
`20`	`20`	`{`
`21`	`21`	`public function __construct(`
`22`		`- private readonly ResourceStorageInterface $storage,`
	`22`	`+ private ResourceStorageInterface $storage,`
`23`	`23`	`) {`
`24`	`24`	`}`
`25`	`25`
Original file line number	Diff line number	Diff line change
`@@ -12,12 +12,12 @@`
`12`	`12`	`use Ray\Aop\MethodInterceptor;`
`13`	`13`	`use Ray\Aop\MethodInvocation;`
`14`	`14`
`15`		`-final class CommandInterceptor implements MethodInterceptor`
	`15`	`+final readonly class CommandInterceptor implements MethodInterceptor`
`16`	`16`	`{`
`17`	`17`	`/** @param CommandInterface[] $commands */`
`18`	`18`	`public function __construct(`
`19`	`19`	`#[Commands]`
`20`		`- private readonly array $commands,`
	`20`	`+ private array $commands,`
`21`	`21`	`) {`
`22`	`22`	`}`
`23`	`23`
Original file line number	Diff line number	Diff line change
`@@ -8,11 +8,11 @@`
`8`	`8`	`use Ray\Di\ProviderInterface;`
`9`	`9`
`10`	`10`	`/** @implements ProviderInterface<array<CommandInterface>> */`
`11`		`-final class CommandsProvider implements ProviderInterface`
	`11`	`+final readonly class CommandsProvider implements ProviderInterface`
`12`	`12`	`{`
`13`	`13`	`public function __construct(`
`14`		`- private readonly RefreshSameCommand $refreshSameCommand,`
`15`		`- private readonly RefreshAnnotatedCommand $refreshAnnotatedCommand,`
	`14`	`+ private RefreshSameCommand $refreshSameCommand,`
	`15`	`+ private RefreshAnnotatedCommand $refreshAnnotatedCommand,`
`16`	`16`	`) {`
`17`	`17`	`}`
`18`	`18`