Merge pull request #36 from dregad/colors-wrap

Fix color not continued on next line when wrapping text

Author: splitbrain

src/Colors.php

@@ -31,6 +31,9 @@ class Colors
     const C_LIGHTGRAY = 'lightgray';
     const C_WHITE = 'white';
 
+    // Regex pattern to match color codes
+    const C_CODE_REGEX = "/(\33\[[0-9;]+m)/";
+
     /** @var array known color names */
     protected $colors = array(
         self::C_RESET => "\33[0m",

src/TableFormatter.php

@@ -293,6 +293,7 @@ protected function substr($string, $start = 0, $length = null)
     protected function wordwrap($str, $width = 75, $break = "\n", $cut = false)
     {
         $lines = explode($break, $str);
+        $color_reset = $this->colors->getColorCode(Colors::C_RESET);
         foreach ($lines as &$line) {
             $line = rtrim($line);
             if ($this->strlen($line) <= $width) {
@@ -301,18 +302,30 @@ protected function wordwrap($str, $width = 75, $break = "\n", $cut = false)
             $words = explode(' ', $line);
             $line = '';
             $actual = '';
+            $color = '';
             foreach ($words as $word) {
+                if (preg_match_all(Colors::C_CODE_REGEX, $word, $color_codes) ) {
+                    # Word contains color codes
+                    foreach ($color_codes[0] as $code) {
+                        if ($code == $color_reset) {
+                            $color = '';
+                        } else {
+                            # Remember color so we can reapply it after a line break
+                            $color = $code;
+                        }
+                    }
+                }
                 if ($this->strlen($actual . $word) <= $width) {
                     $actual .= $word . ' ';
                 } else {
                     if ($actual != '') {
                         $line .= rtrim($actual) . $break;
                     }
-                    $actual = $word;
+                    $actual = $color . $word;
                     if ($cut) {
                         while ($this->strlen($actual) > $width) {
                             $line .= $this->substr($actual, 0, $width) . $break;
-                            $actual = $this->substr($actual, $width);
+                            $actual = $color . $this->substr($actual, $width);
                         }
                     }
                     $actual .= ' ';
@@ -322,4 +335,4 @@ protected function wordwrap($str, $width = 75, $break = "\n", $cut = false)
         }
         return implode($break, $lines);
     }
-}
+}

tests/TableFormatterTest.php

@@ -138,4 +138,51 @@ public function test_onewrap()
         $result = $tf->format([5, '*'], [$col1, $col2]);
         $this->assertEquals($expect, $result);
     }
+
+    /**
+     * Test that colors are correctly applied when text is wrapping across lines.
+     *
+     * @dataProvider colorwrapProvider
+     */
+    public function test_colorwrap($text, $expect)
+    {
+        $tf = new TableFormatter();
+        $tf->setMaxWidth(15);
+
+        $this->assertEquals($expect, $tf->format(['*'], [$text]));
+    }
+
+    /**
+     * Data provider for test_colorwrap.
+     *
+     * @return array[]
+     */
+    public function colorwrapProvider()
+    {
+        $color = new Colors();
+        $cyan = $color->getColorCode(Colors::C_CYAN);
+        $reset = $color->getColorCode(Colors::C_RESET);
+        $wrap = function ($str) use ($color) {
+            return $color->wrap($str, Colors::C_CYAN);
+        };
+
+        return [
+            'color word line 1' => [
+                "This is ". $wrap("cyan") . " text wrapping",
+                "This is {$cyan}cyan{$reset}   \ntext wrapping  \n",
+                ],
+            'color word line 2' => [
+                "This is text ". $wrap("cyan") . " wrapping",
+                "This is text   \n{$cyan}cyan{$reset} wrapping  \n",
+                ],
+            'color across lines' => [
+                "This is ". $wrap("cyan text",) . " wrapping",
+                "This is {$cyan}cyan   \ntext{$reset} wrapping  \n",
+                ],
+            'color across lines until end' => [
+                "This is ". $wrap("cyan text wrapping"),
+                "This is {$cyan}cyan   \n{$cyan}text wrapping{$reset}  \n",
+                ],
+        ];
+    }
 }