[Console] Fix bug with utf-8 bug, change writePrompt to use one function prepareChoices #33911

proggga · 2019-10-08T12:28:57Z

Q	A
Branch?	3.4
Bug fix?	yes
New feature?	no
Deprecations?	no
Tickets	#33928
License	MIT
Doc PR

Refactor QuestionHelper and SymfonyQuestionHelper to use one function that prepare choices question. Remove duplicate code.

stof · 2019-10-08T13:28:08Z

src/Symfony/Component/Console/Helper/QuestionHelper.php

@@ -30,6 +30,7 @@
 */
 class QuestionHelper extends Helper
 {
+    const DEFAULT_PROMPT = ' > ';


should it be a public const ?

Yea, moved to Question class

src/Symfony/Component/Console/Helper/FormatterHelper.php

src/Symfony/Component/Console/Helper/QuestionHelper.php

src/Symfony/Component/Console/Question/ChoiceQuestion.php

proggga · 2019-10-08T17:05:41Z

Please help, why 'TranslationFilesTest.php:42' is failing?
I didn't touch that code

proggga · 2019-10-15T15:36:32Z

Anyone?

ostrolucky · 2019-10-15T17:37:10Z

It doesn't seem related, don't worry about it. But perhaps you could get rid of it by rebasing on top of latest 3.4?

proggga · 2019-10-15T17:51:41Z

Rebased on top 3.4

proggga · 2019-10-24T11:33:12Z

Rebase on top 3.4,
anybody?

proggga · 2019-10-29T09:53:26Z

Are you serious?

javiereguiluz · 2019-10-29T10:00:06Z

@proggga because of how Symfony releases new versions, October-November of each year is a very stressful moment for us. Moreover, every two years, the stress is even more intense because we release a new major version. This year is one of those years. So, we're ultra busy with millions of things and we may respond to you a bit late. Thanks for understanding! (and thanks for your contribution too!)

proggga · 2019-10-29T10:05:03Z

Sorry for maybe being aggressive, It was strange, very fast people came and gave alot of changes, but after it disappeared

nicolas-grekas · 2019-12-02T10:57:19Z

There is a mismatch here: the PR title tells about a refacto, but the linked issue is about UTF-8 length computation. refacto go on master - fixes on 3.4. Could you please update the PR according to what it is? I didn't look better before asking :)

proggga · 2019-12-03T15:30:14Z

Fixed

fancyweb · 2019-12-04T08:22:44Z

src/Symfony/Component/Console/Helper/QuestionHelper.php

+    {
+        $choices = $question->getChoices();
+
+        $maxWidth = max(array_map([$this, 'strlen'], array_keys($choices)));


self::strlen?

[static::class, 'strlen'] (but honestly I've no issue with using $this)

We currently use self:: everywhere, we don't expect those methods to be overidden.

fancyweb · 2019-12-04T08:23:34Z

src/Symfony/Component/Console/Helper/QuestionHelper.php

+        $messages = [];
+
+        foreach ($choices as $key => $value) {
+            $width = $maxWidth - $this->strlen($key);


self::strlen

fancyweb · 2019-12-04T08:25:59Z

src/Symfony/Component/Console/Helper/QuestionHelper.php

+        foreach ($choices as $key => $value) {
+            $width = $maxWidth - $this->strlen($key);
+            // We using strlen + str_repeat to fix sprintf whitespace padding problem with UTF-8)
+            $messages[] = sprintf('  [<%s>%s%s</%s>] %s', $tag, $key, str_repeat(' ', $width), $tag, $value);


@nicolas-grekas sprintf left justify does not work with multibytes. Shouldn't we create a sprintf method in the abstract Helper class like we did for strlen, substr, etc.? Or using str_repeat for all strings is ok?

So, you want to implement sprintf in pure PHP.
Yes, sure... in theory :)
in practice, I don't know :)

I mean add a sprintf helper method to handle the left justify. If the string is not utf-8 we use the normal sprintf. If it is, we use the str_repeat strategy.

@proggga Would you have time to take care of this?

Hi, thanks for reviewing this,
Yea, Maybe I can, but I'm not true symphonist, so I don't know rules for creating new helper/naming/best place for it

@proggga Would you have time to take care of this?

May be you can give instructions, and after may be I can do it

In your proposed changes, you replaces the sprintf left justify feat by strlen + str_repeat everytime. Firstly, this alternative should only be used for multibytes strings. Secondly, it should be done in a new helper method in the abstract Helper.php class (like we did for strlen and sbustr).

fancyweb · 2019-12-04T08:29:09Z

src/Symfony/Component/Console/Helper/SymfonyQuestionHelper.php

-            }
+            $output->writeln($messages);
+            // ChoiceQuestion can have any prompt
+            $output->write($question->getPrompt() ?: Question::DEFAULT_PROMPT);


getPrompt() will always return a string. The constant is also useless. Just write the prompt.

That's another bug fixed by this PR btw. Unrelated to the linked issue.

fancyweb · 2019-12-04T08:29:38Z

src/Symfony/Component/Console/Helper/SymfonyQuestionHelper.php

+            // ChoiceQuestion can have any prompt
+            $output->write($question->getPrompt() ?: Question::DEFAULT_PROMPT);
+        } else {
+            $output->write(Question::DEFAULT_PROMPT);


And here keep the old behavior?

Maybe we should actually move the prompt from the ChoiceQuestion to the Question class? 🤔

nicolas-grekas · 2019-12-17T10:19:45Z

Continued in #35000, thanks @proggga

…n choices keys and custom prompt (fancyweb) 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

carsonbot added the Status: Needs Review label Oct 8, 2019

stof requested changes Oct 8, 2019

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Needs Review labels Oct 8, 2019

proggga force-pushed the progga/refactor_questions_helper branch from b36d10b to cf9efe9 Compare October 8, 2019 14:45

nicolas-grekas added this to the 3.4 milestone Oct 8, 2019

proggga requested a review from stof October 8, 2019 17:07

carsonbot added Status: Needs Review and removed Status: Needs Work labels Oct 8, 2019

proggga mentioned this pull request Oct 9, 2019

SymfonyQuestionHelper wrong output for utf8 #33928

Closed

proggga force-pushed the progga/refactor_questions_helper branch from 0e1edd9 to 913f8c3 Compare October 15, 2019 17:50

proggga added 6 commits October 24, 2019 14:32

Refactor writePrompt to use one function prepareChoices

0b093ff

Fix code style by fabbot.io

ce8526d

Add test that fix previous problem

fe8ae78

Fix review, fix test, not it show that previouse code fails with utf

21c5a8b

Fix code style by fabbot.io

ee637c8

Revert back changes of FormatterHelper.php

b5e1596

proggga force-pushed the progga/refactor_questions_helper branch from 913f8c3 to b5e1596 Compare October 24, 2019 11:32

nicolas-grekas changed the title ~~Refactor writePrompt to use one function prepareChoices~~ [Console ]Refactor writePrompt to use one function prepareChoices Dec 2, 2019

nicolas-grekas changed the title ~~[Console ]Refactor writePrompt to use one function prepareChoices~~ [Console] Refactor writePrompt to use one function prepareChoices Dec 2, 2019

proggga changed the title ~~[Console] Refactor writePrompt to use one function prepareChoices~~ [Console] Fix bug with utf-8 writePrompt to use one function prepareChoices Dec 2, 2019

proggga changed the title ~~[Console] Fix bug with utf-8 writePrompt to use one function prepareChoices~~ [Console] Fix bug with utf-8 bug, change writePrompt to use one function prepareChoices Dec 2, 2019

fancyweb reviewed Dec 4, 2019

View reviewed changes

fancyweb mentioned this pull request Dec 17, 2019

[Console][SymfonyQuestionHelper] Handle multibytes question choices keys and custom prompt #35000

Merged

nicolas-grekas closed this Dec 17, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Console] Fix bug with utf-8 bug, change writePrompt to use one function prepareChoices #33911

[Console] Fix bug with utf-8 bug, change writePrompt to use one function prepareChoices #33911

proggga commented Oct 8, 2019 •

edited

Loading

stof Oct 8, 2019

proggga Oct 8, 2019

proggga commented Oct 8, 2019

proggga commented Oct 15, 2019

ostrolucky commented Oct 15, 2019

proggga commented Oct 15, 2019

proggga commented Oct 24, 2019

proggga commented Oct 29, 2019

javiereguiluz commented Oct 29, 2019

proggga commented Oct 29, 2019 •

edited

Loading

nicolas-grekas commented Dec 2, 2019

proggga commented Dec 3, 2019

fancyweb Dec 4, 2019 •

edited

Loading

nicolas-grekas Dec 4, 2019

fancyweb Dec 4, 2019

fancyweb Dec 4, 2019

fancyweb Dec 4, 2019

nicolas-grekas Dec 4, 2019

fancyweb Dec 4, 2019

nicolas-grekas Dec 4, 2019

fancyweb Dec 4, 2019 •

edited

Loading

proggga Dec 4, 2019

proggga Dec 7, 2019

fancyweb Dec 9, 2019

fancyweb Dec 4, 2019

fancyweb Dec 4, 2019

fancyweb Dec 4, 2019

fancyweb Dec 4, 2019

nicolas-grekas commented Dec 17, 2019

[Console] Fix bug with utf-8 bug, change writePrompt to use one function prepareChoices #33911

[Console] Fix bug with utf-8 bug, change writePrompt to use one function prepareChoices #33911

Conversation

proggga commented Oct 8, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

proggga commented Oct 8, 2019

proggga commented Oct 15, 2019

ostrolucky commented Oct 15, 2019

proggga commented Oct 15, 2019

proggga commented Oct 24, 2019

proggga commented Oct 29, 2019

javiereguiluz commented Oct 29, 2019

proggga commented Oct 29, 2019 • edited Loading

nicolas-grekas commented Dec 2, 2019

proggga commented Dec 3, 2019

fancyweb Dec 4, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fancyweb Dec 4, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicolas-grekas commented Dec 17, 2019

proggga commented Oct 8, 2019 •

edited

Loading

proggga commented Oct 29, 2019 •

edited

Loading

fancyweb Dec 4, 2019 •

edited

Loading

fancyweb Dec 4, 2019 •

edited

Loading