Skip to content

Fix misleading progress indicators with zero ticks #29

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
nickbeen merged 1 commit into from
Aug 23, 2025
Merged

Fix misleading progress indicators with zero ticks #29

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
8 changes: 7 additions & 1 deletion src/ProgressBar.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ public function setMaxProgress(int|float $maxProgress): ProgressBar
$this->maxProgressIsZero = true;
}

$this->maxProgress = max(1, $maxProgress);
$this->maxProgress = max(0, $maxProgress);

return $this;
}
Expand All @@ -235,6 +235,12 @@ public function setMaxProgress(int|float $maxProgress): ProgressBar
*/
private function setPercentage(): void
{
// Handle the "0 of 0" case as fully complete (100%) without division by zero
if ($this->maxProgress == 0) {
$this->percentage = 100;
return;
}

$percentage = ($this->progress / $this->maxProgress) * 100;
$this->percentage = number_format(round($percentage), 2);
}
Expand Down
6 changes: 3 additions & 3 deletions tests/ProgressBarTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ public function it_cannot_set_incorrect_max_progress()
$progressBar = new ProgressBar();
$progressBar->setMaxProgress(-1);

$this->assertEquals(1, $progressBar->getMaxProgress());
$this->assertEquals(0, $progressBar->getMaxProgress());
}

/**
Expand All @@ -155,10 +155,10 @@ public function it_cannot_set_incorrect_max_progress()
public function it_can_gracefully_handle_zero_progress()
{
$progressBar = new ProgressBar(maxProgress: 0);
$this->assertEquals(1, $progressBar->getMaxProgress());
$this->assertEquals(0, $progressBar->getMaxProgress());

$progressBar->tick(0);
$this->assertEquals(1, $progressBar->getProgress());
$this->assertEquals(0, $progressBar->getProgress());

$this->assertEquals(100, $progressBar->getPercentage());
}
Expand Down
Loading