Introduce isMaxKnown variable

freimair · freimair · commit 970186388787 · 2022-08-23T10:12:22.000+02:00
Up until now, it has been very hard to determin whether a progressbar
has a known maximum value or not, because the property `max` is an
integer. Up until now, `max == 0` has been treated like we do _not_
know the `max` value. However, `max == 0` _is_ a valid `max` value
when iterating over an empty but countable array for example.

We cannot simply keep `max == null` if unknown, because that would break
rendering mechanics and fixing those would require interface changes.

Hence, enter `isMaxKnown` - a property which keeps track of whether the
`max` value is known or not.
diff --git a/src/Symfony/Component/Console/Helper/ProgressBar.php b/src/Symfony/Component/Console/Helper/ProgressBar.php
@@ -51,6 +51,7 @@ final class ProgressBar
     private int $step = 0;
     private int $startingStep = 0;
     private int $max = 0;
+    private bool $isMaxKnown = false;
     private int $startTime;
     private int $stepWidth;
     private float $percent = 0.0;
@@ -289,6 +290,8 @@ public function maxSecondsBetweenRedraws(float $seconds): void
      */
     public function iterate(iterable $iterable, int $max = null): iterable
     {
+        $this->isMaxKnown = is_countable($iterable);
+
         $this->start($max ?? (is_countable($iterable) ? \count($iterable) : 0));
 
         foreach ($iterable as $key => $value) {
@@ -377,6 +380,7 @@ public function setMaxSteps(int $max)
         $this->format = null;
         $this->max = max(0, $max);
         $this->stepWidth = $this->max ? Helper::width((string) $this->max) : 4;
+        $this->isMaxKnown = $this->isMaxKnown || 0 < $this->max;
     }
 
     /**
@@ -519,14 +523,14 @@ private static function initPlaceholderFormatters(): array
                 return Helper::formatTime(time() - $bar->getStartTime());
             },
             'remaining' => function (self $bar) {
-                if (!isset($bar->max)) {
+                if (!$bar->isMaxKnown && !$bar->getMaxSteps()) {
                     throw new LogicException('Unable to display the remaining time if the maximum number of steps is not set.');
                 }
 
                 return Helper::formatTime($bar->getRemaining());
             },
             'estimated' => function (self $bar) {
-                if (!isset($bar->max)) {
+                if (!$bar->isMaxKnown && !$bar->getMaxSteps()) {
                     throw new LogicException('Unable to display the estimated time if the maximum number of steps is not set.');
                 }
 
