Merge pull request #23 from pauci/feature/phpstan

feat: Add phpstan check and fix errors found
pauci · Jun 24, 2020 · b6c6f0d · b6c6f0d
2 parents f2d2645 + d4771d9
commit b6c6f0d
Show file tree

Hide file tree

Showing 14 changed files with 40 additions and 65 deletions.
diff --git a/composer.json b/composer.json
@@ -28,6 +28,7 @@
         "doctrine/dbal": "^2.10",
         "doctrine/orm": "^2.7",
         "guzzlehttp/guzzle": "^6.2",
+        "phpstan/phpstan": "^0.12.30",
         "phpunit/phpunit": "^9.1",
         "squizlabs/php_codesniffer": "^3.5"
     },
@@ -47,10 +48,12 @@
     "scripts": {
         "check": [
             "@cs-check",
+            "@stan",
             "@test"
         ],
         "cs-check": "phpcs",
         "cs-fix": "phpcbf",
+        "stan": "phpstan analyse --no-progress --ansi",
         "test": "phpunit --colors=always",
         "test-coverage": "phpunit --colors=always --coverage-clover clover.xml"
     }

diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -0,0 +1,6 @@
+parameters:
+    level: max
+    checkGenericClassInNonGenericObjectType: false
+    checkMissingIterableValueType: false
+    paths:
+        - src
diff --git a/src/Domain/Message/Metadata.php b/src/Domain/Message/Metadata.php
@@ -17,7 +17,7 @@ class Metadata implements IteratorAggregate, ArrayAccess, Countable, JsonSeriali
     private array $data;
 
     /**
-     * @param mixed[]|self|null $metadata
+     * @param self|array|null $metadata
      */
     public static function from($metadata = null): self
     {
@@ -35,7 +35,7 @@ public static function jsonDeserialize(array $data): self
         return new static($data);
     }
 
