Fix: Pad lines in code coverage report only when colors are shown

sebastianbergmann · Mar 9, 2024 · c06fe6c · c06fe6c
1 parent fb2c09c
commit c06fe6c
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 14 deletions.
diff --git a/src/Report/Text.php b/src/Report/Text.php
@@ -10,9 +10,13 @@
 namespace SebastianBergmann\CodeCoverage\Report;
 
 use const PHP_EOL;
+use function array_map;
 use function date;
 use function ksort;
+use function max;
 use function sprintf;
+use function str_pad;
+use function strlen;
 use SebastianBergmann\CodeCoverage\CodeCoverage;
 use SebastianBergmann\CodeCoverage\Node\File;
 use SebastianBergmann\CodeCoverage\Util\Percentage;
@@ -156,28 +160,31 @@ public function process(CodeCoverage $coverage, bool $showColors = false): strin
             $report->numberOfExecutableLines(),
         );
 
+        $padding = max(array_map('strlen', [$classes, $methods, $lines]));
+
         if ($this->showOnlySummary) {
-            $title = 'Code Coverage Report Summary:';
+            $title   = 'Code Coverage Report Summary:';
+            $padding = max($padding, strlen($title));
 
-            $output .= $this->format($colors['header'], $title);
+            $output .= $this->format($colors['header'], $padding, $title);
         } else {
             $date  = date('  Y-m-d H:i:s');
             $title = 'Code Coverage Report:';
 
-            $output .= $this->format($colors['header'], $title);
-            $output .= $this->format($colors['header'], $date);
-            $output .= $this->format($colors['header'], '');
-            $output .= $this->format($colors['header'], ' Summary:');
+            $output .= $this->format($colors['header'], $padding, $title);
+            $output .= $this->format($colors['header'], $padding, $date);
+            $output .= $this->format($colors['header'], $padding, '');
+            $output .= $this->format($colors['header'], $padding, ' Summary:');
         }
 
-        $output .= $this->format($colors['classes'], $classes);
-        $output .= $this->format($colors['methods'], $methods);
+        $output .= $this->format($colors['classes'], $padding, $classes);
+        $output .= $this->format($colors['methods'], $padding, $methods);
 
         if ($hasBranchCoverage) {
-            $output .= $this->format($colors['paths'], $paths);
-            $output .= $this->format($colors['branches'], $branches);
+            $output .= $this->format($colors['paths'], $padding, $paths);
+            $output .= $this->format($colors['branches'], $padding, $branches);
         }
-        $output .= $this->format($colors['lines'], $lines);
+        $output .= $this->format($colors['lines'], $padding, $lines);
 
         if ($this->showOnlySummary) {
             return $output . PHP_EOL;
@@ -297,10 +304,12 @@ private function printCoverageCounts(int $numberOfCoveredElements, int $totalNum
         sprintf($format, $totalNumberOfElements) . ')';
     }
 
-    private function format(string $color, false|string $string): string
+    private function format(string $color, int $padding, false|string $string): string
     {
-        $reset = $color ? self::COLOR_RESET : '';
+        if ($color === '') {
+            return (string) $string . PHP_EOL;
+        }
 
-        return $color . (string) $string . $reset . PHP_EOL;
+        return $color . str_pad((string) $string, $padding) . self::COLOR_RESET . PHP_EOL;
     }
 }
diff --git a/tests/_files/NamespacedBankAccount-text-with-colors.txt b/tests/_files/NamespacedBankAccount-text-with-colors.txt
@@ -0,0 +1,14 @@
+
+
+[1;37;40mCode Coverage Report:  [0m
+[1;37;40m  %s  [0m
+[1;37;40m                       [0m
+[1;37;40m Summary:              [0m
+[37;41m  Classes:  0.00% (0/1)[0m
+[30;43m  Methods: 75.00% (3/4)[0m
+[30;43m  Lines:   62.50% (5/8)[0m
+
+SomeNamespace\BankAccount
+  [30;42mMethods:  ( 0/ 0)[0m   [30;42mLines:  (  0/  0)[0m
+SomeNamespace\BankAccountTrait
+  [30;43mMethods:  75.00% ( 3/ 4)[0m   [30;43mLines:  62.50% (  5/  8)[0m
diff --git a/tests/tests/Report/TextTest.php b/tests/tests/Report/TextTest.php
@@ -57,6 +57,16 @@ public function testTextForNamespacedBankAccountTest(): void
         );
     }
 
+    public function testTextForNamespacedBankAccountTestWhenColorsAreEnabled(): void
+    {
+        $text = new Text(Thresholds::default(), true, false);
+
+        $this->assertStringMatchesFormatFile(
+            TEST_FILES_PATH . 'NamespacedBankAccount-text-with-colors.txt',
+            str_replace(PHP_EOL, "\n", $text->process($this->getLineCoverageForNamespacedBankAccount(), true)),
+        );
+    }
+
     public function testTextForFileWithIgnoredLines(): void
     {
         $text = new Text(Thresholds::default(), false, false);