Merge pull request #25 from greg0ire/null-highlighter

Use null object pattern to decrease complexity

Author: greg0ire

README.md

@@ -49,13 +49,17 @@ Output:
 ### Formatting Only
 
 If you don't want syntax highlighting and only want the indentations and
-line breaks, pass in `false` as the second parameter.
+line breaks, pass in a `NullHighlighter` instance as the second parameter.
 
 This is useful for outputting to error logs or other non-html formats.
 
 ```php
 <?php
-echo (new SqlFormatter())->format($query, false);
+
+use Doctrine\SqlFormatter\NullHighlighter;
+use Doctrine\SqlFormatter\SqlFormatter;
+
+echo (new SqlFormatter(new NullHighlighter()))->format($query);
 ```
 
 Output:

examples/examples.php

@@ -4,7 +4,9 @@
 
 require_once __DIR__ . '/../vendor/autoload.php';
 
+use Doctrine\SqlFormatter\NullHighlighter;
 use Doctrine\SqlFormatter\SqlFormatter;
+use Doctrine\SqlFormatter\Tokenizer;
 
 $formatter = new SqlFormatter();
 
@@ -177,9 +179,9 @@
         <div>
             Usage:
             <pre>
-            <?php highlight_string(
-                '<?php' . "\n" . '$formatted = (new SqlFormatter())->format($sql, false);' . "\n" . '?>'
-            ); ?>
+            <?php highlight_string('<?php' . "\n" .
+            '$formatted = (new SqlFormatter(mew Tokenizer(), new NullHighlighter()))->format($sql);' .
+            "\n" . '?>'); ?>
             </pre>
         </div>
         <table>
@@ -192,7 +194,10 @@
                 <td>
                     <pre><?= $sql; ?></pre>
                 </td>
-                <td><pre><?= htmlentities($formatter->format($sql, false)); ?></pre></td>
+                <td><pre><?= htmlentities((new SqlFormatter(
+                    new Tokenizer(),
+                    new NullHighlighter()
+                ))->format($sql)); ?></pre></td>
             </tr>
             <?php endforeach ?>
         </table>

src/CliHighlighter.php

@@ -4,6 +4,9 @@
 
 namespace Doctrine\SqlFormatter;
 
+use function sprintf;
+use const PHP_EOL;
+
 final class CliHighlighter implements Highlighter
 {
     /** @var string */
@@ -79,7 +82,7 @@ private function prefix(int $type) : ?string
 
     public function highlightError(string $value) : string
     {
-        return $this->cliError . $value . "\x1b[0m";
+        return sprintf('%s%s%s%s', PHP_EOL, $this->cliError, $value, "\x1b[0m");
     }
 
     public function output(string $string) : string

src/HtmlHighlighter.php

@@ -5,9 +5,11 @@
 namespace Doctrine\SqlFormatter;
 
 use function htmlentities;
+use function sprintf;
 use function trim;
 use const ENT_COMPAT;
 use const ENT_IGNORE;
+use const PHP_EOL;
 
 final class HtmlHighlighter implements Highlighter
 {
@@ -94,7 +96,7 @@ public function attributes(int $type) : ?string
 
     public function highlightError(string $value) : string
     {
-        return '<span ' . $this->errorAttributes . '>' . $value . '</span>';
+        return sprintf('%s<span %s>%s</span>', PHP_EOL, $this->errorAttributes, $value);
     }
 
     public function output(string $string) : string

src/NullHighlighter.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\SqlFormatter;
+
+final class NullHighlighter implements Highlighter
+{
+    public function highlightToken(int $type, string $value) : string
+    {
+        return $value;
+    }
+
+    public function highlightError(string $value) : string
+    {
+        return $value;
+    }
+
+    public function output(string $string) : string
+    {
+        return $string;
+    }
+}

src/SqlFormatter.php

@@ -60,12 +60,11 @@ public function __construct(
     /**
      * Format the whitespace in a SQL string to make it easier to read.
      *
-     * @param string $string    The SQL string
-     * @param bool   $highlight If true, syntax highlighting will also be performed
+     * @param string $string The SQL string
      *
      * @return string The SQL string with HTML styles and formatting wrapped in a <pre> tag
      */
-    public function format(string $string, bool $highlight = true) : string
+    public function format(string $string) : string
     {
         // This variable will be populated with formatted html
         $return = '';
@@ -99,13 +98,11 @@ public function format(string $string, bool $highlight = true) : string
 
         // Format token by token
         foreach ($indexedTokens as $i => $indexedToken) {
-            $token = $indexedToken['token'];
-            // Get highlighted token if doing syntax highlighting
-            if ($highlight) {
-                $highlighted = $this->highlighter->highlightToken($token->type(), $token->value());
-            } else { // If returning raw text
-                $highlighted = $token->value();
-            }
+            $token       = $indexedToken['token'];
+            $highlighted = $this->highlighter->highlightToken(
+                $token->type(),
+                $token->value()
+            );
 
             // If we are increasing the special indent level now
             if ($increaseSpecialIndent) {
@@ -247,12 +244,8 @@ public function format(string $string, bool $highlight = true) : string
                     // This is an error
                     $indentLevel = 0;
 
-                    if ($highlight) {
-                        $return .= "\n" . $this->highlighter->highlightError(
-                            $token->value()
-                        );
-                        continue;
-                    }
+                    $return .= $this->highlighter->highlightError($token->value());
+                    continue;
                 }
 
                 // Add a newline before the closing parentheses (if not already added)
@@ -360,18 +353,14 @@ public function format(string $string, bool $highlight = true) : string
         }
 
         // If there are unmatched parentheses
-        if ($highlight && array_search('block', $indentTypes) !== false) {
-            $return .= "\n" . $this->highlighter->highlightError('WARNING: unclosed parentheses or section');
+        if (array_search('block', $indentTypes) !== false) {
+            $return .= $this->highlighter->highlightError('WARNING: unclosed parentheses or section');
         }
 
         // Replace tab characters with the configuration tab character
         $return = trim(str_replace("\t", $this->tab, $return));
 
-        if ($highlight) {
-            $return = $this->highlighter->output($return);
-        }
-
-        return $return;
+        return $this->highlighter->output($return);
     }
 
     /**

tests/SqlFormatterTest.php

@@ -6,6 +6,7 @@
 
 use Doctrine\SqlFormatter\CliHighlighter;
 use Doctrine\SqlFormatter\HtmlHighlighter;
+use Doctrine\SqlFormatter\NullHighlighter;
 use Doctrine\SqlFormatter\SqlFormatter;
 use Doctrine\SqlFormatter\Tokenizer;
 use PHPUnit\Framework\TestCase;
@@ -59,7 +60,8 @@ public function testFormatHighlight(string $sql, string $html) : void
      */
     public function testFormat(string $sql, string $html) : void
     {
-        $this->assertEquals(trim($html), trim($this->formatter->format($sql, false)));
+        $formatter = new SqlFormatter(new Tokenizer(), new NullHighlighter());
+        $this->assertEquals(trim($html), trim($formatter->format($sql)));
     }
 
     /**

tests/format.html

@@ -750,11 +750,10 @@
 FROM 
   Test 
 WHERE 
-  (MyColumn = 1)
-) 
+  (MyColumn = 1))
 AND (
   (
-    (SomeOtherColumn = 2);
+    (SomeOtherColumn = 2); WARNING: unclosed parentheses or section 
 
 SELECT 
   *