Merge pull request #1414 from Myks92/feat-asked-namespace-when-more-one

Ask for a namespace of when more one path
doctrine · Apr 24, 2024 · 7780f8d · 7780f8d
2 parents 95d3937 + c7474af
commit 7780f8d
Show file tree

Hide file tree

Showing 8 changed files with 345 additions and 69 deletions.
diff --git a/src/Tools/Console/Command/DiffCommand.php b/src/Tools/Console/Command/DiffCommand.php
@@ -9,19 +9,15 @@
 use Doctrine\Migrations\Metadata\ExecutedMigrationsList;
 use Doctrine\Migrations\Tools\Console\Exception\InvalidOptionUsage;
 use Doctrine\SqlFormatter\SqlFormatter;
-use OutOfBoundsException;
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
 use function addslashes;
-use function assert;
 use function class_exists;
 use function count;
 use function filter_var;
-use function is_string;
-use function key;
 use function sprintf;
 
 use const FILTER_VALIDATE_BOOLEAN;
@@ -110,10 +106,6 @@ protected function execute(
         $allowEmptyDiff  = $input->getOption('allow-empty-diff');
         $checkDbPlatform = filter_var($input->getOption('check-database-platform'), FILTER_VALIDATE_BOOLEAN);
         $fromEmptySchema = $input->getOption('from-empty-schema');
-        $namespace       = $input->getOption('namespace');
-        if ($namespace === '') {
-            $namespace = null;
-        }
 
         if ($formatted) {
             if (! class_exists(SqlFormatter::class)) {
@@ -123,16 +115,7 @@ protected function execute(
             }
         }
 
-        $configuration = $this->getDependencyFactory()->getConfiguration();
-
-        $dirs = $configuration->getMigrationDirectories();
-        if ($namespace === null) {
-            $namespace = key($dirs);
-        } elseif (! isset($dirs[$namespace])) {
-            throw new OutOfBoundsException(sprintf('Path not defined for the namespace %s', $namespace));
-        }
-
-        assert(is_string($namespace));
+        $namespace = $this->getNamespace($input, $output);
 
         $statusCalculator              = $this->getDependencyFactory()->getMigrationStatusCalculator();
         $executedUnavailableMigrations = $statusCalculator->getExecutedUnavailableMigrations();

diff --git a/src/Tools/Console/Command/DoctrineCommand.php b/src/Tools/Console/Command/DoctrineCommand.php
@@ -10,16 +10,22 @@
 use Doctrine\Migrations\Tools\Console\ConsoleLogger;
 use Doctrine\Migrations\Tools\Console\Exception\DependenciesNotSatisfied;
 use Doctrine\Migrations\Tools\Console\Exception\InvalidOptionUsage;
+use Exception;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Question\ChoiceQuestion;
 use Symfony\Component\Console\Style\StyleInterface;
 use Symfony\Component\Console\Style\SymfonyStyle;
 
+use function array_keys;
 use function assert;
+use function count;
 use function is_string;
+use function key;
+use function sprintf;
 
 /**
  * The DoctrineCommand class provides base functionality for the other migrations commands to extend from.
@@ -138,4 +144,36 @@ private function setNamedEmOrConnection(InputInterface $input): void
             return;
         }
     }
+
+    final protected function getNamespace(InputInterface $input, OutputInterface $output): string
+    {
+        $configuration = $this->getDependencyFactory()->getConfiguration();
+
+        $namespace = $input->getOption('namespace');
+        if ($namespace === '') {
+            $namespace = null;
+        }
+
+        $dirs = $configuration->getMigrationDirectories();
+        if ($namespace === null && count($dirs) === 1) {
+            $namespace = key($dirs);
+        } elseif ($namespace === null && count($dirs) > 1) {
+            $helper    = $this->getHelper('question');
+            $question  = new ChoiceQuestion(
+                'Please choose a namespace (defaults to the first one)',
+                array_keys($dirs),
+                0,
+            );
+            $namespace = $helper->ask($input, $output, $question);
+            $this->io->text(sprintf('You have selected the "%s" namespace', $namespace));
+        }
+
+        if (! isset($dirs[$namespace])) {
+            throw new Exception(sprintf('Path not defined for the namespace "%s"', $namespace));
+        }
+
+        assert(is_string($namespace));
+
+        return $namespace;
+    }
 }
diff --git a/src/Tools/Console/Command/DumpSchemaCommand.php b/src/Tools/Console/Command/DumpSchemaCommand.php
@@ -13,10 +13,7 @@
 use Symfony\Component\Console\Output\OutputInterface;
 
 use function addslashes;
-use function assert;
 use function class_exists;
-use function is_string;
-use function key;
 use function sprintf;
 use function str_contains;
 
@@ -91,15 +88,7 @@ public function execute(
             }
         }
 
-        $configuration = $this->getDependencyFactory()->getConfiguration();
-
-        $namespace = $input->getOption('namespace');
-        if ($namespace === null) {
-            $dirs      = $configuration->getMigrationDirectories();
-            $namespace = key($dirs);
-        }
-
-        assert(is_string($namespace));
+        $namespace = $this->getNamespace($input, $output);
 
         $this->checkNoPreviousDumpExistsForNamespace($namespace);
 

diff --git a/src/Tools/Console/Command/GenerateCommand.php b/src/Tools/Console/Command/GenerateCommand.php
@@ -4,15 +4,11 @@
 
 namespace Doctrine\Migrations\Tools\Console\Command;
 
-use Exception;
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
-use function assert;
-use function is_string;
-use function key;
 use function sprintf;
 
 /**
@@ -47,23 +43,9 @@ protected function configure(): void
 
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
-        $configuration = $this->getDependencyFactory()->getConfiguration();
-
         $migrationGenerator = $this->getDependencyFactory()->getMigrationGenerator();
 
-        $namespace = $input->getOption('namespace');
-        if ($namespace === '') {
-            $namespace = null;
-        }
-
-        $dirs = $configuration->getMigrationDirectories();
-        if ($namespace === null) {
-            $namespace = key($dirs);
-        } elseif (! isset($dirs[$namespace])) {
-            throw new Exception(sprintf('Path not defined for the namespace %s', $namespace));
-        }
-
-        assert(is_string($namespace));
+        $namespace = $this->getNamespace($input, $output);
 
         $fqcn = $this->getDependencyFactory()->getClassNameGenerator()->generateClassName($namespace);
 

diff --git a/tests/Tools/Console/Command/DiffCommandTest.php b/tests/Tools/Console/Command/DiffCommandTest.php
@@ -18,10 +18,13 @@
 use Doctrine\Migrations\Version\Version;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\Console\Helper\HelperSet;
+use Symfony\Component\Console\Helper\QuestionHelper;
 use Symfony\Component\Console\Tester\CommandTester;
 
 use function array_map;
 use function explode;
+use function sprintf;
 use function sys_get_temp_dir;
 use function trim;
 
@@ -139,6 +142,44 @@ public function testExecutedUnavailableMigrationsCancel(): void
         self::assertSame(3, $statusCode);
     }
 
+    /** @return array<string, array{int|null, string}> */
+    public static function getSelectedNamespace(): array
+    {
+        return [
+            'no' => [null, 'FooNs'],
+            'first' => [0, 'FooNs'],
+            'two' => [1, 'FooNs2'],
+        ];
+    }
+
+    /** @dataProvider getSelectedNamespace */
+    public function testExecuteWithMultipleDirectories(int|null $input, string $namespace): void
+    {
+        $this->migrationStatusCalculator
+            ->method('getNewMigrations')
+            ->willReturn(new AvailableMigrationsList([]));
+
+        $this->migrationStatusCalculator
+            ->method('getExecutedUnavailableMigrations')
+            ->willReturn(new ExecutedMigrationsList([]));
+
+        $this->configuration->addMigrationsDirectory('FooNs2', sys_get_temp_dir());
+
+        $this->diffCommand->setHelperSet(new HelperSet(['question' => new QuestionHelper()]));
+
+        $this->migrationDiffGenerator->expects(self::once())->method('generate');
+
+        $this->diffCommandTester->setInputs([$input]);
+        $this->diffCommandTester->execute([]);
+
+        $output = $this->diffCommandTester->getDisplay(true);
+
+        self::assertStringContainsString('Please choose a namespace (defaults to the first one)', $output);
+        self::assertStringContainsString('[0] FooNs', $output);
+        self::assertStringContainsString('[1] FooNs2', $output);
+        self::assertStringContainsString(sprintf('You have selected the "%s" namespace', $namespace), $output);
+    }
+
     protected function setUp(): void
     {
         $this->migrationDiffGenerator    = $this->createMock(DiffGenerator::class);