Common: prepareForOutput(): Use single color code per run of characters

This reduces the size of the output, and lessens weird effects
of the ANSI color code characters on text wrapping, when the
result of this method is used in a sniff error message
(e.g. see LanguageConstructSpacingSniff).

Author: MatmaRex

src/Util/Common.php

@@ -278,35 +278,26 @@ public static function escapeshellcmd($cmd)
      */
     public static function prepareForOutput($content, $exclude=[])
     {
+        $replacements = [
+            "\r" => '\r',
+            "\n" => '\n',
+            "\t" => '\t',
+            " "  => '·',
+        ];
         if (stripos(PHP_OS, 'WIN') === 0) {
-            if (in_array("\r", $exclude, true) === false) {
-                $content = str_replace("\r", '\r', $content);
-            }
-
-            if (in_array("\n", $exclude, true) === false) {
-                $content = str_replace("\n", '\n', $content);
-            }
-
-            if (in_array("\t", $exclude, true) === false) {
-                $content = str_replace("\t", '\t', $content);
-            }
-        } else {
-            if (in_array("\r", $exclude, true) === false) {
-                $content = str_replace("\r", "\033[30;1m\\r\033[0m", $content);
-            }
+            // Do not replace spaces on Windows.
+            unset($replacements[" "]);
+        }
 
-            if (in_array("\n", $exclude, true) === false) {
-                $content = str_replace("\n", "\033[30;1m\\n\033[0m", $content);
-            }
+        $replacements = array_diff_key($replacements, array_fill_keys($exclude, true));
 
-            if (in_array("\t", $exclude, true) === false) {
-                $content = str_replace("\t", "\033[30;1m\\t\033[0m", $content);
-            }
+        if (stripos(PHP_OS, 'WIN') !== 0) {
+            // On non-Windows, colour runs of invisible characters.
+            $match   = implode('', array_keys($replacements));
+            $content = preg_replace("/([$match]+)/", "\033[30;1m$1\033[0m", $content);
+        }
 
-            if (in_array(' ', $exclude, true) === false) {
-                $content = str_replace(' ', "\033[30;1m·\033[0m", $content);
-            }
-        }//end if
+        $content = strtr($content, $replacements);
 
         return $content;
 

tests/Core/Util/Common/PrepareForOutputTest.php

@@ -75,13 +75,13 @@ public static function dataPrepareForOutput()
             'Special characters are replaced with their escapes' => [
                 'content'     => "\r\n\t",
                 'exclude'     => [],
-                'expected'    => "\033[30;1m\\r\033[0m\033[30;1m\\n\033[0m\033[30;1m\\t\033[0m",
+                'expected'    => "\033[30;1m\\r\\n\\t\033[0m",
                 'expectedWin' => "\\r\\n\\t",
             ],
             'Spaces are replaced with a unique mark'             => [
                 'content'     => "    ",
                 'exclude'     => [],
-                'expected'    => "\033[30;1m·\033[0m\033[30;1m·\033[0m\033[30;1m·\033[0m\033[30;1m·\033[0m",
+                'expected'    => "\033[30;1m····\033[0m",
                 'expectedWin' => "    ",
             ],
             'Other characters are unaffected'                    => [
@@ -102,7 +102,7 @@ public static function dataPrepareForOutput()
                     "\r",
                     "\n",
                 ],
-                'expected'    => "\r\n\033[30;1m\\t\033[0m\033[30;1m·\033[0m",
+                'expected'    => "\r\n\033[30;1m\\t·\033[0m",
                 'expectedWin' => "\r\n\\t ",
             ],
         ];