Make PurgerFactory generic

This allows us to remove assertions and natively provide the right type information.
doctrine · Nov 29, 2024 · cccda85 · cccda85
1 parent 42a0cbe
commit cccda85
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 13 deletions.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -1,7 +1,7 @@
 parameters:
 	ignoreErrors:
 		-
-			message: "#^Method class@anonymous/src/Command/LoadDataFixturesDoctrineCommand\\.php\\:121\\:\\:log\\(\\) has parameter \\$message with no type specified\\.$#"
+			message: "#^Method class@anonymous/src/Command/LoadDataFixturesDoctrineCommand\\.php\\:120\\:\\:log\\(\\) has parameter \\$message with no type specified\\.$#"
 			count: 1
 			path: src/Command/LoadDataFixturesDoctrineCommand.php
 

diff --git a/src/Command/LoadDataFixturesDoctrineCommand.php b/src/Command/LoadDataFixturesDoctrineCommand.php
@@ -10,7 +10,6 @@
 use Doctrine\Bundle\FixturesBundle\Purger\ORMPurgerFactory;
 use Doctrine\Bundle\FixturesBundle\Purger\PurgerFactory;
 use Doctrine\Common\DataFixtures\Executor\ORMExecutor;
-use Doctrine\Common\DataFixtures\Purger\ORMPurgerInterface;
 use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\Persistence\ManagerRegistry;
 use Psr\Log\AbstractLogger;
@@ -32,6 +31,7 @@ class LoadDataFixturesDoctrineCommand extends DoctrineCommand
     public function __construct(
         private SymfonyFixturesLoader $fixturesLoader,
         ManagerRegistry $doctrine,
+        /** @var array<string, ORMPurgerFactory> $purgerFactories */
         private array $purgerFactories = [],
     ) {
         parent::__construct($doctrine);
@@ -110,13 +110,12 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $factory = $this->purgerFactories[$input->getOption('purger')];
         }
 
-        $purger = $factory->createForEntityManager(
+        $purger   = $factory->createForEntityManager(
             $input->getOption('em'),
             $em,
             $input->getOption('purge-exclusions'),
             $input->getOption('purge-with-truncate'),
         );
-        assert($purger instanceof ORMPurgerInterface);
         $executor = new ORMExecutor($em, $purger);
         $executor->setLogger(new class ($ui) extends AbstractLogger {
             public function __construct(private SymfonyStyle $ui)

diff --git a/src/Purger/ORMPurgerFactory.php b/src/Purger/ORMPurgerFactory.php
@@ -7,6 +7,7 @@
 use Doctrine\Common\DataFixtures\Purger\ORMPurger;
 use Doctrine\ORM\EntityManagerInterface;
 
+/** @template-implements PurgerFactory<ORMPurger> */
 final class ORMPurgerFactory implements PurgerFactory
 {
     /**

diff --git a/src/Purger/PurgerFactory.php b/src/Purger/PurgerFactory.php
@@ -7,9 +7,14 @@
 use Doctrine\Common\DataFixtures\Purger\PurgerInterface;
 use Doctrine\ORM\EntityManagerInterface;
 
+/** @template T of PurgerInterface */
 interface PurgerFactory
 {
-    /** @phpstan-param list<string> $excluded */
+    /**
+     * @phpstan-param list<string> $excluded
+     *
+     * @return T
+     */
     public function createForEntityManager(
         string|null $emName,
         EntityManagerInterface $em,

diff --git a/tests/Purger/ORMPurgerFactoryTest.php b/tests/Purger/ORMPurgerFactoryTest.php
@@ -10,8 +10,6 @@
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 
-use function assert;
-
 class ORMPurgerFactoryTest extends TestCase
 {
     private ORMPurgerFactory $factory;
@@ -28,9 +26,7 @@ protected function setUp(): void
     public function testCreateDefault(): void
     {
         $purger = $this->factory->createForEntityManager(null, $this->em);
-        assert($purger instanceof ORMPurger);
 
-        self::assertInstanceOf(ORMPurger::class, $purger);
         self::assertSame(ORMPurger::PURGE_MODE_DELETE, $purger->getPurgeMode());
         self::assertSame([], (function () {
             return $this->excluded;
@@ -40,9 +36,7 @@ public function testCreateDefault(): void
     public function testCreateWithExclusions(): void
     {
         $purger = $this->factory->createForEntityManager(null, $this->em, ['tableName']);
-        assert($purger instanceof ORMPurger);
 
-        self::assertInstanceOf(ORMPurger::class, $purger);
         self::assertSame(ORMPurger::PURGE_MODE_DELETE, $purger->getPurgeMode());
         self::assertSame(['tableName'], (function () {
             return $this->excluded;
@@ -52,9 +46,7 @@ public function testCreateWithExclusions(): void
     public function testCreateWithTruncate(): void
     {
         $purger = $this->factory->createForEntityManager(null, $this->em, [], true);
-        assert($purger instanceof ORMPurger);
 
-        self::assertInstanceOf(ORMPurger::class, $purger);
         self::assertSame(ORMPurger::PURGE_MODE_TRUNCATE, $purger->getPurgeMode());
         self::assertSame([], (function () {
             return $this->excluded;