Remove migration table from generated comparison schema

lib/Doctrine/Migrations/Event/Listeners/RemoveMigrationTableFromSchemaListener.php

@@ -0,0 +1,60 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Migrations\Event\Listeners;
+
+use Doctrine\Common\EventSubscriber;
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\Configuration\Configuration;
+use Doctrine\Migrations\DependencyFactory;
+use Doctrine\Migrations\Metadata\Storage\TableMetadataStorageConfiguration;
+use Doctrine\ORM\Tools\Event\GenerateSchemaEventArgs;
+use Doctrine\ORM\Tools\ToolEvents;
+
+class RemoveMigrationTableFromSchemaListener implements EventSubscriber
+{
+    private Configuration $configuration;
+
+    public function __construct(
+        DependencyFactory $dependencyFactory,
+    ) {
+        $this->configuration = $dependencyFactory->getConfiguration();
+    }
+
+    /** {@inheritDoc} */
+    public function getSubscribedEvents()
+    {
+        return [
+            ToolEvents::postGenerateSchema,
+            ToolEvents::postGenerateComparisonSchema,
+        ];
+    }
+
+    public function postGenerateSchema(GenerateSchemaEventArgs $args): void
+    {
+        $this->removeMigrationsTableFromSchema($args->getSchema());
+    }
+
+    public function postGenerateComparisonSchema(GenerateSchemaEventArgs $args): void
+    {
+        $this->removeMigrationsTableFromSchema($args->getSchema());
+    }
+
+    private function removeMigrationsTableFromSchema(Schema $schema): void
+    {
+        $metadataConfiguration = $this->configuration->getMetadataStorageConfiguration();
+
+        if (! ($metadataConfiguration instanceof TableMetadataStorageConfiguration)) {
+            return;
+        }
+
+        $tableName = $metadataConfiguration->getTableName();
+
+        if (! $schema->hasTable($tableName)) {
+            return;
+        }
+
+        $schema->dropTable($tableName);
+    }
+}

lib/Doctrine/Migrations/Version/SortedMigrationPlanCalculator.php

@@ -45,7 +45,7 @@ public function getPlanForVersions(array $versions, string $direction): Migratio
         $availableMigrations = array_filter(
             $migrationsToCheck,
             // in_array third parameter is intentionally false to force object to string casting
-            static fn (AvailableMigration $availableMigration): bool => in_array($availableMigration->getVersion(), $versions, false)
+            static fn (AvailableMigration $availableMigration): bool => in_array($availableMigration->getVersion(), $versions, false),
         );
 
         $planItems = array_map(static fn (AvailableMigration $availableMigration): MigrationPlan => new MigrationPlan($availableMigration->getVersion(), $availableMigration->getMigration(), $direction), $availableMigrations);

tests/Doctrine/Migrations/Tests/Event/Listeners/RemoveMigrationTableFromSchemaListenerTest.php

@@ -0,0 +1,76 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Migrations\Tests\Event\Listeners;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\Configuration\Configuration;
+use Doctrine\Migrations\Configuration\EntityManager\ExistingEntityManager;
+use Doctrine\Migrations\Configuration\Migration\ExistingConfiguration;
+use Doctrine\Migrations\DependencyFactory;
+use Doctrine\Migrations\Event\Listeners\RemoveMigrationTableFromSchemaListener;
+use Doctrine\Migrations\Metadata\Storage\TableMetadataStorageConfiguration;
+use Doctrine\Migrations\Tests\MigrationTestCase;
+use Doctrine\ORM\EntityManager;
+use Doctrine\ORM\EntityManagerInterface;
+use Doctrine\ORM\Tools\Event\GenerateSchemaEventArgs;
+
+class RemoveMigrationTableFromSchemaListenerTest extends MigrationTestCase
+{
+    private RemoveMigrationTableFromSchemaListener $listener;
+    private Configuration $configuration;
+    private EntityManagerInterface $entityManager;
+
+    public function testListenerRemovesMigrationSchema(): void
+    {
+        $metadataConfiguration = new TableMetadataStorageConfiguration();
+        $tableName             = $metadataConfiguration->getTableName();
+        $this->configuration->setMetadataStorageConfiguration($metadataConfiguration);
+
+        $schema = new Schema();
+        $schema->createTable($tableName);
+
+        static::assertTrue($schema->hasTable($tableName));
+
+        $this->listener->postGenerateSchema(new GenerateSchemaEventArgs($this->entityManager, $schema));
+
+        static::assertFalse($schema->hasTable($tableName));
+    }
+
+    public function testListenerIgnoresMissingTable(): void
+    {
+        $metadataConfiguration = new TableMetadataStorageConfiguration();
+        $tableName             = $metadataConfiguration->getTableName();
+        $this->configuration->setMetadataStorageConfiguration($metadataConfiguration);
+
+        $schema = new Schema();
+
+        static::assertFalse($schema->hasTable($tableName));
+
+        $this->listener->postGenerateSchema(new GenerateSchemaEventArgs($this->entityManager, $schema));
+
+        static::assertFalse($schema->hasTable($tableName));
+    }
+
+    public function testListenerIgnoresMissingConfiguration(): void
+    {
+        static::expectNotToPerformAssertions();
+
+        $this->listener->postGenerateSchema(new GenerateSchemaEventArgs($this->entityManager, new Schema()));
+    }
+
+    protected function setUp(): void
+    {
+        $this->entityManager = $this->createMock(EntityManager::class);
+
+        $this->configuration = new Configuration();
+
+        $dependencyFactory = DependencyFactory::fromEntityManager(
+            new ExistingConfiguration($this->configuration),
+            new ExistingEntityManager($this->entityManager),
+        );
+
+        $this->listener = new RemoveMigrationTableFromSchemaListener($dependencyFactory);
+    }
+}