Mark most of the classes readonly (BC break)

nepada · Jan 10, 2024 · f40ca66 · f40ca66
1 parent 8b55d00
commit f40ca66
Show file tree

Hide file tree

Showing 24 changed files with 38 additions and 44 deletions.
diff --git a/src/MessageBus/Commands/CommandHandlerLocator.php b/src/MessageBus/Commands/CommandHandlerLocator.php
@@ -8,7 +8,7 @@
 use Symfony\Component\Messenger\Handler\HandlerDescriptor;
 use Symfony\Component\Messenger\Handler\HandlersLocatorInterface;
 
-final class CommandHandlerLocator implements HandlersLocatorInterface
+final readonly class CommandHandlerLocator implements HandlersLocatorInterface
 {
 
     private ContainerInterface $container;

diff --git a/src/MessageBus/Commands/MessengerCommandBus.php b/src/MessageBus/Commands/MessengerCommandBus.php
@@ -6,7 +6,7 @@
 use Symfony\Component\Messenger\Exception\HandlerFailedException;
 use Symfony\Component\Messenger\MessageBusInterface;
 
-final class MessengerCommandBus implements CommandBus
+final readonly class MessengerCommandBus implements CommandBus
 {
 
     private MessageBusInterface $messageBus;

diff --git a/src/MessageBus/Events/EventSubscribersLocator.php b/src/MessageBus/Events/EventSubscribersLocator.php
@@ -8,7 +8,7 @@
 use Symfony\Component\Messenger\Handler\HandlerDescriptor;
 use Symfony\Component\Messenger\Handler\HandlersLocatorInterface;
 
-final class EventSubscribersLocator implements HandlersLocatorInterface
+final readonly class EventSubscribersLocator implements HandlersLocatorInterface
 {
 
     private ContainerInterface $container;

diff --git a/src/MessageBus/Events/MessengerEventDispatcher.php b/src/MessageBus/Events/MessengerEventDispatcher.php
@@ -6,7 +6,7 @@
 use Symfony\Component\Messenger\MessageBusInterface;
 use Symfony\Component\Messenger\Stamp\DispatchAfterCurrentBusStamp;
 
-final class MessengerEventDispatcher implements EventDispatcher
+final readonly class MessengerEventDispatcher implements EventDispatcher
 {
 
     private MessageBusInterface $messageBus;

diff --git a/src/MessageBus/Logging/LogMessageResolver.php b/src/MessageBus/Logging/LogMessageResolver.php
@@ -7,7 +7,7 @@
 use Symfony\Component\Messenger\Envelope;
 use Symfony\Component\Messenger\Exception\HandlerFailedException;
 
-final class LogMessageResolver
+final readonly class LogMessageResolver
 {
 
     public function getHandlingStartedMessage(Envelope $envelope): string

diff --git a/src/MessageBus/Logging/MessageContextResolver.php b/src/MessageBus/Logging/MessageContextResolver.php
@@ -8,7 +8,7 @@
 use Symfony\Component\Messenger\Exception\HandlerFailedException;
 use Symfony\Component\Messenger\Stamp\HandledStamp;
 
-final class MessageContextResolver
+final readonly class MessageContextResolver
 {
 
     private string $keyPrefix;

diff --git a/src/MessageBus/Logging/PrivateClassPropertiesExtractor.php b/src/MessageBus/Logging/PrivateClassPropertiesExtractor.php
@@ -3,7 +3,7 @@
 
 namespace Nepada\MessageBus\Logging;
 
-final class PrivateClassPropertiesExtractor
+final readonly class PrivateClassPropertiesExtractor
 {
 
     /**

diff --git a/src/MessageBus/Middleware/LoggingMiddleware.php b/src/MessageBus/Middleware/LoggingMiddleware.php
@@ -12,7 +12,7 @@
 use Symfony\Component\Messenger\Middleware\MiddlewareInterface;
 use Symfony\Component\Messenger\Middleware\StackInterface;
 
-final class LoggingMiddleware implements MiddlewareInterface
+final readonly class LoggingMiddleware implements MiddlewareInterface
 {
 
     private LogMessageResolver $logMessageResolver;

diff --git a/src/MessageBus/StaticAnalysis/ConfigurableHandlerValidator.php b/src/MessageBus/StaticAnalysis/ConfigurableHandlerValidator.php
@@ -14,7 +14,7 @@
 use Nepada\MessageBus\StaticAnalysis\Rules\MethodReturnTypeIsVoidRule;
 use Nepada\MessageBus\StaticAnalysis\Rules\ShortClassNameMatchesRule;
 
-final class ConfigurableHandlerValidator implements MessageHandlerValidator
+final readonly class ConfigurableHandlerValidator implements MessageHandlerValidator
 {
 
     private MessageHandlerValidationConfiguration $configuration;

diff --git a/src/MessageBus/StaticAnalysis/HandlerType.php b/src/MessageBus/StaticAnalysis/HandlerType.php
@@ -9,7 +9,7 @@
 /**
  * @template T of CommandHandler|EventSubscriber
  */
-final class HandlerType
+final readonly class HandlerType
 {
 
     /**

diff --git a/src/MessageBus/StaticAnalysis/MessageHandlerValidationConfiguration.php b/src/MessageBus/StaticAnalysis/MessageHandlerValidationConfiguration.php
@@ -6,7 +6,7 @@
 use Nepada\MessageBus\Commands\Command;
 use Nepada\MessageBus\Events\Event;
 
-class MessageHandlerValidationConfiguration
+readonly class MessageHandlerValidationConfiguration
 {
 
     private bool $handlerClassMustBeFinal;
@@ -48,30 +48,24 @@ public function __construct(
 
     public static function command(bool $bleedingEdge = false): self
     {
-        $configuration = new self();
-
-        $configuration->handleMethodParameterName = 'command';
-        $configuration->handleMethodParameterType = Command::class;
-
-        $configuration->messageClassSuffix = 'Command';
-        $configuration->handlerClassSuffix = 'Handler';
-        $configuration->handlerClassPrefixRegex = '';
-
-        return $configuration;
+        return new self(
+            handleMethodParameterName: 'command',
+            handleMethodParameterType: Command::class,
+            messageClassSuffix: 'Command',
+            handlerClassSuffix: 'Handler',
+            handlerClassPrefixRegex: '',
+        );
     }
 
     public static function event(bool $bleedingEdge = false): self
     {
-        $configuration = new self();
-
-        $configuration->handleMethodParameterName = 'event';
-        $configuration->handleMethodParameterType = Event::class;
-
-        $configuration->messageClassSuffix = 'Event';
-        $configuration->handlerClassSuffix = '';
-        $configuration->handlerClassPrefixRegex = '(.+)On';
-
-        return $configuration;
+        return new self(
+            handleMethodParameterName: 'event',
+            handleMethodParameterType: Event::class,
+            messageClassSuffix: 'Event',
+            handlerClassSuffix: '',
+            handlerClassPrefixRegex: '(.+)On',
+        );
     }
 
     public function shouldHandlerClassBeFinal(): bool

diff --git a/src/MessageBus/StaticAnalysis/MessageType.php b/src/MessageBus/StaticAnalysis/MessageType.php
@@ -7,7 +7,7 @@
 use Nepada\MessageBus\Events\Event;
 use Nepada\MessageBus\StaticAnalysis\Rules\ClassNameHasSuffixRule;
 
-final class MessageType
+final readonly class MessageType
 {
 
     /**

diff --git a/src/MessageBus/StaticAnalysis/MessageTypeExtractor.php b/src/MessageBus/StaticAnalysis/MessageTypeExtractor.php
@@ -6,7 +6,7 @@
 use Nepada\MessageBus\Commands\CommandHandler;
 use Nepada\MessageBus\Events\EventSubscriber;
 
-final class MessageTypeExtractor
+final readonly class MessageTypeExtractor
 {
 
     public const METHOD_NAME = '__invoke';

diff --git a/src/MessageBus/StaticAnalysis/ReflectionHelper.php b/src/MessageBus/StaticAnalysis/ReflectionHelper.php
@@ -3,7 +3,7 @@
 
 namespace Nepada\MessageBus\StaticAnalysis;
 
-final class ReflectionHelper
+final readonly class ReflectionHelper
 {
 
     /**

diff --git a/src/MessageBus/StaticAnalysis/Rules/ClassExistsRule.php b/src/MessageBus/StaticAnalysis/Rules/ClassExistsRule.php
@@ -6,7 +6,7 @@
 use Nepada\MessageBus\StaticAnalysis\ReflectionHelper;
 use Nepada\MessageBus\StaticAnalysis\StaticAnalysisFailedException;
 
-final class ClassExistsRule
+final readonly class ClassExistsRule
 {
 
     /**

diff --git a/src/MessageBus/StaticAnalysis/Rules/ClassHasPublicMethodRule.php b/src/MessageBus/StaticAnalysis/Rules/ClassHasPublicMethodRule.php
@@ -6,7 +6,7 @@
 use Nepada\MessageBus\StaticAnalysis\ReflectionHelper;
 use Nepada\MessageBus\StaticAnalysis\StaticAnalysisFailedException;
 
-final class ClassHasPublicMethodRule
+final readonly class ClassHasPublicMethodRule
 {
 
     private string $methodName;

diff --git a/src/MessageBus/StaticAnalysis/Rules/ClassIsFinalRule.php b/src/MessageBus/StaticAnalysis/Rules/ClassIsFinalRule.php
@@ -6,7 +6,7 @@
 use Nepada\MessageBus\StaticAnalysis\ReflectionHelper;
 use Nepada\MessageBus\StaticAnalysis\StaticAnalysisFailedException;
 
-final class ClassIsFinalRule
+final readonly class ClassIsFinalRule
 {
 
     /**

diff --git a/src/MessageBus/StaticAnalysis/Rules/ClassIsReadOnlyRule.php b/src/MessageBus/StaticAnalysis/Rules/ClassIsReadOnlyRule.php
@@ -6,7 +6,7 @@
 use Nepada\MessageBus\StaticAnalysis\ReflectionHelper;
 use Nepada\MessageBus\StaticAnalysis\StaticAnalysisFailedException;
 
-final class ClassIsReadOnlyRule
+final readonly class ClassIsReadOnlyRule
 {
 
     /**

diff --git a/src/MessageBus/StaticAnalysis/Rules/ClassNameHasSuffixRule.php b/src/MessageBus/StaticAnalysis/Rules/ClassNameHasSuffixRule.php
@@ -6,7 +6,7 @@
 use Nepada\MessageBus\StaticAnalysis\ReflectionHelper;
 use Nepada\MessageBus\StaticAnalysis\StaticAnalysisFailedException;
 
-final class ClassNameHasSuffixRule
+final readonly class ClassNameHasSuffixRule
 {
 
     private string $suffix;

diff --git a/src/MessageBus/StaticAnalysis/Rules/MethodHasOneParameterRule.php b/src/MessageBus/StaticAnalysis/Rules/MethodHasOneParameterRule.php
@@ -6,7 +6,7 @@
 use Nepada\MessageBus\StaticAnalysis\StaticAnalysisFailedException;
 use ReflectionMethod;
 
-final class MethodHasOneParameterRule
+final readonly class MethodHasOneParameterRule
 {
 
     /**

diff --git a/src/MessageBus/StaticAnalysis/Rules/MethodParameterNameMatchesRule.php b/src/MessageBus/StaticAnalysis/Rules/MethodParameterNameMatchesRule.php
@@ -6,7 +6,7 @@
 use Nepada\MessageBus\StaticAnalysis\StaticAnalysisFailedException;
 use ReflectionParameter;
 
-final class MethodParameterNameMatchesRule
+final readonly class MethodParameterNameMatchesRule
 {
 
     private string $parameterName;

diff --git a/src/MessageBus/StaticAnalysis/Rules/MethodParameterTypeMatchesRule.php b/src/MessageBus/StaticAnalysis/Rules/MethodParameterTypeMatchesRule.php
@@ -6,7 +6,7 @@
 use Nepada\MessageBus\StaticAnalysis\StaticAnalysisFailedException;
 use ReflectionParameter;
 
-final class MethodParameterTypeMatchesRule
+final readonly class MethodParameterTypeMatchesRule
 {
 
     private string $parameterType;

diff --git a/src/MessageBus/StaticAnalysis/Rules/MethodReturnTypeIsVoidRule.php b/src/MessageBus/StaticAnalysis/Rules/MethodReturnTypeIsVoidRule.php
@@ -5,7 +5,7 @@
 
 use Nepada\MessageBus\StaticAnalysis\StaticAnalysisFailedException;
 
-final class MethodReturnTypeIsVoidRule
+final readonly class MethodReturnTypeIsVoidRule
 {
 
     /**

diff --git a/src/MessageBus/StaticAnalysis/Rules/ShortClassNameMatchesRule.php b/src/MessageBus/StaticAnalysis/Rules/ShortClassNameMatchesRule.php
@@ -6,7 +6,7 @@
 use Nepada\MessageBus\StaticAnalysis\ReflectionHelper;
 use Nepada\MessageBus\StaticAnalysis\StaticAnalysisFailedException;
 
-final class ShortClassNameMatchesRule
+final readonly class ShortClassNameMatchesRule
 {
 
     private string $regexPattern;