Merge pull request #31 from matthiasnoback/fransik-improved-types

Fransik improved types

Author: matthiasnoback

build_and_push.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+
+# Use this script to build new versions of the Docker images that can be pulled by anyone who wants to run the tests.
+
+set -e
+
+docker-compose build
+docker-compose push

composer.json

@@ -11,7 +11,8 @@
         "php": ">=7.2",
         "doctrine/dbal": "^2.5",
         "webmozart/assert": "^1.4",
-        "ext-pdo": "*"
+        "ext-pdo": "*",
+        "composer/package-versions-deprecated": "1.11.99.1"
     },
     "require-dev": {
         "doctrine/migrations": "^1.5",

composer.lock

@@ -31,7 +31,7 @@ RUN docker-php-ext-install pdo pdo_mysql \
 
 # Install Xdebug (for code coverage)
 RUN apk add --no-cache --virtual .build-dependencies $PHPIZE_DEPS \
-    && pecl install xdebug \
+    && pecl install xdebug-2.9.8 \
     && docker-php-ext-enable xdebug \
     && apk --no-cache del .build-dependencies \
     && php -m | grep xdebug

docker/php72/Dockerfile

@@ -7,6 +7,7 @@ HOST_GID=$(id -g)
 
 mkdir -p build/logs/
 docker-compose up -d mysql
+sleep 5
 
 docker-compose run --user="${HOST_UID}:${HOST_GID}" php72 \
     composer install --prefer-dist

run_tests.sh

@@ -6,6 +6,7 @@
 
 /**
  * @see AggregateBehavior
+ * @phpstan-template T
  */
 interface Aggregate extends Entity
 {
@@ -21,6 +22,10 @@ interface Aggregate extends Entity
      *     return [
      *         Line::class => $this->lines()
      *     ];
+     *
+     * @return array<string, mixed[]>
+     *
+     * @phpstan-return array<class-string<ChildEntity>, mixed[]>
      */
     public function childEntitiesByType(): array;
 
@@ -30,6 +35,10 @@ public function childEntitiesByType(): array;
      *     return [
      *         Line::class
      *     ]
+     *
+     * @return array<int, string>
+     *
+     * @phpstan-return array<int, class-string<ChildEntity>>
      */
     public static function childEntityTypes(): array;
 
@@ -50,9 +59,12 @@ public static function childEntityTypes(): array;
      *     return $order;
      * }
      *
-     * @param array $aggregateState
-     * @param array $childEntitiesByType
+     * @param array<string, mixed> $aggregateState
+     * @param array<string, mixed[]> $childEntitiesByType
      * @return static
+     *
+     * @phpstan-param array<class-string<ChildEntity>, mixed[]> $childEntitiesByType
+     * @phpstan-return T
      */
     public static function fromState(array $aggregateState, array $childEntitiesByType);
 

src/TalisOrm/Aggregate.php

@@ -4,14 +4,13 @@
 namespace TalisOrm;
 
 use TalisOrm\DomainEvents\EventRecordingCapabilities;
-use Webmozart\Assert\Assert;
 
 trait AggregateBehavior
 {
     use EventRecordingCapabilities;
 
     /**
-     * @var array
+     * @var ChildEntity[]
      */
     private $deletedChildEntities = [];
 
@@ -34,7 +33,7 @@ public function deletedChildEntities(): array
         return $deletedChildEntities;
     }
 
-    private function deleteChildEntity(ChildEntity $childEntity)
+    private function deleteChildEntity(ChildEntity $childEntity): void
     {
         $this->deletedChildEntities[] = $childEntity;
     }
@@ -49,10 +48,7 @@ public function markAsPersisted(): void
         $this->isNew = false;
     }
 
-    /**
-     * @return int
-     */
-    public function aggregateVersion()
+    public function aggregateVersion(): int
     {
         return $this->aggregateVersion;
     }

src/TalisOrm/AggregateBehavior.php

@@ -11,6 +11,9 @@
 use TalisOrm\DomainEvents\EventDispatcher;
 use Webmozart\Assert\Assert;
 
