feature #33732 [Console] Rename some methods related to redraw frequency (javiereguiluz)

fabpot · fabpot · commit e4c661901e3b · 2019-11-04T13:46:19.000+01:00
This PR was squashed before being merged into the 4.4 branch (closes #33732). Discussion ---------- [Console] Rename some methods related to redraw frequency | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | - | License | MIT | Doc PR | - In #26339 we added `preventRedrawFasterThan()` and `forceRedrawSlowerThan()`. While merging the docs for them (symfony/symfony-docs#12364) I thought that the method names are a bit hard to understand. In this PR I propose a renaming for your consideration. Thanks! In the following example, we want to update the progress bar every 100 iterations, but not faster than 100ms or slower than 200ms. **Before** ```php $progressBar = new ProgressBar($output, 50000); $progressBar->start(); $progressBar->setRedrawFrequency(100); $progressBar->preventRedrawFasterThan(0.1); $progressBar->forceRedrawSlowerThan(0.2); ``` **After** ```php $progressBar = new ProgressBar($output, 50000); $progressBar->start(); $progressBar->setRedrawFrequency(100); $progressBar->maxRefreshInterval(0.1); $progressBar->minRefreshInterval(0.2); ``` Commits ------- e6ee7b0 [Console] Rename some methods related to redraw frequency
diff --git a/src/Symfony/Component/Console/CHANGELOG.md b/src/Symfony/Component/Console/CHANGELOG.md
@@ -6,7 +6,7 @@ CHANGELOG
 
  * deprecated finding hidden commands using an abbreviation, use the full name instead
  * added `Question::setTrimmable` default to true to allow the answer to be trimmed
- * added method `preventRedrawFasterThan()` and `forceRedrawSlowerThan()` on `ProgressBar`
+ * added method `minSecondsBetweenRedraws()` and `maxSecondsBetweenRedraws()` on `ProgressBar`
  * `Application` implements `ResetInterface`
  * marked all dispatched event classes as `@final`
  * added support for displaying table horizontally
diff --git a/src/Symfony/Component/Console/Helper/ProgressBar.php b/src/Symfony/Component/Console/Helper/ProgressBar.php
@@ -256,14 +256,14 @@ public function setRedrawFrequency(?int $freq)
         $this->redrawFreq = null !== $freq ? max(1, $freq) : null;
     }
 
-    public function preventRedrawFasterThan(float $intervalInSeconds): void
+    public function minSecondsBetweenRedraws(float $seconds): void
     {
-        $this->minSecondsBetweenRedraws = $intervalInSeconds;
+        $this->minSecondsBetweenRedraws = $seconds;
     }
 
-    public function forceRedrawSlowerThan(float $intervalInSeconds): void
+    public function maxSecondsBetweenRedraws(float $seconds): void
     {
-        $this->maxSecondsBetweenRedraws = $intervalInSeconds;
+        $this->maxSecondsBetweenRedraws = $seconds;
     }
 
     /**
diff --git a/src/Symfony/Component/Console/Tests/Helper/ProgressBarTest.php b/src/Symfony/Component/Console/Tests/Helper/ProgressBarTest.php
@@ -936,23 +936,47 @@ public function testBarWidthWithMultilineFormat()
         putenv('COLUMNS=120');
     }
 
-    public function testForceRedrawSlowerThan(): void
+    public function testMinAndMaxSecondsBetweenRedraws(): void
+    {
+        $bar = new ProgressBar($output = $this->getOutputStream());
+        $bar->setRedrawFrequency(1);
+        $bar->minSecondsBetweenRedraws(5);
+        $bar->maxSecondsBetweenRedraws(10);
+
+        $bar->start();
+        $bar->setProgress(1);
+        sleep(10);
+        $bar->setProgress(2);
+        sleep(20);
+        $bar->setProgress(3);
+
+        rewind($output->getStream());
+        $this->assertEquals(
+            '    0 [>---------------------------]'.
+            $this->generateOutput('    2 [-->-------------------------]').
+            $this->generateOutput('    3 [--->------------------------]'),
+            stream_get_contents($output->getStream())
+        );
+    }
+
+    public function testMaxSecondsBetweenRedraws(): void
     {
         $bar = new ProgressBar($output = $this->getOutputStream(), 0, 0);
         $bar->setRedrawFrequency(4); // disable step based redraws
         $bar->start();
+
         $bar->setProgress(1); // No treshold hit, no redraw
-        $bar->forceRedrawSlowerThan(2);
+        $bar->maxSecondsBetweenRedraws(2);
         sleep(1);
-        $bar->setProgress(2); // Still no redraw because redraw is forced after 2 seconds only
+        $bar->setProgress(2); // Still no redraw because it takes 2 seconds for a redraw
         sleep(1);
         $bar->setProgress(3); // 1+1 = 2 -> redraw finally
         $bar->setProgress(4); // step based redraw freq hit, redraw even without sleep
         $bar->setProgress(5); // No treshold hit, no redraw
-        $bar->preventRedrawFasterThan(3);
+        $bar->maxSecondsBetweenRedraws(3);
         sleep(2);
         $bar->setProgress(6); // No redraw even though 2 seconds passed. Throttling has priority
-        $bar->preventRedrawFasterThan(2);
+        $bar->maxSecondsBetweenRedraws(2);
         $bar->setProgress(7); // Throttling relaxed, draw
 
         rewind($output->getStream());
@@ -965,16 +989,16 @@ public function testForceRedrawSlowerThan(): void
         );
     }
 
-    public function testPreventRedrawFasterThan()
+    public function testMinSecondsBetweenRedraws()
     {
         $bar = new ProgressBar($output = $this->getOutputStream(), 0, 0);
         $bar->setRedrawFrequency(1);
-        $bar->preventRedrawFasterThan(1);
+        $bar->minSecondsBetweenRedraws(1);
         $bar->start();
         $bar->setProgress(1); // Too fast, should not draw
         sleep(1);
         $bar->setProgress(2); // 1 second passed, draw
-        $bar->preventRedrawFasterThan(2);
+        $bar->minSecondsBetweenRedraws(2);
         sleep(1);
         $bar->setProgress(3); // 1 second passed but we changed threshold, should not draw
         sleep(1);

Original file line number	Diff line number	Diff line change
`@@ -256,14 +256,14 @@ public function setRedrawFrequency(?int $freq)`
`256`	`256`	`$this->redrawFreq = null !== $freq ? max(1, $freq) : null;`
`257`	`257`	`}`
`258`	`258`
`259`		`- public function preventRedrawFasterThan(float $intervalInSeconds): void`
	`259`	`+ public function minSecondsBetweenRedraws(float $seconds): void`
`260`	`260`	`{`
`261`		`- $this->minSecondsBetweenRedraws = $intervalInSeconds;`
	`261`	`+ $this->minSecondsBetweenRedraws = $seconds;`
`262`	`262`	`}`
`263`	`263`
`264`		`- public function forceRedrawSlowerThan(float $intervalInSeconds): void`
	`264`	`+ public function maxSecondsBetweenRedraws(float $seconds): void`
`265`	`265`	`{`
`266`		`- $this->maxSecondsBetweenRedraws = $intervalInSeconds;`
	`266`	`+ $this->maxSecondsBetweenRedraws = $seconds;`
`267`	`267`	`}`
`268`	`268`
`269`	`269`	`/**`