Token class taking some responsabilities from Formatter

Author: nilportugues

src/Formatter.php

@@ -13,6 +13,7 @@
 use NilPortugues\SqlQueryFormatter\Helper\Indent;
 use NilPortugues\SqlQueryFormatter\Helper\NewLine;
 use NilPortugues\SqlQueryFormatter\Helper\Parentheses;
+use NilPortugues\SqlQueryFormatter\Helper\Token;
 use NilPortugues\SqlQueryFormatter\Helper\WhiteSpace;
 use NilPortugues\SqlQueryFormatter\Tokenizer\Tokenizer;
 
@@ -78,7 +79,7 @@ public function format($sql)
         $this->reset();
         $tab = "\t";
 
-        $originalTokens = $this->tokenizer->tokenize((string) $sql);
+        $originalTokens = $this->tokenizer->tokenize((string)$sql);
         $tokens         = WhiteSpace::removeTokenWhitespace($originalTokens);
 
         foreach ($tokens as $i => $token) {
@@ -133,7 +134,7 @@ public function format($sql)
             } elseif ($this->parentheses->stringIsClosingParentheses($token)) {
                 $this->indentation->decreaseIndentLevelUntilIndentTypeIsSpecial($this);
                 $this->newLine->addNewLineBeforeToken($addedNewline, $tab);
-            } elseif ($this->isTokenTypeReservedTopLevel($token)) {
+            } elseif (Token::isTokenTypeReservedTopLevel($token)) {
                 $this->indentation
                     ->setIncreaseSpecialIndent(true)
                     ->decreaseSpecialIndentIfCurrentIndentTypeIsSpecial();
@@ -143,7 +144,7 @@ public function format($sql)
                 if (WhiteSpace::tokenHasExtraWhiteSpaces($token)) {
                     $queryValue = preg_replace('/\s+/', ' ', $queryValue);
                 }
-                $this->tokenHasLimitClause($token);
+                Token::tokenHasLimitClause($token, $this->parentheses, $this);
             } elseif ($this->stringIsEndOfLimitClause($token)) {
                 $this->clauseLimit = false;
             } elseif (
@@ -159,7 +160,7 @@ public function format($sql)
                 }
             }
 
-            if ($this->tokenHasMultipleBoundaryCharactersTogether($token, $tokens, $i, $originalTokens)) {
+            if (Token::tokenHasMultipleBoundaryCharactersTogether($token, $tokens, $i, $originalTokens)) {
                 $this->formattedSql = rtrim($this->formattedSql, ' ');
             }
 
@@ -173,7 +174,7 @@ public function format($sql)
                 $this->formattedSql = rtrim($this->formattedSql, ' ');
             }
 
