Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[Console] Fix clear line with question in section #48089

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 14, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,14 @@ public function addContent(string $input)
}
}

/**
* @internal
*/
public function incrementLines()
{
++$this->lines;
}

/**
* {@inheritdoc}
*/
Expand Down
6 changes: 6 additions & 0 deletions src/Symfony/Component/Console/Style/SymfonyStyle.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
use Symfony\Component\Console\Helper\TableSeparator;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\ConsoleOutputInterface;
use Symfony\Component\Console\Output\ConsoleSectionOutput;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Output\TrimmedBufferOutput;
use Symfony\Component\Console\Question\ChoiceQuestion;
Expand Down Expand Up @@ -350,6 +351,11 @@ public function askQuestion(Question $question): mixed
if ($this->input->isInteractive()) {
$this->newLine();
$this->bufferedOutput->write("\n");
if ($this->output instanceof ConsoleSectionOutput) {
// add one line more to the ConsoleSectionOutput because of the `return` to submit the input
// this is relevant when a `ConsoleSectionOutput::clear` is called.
$this->output->incrementLines();
}
}

return $answer;
Expand Down
36 changes: 36 additions & 0 deletions src/Symfony/Component/Console/Tests/Style/SymfonyStyleTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,13 @@
use Symfony\Component\Console\Exception\RuntimeException;
use Symfony\Component\Console\Formatter\OutputFormatter;
use Symfony\Component\Console\Input\ArrayInput;
use Symfony\Component\Console\Input\Input;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\ConsoleOutputInterface;
use Symfony\Component\Console\Output\ConsoleSectionOutput;
use Symfony\Component\Console\Output\NullOutput;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Output\StreamOutput;
use Symfony\Component\Console\Style\SymfonyStyle;
use Symfony\Component\Console\Tester\CommandTester;

Expand Down Expand Up @@ -181,4 +183,38 @@ public function testMemoryConsumption()

$this->assertSame(0, memory_get_usage() - $start);
}

public function testAskAndClearExpectFullSectionCleared()
{
$answer = 'Answer';
$inputStream = fopen('php://memory', 'r+');
fwrite($inputStream, $answer.\PHP_EOL);
rewind($inputStream);
$input = $this->createMock(Input::class);
$sections = [];
$output = new ConsoleSectionOutput(fopen('php://memory', 'r+', false), $sections, StreamOutput::VERBOSITY_NORMAL, true, new OutputFormatter());
$input
->method('isInteractive')
->willReturn(true);
$input
->method('getStream')
->willReturn($inputStream);

$style = new SymfonyStyle($input, $output);

$style->write('foo');
$givenAnswer = $style->ask('Dummy question?');
$output->write('bar');
$output->clear();

rewind($output->getStream());
$this->assertEquals($answer, $givenAnswer);
$this->assertEquals(
'foo'.\PHP_EOL. // write foo
\PHP_EOL.\PHP_EOL.\PHP_EOL." \033[32mDummy question?\033[39m:".\PHP_EOL.' > '.\PHP_EOL.\PHP_EOL.\PHP_EOL. // question
'bar'.\PHP_EOL. // write bar
"\033[10A\033[0J", // clear 10 lines (9 output lines and one from the answer input return)
stream_get_contents($output->getStream())
);
}
}