Merge pull request #968 from emodric/symfony_style

Use SymfonyStyle to output text in console
doctrine · Apr 29, 2020 · 9bd1bc3 · 9bd1bc3
2 parents 79ff97d + 362ca53
commit 9bd1bc3
Show file tree

Hide file tree

Showing 21 changed files with 143 additions and 194 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -13,6 +13,8 @@ cache:
 
 before_install:
   - mv ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/xdebug.ini{,.disabled} || echo "xdebug not available"
+  - stty cols 120
+  - export COLUMNS=120
 
 install:
   - rm composer.lock

diff --git a/lib/Doctrine/Migrations/Tools/Console/Command/CurrentCommand.php b/lib/Doctrine/Migrations/Tools/Console/Command/CurrentCommand.php
@@ -42,8 +42,8 @@ protected function execute(InputInterface $input, OutputInterface $output) : int
             }
         }
 
-        $output->writeln(sprintf(
-            '<info>%s</info>%s',
+        $this->io->text(sprintf(
+            "<info>%s</info>%s\n",
             (string) $version,
             $description !== '' ? ' - ' . $description : ''
         ));

diff --git a/lib/Doctrine/Migrations/Tools/Console/Command/DiffCommand.php b/lib/Doctrine/Migrations/Tools/Console/Command/DiffCommand.php
@@ -130,7 +130,7 @@ protected function execute(
         $newMigrations                 = $statusCalculator->getNewMigrations();
 
         if (! $this->checkNewMigrationsOrExecutedUnavailable($newMigrations, $executedUnavailableMigrations, $input, $output)) {
-            $output->writeln('<error>Migration cancelled!</error>');
+            $this->io->error('Migration cancelled!');
 
             return 3;
         }
@@ -149,15 +149,15 @@ protected function execute(
             );
         } catch (NoChangesDetected $exception) {
             if ($allowEmptyDiff) {
-                $output->writeln($exception->getMessage());
+                $this->io->error($exception->getMessage());
 
                 return 0;
             }
 
             throw $exception;
         }
 
-        $output->writeln([
+        $this->io->text([
             sprintf('Generated new migration class to "<info>%s</info>"', $path),
             '',
             sprintf(
@@ -169,6 +169,7 @@ protected function execute(
                 'To revert the migration you can use <info>migrations:execute --down \'%s\'</info>',
                 addslashes($fqcn)
             ),
+            '',
         ]);
 
         return 0;
@@ -185,19 +186,19 @@ private function checkNewMigrationsOrExecutedUnavailable(
         }
 
         if (count($newMigrations) !== 0) {
-            $output->writeln(sprintf(
-                '<error>WARNING! You have %d available migrations to execute.</error>',
+            $this->io->warning(sprintf(
+                'You have %d available migrations to execute.',
                 count($newMigrations)
             ));
         }
 
         if (count($executedUnavailableMigrations) !== 0) {
-            $output->writeln(sprintf(
-                '<error>WARNING! You have %d previously executed migrations in the database that are not registered migrations.</error>',
+            $this->io->warning(sprintf(
+                'You have %d previously executed migrations in the database that are not registered migrations.',
                 count($executedUnavailableMigrations)
             ));
         }
 
-        return $this->canExecute('Are you sure you wish to continue? (y/n)', $input, $output);
+        return $this->canExecute('Are you sure you wish to continue?', $input);
     }
 }
diff --git a/lib/Doctrine/Migrations/Tools/Console/Command/DoctrineCommand.php b/lib/Doctrine/Migrations/Tools/Console/Command/DoctrineCommand.php
@@ -14,7 +14,8 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
-use Symfony\Component\Console\Question\ConfirmationQuestion;
+use Symfony\Component\Console\Style\StyleInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
 use function is_string;
 
 /**
@@ -25,6 +26,9 @@ abstract class DoctrineCommand extends Command
     /** @var DependencyFactory|null */
     private $dependencyFactory;
 
+    /** @var StyleInterface */
+    protected $io;
+
     public function __construct(?DependencyFactory $dependencyFactory = null, ?string $name = null)
     {
         parent::__construct($name);
@@ -55,6 +59,8 @@ protected function configure() : void
 
     protected function initialize(InputInterface $input, OutputInterface $output) : void
     {
+        $this->io = new SymfonyStyle($input, $output);
+
         $configurationParameter = $input->getOption('configuration');
         if ($this->dependencyFactory === null) {
             $configurationLoader     = new ConfigurationFileWithFallback(
@@ -87,23 +93,8 @@ protected function getDependencyFactory() : DependencyFactory
         return $this->dependencyFactory;
     }
 
-    protected function askConfirmation(
-        string $question,
-        InputInterface $input,
-        OutputInterface $output
-    ) : bool {
-        return $this->getHelper('question')->ask(
-            $input,
-            $output,
-            new ConfirmationQuestion($question)
-        );
-    }
-
-    protected function canExecute(
-        string $question,
-        InputInterface $input,
-        OutputInterface $output
-    ) : bool {
-        return ! $input->isInteractive() || $this->askConfirmation($question, $input, $output);
+    protected function canExecute(string $question, InputInterface $input) : bool
+    {
+        return ! $input->isInteractive() || $this->io->confirm($question);
     }
 }
diff --git a/lib/Doctrine/Migrations/Tools/Console/Command/DumpSchemaCommand.php b/lib/Doctrine/Migrations/Tools/Console/Command/DumpSchemaCommand.php
@@ -111,7 +111,7 @@ public function execute(
             $lineLength
         );
 
-        $output->writeln([
+        $this->io->text([
             sprintf('Dumped your schema to a new migration class at "<info>%s</info>"', $path),
             '',
             sprintf(
@@ -125,6 +125,7 @@ public function execute(
             ),
             '',
             'To use this as a rollup migration you can use the <info>migrations:rollup</info> command.',
+            '',
         ]);
 
         return 0;

diff --git a/lib/Doctrine/Migrations/Tools/Console/Command/ExecuteCommand.php b/lib/Doctrine/Migrations/Tools/Console/Command/ExecuteCommand.php
@@ -123,7 +123,7 @@ protected function execute(InputInterface $input, OutputInterface $output) : int
             $path = is_string($path) ? $path : getcwd();
 
             if (! is_string($path) || ! is_writable($path)) {
-                $output->writeln('<error>Path not writeable!</error>');
+                $this->io->error('Path not writeable!');
 
                 return 1;
             }
@@ -134,10 +134,10 @@ protected function execute(InputInterface $input, OutputInterface $output) : int
             return 0;
         }
 
-        $question = 'WARNING! You are about to execute a database migration that could result in schema changes and data lost. Are you sure you wish to continue? (y/n)';
+        $question = 'WARNING! You are about to execute a database migration that could result in schema changes and data lost. Are you sure you wish to continue?';
 
-        if (! $migratorConfiguration->isDryRun() && ! $this->canExecute($question, $input, $output)) {
-            $output->writeln('<error>Migration cancelled!</error>');
+        if (! $migratorConfiguration->isDryRun() && ! $this->canExecute($question, $input)) {
+            $this->io->error('Migration cancelled!');
 
             return 1;
         }

diff --git a/lib/Doctrine/Migrations/Tools/Console/Command/GenerateCommand.php b/lib/Doctrine/Migrations/Tools/Console/Command/GenerateCommand.php
@@ -67,7 +67,7 @@ protected function execute(InputInterface $input, OutputInterface $output) : int
 
         $path = $migrationGenerator->generateMigration($fqcn);
 
-        $output->writeln([
+        $this->io->text([
             sprintf('Generated new migration class to "<info>%s</info>"', $path),
             '',
             sprintf(
@@ -79,6 +79,7 @@ protected function execute(InputInterface $input, OutputInterface $output) : int
                 'To revert the migration you can use <info>migrations:execute --down \'%s\'</info>',
                 $fqcn
             ),
+            '',
         ]);
 
         return 0;

diff --git a/lib/Doctrine/Migrations/Tools/Console/Command/LatestCommand.php b/lib/Doctrine/Migrations/Tools/Console/Command/LatestCommand.php
@@ -39,8 +39,8 @@ protected function execute(InputInterface $input, OutputInterface $output) : int
             $description = '';
         }
 
-        $output->writeln(sprintf(
-            '<info>%s</info>%s',
+        $this->io->text(sprintf(
+            "<info>%s</info>%s\n",
             $version,
             $description !== '' ? ' - ' . $description : ''
         ));

diff --git a/lib/Doctrine/Migrations/Tools/Console/Command/MigrateCommand.php b/lib/Doctrine/Migrations/Tools/Console/Command/MigrateCommand.php
@@ -123,7 +123,7 @@ protected function execute(InputInterface $input, OutputInterface $output) : int
         try {
             $version = $this->getDependencyFactory()->getVersionAliasResolver()->resolveVersionAlias($versionAlias);
         } catch (UnknownMigrationVersion|NoMigrationsFoundWithCriteria $e) {
-            $this->getVersionNameFromAlias($versionAlias, $output);
+            $this->getVersionNameFromAlias($versionAlias);
 
             return 1;
         }
@@ -132,7 +132,7 @@ protected function execute(InputInterface $input, OutputInterface $output) : int
         $statusCalculator              = $this->getDependencyFactory()->getMigrationStatusCalculator();
         $executedUnavailableMigrations = $statusCalculator->getExecutedUnavailableMigrations();
 
-        if ($this->checkExecutedUnavailableMigrations($executedUnavailableMigrations, $input, $output) === false) {
+        if ($this->checkExecutedUnavailableMigrations($executedUnavailableMigrations, $input) === false) {
             return 3;
         }
 
@@ -142,13 +142,13 @@ protected function execute(InputInterface $input, OutputInterface $output) : int
         $plan = $planCalculator->getPlanUntilVersion($version);
 
         if (count($plan) === 0 && ! $allowNoMigration) {
-            $output->writeln('Could not find any migrations to execute.');
+            $this->io->warning('Could not find any migrations to execute.');
 
             return 1;
         }
 
         if (count($plan) === 0) {
-            $this->getVersionNameFromAlias($versionAlias, $output);
+            $this->getVersionNameFromAlias($versionAlias);
 
             return 0;
         }
@@ -161,7 +161,7 @@ protected function execute(InputInterface $input, OutputInterface $output) : int
             $path = is_string($path) ? $path : getcwd();
 
             if (! is_string($path) || ! is_writable($path)) {
-                $output->writeln('<error>Path not writeable!</error>');
+                $this->io->error('Path not writeable!');
 
                 return 1;
             }
@@ -172,10 +172,10 @@ protected function execute(InputInterface $input, OutputInterface $output) : int
             return 0;
         }
 
-        $question = 'WARNING! You are about to execute a database migration that could result in schema changes and data loss. Are you sure you wish to continue? (y/n)';
+        $question = 'WARNING! You are about to execute a database migration that could result in schema changes and data loss. Are you sure you wish to continue?';
 
-        if (! $migratorConfiguration->isDryRun() && ! $this->canExecute($question, $input, $output)) {
-            $output->writeln('<error>Migration cancelled!</error>');
+        if (! $migratorConfiguration->isDryRun() && ! $this->canExecute($question, $input)) {
+            $this->io->error('Migration cancelled!');
 
             return 3;
         }
@@ -192,34 +192,35 @@ protected function execute(InputInterface $input, OutputInterface $output) : int
 
         $migrator->migrate($plan, $migratorConfiguration);
 
+        $this->io->newLine();
+
         return 0;
     }
 
     private function checkExecutedUnavailableMigrations(
         ExecutedMigrationsSet $executedUnavailableMigrations,
-        InputInterface $input,
-        OutputInterface $output
+        InputInterface $input
     ) : bool {
         if (count($executedUnavailableMigrations) !== 0) {
-            $output->writeln(sprintf(
-                '<error>WARNING! You have %s previously executed migrations in the database that are not registered migrations.</error>',
+            $this->io->warning(sprintf(
+                'You have %s previously executed migrations in the database that are not registered migrations.',
                 count($executedUnavailableMigrations)
             ));
 
             foreach ($executedUnavailableMigrations->getItems() as $executedUnavailableMigration) {
-                $output->writeln(sprintf(
-                    '    <comment>>></comment> %s (<comment>%s</comment>)',
+                $this->io->text(sprintf(
+                    '<comment>>></comment> %s (<comment>%s</comment>)',
                     $executedUnavailableMigration->getExecutedAt() !== null
                         ? $executedUnavailableMigration->getExecutedAt()->format('Y-m-d H:i:s')
                         : null,
                     $executedUnavailableMigration->getVersion()
                 ));
             }
 
-            $question = 'Are you sure you wish to continue? (y/n)';
+            $question = 'Are you sure you wish to continue?';
 
-            if (! $this->canExecute($question, $input, $output)) {
-                $output->writeln('<error>Migration cancelled!</error>');
+            if (! $this->canExecute($question, $input)) {
+                $this->io->error('Migration cancelled!');
 
                 return false;
             }
@@ -228,30 +229,28 @@ private function checkExecutedUnavailableMigrations(
         return true;
     }
 
-    private function getVersionNameFromAlias(
-        string $versionAlias,
-        OutputInterface $output
-    ) : void {
+    private function getVersionNameFromAlias(string $versionAlias) : void
+    {
         if ($versionAlias === 'first') {
-            $output->writeln('<error>Already at first version.</error>');
+            $this->io->error('Already at first version.');
 
             return;
         }
 
         if ($versionAlias === 'next' || $versionAlias === 'latest') {
-            $output->writeln('<error>Already at latest version.</error>');
+            $this->io->error('Already at latest version.');
 
             return;
         }
 
         if (substr($versionAlias, 0, 7) === 'current') {
-            $output->writeln('<error>The delta couldn\'t be reached.</error>');
+            $this->io->error('The delta couldn\'t be reached.');
 
             return;
         }
 
-        $output->writeln(sprintf(
-            '<error>Unknown version: %s</error>',
+        $this->io->error(sprintf(
+            'Unknown version: %s',
             OutputFormatter::escape($versionAlias)
         ));
     }

diff --git a/lib/Doctrine/Migrations/Tools/Console/Command/RollupCommand.php b/lib/Doctrine/Migrations/Tools/Console/Command/RollupCommand.php
@@ -37,19 +37,19 @@ protected function configure() : void
 
     protected function execute(InputInterface $input, OutputInterface $output) : int
     {
-        $question = 'WARNING! You are about to execute a database migration that could result in schema changes and data loss. Are you sure you wish to continue? (y/n)';
+        $question = 'WARNING! You are about to execute a database migration that could result in schema changes and data loss. Are you sure you wish to continue?';
 
-        if (! $this->canExecute($question, $input, $output)) {
-            $output->writeln('<error>Migration cancelled!</error>');
+        if (! $this->canExecute($question, $input)) {
+            $this->io->error('Migration cancelled!');
 
             return 3;
         }
 
         $this->getDependencyFactory()->getMetadataStorage()->ensureInitialized();
         $version = $this->getDependencyFactory()->getRollup()->rollup();
 
-        $output->writeln(sprintf(
-            'Rolled up migrations to version <info>%s</info>',
+        $this->io->success(sprintf(
+            'Rolled up migrations to version %s',
             (string) $version
         ));
 

diff --git a/lib/Doctrine/Migrations/Tools/Console/Command/SyncMetadataCommand.php b/lib/Doctrine/Migrations/Tools/Console/Command/SyncMetadataCommand.php
@@ -33,7 +33,7 @@ public function execute(
     ) : int {
         $this->getDependencyFactory()->getMetadataStorage()->ensureInitialized();
 
-        $output->writeln('Metadata storage synchronized');
+        $this->io->success('Metadata storage synchronized');
 
         return 0;
     }