minor #43628 [Console] Remove CompletionInterface (derrabus)

This PR was merged into the 5.4 branch. Discussion ---------- [Console] Remove `CompletionInterface` | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | #43620 (comment) | License | MIT | Doc PR | N/A Commits ------- cd49146 [Console] Remove CompletionInterface
symfony · Oct 21, 2021 · 540ee0a · 540ee0a
2 parents ec34dd5 + cd49146
commit 540ee0a
Show file tree

Hide file tree

Showing 11 changed files with 19 additions and 52 deletions.
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/SecretsRemoveCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/SecretsRemoveCommand.php
@@ -14,7 +14,6 @@
 use Symfony\Bundle\FrameworkBundle\Secrets\AbstractVault;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Completion\CompletionInput;
-use Symfony\Component\Console\Completion\CompletionInterface;
 use Symfony\Component\Console\Completion\CompletionSuggestions;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
@@ -29,7 +28,7 @@
  *
  * @internal
  */
-final class SecretsRemoveCommand extends Command implements CompletionInterface
+final class SecretsRemoveCommand extends Command
 {
     protected static $defaultName = 'secrets:remove';
     protected static $defaultDescription = 'Remove a secret from the vault';

diff --git a/src/Symfony/Component/Console/Application.php b/src/Symfony/Component/Console/Application.php
@@ -20,7 +20,6 @@
 use Symfony\Component\Console\Command\SignalableCommandInterface;
 use Symfony\Component\Console\CommandLoader\CommandLoaderInterface;
 use Symfony\Component\Console\Completion\CompletionInput;
-use Symfony\Component\Console\Completion\CompletionInterface;
 use Symfony\Component\Console\Completion\CompletionSuggestions;
 use Symfony\Component\Console\Event\ConsoleCommandEvent;
 use Symfony\Component\Console\Event\ConsoleErrorEvent;
@@ -69,7 +68,7 @@
  *
  * @author Fabien Potencier <fabien@symfony.com>
  */
-class Application implements ResetInterface, CompletionInterface
+class Application implements ResetInterface
 {
     private $commands = [];
     private $wantHelps = false;
@@ -356,7 +355,7 @@ public function getDefinition()
     }
 
     /**
-     * {@inheritdoc}
+     * Adds suggestions to $suggestions for the current completion input (e.g. option or argument).
      */
     public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void
     {

diff --git a/src/Symfony/Component/Console/Command/Command.php b/src/Symfony/Component/Console/Command/Command.php
@@ -13,6 +13,8 @@
 
 use Symfony\Component\Console\Application;
 use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Completion\CompletionInput;
+use Symfony\Component\Console\Completion\CompletionSuggestions;
 use Symfony\Component\Console\Exception\ExceptionInterface;
 use Symfony\Component\Console\Exception\InvalidArgumentException;
 use Symfony\Component\Console\Exception\LogicException;
@@ -303,6 +305,13 @@ public function run(InputInterface $input, OutputInterface $output)
         return is_numeric($statusCode) ? (int) $statusCode : 0;
     }
 
+    /**
+     * Adds suggestions to $suggestions for the current completion input (e.g. option or argument).
+     */
+    public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void
+    {
+    }
+
     /**
      * Sets the code to execute when running this command.
      *

diff --git a/src/Symfony/Component/Console/Command/CompleteCommand.php b/src/Symfony/Component/Console/Command/CompleteCommand.php
@@ -12,7 +12,6 @@
 namespace Symfony\Component\Console\Command;
 
 use Symfony\Component\Console\Completion\CompletionInput;
-use Symfony\Component\Console\Completion\CompletionInterface;
 use Symfony\Component\Console\Completion\CompletionSuggestions;
 use Symfony\Component\Console\Completion\Output\BashCompletionOutput;
 use Symfony\Component\Console\Exception\CommandNotFoundException;
@@ -107,7 +106,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                     $this->log('  Completing option names for the <comment>'.\get_class($command instanceof LazyCommand ? $command->getCommand() : $command).'</> command.');
 
                     $suggestions->suggestOptions($command->getDefinition()->getOptions());
-                } elseif ($command instanceof CompletionInterface) {
+                } else {
                     $this->log([
                         '  Completing using the <comment>'.\get_class($command).'</> class.',
                         '  Completing <comment>'.$completionInput->getCompletionType().'</> for <comment>'.$completionInput->getCompletionName().'</>',

diff --git a/src/Symfony/Component/Console/Command/DumpCompletionCommand.php b/src/Symfony/Component/Console/Command/DumpCompletionCommand.php
@@ -12,7 +12,6 @@
 namespace Symfony\Component\Console\Command;
 
 use Symfony\Component\Console\Completion\CompletionInput;
-use Symfony\Component\Console\Completion\CompletionInterface;
 use Symfony\Component\Console\Completion\CompletionSuggestions;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
@@ -26,7 +25,7 @@
  *
  * @author Wouter de Jong <wouter@wouterj.nl>
  */
-final class DumpCompletionCommand extends Command implements CompletionInterface
+final class DumpCompletionCommand extends Command
 {
     protected static $defaultName = 'completion';
     protected static $defaultDescription = 'Dump the shell completion script';

diff --git a/src/Symfony/Component/Console/Command/HelpCommand.php b/src/Symfony/Component/Console/Command/HelpCommand.php
@@ -12,7 +12,6 @@
 namespace Symfony\Component\Console\Command;
 
 use Symfony\Component\Console\Completion\CompletionInput;
-use Symfony\Component\Console\Completion\CompletionInterface;
 use Symfony\Component\Console\Completion\CompletionSuggestions;
 use Symfony\Component\Console\Descriptor\ApplicationDescription;
 use Symfony\Component\Console\Helper\DescriptorHelper;
@@ -26,7 +25,7 @@
  *
  * @author Fabien Potencier <fabien@symfony.com>
  */
-class HelpCommand extends Command implements CompletionInterface
+class HelpCommand extends Command
 {
     private $command;
 

diff --git a/src/Symfony/Component/Console/Command/LazyCommand.php b/src/Symfony/Component/Console/Command/LazyCommand.php
@@ -13,7 +13,6 @@
 
 use Symfony\Component\Console\Application;
 use Symfony\Component\Console\Completion\CompletionInput;
-use Symfony\Component\Console\Completion\CompletionInterface;
 use Symfony\Component\Console\Completion\CompletionSuggestions;
 use Symfony\Component\Console\Helper\HelperSet;
 use Symfony\Component\Console\Input\InputDefinition;
@@ -23,7 +22,7 @@
 /**
  * @author Nicolas Grekas <p@tchwork.com>
  */
-final class LazyCommand extends Command implements CompletionInterface
+final class LazyCommand extends Command
 {
     private $command;
     private $isEnabled;
@@ -74,9 +73,7 @@ public function run(InputInterface $input, OutputInterface $output): int
 
     public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void
     {
-        if ($this->getCommand() instanceof CompletionInterface) {
-            $this->getCommand()->complete($input, $suggestions);
-        }
+        $this->getCommand()->complete($input, $suggestions);
     }
 
     /**

diff --git a/src/Symfony/Component/Console/Command/ListCommand.php b/src/Symfony/Component/Console/Command/ListCommand.php
@@ -12,7 +12,6 @@
 namespace Symfony\Component\Console\Command;
 
 use Symfony\Component\Console\Completion\CompletionInput;
-use Symfony\Component\Console\Completion\CompletionInterface;
 use Symfony\Component\Console\Completion\CompletionSuggestions;
 use Symfony\Component\Console\Descriptor\ApplicationDescription;
 use Symfony\Component\Console\Helper\DescriptorHelper;
@@ -26,7 +25,7 @@
  *
  * @author Fabien Potencier <fabien@symfony.com>
  */
-class ListCommand extends Command implements CompletionInterface
+class ListCommand extends Command
 {
     /**
      * {@inheritdoc}

diff --git a/src/Symfony/Component/Console/Completion/CompletionInterface.php b/src/Symfony/Component/Console/Completion/CompletionInterface.php
diff --git a/src/Symfony/Component/Console/Tester/CommandCompletionTester.php b/src/Symfony/Component/Console/Tester/CommandCompletionTester.php
@@ -13,7 +13,6 @@
 
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Completion\CompletionInput;
-use Symfony\Component\Console\Completion\CompletionInterface;
 use Symfony\Component\Console\Completion\CompletionSuggestions;
 
 /**
@@ -35,10 +34,6 @@ public function __construct(Command $command)
      */
     public function complete(array $input): array
     {
-        if (!$this->command instanceof CompletionInterface) {
-            throw new \LogicException(sprintf('Command "%s" must implement "%s" to support completion.', \get_class($this->command), CompletionInput::class));
-        }
-
         $currentIndex = \count($input);
         if ('' === end($input)) {
             array_pop($input);

diff --git a/src/Symfony/Component/Console/Tests/Command/CompleteCommandTest.php b/src/Symfony/Component/Console/Tests/Command/CompleteCommandTest.php
@@ -16,7 +16,6 @@
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Command\CompleteCommand;
 use Symfony\Component\Console\Completion\CompletionInput;
-use Symfony\Component\Console\Completion\CompletionInterface;
 use Symfony\Component\Console\Completion\CompletionSuggestions;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -115,7 +114,7 @@ private function execute(array $input)
     }
 }
 
-class CompleteCommandTest_HelloCommand extends Command implements CompletionInterface
+class CompleteCommandTest_HelloCommand extends Command
 {
     public function configure(): void
     {