Code Quality using Rector (#211)

## Description ## Checklist - [ ] Updated CHANGELOG files - [ ] Updated Documentation - [ ] Unit Tests Created - [x] php-cs-fixer
SonsOfPHP · Aug 1, 2024 · 16fe677 · 16fe677
1 parent b9781aa
commit 16fe677
Show file tree

Hide file tree

Showing 43 changed files with 234 additions and 529 deletions.
diff --git a/Aggregate/AbstractAggregate.php b/Aggregate/AbstractAggregate.php
@@ -4,6 +4,8 @@
 
 namespace SonsOfPHP\Component\EventSourcing\Aggregate;
 
+use DateTimeImmutable;
+use Generator;
 use SonsOfPHP\Component\EventSourcing\Message\MessageInterface;
 use SonsOfPHP\Component\EventSourcing\Metadata;
 
@@ -12,7 +14,7 @@
  */
 abstract class AbstractAggregate implements AggregateInterface
 {
-    private AggregateIdInterface $id;
+    private readonly AggregateIdInterface $id;
     private AggregateVersionInterface $version;
     private array $pendingEvents = [];
 
@@ -72,7 +74,7 @@ final public function peekPendingEvents(): iterable
         return $this->pendingEvents;
     }
 
-    final public static function buildFromEvents(AggregateIdInterface $id, \Generator $events): AggregateInterface
+    final public static function buildFromEvents(AggregateIdInterface $id, Generator $events): AggregateInterface
     {
         $aggregate = new static($id);
         foreach ($events as $event) {
@@ -93,7 +95,7 @@ final protected function raiseEvent(MessageInterface $event): void
         // Prepopulate with some metadata
         $event = $event->withMetadata([
             Metadata::AGGREGATE_ID     => $this->getAggregateId()->toString(),
-            Metadata::TIMESTAMP        => (new \DateTimeImmutable())->format(Metadata::DEFAULT_TIMESTAMP_FORMAT),
+            Metadata::TIMESTAMP        => (new DateTimeImmutable())->format(Metadata::DEFAULT_TIMESTAMP_FORMAT),
             Metadata::TIMESTAMP_FORMAT => Metadata::DEFAULT_TIMESTAMP_FORMAT,
         ]);
 

diff --git a/Aggregate/AbstractAggregateId.php b/Aggregate/AbstractAggregateId.php
@@ -17,7 +17,7 @@
 abstract class AbstractAggregateId implements AggregateIdInterface
 {
     public function __construct(
-        private ?string $id = null,
+        private readonly ?string $id = null,
     ) {
         if (null === $id) {
             throw new EventSourcingException('Argument (#1) $id cannot be null');

diff --git a/Aggregate/AbstractSnapshotableAggregate.php b/Aggregate/AbstractSnapshotableAggregate.php
@@ -4,6 +4,7 @@
 
 namespace SonsOfPHP\Component\EventSourcing\Aggregate;
 
+use Generator;
 use SonsOfPHP\Component\EventSourcing\Snapshot\Snapshot;
 use SonsOfPHP\Component\EventSourcing\Snapshot\SnapshotInterface;
 
@@ -34,7 +35,7 @@ public function createSnapshot(): SnapshotInterface
     /**
      * @see SnapshotableAggregateInterface::buildFromSnapshotAndEvents
      */
-    public static function buildFromSnapshotAndEvents(SnapshotInterface $snapshot, \Generator $messages): SnapshotableAggregateInterface
+    public static function buildFromSnapshotAndEvents(SnapshotInterface $snapshot, Generator $messages): SnapshotableAggregateInterface
     {
         $aggregate = static::buildFromSnapshot($snapshot);
         foreach ($messages as $msg) {

diff --git a/Aggregate/AggregateIdInterface.php b/Aggregate/AggregateIdInterface.php
@@ -5,13 +5,14 @@
 namespace SonsOfPHP\Component\EventSourcing\Aggregate;
 
 use SonsOfPHP\Component\EventSourcing\Exception\EventSourcingException;
+use Stringable;
 
 /**
  * Aggregate ID.
  *
  * @author Joshua Estes <[email protected]>
  */
-interface AggregateIdInterface extends \Stringable
+interface AggregateIdInterface extends Stringable
 {
     /**
      * Create a new AggregateID.

diff --git a/Aggregate/AggregateInterface.php b/Aggregate/AggregateInterface.php
@@ -4,6 +4,7 @@
 
 namespace SonsOfPHP\Component\EventSourcing\Aggregate;
 
+use Generator;
 use SonsOfPHP\Component\EventSourcing\Exception\EventSourcingException;
 use SonsOfPHP\Component\EventSourcing\Message\MessageInterface;
 
@@ -47,9 +48,9 @@ public function peekPendingEvents(): iterable;
     /**
      * Build Aggregate from a collection of Domain Events.
      *
-     * @param \Generator $events yields MessageInterface objects
+     * @param Generator $events yields MessageInterface objects
      *
      * @throws EventSourcingException
      */
-    public static function buildFromEvents(AggregateIdInterface $id, \Generator $events): self;
+    public static function buildFromEvents(AggregateIdInterface $id, Generator $events): self;
 }
diff --git a/Aggregate/AggregateVersion.php b/Aggregate/AggregateVersion.php
@@ -13,12 +13,8 @@
  */
 final class AggregateVersion implements AggregateVersionInterface
 {
-    private int $version;
-
-    public function __construct(int $version = 0)
+    public function __construct(private readonly int $version = 0)
     {
-        $this->version = $version;
-
         if (!$this->isValid()) {
             throw new EventSourcingException(sprintf('Version "%s" is invalid.', $this->version));
         }

diff --git a/Aggregate/Repository/AggregateRepository.php b/Aggregate/Repository/AggregateRepository.php
@@ -19,14 +19,7 @@
  */
 class AggregateRepository implements AggregateRepositoryInterface
 {
-    public function __construct(
-        protected string $aggregateClass,
-        protected EventDispatcherInterface $eventDispatcher,
-        protected MessageRepositoryInterface $messageRepository,
-        protected ?MessageEnricherInterface $messageEnricher = null
-    ) {
-        $this->messageEnricher = $messageEnricher ?? new MessageEnricher(new NullMessageEnricherProvider());
-    }
+    public function __construct(protected string $aggregateClass, protected EventDispatcherInterface $eventDispatcher, protected MessageRepositoryInterface $messageRepository, protected MessageEnricherInterface $messageEnricher = new MessageEnricher(new NullMessageEnricherProvider())) {}
 
     public function find(AggregateIdInterface|string $id): ?AggregateInterface
     {
@@ -39,7 +32,7 @@ public function find(AggregateIdInterface|string $id): ?AggregateInterface
             $aggregateClass = $this->aggregateClass;
 
             return $aggregateClass::buildFromEvents($id, $events);
-        } catch (AggregateNotFoundException $e) {
+        } catch (AggregateNotFoundException) {
         }
 
         return null;

diff --git a/Aggregate/SnapshotableAggregateInterface.php b/Aggregate/SnapshotableAggregateInterface.php
@@ -4,6 +4,7 @@
 
 namespace SonsOfPHP\Component\EventSourcing\Aggregate;
 
+use Generator;
 use SonsOfPHP\Component\EventSourcing\Snapshot\SnapshotInterface;
 
 /**
@@ -20,5 +21,5 @@ public function createSnapshot(): SnapshotInterface;
 
     public static function buildFromSnapshot(SnapshotInterface $snapshot): self;
 
-    public static function buildFromSnapshotAndEvents(SnapshotInterface $snapshot, \Generator $events): self;
+    public static function buildFromSnapshotAndEvents(SnapshotInterface $snapshot, Generator $events): self;
 }
diff --git a/Exception/AggregateNotFoundException.php b/Exception/AggregateNotFoundException.php
@@ -4,7 +4,9 @@
 
 namespace SonsOfPHP\Component\EventSourcing\Exception;
 
+use Exception;
+
 /**
  * @author Joshua Estes <[email protected]>
  */
-class AggregateNotFoundException extends \Exception {}
+class AggregateNotFoundException extends Exception {}
diff --git a/Exception/EventSourcingException.php b/Exception/EventSourcingException.php
@@ -14,4 +14,4 @@
  *
  * @author Joshua Estes <[email protected]>
  */
-class EventSourcingException extends \Exception {}
+class EventSourcingException extends Exception {}
diff --git a/Message/Enricher/Handler/EventTypeMessageEnricherHandler.php b/Message/Enricher/Handler/EventTypeMessageEnricherHandler.php
@@ -17,12 +17,7 @@
  */
 final class EventTypeMessageEnricherHandler implements MessageEnricherHandlerInterface
 {
-    private MessageProviderInterface $messageProvider;
-
-    public function __construct(MessageProviderInterface $messageProvider)
-    {
-        $this->messageProvider = $messageProvider;
-    }
+    public function __construct(private readonly MessageProviderInterface $messageProvider) {}
 
     public function enrich(MessageInterface $message): MessageInterface
     {

diff --git a/Message/Enricher/MessageEnricher.php b/Message/Enricher/MessageEnricher.php
@@ -12,12 +12,7 @@
  */
 final class MessageEnricher implements MessageEnricherInterface
 {
-    private MessageEnricherProviderInterface $provider;
-
-    public function __construct(MessageEnricherProviderInterface $provider)
-    {
-        $this->provider = $provider;
-    }
+    public function __construct(private readonly MessageEnricherProviderInterface $provider) {}
 
     public function enrich(MessageInterface $message): MessageInterface
     {

diff --git a/Message/MessageMetadata.php b/Message/MessageMetadata.php
@@ -4,19 +4,24 @@
 
 namespace SonsOfPHP\Component\EventSourcing\Message;
 
+use ArrayIterator;
+use Countable;
+use DateTimeImmutable;
+use IteratorAggregate;
 use SonsOfPHP\Component\EventSourcing\Aggregate\AggregateId;
 use SonsOfPHP\Component\EventSourcing\Aggregate\AggregateIdInterface;
 use SonsOfPHP\Component\EventSourcing\Aggregate\AggregateVersion;
 use SonsOfPHP\Component\EventSourcing\Aggregate\AggregateVersionInterface;
 use SonsOfPHP\Component\EventSourcing\Exception\EventSourcingException;
 use SonsOfPHP\Component\EventSourcing\Metadata;
+use Traversable;
 
 /**
  * The Event Message Metadata is stored in here.
  *
  * @author Joshua Estes <[email protected]>
  */
-final class MessageMetadata implements \IteratorAggregate, \Countable
+final class MessageMetadata implements IteratorAggregate, Countable
 {
     public function __construct(
         private array $metadata = [],
@@ -31,9 +36,9 @@ public function __construct(
         ], $metadata);
     }
 
-    public function getIterator(): \Traversable
+    public function getIterator(): Traversable
     {
-        return new \ArrayIterator($this->metadata);
+        return new ArrayIterator($this->metadata);
     }
 
     public function count(): int
@@ -46,7 +51,7 @@ public function all(): array
         return $this->metadata;
     }
 
-    public function with(string $key, $value)
+    public function with(string $key, $value): self
     {
         $that                 = clone $this;
         $that->metadata[$key] = $value;
@@ -87,13 +92,13 @@ public function getEventType(): string
         return $this->get(Metadata::EVENT_TYPE);
     }
 
-    public function getTimestamp(): \DateTimeImmutable
+    public function getTimestamp(): DateTimeImmutable
     {
         if (false === $this->has(Metadata::TIMESTAMP) || null === $this->get(Metadata::TIMESTAMP)) {
             throw new EventSourcingException('Timestamp is required.');
         }
 
-        return new \DateTimeImmutable($this->get(Metadata::TIMESTAMP));
+        return new DateTimeImmutable($this->get(Metadata::TIMESTAMP));
     }
 
     public function getTimestampFormat(): string

diff --git a/Message/MessagePayload.php b/Message/MessagePayload.php
@@ -4,20 +4,25 @@
 
 namespace SonsOfPHP\Component\EventSourcing\Message;
 
+use ArrayIterator;
+use Countable;
+use IteratorAggregate;
+use Traversable;
+
 /**
  * The Event Message Payload is stored in here.
  *
  * @author Joshua Estes <[email protected]>
  */
-final class MessagePayload implements \IteratorAggregate, \Countable
+final class MessagePayload implements IteratorAggregate, Countable
 {
     public function __construct(
         private array $payload = [],
     ) {}
 
-    public function getIterator(): \Traversable
+    public function getIterator(): Traversable
     {
-        return new \ArrayIterator($this->payload);
+        return new ArrayIterator($this->payload);
     }
 
     public function count(): int
@@ -30,7 +35,7 @@ public function all(): array
         return $this->payload;
     }
 
-    public function with(string $key, $value)
+    public function with(string $key, $value): self
     {
         $that                = clone $this;
         $that->payload[$key] = $value;

diff --git a/Message/NamespaceMessageProvider.php b/Message/NamespaceMessageProvider.php
@@ -13,12 +13,7 @@
  */
 class NamespaceMessageProvider implements MessageProviderInterface
 {
-    private string $namespace;
-
-    public function __construct(string $namespace)
-    {
-        $this->namespace = $namespace;
-    }
+    public function __construct(private readonly string $namespace) {}
 
     public function getEventTypeForMessage($message): string
     {
@@ -32,7 +27,7 @@ public function getEventTypeForMessage($message): string
 
         $eventType = trim(substr($message, \strlen($this->namespace)), '\\');
 
-        if ($this->namespace !== substr($message, 0, \strlen($this->namespace))) {
+        if (!str_starts_with($message, $this->namespace)) {
             throw new EventSourcingException(sprintf('Message "%s" is not in the Namespace "%s"', $message, $this->namespace));
         }
 

diff --git a/Message/Repository/InMemoryMessageRepository.php b/Message/Repository/InMemoryMessageRepository.php
@@ -41,7 +41,7 @@ public function find(string|AggregateIdInterface $id, int|AggregateVersionInterf
         }
 
         foreach ($this->storage[$id->toString()] as $ver => $message) {
-            if (null !== $version && $ver <= $version->toInt()) {
+            if ($version instanceof AggregateVersionInterface && $ver <= $version->toInt()) {
                 continue;
             }
 

diff --git a/Message/Serializer/MessageSerializer.php b/Message/Serializer/MessageSerializer.php
@@ -21,16 +21,14 @@
  */
 class MessageSerializer implements MessageSerializerInterface
 {
-    private MessageProviderInterface $messageProvider;
-    private MessageEnricherInterface $messageEnricher;
-    private MessageUpcasterInterface $messageUpcaster;
+    private readonly MessageEnricherInterface $messageEnricher;
+    private readonly MessageUpcasterInterface $messageUpcaster;
 
     public function __construct(
-        MessageProviderInterface $messageProvider,
+        private readonly MessageProviderInterface $messageProvider,
         MessageEnricherInterface $messageEnricher = null,
         MessageUpcasterInterface $messageUpcaster = null
     ) {
-        $this->messageProvider = $messageProvider;
         $this->messageEnricher = $messageEnricher ?? new MessageEnricher(new AllMessageEnricherProvider([new EventTypeMessageEnricherHandler($this->messageProvider)]));
         $this->messageUpcaster = $messageUpcaster ?? new MessageUpcaster(new NullMessageUpcasterProvider());
     }

diff --git a/Message/Upcaster/MessageUpcaster.php b/Message/Upcaster/MessageUpcaster.php
@@ -11,12 +11,7 @@
  */
 final class MessageUpcaster implements MessageUpcasterInterface
 {
-    private MessageUpcasterProviderInterface $provider;
-
-    public function __construct(MessageUpcasterProviderInterface $provider)
-    {
-        $this->provider = $provider;
-    }
+    public function __construct(private readonly MessageUpcasterProviderInterface $provider) {}
 
     public function upcast(array $data): array
     {

diff --git a/Snapshot/Snapshot.php b/Snapshot/Snapshot.php
@@ -12,16 +12,7 @@
  */
 final class Snapshot implements SnapshotInterface
 {
-    private AggregateIdInterface $id;
-    private AggregateVersionInterface $version;
-    private $state;
-
-    public function __construct(AggregateIdInterface $id, AggregateVersionInterface $version, $state)
-    {
-        $this->id      = $id;
-        $this->version = $version;
-        $this->state   = $state;
-    }
+    public function __construct(private readonly AggregateIdInterface $id, private readonly AggregateVersionInterface $version, private $state) {}
 
     public function getAggregateId(): AggregateIdInterface
     {