-    private function __construct(array $data = [])
+    final private function __construct(array $data = [])
     {
         ksort($data);
         $this->data = $data;

diff --git a/src/Domain/Model/AggregateRootTrait.php b/src/Domain/Model/AggregateRootTrait.php
@@ -59,7 +59,7 @@ public function getUncommittedEvents(): array
      */
     public function getUncommittedEventsCount(): int
     {
-        return count($this->eventContainer);
+        return $this->eventContainer ? count($this->eventContainer) : 0;
     }
 
     /**

diff --git a/src/Domain/Model/EventContainer.php b/src/Domain/Model/EventContainer.php
@@ -18,7 +18,7 @@
 class EventContainer implements Countable
 {
     /**
-     * @var GenericDomainEventMessage[]
+     * @var DomainEventMessageInterface[]
      */
     private array $events = [];
 
@@ -96,7 +96,7 @@ public function addEventMessage(DomainEventMessageInterface $domainEventMessage)
     }
 
     /**
-     * @return GenericDomainEventMessage[]
+     * @return DomainEventMessageInterface[]
      */
     public function getEvents(): array
     {

diff --git a/src/EventHandling/EventHandlerLocator.php b/src/EventHandling/EventHandlerLocator.php
@@ -11,7 +11,7 @@ class EventHandlerLocator implements ContainerInterface
     protected array $handlers = [];
 
     /**
-     * @var callable
+     * @var callable|null
      */
     protected $resolver;
 

diff --git a/src/EventHandling/Publisher/SimpleEventPublisher.php b/src/EventHandling/Publisher/SimpleEventPublisher.php
@@ -13,14 +13,14 @@ class SimpleEventPublisher implements EventPublisherInterface
 {
     private EventBusInterface $eventBus;
 
-    private EventQueueInterface $queue;
+    private ?EventQueueInterface $queue;
 
-    private EventStoreInterface $eventStore;
+    private ?EventStoreInterface $eventStore;
 
-    private Metadata $additionalMetadata;
+    private ?Metadata $additionalMetadata = null;
 
     /**
-     * @param Metadata|array $additionalMetadata
+     * @param Metadata|array|null $additionalMetadata
      */
     public function __construct(
         EventBusInterface $eventBus,
@@ -50,7 +50,7 @@ public function setAdditionalMetadata($additionalMetadata): void
         $this->additionalMetadata = Metadata::from($additionalMetadata);
     }
 
-    public function getAdditionalMetadata(): Metadata
+    public function getAdditionalMetadata(): ?Metadata
     {
         return $this->additionalMetadata;
     }

diff --git a/src/HandlerResolver/CommandHandlerResolver.php b/src/HandlerResolver/CommandHandlerResolver.php
@@ -13,8 +13,9 @@ public function __invoke($handler, string $commandType): callable
     {
         if (is_object($handler) && !is_callable($handler)) {
             $method = $this->resolveHandlingMethod($commandType);
-            if (method_exists($handler, $method)) {
-                return [$handler, $method];
+            $callback = [$handler, $method];
+            if (is_callable($callback)) {
+                return $callback;
             }
         }
 

diff --git a/src/HandlerResolver/ContainerHandlerResolver.php b/src/HandlerResolver/ContainerHandlerResolver.php
@@ -4,18 +4,16 @@
 
 namespace CQRS\HandlerResolver;
 
+use Closure;
 use Psr\Container\ContainerInterface;
 
 class ContainerHandlerResolver
 {
     protected ContainerInterface $container;
 
-    /**
-     * @var callable
-     */
-    protected $nextResolver;
+    protected ?Closure $nextResolver;
 
-    public function __construct(ContainerInterface $container, callable $nextResolver = null)
+    public function __construct(ContainerInterface $container, Closure $nextResolver = null)
     {
         $this->container = $container;
         $this->nextResolver = $nextResolver;
@@ -33,7 +31,7 @@ public function __invoke($handler, string $messageType): callable
         }
 
         if ($this->nextResolver) {
-            $handler = call_user_func($this->nextResolver, $handler, $messageType);
+            $handler = ($this->nextResolver)($handler, $messageType);
         }
 
         return $handler;

diff --git a/src/HandlerResolver/EventHandlerResolver.php b/src/HandlerResolver/EventHandlerResolver.php
@@ -13,8 +13,9 @@ public function __invoke($handler, string $eventType): callable
     {
         if (is_object($handler) && !is_callable($handler)) {
             $method = $this->resolveHandlingMethod($eventType);
-            if (method_exists($handler, $method)) {
-                return [$handler, $method];
+            $callback = [$handler, $method];
+            if (is_callable($callback)) {
+                return $callback;
             }
         }
 

diff --git a/src/Plugin/Doctrine/Domain/AggregateRootMetadataListener.php b/src/Plugin/Doctrine/Domain/AggregateRootMetadataListener.php
diff --git a/src/Plugin/Doctrine/EventHandling/Publisher/DoctrineEventPublisher.php b/src/Plugin/Doctrine/EventHandling/Publisher/DoctrineEventPublisher.php
@@ -4,15 +4,15 @@
 
 namespace CQRS\Plugin\Doctrine\EventHandling\Publisher;
 
-use CQRS\Domain\Message\DomainEventMessageInterface;
+use CQRS\Domain\Message\EventMessageInterface;
 use CQRS\EventHandling\Publisher\SimpleEventPublisher;
 use Doctrine\Common\EventSubscriber;
 use Doctrine\ORM\Events;
 
 class DoctrineEventPublisher extends SimpleEventPublisher implements EventSubscriber
 {
     /**
-     * @var DomainEventMessageInterface[]
+     * @var EventMessageInterface[]
      */
     private array $events = [];
 

diff --git a/src/Plugin/Doctrine/EventStore/TableEventStore.php b/src/Plugin/Doctrine/EventStore/TableEventStore.php
@@ -14,7 +14,7 @@
 use CQRS\Serializer\SerializerInterface;
 use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\DBALException;
-use Doctrine\DBAL\Types\Types;
+use Doctrine\DBAL\ParameterType;
 use Generator;
 use Pauci\DateTime\DateTime;
 use PDO;
@@ -27,7 +27,7 @@ class TableEventStore implements EventStoreInterface
 
     private Connection $connection;
 
-    private ?string $table = 'cqrs_event';
+    private string $table = 'cqrs_event';
 
     public function __construct(SerializerInterface $serializer, Connection $connection, string $table = null)
     {
@@ -63,8 +63,8 @@ public function read(int $offset = 0, int $limit = 10): array
         $events = [];
 
         $stmt = $this->connection->prepare($sql);
-        $stmt->bindValue(1, $offset, Types::INTEGER);
-        $stmt->bindValue(2, $limit, Types::INTEGER);
+        $stmt->bindValue(1, $offset, ParameterType::INTEGER);
+        $stmt->bindValue(2, $limit, ParameterType::INTEGER);
         $stmt->execute();
 
         while ($row = $stmt->fetch(PDO::FETCH_ASSOC)) {
@@ -90,8 +90,8 @@ public function iterate(UuidInterface $previousEventId = null): Generator
         $stmt = $this->connection->prepare($sql);
 
         while (true) {
-            $stmt->bindValue(1, $id, Types::INTEGER);
-            $stmt->bindValue(2, 100, Types::INTEGER);
+            $stmt->bindValue(1, $id, ParameterType::INTEGER);
+            $stmt->bindValue(2, 100, ParameterType::INTEGER);
             $stmt->execute();
 
             $count = 0;
@@ -187,7 +187,7 @@ private function getRowIdByEventId(UuidInterface $eventId): int
         $sql = "SELECT id FROM {$this->table} WHERE event_id = ? LIMIT 1";
 
         $stmt = $this->connection->prepare($sql);
-        $stmt->bindValue(1, (string) $eventId, Types::STRING);
+        $stmt->bindValue(1, (string) $eventId, ParameterType::STRING);
         $stmt->execute();
 
         $rowId = $stmt->fetchColumn();

diff --git a/src/Serializer/Helper/ParamDeserializationHelper.php b/src/Serializer/Helper/ParamDeserializationHelper.php
@@ -63,7 +63,7 @@ private function getValue(array $data, string $key)
 
     private function camelCaseToUnderscore(string $key): string
     {
-        $string = preg_replace('/(?<=\\w)(?=[A-Z])/', '_$1', $key);
+        $string = preg_replace('/(?<=\\w)(?=[A-Z])/', '_$1', $key) ?? $key;
         return strtolower($string);
     }