[Console] Added better interaction for choice questions #11326

florianv · 2014-07-05T17:40:40Z

Q	A
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets
License	MIT
Doc PR

This PR adds a more user friendly way to ask choice questions when stty is available.

Single choice question

You can move up and down with the arrow keys.
To validate your choice press enter.

Multi choice question

You can move up and down with the arrow keys.
To select / deselect a choice press the spacebar.
To validate your choices press enter.

Todos:

Finish tests
Documentation

cordoval · 2014-07-07T20:41:52Z

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

+     * @throws \InvalidArgumentException
+     * @throws \RuntimeException
+     *
+     * @api


i think putting @api on the class is enough. I mean I would assume it would have methods unshakable

Actually, @api shoulmd never be added in a PR submitting the code. you cannot make it part of the stable API if it is not even part of the codebase.
We will mark it as part of the stable API only a bit later

florianv · 2014-07-07T21:02:54Z

I was thinking that this helper could replace the current one for choice questions only when stty is available. This could be done by renaming QuestionHelper into GenericQuestionHelper for example, and then creating a new QuestionHelper that just proxies the other two:

public function ask(InputInterface $input, OutputInterface $output, Question $question)
{
   if ($this->hasSttyAvailable() && $question instanceof ChoiceQuestion) {
       return $this->helperSet->get('choice_question')
           ->ask($input, $output, $question);
   }

   return $this->helperSet->get('generic_question')
       ->ask($input, $output, $question);
}

florianv · 2014-07-07T21:11:20Z

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

+        $output->write($text);
+
+        // Move the cursor left
+        $output->write("\033[10000D");


Note that here I pull the cursor left of 10 000 columns to avoid using mb_strlen (maybe less should be enough too).

stof · 2014-07-08T11:42:35Z

IMO, it does not mak sense to have a separate helper for choice questions. It makes things harder to use for developers, by requiring to choose the right helper (or they will always use the question helper they already know, and users will not benefit from the better experience).
The enhanced experience should be implemented in the QuestionHelper directly (using the existing logic when you don't have stty)

florianv · 2014-07-08T15:26:25Z

I didn't put it in the QuestionHelper because I feared it becomes a mess with the different handlings (for example they write the questions and choices differently). On the other side the choice question handling is mostly done by the SingleChoiceQuestionAsker and the MultiChoiceQuestionAsker.

What I could do is to put the default handling from https://github.com/symfony/symfony/blob/master/src/Symfony/Component/Console/Helper/QuestionHelper.php#L110 in a separate command like GenericQuestionAsker to keep the QuestionHelper clean. It will choose the appropriate Asker depending on the type of question and if stty is available and use that directly.

What do you think @stof ?

florianv · 2014-07-11T13:19:34Z

I have updated the PR, so it keeps only the QuestionHelper and uses the new way when stty is available and it's a choice question. I have also completed the tests.

florianv · 2014-07-11T13:28:36Z

Btw, it would be nice if someone without stty could run the tests.

florianv · 2014-07-17T09:36:43Z

What do you think about this PR ? @fabpot @stof

stof · 2014-07-17T09:44:50Z

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

@@ -24,8 +26,8 @@
 */
 class QuestionHelper extends Helper
 {
+    private $options = array();


I don't like these options. They are making the helper stateful, which is causing issues (it means asking a question in one place will have side effects on next questions in other places).

The configuration should be part of the Question object instead

Yes but I think when you want to configure the templates, you want to do it globally for all questions.

but here, your options are mutable. This means that some code using the helper can decide to change the options, and this will impact unrelated code (which was expecting to use the defaults).

If the goal is to configure them globally, they should not be mutable by code using the helper

Yes it's better to attach them to the Question as you propose. Thanks

eko · 2014-07-17T10:18:32Z

This is a great addition, a much better way to give answers, user-friendly 👍

mickaelandrieu · 2014-07-17T10:54:20Z

👍

florianv · 2014-07-17T11:00:04Z

Thanks for reviewing @stof, I have addressed your comments

stof · 2014-07-17T11:54:42Z

src/Symfony/Component/Console/EscapeSequence.php

+ *
+ * @author Florian Voutzinos <[email protected]>
+ */
+interface EscapeSequence


I'm not sure these utility classes/Interface should actually be in the root of the component (I don't have a good idea for the naming of a subnamespace holding them though).

also, Symfony uses a final class with a private constructor for enums, not an interface (it would not make sense for someone to implement this interface)

Maybe IOUtil or something like that ?

jjsaunier · 2014-07-17T12:59:28Z

👍

florianv · 2014-10-31T01:55:55Z

Any new about this PR @fabpot @stof ?

fabpot · 2018-03-31T06:00:37Z

@ro0NL Probably one that you could be interested in taking over :)