-            if ($this->tokenIsMinusSign($token, $tokens, $i)) {
+            if (Token::tokenIsMinusSign($token, $tokens, $i)) {
                 $previousTokenType = $tokens[$i - 1][Tokenizer::TOKEN_TYPE];
 
                 if (WhiteSpace::tokenIsNumberAndHasExtraWhiteSpaceRight($previousTokenType)) {
@@ -200,26 +201,6 @@ public function reset()
     }
 
 
-    /**
-     * @param $token
-     *
-     * @return bool
-     */
-    protected function isTokenTypeReservedTopLevel($token)
-    {
-        return $token[Tokenizer::TOKEN_TYPE] === Tokenizer::TOKEN_TYPE_RESERVED_TOP_LEVEL;
-    }
-
-    /**
-     * @param $token
-     */
-    protected function tokenHasLimitClause($token)
-    {
-        if ('LIMIT' === $token[Tokenizer::TOKEN_VALUE] && false === $this->parentheses->getInlineParentheses()) {
-            $this->clauseLimit = true;
-        }
-    }
-
     /**
      * @param $token
      *
@@ -233,39 +214,6 @@ protected function stringIsEndOfLimitClause($token)
         && $token[Tokenizer::TOKEN_TYPE] !== Tokenizer::TOKEN_TYPE_WHITESPACE;
     }
 
-
-    /**
-     * @param $token
-     * @param $tokens
-     * @param $i
-     * @param $originalTokens
-     *
-     * @return bool
-     */
-    protected function tokenHasMultipleBoundaryCharactersTogether($token, &$tokens, $i, &$originalTokens)
-    {
-        return $token[Tokenizer::TOKEN_TYPE] === Tokenizer::TOKEN_TYPE_BOUNDARY
-        && isset($tokens[$i - 1])
-        && $tokens[$i - 1][Tokenizer::TOKEN_TYPE] === Tokenizer::TOKEN_TYPE_BOUNDARY
-        && isset($originalTokens[$token['i'] - 1])
-        && $originalTokens[$token['i'] - 1][Tokenizer::TOKEN_TYPE] !== Tokenizer::TOKEN_TYPE_WHITESPACE;
-    }
-
-    /**
-     * @param $token
-     * @param $tokens
-     * @param $i
-     *
-     * @return bool
-     */
-    protected function tokenIsMinusSign($token, &$tokens, $i)
-    {
-        return '-' === $token[Tokenizer::TOKEN_VALUE]
-        && isset($tokens[$i + 1])
-        && $tokens[$i + 1][Tokenizer::TOKEN_TYPE] === Tokenizer::TOKEN_TYPE_NUMBER
-        && isset($tokens[$i - 1]);
-    }
-
     /**
      * @return string
      */

src/Helper/Token.php

@@ -10,6 +10,9 @@
 
 namespace NilPortugues\SqlQueryFormatter\Helper;
 
+use NilPortugues\SqlQueryFormatter\Formatter;
+use NilPortugues\SqlQueryFormatter\Tokenizer\Tokenizer;
+
 /**
  * Class Token
  * @package NilPortugues\SqlQueryFormatter\Helper
@@ -658,4 +661,91 @@ final class Token
         '&',
         '#'
     ];
+
+
+    /**
+     * @param $token
+     *
+     * @return bool
+     */
+    public static function isTokenTypeReservedTopLevel($token)
+    {
+        return $token[Tokenizer::TOKEN_TYPE] === Tokenizer::TOKEN_TYPE_RESERVED_TOP_LEVEL;
+    }
+
+    /**
+     * @param string $token
+     * @param Parentheses $parentheses
+     * @param Formatter $formatter
+     */
+    public static function tokenHasLimitClause($token, Parentheses $parentheses, Formatter $formatter)
+    {
+        if ('LIMIT' === $token[Tokenizer::TOKEN_VALUE] && false === $parentheses->getInlineParentheses()) {
+            $formatter->setClauseLimit(true);
+        }
+    }
+
+    /**
+     * @param $token
+     * @param $tokens
+     * @param $i
+     * @param $originalTokens
+     *
+     * @return bool
+     */
+    public static function tokenHasMultipleBoundaryCharactersTogether($token, &$tokens, $i, &$originalTokens)
+    {
+        return $token[Tokenizer::TOKEN_TYPE] === Tokenizer::TOKEN_TYPE_BOUNDARY
+        && self::tokenPreviousCharacterIsBoundary($tokens, $i)
+        && self::tokenPreviousCharacterIsWhiteSpace($token, $originalTokens);
+    }
+
+    /**
+     * @param $tokens
+     * @param $i
+     *
+     * @return bool
+     */
+    public static function tokenPreviousCharacterIsBoundary(&$tokens, $i)
+    {
+        return (isset($tokens[$i - 1]) && $tokens[$i - 1][Tokenizer::TOKEN_TYPE] === Tokenizer::TOKEN_TYPE_BOUNDARY);
+    }
+
+    /**
+     * @param $token
+     * @param $originalTokens
+     *
+     * @return bool
+     */
+    public static function tokenPreviousCharacterIsWhiteSpace($token, &$originalTokens)
+    {
+        return (isset($originalTokens[$token['i'] - 1])
+            && $originalTokens[$token['i'] - 1][Tokenizer::TOKEN_TYPE] !== Tokenizer::TOKEN_TYPE_WHITESPACE);
+    }
+
+    /**
+     * @param $token
+     * @param $tokens
+     * @param $i
+     *
+     * @return bool
+     */
+    public static function tokenIsMinusSign($token, &$tokens, $i)
+    {
+        return '-' === $token[Tokenizer::TOKEN_VALUE]
+        && self::tokenNextCharacterIsNumber($tokens, $i)
+        && isset($tokens[$i - 1]);
+    }
+
+    /**
+     * @param $tokens
+     * @param $i
+     *
+     * @return bool
+     */
+    public static function tokenNextCharacterIsNumber(&$tokens, $i)
+    {
+        return (isset($tokens[$i + 1])
+            && $tokens[$i + 1][Tokenizer::TOKEN_TYPE] === Tokenizer::TOKEN_TYPE_NUMBER);
+    }
 }