Split migration planner and extract relative interfaces

lib/Doctrine/Migrations/DependencyFactory.php

@@ -30,10 +30,14 @@
 use Doctrine\Migrations\Tools\Console\Helper\MigrationStatusInfosHelper;
 use Doctrine\Migrations\Tools\Console\MigratorConfigurationFactory;
 use Doctrine\Migrations\Version\AliasResolver;
+use Doctrine\Migrations\Version\CurrentMigrationStatusCalculator;
 use Doctrine\Migrations\Version\DbalExecutor;
 use Doctrine\Migrations\Version\DefaultAliasResolver;
 use Doctrine\Migrations\Version\Executor;
 use Doctrine\Migrations\Version\MigrationFactory;
+use Doctrine\Migrations\Version\MigrationPlanCalculator;
+use Doctrine\Migrations\Version\MigrationStatusCalculator;
+use Doctrine\Migrations\Version\SortedMigrationPlanCalculator;
 use Doctrine\ORM\EntityManagerInterface;
 use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
@@ -285,15 +289,25 @@ public function getVersionAliasResolver() : AliasResolver
             return new DefaultAliasResolver(
                 $this->getMigrationRepository(),
                 $this->getMetadataStorage(),
-                $this->getMigrationPlanCalculator()
+                $this->getMigrationStatusCalculator()
+            );
+        });
+    }
+
+    public function getMigrationStatusCalculator() : MigrationStatusCalculator
+    {
+        return $this->getDependency(MigrationStatusCalculator::class, function () : MigrationStatusCalculator {
+            return new CurrentMigrationStatusCalculator(
+                $this->getMigrationRepository(),
+                $this->getMetadataStorage()
             );
         });
     }
 
     public function getMigrationPlanCalculator() : MigrationPlanCalculator
     {
         return $this->getDependency(MigrationPlanCalculator::class, function () : MigrationPlanCalculator {
-            return new MigrationPlanCalculator(
+            return new SortedMigrationPlanCalculator(
                 $this->getMigrationRepository(),
                 $this->getMetadataStorage()
             );

lib/Doctrine/Migrations/Tools/Console/Command/MigrateCommand.php

@@ -130,7 +130,8 @@ public function execute(InputInterface $input, OutputInterface $output) : ?int
         }
 
         $planCalculator                = $this->getDependencyFactory()->getMigrationPlanCalculator();
-        $executedUnavailableMigrations = $planCalculator->getExecutedUnavailableMigrations();
+        $statusCalculator              = $this->getDependencyFactory()->getMigrationStatusCalculator();
+        $executedUnavailableMigrations = $statusCalculator->getExecutedUnavailableMigrations();
 
         if ($this->checkExecutedUnavailableMigrations($executedUnavailableMigrations, $input, $output) === false) {
             return 3;

lib/Doctrine/Migrations/Tools/Console/Command/StatusCommand.php

@@ -50,15 +50,15 @@ protected function configure() : void
 
     public function execute(InputInterface $input, OutputInterface $output) : ?int
     {
-        $storage        = $this->getDependencyFactory()->getMetadataStorage();
-        $migrationRepo  = $this->getDependencyFactory()->getMigrationRepository();
-        $planCalculator = $this->getDependencyFactory()->getMigrationPlanCalculator();
+        $storage       = $this->getDependencyFactory()->getMetadataStorage();
+        $migrationRepo = $this->getDependencyFactory()->getMigrationRepository();
 
         $availableMigrations = $migrationRepo->getMigrations();
         $executedMigrations  = $storage->getExecutedMigrations();
 
-        $newMigrations                 = $planCalculator->getNewMigrations();
-        $executedUnavailableMigrations = $planCalculator->getExecutedUnavailableMigrations();
+        $statusCalculator              = $this->getDependencyFactory()->getMigrationStatusCalculator();
+        $newMigrations                 = $statusCalculator->getNewMigrations();
+        $executedUnavailableMigrations = $statusCalculator->getExecutedUnavailableMigrations();
 
         $infosHelper = $this->getDependencyFactory()->getMigrationStatusInfosHelper();
         $infosHelper->showMigrationsInfo($output, $availableMigrations, $executedMigrations, $newMigrations, $executedUnavailableMigrations);

lib/Doctrine/Migrations/Tools/Console/Command/UpToDateCommand.php

@@ -37,9 +37,11 @@ protected function configure() : void
 
     public function execute(InputInterface $input, OutputInterface $output) : ?int
     {
-        $planCalculator                = $this->getDependencyFactory()->getMigrationPlanCalculator();
-        $executedUnavailableMigrations = $planCalculator->getExecutedUnavailableMigrations();
-        $newMigrations                 = $planCalculator->getNewMigrations();
+        $statusCalculator = $this->getDependencyFactory()->getMigrationStatusCalculator();
+
+        $executedUnavailableMigrations = $statusCalculator->getExecutedUnavailableMigrations();
+
+        $newMigrations = $statusCalculator->getNewMigrations();
 
         $newMigrationsCount                 = count($newMigrations);
         $executedUnavailableMigrationsCount =  count($executedUnavailableMigrations);

lib/Doctrine/Migrations/Version/CurrentMigrationStatusCalculator.php

@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Migrations\Version;
+
+use Doctrine\Migrations\Metadata\AvailableMigration;
+use Doctrine\Migrations\Metadata\AvailableMigrationsList;
+use Doctrine\Migrations\Metadata\ExecutedMigration;
+use Doctrine\Migrations\Metadata\ExecutedMigrationsSet;
+use Doctrine\Migrations\Metadata\Storage\MetadataStorage;
+use Doctrine\Migrations\MigrationRepository;
+use function array_filter;
+
+/**
+ * The MigrationPlanCalculator is responsible for calculating the plan for migrating from the current
+ * version to another version.
+ */
+final class CurrentMigrationStatusCalculator implements MigrationStatusCalculator
+{
+    /** @var MigrationRepository */
+    private $migrationRepository;
+
+    /** @var MetadataStorage */
+    private $metadataStorage;
+
+    public function __construct(MigrationRepository $migrationRepository, MetadataStorage $metadataStorage)
+    {
+        $this->migrationRepository = $migrationRepository;
+        $this->metadataStorage     = $metadataStorage;
+    }
+
+    public function getExecutedUnavailableMigrations() : ExecutedMigrationsSet
+    {
+        $executedMigrationsSet  = $this->metadataStorage->getExecutedMigrations();
+        $availableMigrationsSet = $this->migrationRepository->getMigrations();
+
+        return new ExecutedMigrationsSet(array_filter($executedMigrationsSet->getItems(), static function (ExecutedMigration $migrationInfo) use ($availableMigrationsSet) : bool {
+            return ! $availableMigrationsSet->hasMigration($migrationInfo->getVersion());
+        }));
+    }
+
+    public function getNewMigrations() : AvailableMigrationsList
+    {
+        $executedMigrationsSet  = $this->metadataStorage->getExecutedMigrations();
+        $availableMigrationsSet = $this->migrationRepository->getMigrations();
+
+        return new AvailableMigrationsList(array_filter($availableMigrationsSet->getItems(), static function (AvailableMigration $migrationInfo) use ($executedMigrationsSet) : bool {
+            return ! $executedMigrationsSet->hasMigration($migrationInfo->getVersion());
+        }));
+    }
+}

lib/Doctrine/Migrations/Version/DefaultAliasResolver.php

@@ -8,7 +8,6 @@
 use Doctrine\Migrations\Exception\NoMigrationsToExecute;
 use Doctrine\Migrations\Exception\UnknownMigrationVersion;
 use Doctrine\Migrations\Metadata\Storage\MetadataStorage;
-use Doctrine\Migrations\MigrationPlanCalculator;
 use Doctrine\Migrations\MigrationRepository;
 use function count;
 use function substr;
@@ -32,14 +31,17 @@ final class DefaultAliasResolver implements AliasResolver
     /** @var MetadataStorage */
     private $metadataStorage;
 
-    /** @var MigrationPlanCalculator */
-    private $migrationPlanCalculator;
-
-    public function __construct(MigrationRepository $migrationRepository, MetadataStorage $metadataStorage, MigrationPlanCalculator $migrationPlanCalculator)
-    {
-        $this->migrationRepository     = $migrationRepository;
-        $this->metadataStorage         = $metadataStorage;
-        $this->migrationPlanCalculator = $migrationPlanCalculator;
+    /** @var MigrationStatusCalculator */
+    private $migrationStatusCalculator;
+
+    public function __construct(
+        MigrationRepository $migrationRepository,
+        MetadataStorage $metadataStorage,
+        MigrationStatusCalculator $migrationStatusCalculator
+    ) {
+        $this->migrationRepository       = $migrationRepository;
+        $this->metadataStorage           = $metadataStorage;
+        $this->migrationStatusCalculator = $migrationStatusCalculator;
     }
 
     /**
@@ -82,7 +84,7 @@ public function resolveVersionAlias(string $alias) : Version
                 }
                 break;
             case self::ALIAS_NEXT:
-                $newMigrations = $this->migrationPlanCalculator->getNewMigrations();
+                $newMigrations = $this->migrationStatusCalculator->getNewMigrations();
 
                 try {
                     return $newMigrations->getFirst()->getVersion();
@@ -106,7 +108,7 @@ public function resolveVersionAlias(string $alias) : Version
                     $val             = (int) substr($alias, 7);
                     $targetMigration = null;
                     if ($val > 0) {
-                        $newMigrations = $this->migrationPlanCalculator->getNewMigrations();
+                        $newMigrations = $this->migrationStatusCalculator->getNewMigrations();
 
                         return $newMigrations->getFirst($val - 1)->getVersion();
                     }

lib/Doctrine/Migrations/Version/MigrationPlanCalculator.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Migrations\Version;
+
+use Doctrine\Migrations\Metadata\MigrationPlanList;
+
+/**
+ * The MigrationPlanCalculator is responsible for calculating the plan for migrating from the current
+ * version to another version.
+ */
+interface MigrationPlanCalculator
+{
+    public function getPlanForExactVersion(Version $version, string $direction) : MigrationPlanList;
+
+    public function getPlanUntilVersion(?Version $to = null) : MigrationPlanList;
+}

lib/Doctrine/Migrations/Version/MigrationStatusCalculator.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Migrations\Version;
+
+use Doctrine\Migrations\Metadata\AvailableMigrationsList;
+use Doctrine\Migrations\Metadata\ExecutedMigrationsSet;
+
+/**
+ * The MigrationStatusCalculator is responsible for calculating the current status of
+ * migrated and not available versions.
+ */
+interface MigrationStatusCalculator
+{
+    public function getExecutedUnavailableMigrations() : ExecutedMigrationsSet;
+
+    public function getNewMigrations() : AvailableMigrationsList;
+}

lib/Doctrine/Migrations/MigrationPlanCalculator.php → lib/Doctrine/Migrations/Version/SortedMigrationPlanCalculator.php

@@ -2,20 +2,16 @@
 
 declare(strict_types=1);
 
-namespace Doctrine\Migrations;
+namespace Doctrine\Migrations\Version;
 
 use Doctrine\Migrations\Exception\NoMigrationsFoundWithCriteria;
 use Doctrine\Migrations\Exception\NoMigrationsToExecute;
+use Doctrine\Migrations\Metadata;
 use Doctrine\Migrations\Metadata\AvailableMigration;
-use Doctrine\Migrations\Metadata\AvailableMigrationsList;
-use Doctrine\Migrations\Metadata\ExecutedMigration;
-use Doctrine\Migrations\Metadata\ExecutedMigrationsSet;
 use Doctrine\Migrations\Metadata\MigrationPlan;
 use Doctrine\Migrations\Metadata\MigrationPlanList;
 use Doctrine\Migrations\Metadata\Storage\MetadataStorage;
-use Doctrine\Migrations\Version\Direction;
-use Doctrine\Migrations\Version\Version;
-use function array_filter;
+use Doctrine\Migrations\MigrationRepository;
 use function array_map;
 use function array_reverse;
 
@@ -25,7 +21,7 @@
  *
  * @internal
  */
-final class MigrationPlanCalculator
+final class SortedMigrationPlanCalculator implements MigrationPlanCalculator
 {
     /** @var MigrationRepository */
     private $migrationRepository;
@@ -113,24 +109,4 @@ private function findMigrationsToExecute(Version $to, array $migrationsToCheck,
 
         return $toExecute;
     }
-
-    public function getExecutedUnavailableMigrations() : ExecutedMigrationsSet
-    {
-        $executedMigrationsSet  = $this->metadataStorage->getExecutedMigrations();
-        $availableMigrationsSet = $this->migrationRepository->getMigrations();
-
-        return new ExecutedMigrationsSet(array_filter($executedMigrationsSet->getItems(), static function (ExecutedMigration $migrationInfo) use ($availableMigrationsSet) {
-            return ! $availableMigrationsSet->hasMigration($migrationInfo->getVersion());
-        }));
-    }
-
-    public function getNewMigrations() : AvailableMigrationsList
-    {
-        $executedMigrationsSet  = $this->metadataStorage->getExecutedMigrations();
-        $availableMigrationsSet = $this->migrationRepository->getMigrations();
-
-        return new AvailableMigrationsList(array_filter($availableMigrationsSet->getItems(), static function (AvailableMigration $migrationInfo) use ($executedMigrationsSet) {
-            return ! $executedMigrationsSet->hasMigration($migrationInfo->getVersion());
-        }));
-    }
 }

tests/Doctrine/Migrations/Tests/Tools/Console/Command/ExecuteCommandTest.php

@@ -11,12 +11,12 @@
 use Doctrine\Migrations\Metadata\MigrationPlanList;
 use Doctrine\Migrations\Metadata\Storage\MetadataStorage;
 use Doctrine\Migrations\Metadata\Storage\TableMetadataStorageConfiguration;
-use Doctrine\Migrations\MigrationPlanCalculator;
 use Doctrine\Migrations\MigrationRepository;
 use Doctrine\Migrations\Migrator;
 use Doctrine\Migrations\MigratorConfiguration;
 use Doctrine\Migrations\QueryWriter;
 use Doctrine\Migrations\Tools\Console\Command\ExecuteCommand;
+use Doctrine\Migrations\Version\SortedMigrationPlanCalculator;
 use Doctrine\Migrations\Version\Version;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
@@ -149,7 +149,7 @@ protected function setUp() : void
             ->method('getMigration')
             ->willReturn($m1);
 
-        $planCalculator = new MigrationPlanCalculator($migrationRepository, $storage);
+        $planCalculator = new SortedMigrationPlanCalculator($migrationRepository, $storage);
 
         $configuration = new Configuration();
         $configuration->setMetadataStorageConfiguration(new TableMetadataStorageConfiguration());

tests/Doctrine/Migrations/Tests/Version/AliasResolverTest.php

@@ -13,12 +13,13 @@
 use Doctrine\Migrations\Finder\RecursiveRegexFinder;
 use Doctrine\Migrations\Metadata\Storage\TableMetadataStorage;
 use Doctrine\Migrations\Metadata\Storage\TableMetadataStorageConfiguration;
-use Doctrine\Migrations\MigrationPlanCalculator;
 use Doctrine\Migrations\MigrationRepository;
+use Doctrine\Migrations\Version\CurrentMigrationStatusCalculator;
 use Doctrine\Migrations\Version\DefaultAliasResolver;
 use Doctrine\Migrations\Version\Direction;
 use Doctrine\Migrations\Version\ExecutionResult;
 use Doctrine\Migrations\Version\MigrationFactory;
+use Doctrine\Migrations\Version\MigrationStatusCalculator;
 use Doctrine\Migrations\Version\Version;
 use PHPUnit\Framework\TestCase;
 use function sys_get_temp_dir;
@@ -34,8 +35,8 @@ final class AliasResolverTest extends TestCase
     /** @var TableMetadataStorage */
     private $metadataStorage;
 
-    /** @var MigrationPlanCalculator */
-    private $planCalculator;
+    /** @var MigrationStatusCalculator */
+    private $statusCalculator;
 
     /**
      * @dataProvider getAliases
@@ -137,11 +138,11 @@ protected function setUp() : void
             $versionFactory
         );
         $this->metadataStorage      = new TableMetadataStorage($conn);
-        $this->planCalculator       = new MigrationPlanCalculator($this->migrationRepository, $this->metadataStorage);
+        $this->statusCalculator     = new CurrentMigrationStatusCalculator($this->migrationRepository, $this->metadataStorage);
         $this->versionAliasResolver = new DefaultAliasResolver(
             $this->migrationRepository,
             $this->metadataStorage,
-            $this->planCalculator
+            $this->statusCalculator
         );
     }