bug #35000 [Console][SymfonyQuestionHelper] Handle multibytes question choices keys and custom prompt (fancyweb)

nicolas-grekas · nicolas-grekas · commit ae9c41cb168a · 2019-12-17T11:19:24.000+01:00
This PR was merged into the 3.4 branch. Discussion ---------- [Console][SymfonyQuestionHelper] Handle multibytes question choices keys and custom prompt | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | #33928 | License | MIT | Doc PR | - Replaces / finishes #33911 Commits ------- f175032 [Console][SymfonyQuestionHelper] Handle multibytes question choices keys and custom prompt
diff --git a/src/Symfony/Component/Console/Helper/QuestionHelper.php b/src/Symfony/Component/Console/Helper/QuestionHelper.php
@@ -198,22 +198,36 @@ protected function writePrompt(OutputInterface $output, Question $question)
         $message = $question->getQuestion();
 
         if ($question instanceof ChoiceQuestion) {
-            $maxWidth = max(array_map([$this, 'strlen'], array_keys($question->getChoices())));
-
-            $messages = (array) $question->getQuestion();
-            foreach ($question->getChoices() as $key => $value) {
-                $width = $maxWidth - $this->strlen($key);
-                $messages[] = '  [<info>'.$key.str_repeat(' ', $width).'</info>] '.$value;
-            }
-
-            $output->writeln($messages);
+            $output->writeln(array_merge([
+                $question->getQuestion(),
+            ], $this->formatChoiceQuestionChoices($question, 'info')));
 
             $message = $question->getPrompt();
         }
 
         $output->write($message);
     }
 
+    /**
+     * @param string $tag
+     *
+     * @return string[]
+     */
+    protected function formatChoiceQuestionChoices(ChoiceQuestion $question, $tag)
+    {
+        $messages = [];
+
+        $maxWidth = max(array_map('self::strlen', array_keys($choices = $question->getChoices())));
+
+        foreach ($choices as $key => $value) {
+            $padding = str_repeat(' ', $maxWidth - self::strlen($key));
+
+            $messages[] = sprintf("  [<$tag>%s$padding</$tag>] %s", $key, $value);
+        }
+
+        return $messages;
+    }
+
     /**
      * Outputs an error message.
      */
diff --git a/src/Symfony/Component/Console/Helper/SymfonyQuestionHelper.php b/src/Symfony/Component/Console/Helper/SymfonyQuestionHelper.php
@@ -96,15 +96,15 @@ protected function writePrompt(OutputInterface $output, Question $question)
 
         $output->writeln($text);
 
+        $prompt = ' > ';
+
         if ($question instanceof ChoiceQuestion) {
-            $width = max(array_map('strlen', array_keys($question->getChoices())));
+            $output->writeln($this->formatChoiceQuestionChoices($question, 'comment'));
 
-            foreach ($question->getChoices() as $key => $value) {
-                $output->writeln(sprintf("  [<comment>%-${width}s</comment>] %s", $key, $value));
-            }
+            $prompt = $question->getPrompt();
         }
 
-        $output->write(' > ');
+        $output->write($prompt);
     }
 
     /**
diff --git a/src/Symfony/Component/Console/Tests/Helper/SymfonyQuestionHelperTest.php b/src/Symfony/Component/Console/Tests/Helper/SymfonyQuestionHelperTest.php
@@ -130,6 +130,49 @@ public function testAskThrowsExceptionOnMissingInput()
         $dialog->ask($this->createStreamableInputInterfaceMock($this->getInputStream('')), $this->createOutputInterface(), new Question('What\'s your name?'));
     }
 
+    public function testChoiceQuestionPadding()
+    {
+        $choiceQuestion = new ChoiceQuestion('qqq', [
+            'foo' => 'foo',
+            'żółw' => 'bar',
+            'łabądź' => 'baz',
+        ]);
+
+        (new SymfonyQuestionHelper())->ask(
+            $this->createStreamableInputInterfaceMock($this->getInputStream("foo\n")),
+            $output = $this->createOutputInterface(),
+            $choiceQuestion
+        );
+
+        $this->assertOutputContains(<<<EOT
+qqq:
+  [foo   ] foo
+  [żółw  ] bar
+  [łabądź] baz
+ > 
+EOT
+        , $output);
+    }
+
+    public function testChoiceQuestionCustomPrompt()
+    {
+        $choiceQuestion = new ChoiceQuestion('qqq', ['foo']);
+        $choiceQuestion->setPrompt(' >ccc> ');
+
+        (new SymfonyQuestionHelper())->ask(
+            $this->createStreamableInputInterfaceMock($this->getInputStream("foo\n")),
+            $output = $this->createOutputInterface(),
+            $choiceQuestion
+        );
+
+        $this->assertOutputContains(<<<EOT
+ qqq:
+  [0] foo
+ >ccc>
+EOT
+        , $output);
+    }
+
     protected function getInputStream($input)
     {
         $stream = fopen('php://memory', 'r+', false);
