refactor(test-utilities): generic-type AggregateRootTestCase

src/LibraryConsumptionTests/AggregateWithDelegatedBehavior/AggregateRootWithDelegatedBehaviorTest.php

@@ -9,7 +9,7 @@
 use EventSauce\EventSourcing\TestUtilities\AggregateRootTestCase;
 
 /**
- * @method DummyAggregateRootId aggregateRootId()
+ * @extends AggregateRootTestCase<DummyAggregateRootId, AggregateRootWithDelegatedBehavior>
  */
 class AggregateRootWithDelegatedBehaviorTest extends AggregateRootTestCase
 {

src/LibraryConsumptionTests/ShoppingCartExample/ShoppingCartTestCase.php

@@ -7,6 +7,9 @@
 use Closure;
 use EventSauce\EventSourcing\TestUtilities\AggregateRootTestCase;
 
+/**
+ * @extends AggregateRootTestCase<ShoppingCartId, ShoppingCart>
+ */
 class ShoppingCartTestCase extends AggregateRootTestCase
 {
     protected function newAggregateRootId(): ShoppingCartId
@@ -21,7 +24,6 @@ protected function aggregateRootClassName(): string
 
     public function handle(Closure $closure): void
     {
-        /** @var ShoppingCart $aggregate */
         $aggregate = $this->repository->retrieve($this->aggregateRootId);
         $closure($aggregate);
         $this->repository->persist($aggregate);

src/Snapshotting/Tests/AggregateSnapshottingTest.php

@@ -15,6 +15,9 @@
 use EventSauce\EventSourcing\Snapshotting\Snapshot;
 use EventSauce\EventSourcing\TestUtilities\AggregateRootTestCase;
 
+/**
+ * @extends AggregateRootTestCase<LightSwitchId, LightSwitch>
+ */
 class AggregateSnapshottingTest extends AggregateRootTestCase
 {
     protected InMemorySnapshotRepository $snapshotRepository;

src/Snapshotting/Tests/LightSwitchTest.php

@@ -8,7 +8,7 @@
 use EventSauce\EventSourcing\TestUtilities\AggregateRootTestCase;
 
 /**
- * @method LightSwitchId aggregateRootId()
+ * @extends AggregateRootTestCase<LightSwitchId, LightSwitch>
  */
 class LightSwitchTest extends AggregateRootTestCase
 {
@@ -68,7 +68,6 @@ protected function handle(object $command): void
             return;
         }
 
-        /** @var LightSwitch $lightSwitch */
         $lightSwitch = $this->retrieveAggregateRoot($command->id());
 
         if ($command instanceof TurnLightOn) {

src/TestUtilities/AggregateRootTestCase.php

@@ -41,6 +41,9 @@
 use function sprintf;
 
 /**
+ * @template AggregateRootIdType of AggregateRootId
+ * @template AggregateRootType of AggregateRoot<AggregateRootIdType>
+ *
  * @method handle(...$arguments)
  */
 abstract class AggregateRootTestCase extends TestCase
@@ -51,7 +54,7 @@ abstract class AggregateRootTestCase extends TestCase
     protected $messageRepository;
 
     /**
-     * @phpstan-var AggregateRootRepository<AggregateRoot>
+     * @phpstan-var AggregateRootRepository<AggregateRootType>
      */
     protected AggregateRootRepository $repository;
 
@@ -81,7 +84,7 @@ abstract class AggregateRootTestCase extends TestCase
     private $assertedScenario = false;
 
     /**
-     * @var AggregateRootId
+     * @var AggregateRootIdType
      */
     protected $aggregateRootId;
 
@@ -109,11 +112,17 @@ protected function setUpEventSauce(): void
         $this->caughtException = null;
     }
 
+    /**
+     * @return AggregateRootType
+     */
     protected function retrieveAggregateRoot(AggregateRootId $id): object
     {
         return $this->repository->retrieve($id);
     }
 
+    /**
+     * @param AggregateRootType $aggregateRoot
+     */
     protected function persistAggregateRoot(AggregateRoot $aggregateRoot): void
     {
         $this->repository->persist($aggregateRoot);
@@ -142,15 +151,21 @@ protected function assertScenario(): void
         }
     }
 
+    /**
+     * @return AggregateRootIdType
+     */
     protected function aggregateRootId(): AggregateRootId
     {
         return $this->aggregateRootId;
     }
 
+    /**
+     * @return AggregateRootIdType
+     */
     abstract protected function newAggregateRootId(): AggregateRootId;
 
     /**
-     * @phpstan-return class-string<AggregateRoot>
+     * @phpstan-return class-string<AggregateRootType>
      */
     abstract protected function aggregateRootClassName(): string;
 

src/TestUtilities/TestingAggregates/ExampleAggregateRootTest.php

@@ -16,7 +16,7 @@
 use PHPUnit\Framework\ExpectationFailedException;
 
 /**
- * @method DummyAggregateRootId aggregateRootId()
+ * @extends AggregateRootTestCase<DummyAggregateRootId, DummyAggregate>
  */
 class ExampleAggregateRootTest extends AggregateRootTestCase
 {

src/TestUtilities/TestingAggregates/TestCaseMustHaveHandleMethodsTest.php

@@ -10,7 +10,7 @@
 use LogicException;
 
 /**
- * @method DummyAggregateRootId aggregateRootId()
+ * @extends AggregateRootTestCase<DummyAggregateRootId, DummyAggregate>
  */
 class TestCaseMustHaveHandleMethodsTest extends AggregateRootTestCase
 {

tests/ShoppingCartTestCase.php

@@ -8,6 +8,9 @@
 use EventSauce\EventSourcing\LibraryConsumptionTests\ShoppingCartExample\ShoppingCartId;
 use EventSauce\EventSourcing\TestUtilities\AggregateRootTestCase;
 
+/**
+ * @extends AggregateRootTestCase<ShoppingCartId, ShoppingCart>
+ */
 abstract class ShoppingCartTestCase extends AggregateRootTestCase
 {
     protected function newAggregateRootId(): ShoppingCartId
@@ -22,7 +25,6 @@ protected function aggregateRootClassName(): string
 
     public function handle(Closure $closure): void
     {
-        /** @var ShoppingCart $aggregate */
         $aggregate = $this->repository->retrieve($this->aggregateRootId);
         $closure($aggregate);
         $this->repository->persist($aggregate);