vudaltsov · 2019-06-28T12:14:21Z

I guess, this PR could be closed after #26698.

cordoval reviewed Jul 7, 2014
View reviewed changes

florianv reviewed Jul 7, 2014
View reviewed changes

florianv changed the title ~~[Console] Added a new helper for choice questions~~ [Console] Added better interaction for choice questions Jul 11, 2014

romainneutron added the Console label Jul 12, 2014

stof reviewed Jul 17, 2014
View reviewed changes

florianv added 2 commits July 17, 2014 16:30

[Console] Added better interaction for choice questions

7b6daea

Grouped display options under the same array

4373873

stof mentioned this pull request Sep 25, 2014

[RFC] The Symfony Console Style Guide symfony/symfony-docs#4265

Closed

javiereguiluz added the Feature label Mar 3, 2016

nicolas-grekas added this to the 3.x milestone Dec 6, 2016

prisis mentioned this pull request Mar 20, 2017

Added better interaction for choice questions narrowspark/framework#488

Open

nicolas-grekas modified the milestones: 3.4, 4.1 Sep 28, 2017

chalasr self-requested a review February 5, 2018 15:34

carsonbot added the Status: Needs Review label Feb 5, 2018

ro0NL mentioned this pull request Mar 31, 2018

[Console] Use UTF-8 triangle for question prompt #26718

Closed

nicolas-grekas modified the milestones: 4.1, next Apr 20, 2018

fabpot closed this Feb 3, 2020

nicolas-grekas modified the milestones: next, 5.1 May 4, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Console] Added better interaction for choice questions #11326

[Console] Added better interaction for choice questions #11326

florianv commented Jul 5, 2014

cordoval Jul 7, 2014

stof Jul 8, 2014

florianv commented Jul 7, 2014

florianv Jul 7, 2014

stof commented Jul 8, 2014

florianv commented Jul 8, 2014

florianv commented Jul 11, 2014

florianv commented Jul 11, 2014

florianv commented Jul 17, 2014

stof Jul 17, 2014

florianv Jul 17, 2014

stof Jul 17, 2014

florianv Jul 17, 2014

eko commented Jul 17, 2014

mickaelandrieu commented Jul 17, 2014

florianv commented Jul 17, 2014

stof Jul 17, 2014

florianv Jul 17, 2014

jjsaunier commented Jul 17, 2014

florianv commented Oct 31, 2014

fabpot commented Mar 31, 2018

vudaltsov commented Jun 28, 2019

[Console] Added better interaction for choice questions #11326

[Console] Added better interaction for choice questions #11326

Conversation

florianv commented Jul 5, 2014

Single choice question

Multi choice question

Choose a reason for hiding this comment

Choose a reason for hiding this comment

florianv commented Jul 7, 2014

Choose a reason for hiding this comment

stof commented Jul 8, 2014

florianv commented Jul 8, 2014

florianv commented Jul 11, 2014

florianv commented Jul 11, 2014

florianv commented Jul 17, 2014

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

eko commented Jul 17, 2014

mickaelandrieu commented Jul 17, 2014

florianv commented Jul 17, 2014

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jjsaunier commented Jul 17, 2014

florianv commented Oct 31, 2014

fabpot commented Mar 31, 2018

vudaltsov commented Jun 28, 2019