Moved migration sorting from MigrationRepository to MigrationPlanCalculator

lib/Doctrine/Migrations/DependencyFactory.php

@@ -299,8 +299,7 @@ public function getMigrationRepository() : MigrationsRepository
                 $this->getConfiguration()->getMigrationClasses(),
                 $this->getConfiguration()->getMigrationDirectories(),
                 $this->getMigrationsFinder(),
-                $this->getMigrationFactory(),
-                $this->getVersionComparator()
+                $this->getMigrationFactory()
             );
         });
     }
@@ -362,7 +361,7 @@ public function getVersionAliasResolver() : AliasResolver
     {
         return $this->getDependency(AliasResolver::class, function () : AliasResolver {
             return new DefaultAliasResolver(
-                $this->getMigrationRepository(),
+                $this->getMigrationPlanCalculator(),
                 $this->getMetadataStorage(),
                 $this->getMigrationStatusCalculator()
             );
@@ -373,7 +372,7 @@ public function getMigrationStatusCalculator() : MigrationStatusCalculator
     {
         return $this->getDependency(MigrationStatusCalculator::class, function () : MigrationStatusCalculator {
             return new CurrentMigrationStatusCalculator(
-                $this->getMigrationRepository(),
+                $this->getMigrationPlanCalculator(),
                 $this->getMetadataStorage()
             );
         });
@@ -384,7 +383,8 @@ public function getMigrationPlanCalculator() : MigrationPlanCalculator
         return $this->getDependency(MigrationPlanCalculator::class, function () : MigrationPlanCalculator {
             return new SortedMigrationPlanCalculator(
                 $this->getMigrationRepository(),
-                $this->getMetadataStorage()
+                $this->getMetadataStorage(),
+                $this->getVersionComparator()
             );
         });
     }
@@ -422,7 +422,7 @@ public function getMigrationStatusInfosHelper() : MigrationStatusInfosHelper
                 $this->getConfiguration(),
                 $this->getConnection(),
                 $this->getVersionAliasResolver(),
-                $this->getMigrationRepository(),
+                $this->getMigrationPlanCalculator(),
                 $this->getMigrationStatusCalculator(),
                 $this->getMetadataStorage()
             );

lib/Doctrine/Migrations/FilesystemMigrationsRepository.php

@@ -9,15 +9,13 @@
 use Doctrine\Migrations\Exception\MigrationException;
 use Doctrine\Migrations\Finder\MigrationFinder;
 use Doctrine\Migrations\Metadata\AvailableMigration;
-use Doctrine\Migrations\Metadata\AvailableMigrationsList;
-use Doctrine\Migrations\Version\Comparator;
+use Doctrine\Migrations\Metadata\AvailableMigrationsSet;
 use Doctrine\Migrations\Version\MigrationFactory;
 use Doctrine\Migrations\Version\Version;
 use function class_exists;
-use function uasort;
 
 /**
- * The MigrationRepository class is responsible for retrieving migrations, determining what the current migration
+ * The FilesystemMigrationsRepository class is responsible for retrieving migrations, determining what the current migration
  * version, etc.
  *
  * @internal
@@ -39,24 +37,19 @@ class FilesystemMigrationsRepository implements MigrationsRepository
     /** @var AvailableMigration[] */
     private $migrations = [];
 
-    /** @var Comparator */
-    private $sorter;
-
     /**
-     * @param array<string, string> $migrationDirectories
      * @param string[]              $classes
+     * @param array<string, string> $migrationDirectories
      */
     public function __construct(
         array $classes,
         array $migrationDirectories,
         MigrationFinder $migrationFinder,
-        MigrationFactory $versionFactory,
-        Comparator $sorter
+        MigrationFactory $versionFactory
     ) {
         $this->migrationDirectories = $migrationDirectories;
         $this->migrationFinder      = $migrationFinder;
         $this->versionFactory       = $versionFactory;
-        $this->sorter               = $sorter;
 
         $this->registerMigrations($classes);
     }
@@ -120,11 +113,14 @@ public function getMigration(Version $version) : AvailableMigration
         return $this->migrations[(string) $version];
     }
 
-    public function getMigrations() : AvailableMigrationsList
+    /**
+     * Returns a non-sorted set of migrations.
+     */
+    public function getMigrations() : AvailableMigrationsSet
     {
         $this->loadMigrationsFromDirectories();
 
-        return new AvailableMigrationsList($this->migrations);
+        return new AvailableMigrationsSet($this->migrations);
     }
 
     /** @throws MigrationException */
@@ -152,9 +148,5 @@ private function loadMigrationsFromDirectories() : void
                 );
                 $this->registerMigrations($migrations);
         }
