Skip to content

[Console] add overwrite flag to ProgressBar helper to allow non-decorated output #11852

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.

Sign up for GitHub

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
Sep 22, 2014
Merged

[Console] add overwrite flag to ProgressBar helper to allow non-decorated output #11852

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
44 changes: 39 additions & 5 deletions src/Symfony/Component/Console/Helper/ProgressBar.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@

namespace Symfony\Component\Console\Helper;

use Symfony\Component\Console\Output\NullOutput;
use Symfony\Component\Console\Output\OutputInterface;

/**
Expand Down Expand Up @@ -42,6 +41,7 @@ class ProgressBar
private $lastMessagesLength = 0;
private $formatLineCount;
private $messages;
private $overwrite = true;

private static $formatters;
private static $formats;
Expand All @@ -54,10 +54,19 @@ class ProgressBar
*/
public function __construct(OutputInterface $output, $max = 0)
{
// Disabling output when it does not support ANSI codes as it would result in a broken display anyway.
$this->output = $output->isDecorated() ? $output : new NullOutput();
$this->output = $output;
$this->setMaxSteps($max);

if (!$this->output->isDecorated()) {
// disable overwrite when output does not support ANSI codes.
$this->overwrite = false;

if ($this->max > 10) {
// set a reasonable redraw frequency so output isn't flooded
$this->setRedrawFrequency($max / 10);
}
}

$this->setFormat($this->determineBestFormat());

$this->startTime = time();
Expand Down Expand Up @@ -360,6 +369,16 @@ public function setCurrent($step)
$this->setProgress($step);
}

/**
* Sets whether to overwrite the progressbar, false for new line
*
* @param bool $overwrite
*/
public function setOverwrite($overwrite)
{
$this->overwrite = (bool) $overwrite;
}

/**
* Sets the current progress.
*
Expand Down Expand Up @@ -396,6 +415,11 @@ public function finish()
$this->max = $this->step;
}

if ($this->step === $this->max && !$this->overwrite) {
// prevent double 100% output
return;
}

$this->setProgress($this->max);
}

Expand Down Expand Up @@ -438,6 +462,10 @@ public function display()
*/
public function clear()
{
if (!$this->overwrite) {
return;
}

$this->overwrite(str_repeat("\n", $this->formatLineCount));
}

Expand Down Expand Up @@ -470,8 +498,14 @@ private function overwrite($message)
}
}

// move back to the beginning of the progress bar before redrawing it
$this->output->write("\x0D");
if ($this->overwrite) {
// move back to the beginning of the progress bar before redrawing it
$this->output->write("\x0D");
} elseif ($this->step > 0) {
// move to new line
$this->output->writeln('');
}

if ($this->formatLineCount) {
$this->output->write(sprintf("\033[%dA", $this->formatLineCount));
}
Expand Down
52 changes: 51 additions & 1 deletion src/Symfony/Component/Console/Tests/Helper/ProgressBarTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -311,13 +311,63 @@ public function testPercentNotHundredBeforeComplete()
}

public function testNonDecoratedOutput()
{
$bar = new ProgressBar($output = $this->getOutputStream(false), 200);
$bar->start();

for ($i = 0; $i < 200; $i++) {
$bar->advance();
}

$bar->finish();

rewind($output->getStream());
$this->assertEquals(
" 0/200 [>---------------------------] 0%\n".
" 20/200 [==>-------------------------] 10%\n".
" 40/200 [=====>----------------------] 20%\n".
" 60/200 [========>-------------------] 30%\n".
" 80/200 [===========>----------------] 40%\n".
" 100/200 [==============>-------------] 50%\n".
" 120/200 [================>-----------] 60%\n".
" 140/200 [===================>--------] 70%\n".
" 160/200 [======================>-----] 80%\n".
" 180/200 [=========================>--] 90%\n".
" 200/200 [============================] 100%",
stream_get_contents($output->getStream())
);
}

public function testNonDecoratedOutputWithClear()
{
$bar = new ProgressBar($output = $this->getOutputStream(false), 50);
$bar->start();
$bar->setProgress(25);
$bar->clear();
$bar->setProgress(50);
$bar->finish();

rewind($output->getStream());
$this->assertEquals(
" 0/50 [>---------------------------] 0%\n".
" 25/50 [==============>-------------] 50%\n".
" 50/50 [============================] 100%",
stream_get_contents($output->getStream())
);
}

public function testNonDecoratedOutputWithoutMax()
{
$bar = new ProgressBar($output = $this->getOutputStream(false));
$bar->start();
$bar->advance();

rewind($output->getStream());
$this->assertEquals('', stream_get_contents($output->getStream()));
$this->assertEquals(
" 0 [>---------------------------]\n".
" 1 [->--------------------------]",
stream_get_contents($output->getStream())
);
}

public function testParallelBars()
Expand Down