[Console][ProgressHelper] Fix ProgressHelper redraw when redrawFreq is greater than 1 #9420
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I've amended few changes:
...and rebased to upstream/2.3. |
| if ($redraw || 0 === $this->current % $this->redrawFreq) { | ||
|
|
||
| $currPeriod = intval($this->current / $this->redrawFreq); | ||
| if ($redraw || $prevPeriod != $currPeriod || $this->max === $this->current) { |
|
@stof Thanks, I didn't noticed it. |
|
@fabpot What about removing code duplication by rewriting public function advance($step = 1, $redraw = false)
{
$this->setCurrent($this->current + $step, $redraw);
}the only change would be that advancing from a negative step would be forbidden. But I don't think it works properly currently anyway (IIRC, this is the reason why |
fabpot
added a commit
that referenced
this pull request
Nov 9, 2013
…drawFreq is greater than 1 (giosh94mhz)
This PR was merged into the 2.3 branch.
Discussion
----------
[Console][ProgressHelper] Fix ProgressHelper redraw when redrawFreq is greater than 1
| Q | A
| ------------- | ---
| Bug fix? | yes
| New feature? | no
| BC breaks? | no
| Deprecations? | no
| Tests pass? | yes
| Fixed tickets |
| License | MIT
| Doc PR |
When using a ProgressHelper object with redrawFreq > 1, there are situation where redraw may never occur.
E.g.
redrawFreq = 2
setContent = 1
advance(2) ... the redraw event is detected by 0 == current % redrawFreq.
I've tested the patch against phpunit and my local environment.
Maybe, a new test can be implemented to avoid the previous example, but I'm not familiar with mock object... :)
Commits
-------
5eca1fb Fix ProgressHelper redraw when redrawFreq is greater than 1
fabpot
added a commit
that referenced
this pull request
Nov 9, 2013
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When using a ProgressHelper object with redrawFreq > 1, there are situation where redraw may never occur.
E.g.
I've tested the patch against phpunit and my local environment.
Maybe, a new test can be implemented to avoid the previous example, but I'm not familiar with mock object... :)