-
-        uasort($this->migrations, function (AvailableMigration $a, AvailableMigration $b) : int {
-            return $this->sorter->compare($a->getVersion(), $b->getVersion());
-        });
     }
 }

lib/Doctrine/Migrations/Metadata/AvailableMigration.php

@@ -7,6 +7,10 @@
 use Doctrine\Migrations\AbstractMigration;
 use Doctrine\Migrations\Version\Version;
 
+/**
+ * Available migrations may or may not be already executed
+ * The migration might be already executed or not.
+ */
 final class AvailableMigration
 {
     /** @var Version */

lib/Doctrine/Migrations/Metadata/AvailableMigrationsList.php

@@ -11,6 +11,9 @@
 use function array_values;
 use function count;
 
+/**
+ * Represents a sorted list of migrations that may or maybe not be already executed.
+ */
 final class AvailableMigrationsList implements Countable
 {
     /** @var AvailableMigration[] */

lib/Doctrine/Migrations/Metadata/AvailableMigrationsSet.php

@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Migrations\Metadata;
+
+use Countable;
+use Doctrine\Migrations\Exception\MigrationNotAvailable;
+use Doctrine\Migrations\Version\Version;
+use function array_values;
+use function count;
+
+/**
+ * Represents a non sorted list of migrations that may or may not be already executed.
+ */
+final class AvailableMigrationsSet implements Countable
+{
+    /** @var AvailableMigration[] */
+    private $items = [];
+
+    /**
+     * @param AvailableMigration[] $items
+     */
+    public function __construct(array $items)
+    {
+        $this->items = array_values($items);
+    }
+
+    /**
+     * @return AvailableMigration[]
+     */
+    public function getItems() : array
+    {
+        return $this->items;
+    }
+
+    public function count() : int
+    {
+        return count($this->items);
+    }
+
+    public function hasMigration(Version $version) : bool
+    {
+        foreach ($this->items as $migration) {
+            if ($migration->getVersion()->equals($version)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    public function getMigration(Version $version) : AvailableMigration
+    {
+        foreach ($this->items as $migration) {
+            if ($migration->getVersion()->equals($version)) {
+                return $migration;
+            }
+        }
+
+        throw MigrationNotAvailable::forVersion($version);
+    }
+}

lib/Doctrine/Migrations/Metadata/ExecutedMigration.php

@@ -7,6 +7,10 @@
 use DateTimeImmutable;
 use Doctrine\Migrations\Version\Version;
 
+/**
+ * Represents an already executed migration.
+ * The migration might be not available anymore.
+ */
 final class ExecutedMigration
 {
     /** @var Version */

lib/Doctrine/Migrations/Metadata/ExecutedMigrationsList.php

@@ -11,6 +11,10 @@
 use function array_values;
 use function count;
 
+/**
+ * Represents a sorted list of executed migrations.
+ * The migrations in this set might be not available anymore.
+ */
 final class ExecutedMigrationsList implements Countable
 {
     /** @var ExecutedMigration[] */

lib/Doctrine/Migrations/Metadata/MigrationPlan.php

@@ -9,6 +9,9 @@
 use Doctrine\Migrations\Version\ExecutionResult;
 use Doctrine\Migrations\Version\Version;
 
+/**
+ * Represents an available migration to be executed in a specific direction.
+ */
 final class MigrationPlan
 {
     /** @var string */
@@ -17,7 +20,6 @@ final class MigrationPlan
     private $version;
     /** @var AbstractMigration */
     private $migration;
-
     /** @var ExecutionResult */
     public $result;
 

lib/Doctrine/Migrations/Metadata/MigrationPlanList.php

@@ -10,6 +10,9 @@
 use function end;
 use function reset;
 
+/**
+ * Represents a sorted list of MigrationPlan instances to execute.
+ */
 final class MigrationPlanList implements Countable
 {
     /** @var string */

lib/Doctrine/Migrations/MigrationsRepository.php

@@ -5,7 +5,7 @@
 namespace Doctrine\Migrations;
 
 use Doctrine\Migrations\Metadata\AvailableMigration;
-use Doctrine\Migrations\Metadata\AvailableMigrationsList;
+use Doctrine\Migrations\Metadata\AvailableMigrationsSet;
 use Doctrine\Migrations\Version\Version;
 
 interface MigrationsRepository
@@ -14,5 +14,5 @@ public function hasMigration(string $version) : bool;
 
     public function getMigration(Version $version) : AvailableMigration;
 
-    public function getMigrations() : AvailableMigrationsList;
+    public function getMigrations() : AvailableMigrationsSet;
 }

lib/Doctrine/Migrations/Rollup.php

@@ -49,7 +49,7 @@ public function rollup() : Version
 
         $this->metadataStorage->reset();
 
-        $result = new ExecutionResult($versions->getFirst()->getVersion());
+        $result = new ExecutionResult($versions->getItems()[0]->getVersion());
         $this->metadataStorage->complete($result);
 
         return $result->getVersion();

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

@@ -42,7 +42,7 @@ protected function configure() : void
     protected function execute(InputInterface $input, OutputInterface $output) : int
     {
         $versions = $this->getSortedVersions(
-            $this->getDependencyFactory()->getMigrationRepository()->getMigrations(), // available migrations
+            $this->getDependencyFactory()->getMigrationPlanCalculator()->getMigrations(), // available migrations
             $this->getDependencyFactory()->getMetadataStorage()->getExecutedMigrations() // executed migrations
         );
 

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

@@ -150,7 +150,7 @@ private function markVersions(InputInterface $input, OutputInterface $output) :
         }
 
         $executedMigrations = $this->getDependencyFactory()->getMetadataStorage()->getExecutedMigrations();
-        $availableVersions  = $this->getDependencyFactory()->getMigrationRepository()->getMigrations();
+        $availableVersions  = $this->getDependencyFactory()->getMigrationPlanCalculator()->getMigrations();
         if ($allOption === true) {
             if ($input->getOption('delete') === true) {
                 foreach ($executedMigrations->getItems() as $availableMigration) {

lib/Doctrine/Migrations/Tools/Console/Helper/MigrationStatusInfosHelper.php

@@ -10,8 +10,8 @@
 use Doctrine\Migrations\Metadata\ExecutedMigrationsList;
 use Doctrine\Migrations\Metadata\Storage\MetadataStorage;
 use Doctrine\Migrations\Metadata\Storage\TableMetadataStorageConfiguration;
-use Doctrine\Migrations\MigrationsRepository;
 use Doctrine\Migrations\Version\AliasResolver;
+use Doctrine\Migrations\Version\MigrationPlanCalculator;
 use Doctrine\Migrations\Version\MigrationStatusCalculator;
 use Doctrine\Migrations\Version\Version;
 use Symfony\Component\Console\Helper\Table;
@@ -46,8 +46,8 @@ class MigrationStatusInfosHelper
     /** @var MetadataStorage */
     private $metadataStorage;
 
-    /** @var MigrationsRepository */
-    private $migrationRepository;
+    /** @var MigrationPlanCalculator */
+    private $migrationPlanCalculator;
 
     /** @var MigrationStatusCalculator */
     private $statusCalculator;
@@ -56,16 +56,16 @@ public function __construct(
         Configuration $configuration,
         Connection $connection,
         AliasResolver $aliasResolver,
-        MigrationsRepository $migrationRepository,
+        MigrationPlanCalculator $migrationPlanCalculator,
         MigrationStatusCalculator $statusCalculator,
         MetadataStorage $metadataStorage
     ) {
-        $this->configuration       = $configuration;
-        $this->connection          = $connection;
-        $this->aliasResolver       = $aliasResolver;
-        $this->migrationRepository = $migrationRepository;
-        $this->metadataStorage     = $metadataStorage;
-        $this->statusCalculator    = $statusCalculator;
+        $this->configuration           = $configuration;
+        $this->connection              = $connection;
+        $this->aliasResolver           = $aliasResolver;
+        $this->migrationPlanCalculator = $migrationPlanCalculator;
+        $this->metadataStorage         = $metadataStorage;
+        $this->statusCalculator        = $statusCalculator;
     }
 
     /**
@@ -81,7 +81,7 @@ public function listVersions(array $versions, OutputInterface $output) : void
             ]
         );
         $executedMigrations  = $this->metadataStorage->getExecutedMigrations();
-        $availableMigrations = $this->migrationRepository->getMigrations();
+        $availableMigrations = $this->migrationPlanCalculator->getMigrations();
 
         foreach ($versions as $version) {
             $description   = null;
@@ -123,7 +123,7 @@ public function listVersions(array $versions, OutputInterface $output) : void
     public function showMigrationsInfo(OutputInterface $output) : void
     {
         $executedMigrations  = $this->metadataStorage->getExecutedMigrations();
-        $availableMigrations = $this->migrationRepository->getMigrations();
+        $availableMigrations = $this->migrationPlanCalculator->getMigrations();
 
         $newMigrations                 = $this->statusCalculator->getNewMigrations();
         $executedUnavailableMigrations = $this->statusCalculator->getExecutedUnavailableMigrations();