feat: add completion for DebugAutowiring search argument

eclairia · eclairia · commit 0ebd8e89e9b3 · 2021-10-30T13:15:19.000+02:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/DebugAutowiringCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/DebugAutowiringCommand.php
@@ -12,12 +12,15 @@
 namespace Symfony\Bundle\FrameworkBundle\Command;
 
 use Symfony\Bundle\FrameworkBundle\Console\Descriptor\Descriptor;
+use Symfony\Component\Console\Completion\CompletionInput;
+use Symfony\Component\Console\Completion\CompletionSuggestions;
 use Symfony\Component\Console\Formatter\OutputFormatterStyle;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Style\SymfonyStyle;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Debug\FileLinkFormatter;
 
 /**
@@ -77,11 +80,11 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $errorIo = $io->getErrorStyle();
 
         $builder = $this->getContainerBuilder($this->getApplication()->getKernel());
-        $serviceIds = $builder->getServiceIds();
-        $serviceIds = array_filter($serviceIds, [$this, 'filterToServiceTypes']);
+        $serviceIds = $this->getServices($builder);
 
         if ($search = $input->getArgument('search')) {
-            $searchNormalized = preg_replace('/[^a-zA-Z0-9\x7f-\xff]++/', '', $search);
+            $searchNormalized = $this->getSearchNormalized($search);
+
             $serviceIds = array_filter($serviceIds, function ($serviceId) use ($searchNormalized) {
                 return false !== stripos(str_replace('\\', '', $serviceId), $searchNormalized) && !str_starts_with($serviceId, '.');
             });
@@ -162,4 +165,33 @@ private function getFileLink(string $class): string
 
         return (string) $this->fileLinkFormatter->format($r->getFileName(), $r->getStartLine());
     }
+
+    public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void
+    {
+        $builder = $this->getContainerBuilder($this->getApplication()->getKernel());
+        $serviceIds = $this->getServices($builder);
+
+        $searchNormalized = $this->getSearchNormalized($input->getArgument('search'));
+
+        $serviceIds = array_filter($serviceIds, function ($serviceId) use ($searchNormalized) {
+            $serviceId = str_replace('\\', '', $serviceId);
+            $serviceId = str_replace('.', '', $serviceId);
+
+            return false !== stripos($serviceId, $searchNormalized) && !str_starts_with($serviceId, '.');
+        });
+
+        $suggestions->suggestValues($serviceIds);
+    }
+
+    private function getServices(ContainerBuilder $builder): array
+    {
+        $serviceIds = $builder->getServiceIds();
+
+        return array_filter($serviceIds, [$this, 'filterToServiceTypes']);
+    }
+
+    private function getSearchNormalized(string $search): string
+    {
+        return preg_replace('/[^a-zA-Z0-9\x7f-\xff]++/', '', $search);
+    }
 }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/DebugAutowiringCommandTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/DebugAutowiringCommandTest.php
@@ -11,8 +11,10 @@
 
 namespace Symfony\Bundle\FrameworkBundle\Tests\Functional;
 
+use Symfony\Bundle\FrameworkBundle\Command\DebugAutowiringCommand;
 use Symfony\Bundle\FrameworkBundle\Console\Application;
 use Symfony\Component\Console\Tester\ApplicationTester;
+use Symfony\Component\Console\Tester\CommandCompletionTester;
 
 /**
  * @group functional
@@ -109,4 +111,29 @@ public function testNotConfusedByClassAliases()
         $tester->run(['command' => 'debug:autowiring', 'search' => 'ClassAlias']);
         $this->assertStringContainsString('Symfony\Bundle\FrameworkBundle\Tests\Fixtures\ClassAliasExampleClass', $tester->getDisplay());
     }
+
+    /**
+     * @dataProvider provideCompletionSuggestions
+     */
+    public function testCompletingName(array $input, array $expectedSuggestions)
+    {
+        $kernel = static::bootKernel(['test_case' => 'BundlePaths']);
+        $command = (new Application($kernel))->add(new DebugAutowiringCommand());
+
+        $tester = new CommandCompletionTester($command);
+
+        $suggestions = $tester->complete($input);
+
+        $this->assertSame($expectedSuggestions, $suggestions);
+    }
+
+    public function provideCompletionSuggestions(): \Generator
+    {
+        yield 'search' => [
+            ['twig'],
+            [
+                'Twig\Environment'
+            ],
+        ];
+    }
 }