+/**
+ * @phpstan-template T of Aggregate
+ */
 final class AggregateRepository
 {
     /**
@@ -31,11 +34,12 @@ public function __construct(Connection $connection, EventDispatcher $eventDispat
 
     /**
      * @throws ConcurrentUpdateOccurred (only when you use optimistic concurrency locking)
+     *
+     * @phpstan-param T $aggregate
      */
     public function save(Aggregate $aggregate): void
     {
         $this->connection->transactional(function () use ($aggregate) {
-            /** @var Entity[] $persistedEntities */
             $persistedEntities = [];
 
             $this->insertOrUpdate($aggregate);
@@ -63,6 +67,13 @@ public function save(Aggregate $aggregate): void
         $this->eventDispatcher->dispatch($aggregate->releaseEvents());
     }
 
+    /**
+     * @param array<string, mixed> $extraState
+     * @return mixed|Aggregate
+     *
+     * @phpstan-param class-string<T> $aggregateClass
+     * @phpstan-return T
+     */
     public function getById(string $aggregateClass, AggregateId $aggregateId, array $extraState = []): Aggregate
     {
         if (!is_a($aggregateClass, Aggregate::class, true)) {
@@ -92,6 +103,11 @@ public function getById(string $aggregateClass, AggregateId $aggregateId, array
         return $aggregate;
     }
 
+    /**
+     * @return array<string, mixed>
+     *
+     * @phpstan-param class-string<T> $aggregateClass
+     */
     private function getAggregateState(string $aggregateClass, AggregateId $aggregateId): array
     {
         $aggregateStates = $this->fetchAll(
@@ -115,7 +131,11 @@ private function getAggregateState(string $aggregateClass, AggregateId $aggregat
     }
 
     /**
-     * @return array[]
+     * @param array<string, mixed> $aggregateState
+     * @return array<string, mixed[]>
+     *
+     * @phpstan-param class-string<T> $aggregateClass
+     * @phpstan-return array<class-string<ChildEntity>, mixed[]>
      */
     private function getChildEntitiesByType(
         string $aggregateClass,
@@ -145,6 +165,9 @@ function (array $childEntityState) use ($childEntityType, $aggregateState) {
         return $childEntitiesByType;
     }
 
+    /**
+     * @phpstan-param T $aggregate
+     */
     public function delete(Aggregate $aggregate): void
     {
         $this->connection->transactional(function () use ($aggregate) {
@@ -155,7 +178,6 @@ public function delete(Aggregate $aggregate): void
 
             foreach ($aggregate->childEntitiesByType() as $type => $childEntities) {
                 foreach ($childEntities as $childEntity) {
-                    /** @var ChildEntity $childEntity */
                     $this->connection->delete(
                         $this->connection->quoteIdentifier($childEntity::tableName()),
                         $childEntity->identifier()
@@ -194,7 +216,8 @@ private function insertOrUpdate(Entity $entity): void
     }
 
     /**
-     * @return array[]
+     * @param array<string, mixed> $identifier
+     * @return array<int, array<string, mixed>>
      */
     private function fetchAll(string $tableName, array $identifier): array
     {
@@ -206,7 +229,8 @@ private function fetchAll(string $tableName, array $identifier): array
     /**
      * This method might have been on Connection itself...
      *
-     * @return ResultStatement
+     * @param array<string, mixed> $where
+     * @return ResultStatement<mixed>
      */
     private function select(string $selectExpression, string $tableExpression, array $where): ResultStatement
     {

src/TalisOrm/AggregateRepository.php

@@ -18,8 +18,8 @@ interface ChildEntity extends Entity
      *
      *     return $line;
      *
-     * @param array $state
-     * @param array $aggregateState
+     * @param array<string, mixed> $state
+     * @param array<string, mixed> $aggregateState
      * @return static
      */
     public static function fromState(array $state, array $aggregateState);

src/TalisOrm/ChildEntity.php

@@ -15,6 +15,9 @@ public static function ofEntity(Entity $entity): ConcurrentUpdateOccurred
         ));
     }
 
+    /**
+     * @param array<string, mixed> $identifier
+     */
     private static function renderIdentifier(array $identifier): string
     {
         $parts = [];