Split up build() into a static and instance method

Signed-off-by: Kamil Tekiela <[email protected]>
phpmyadmin · Aug 30, 2023 · dfe2577 · dfe2577
1 parent 9516074
commit dfe2577
Show file tree

Hide file tree

Showing 8 changed files with 45 additions and 90 deletions.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -1,10 +1,5 @@
 parameters:
 	ignoreErrors:
-		-
-			message: "#^Cannot assign new offset to array\\<PhpMyAdmin\\\\SqlParser\\\\Token\\>\\|string\\.$#"
-			count: 3
-			path: src/Components/AlterOperation.php
-
 		-
 			message: "#^Parameter \\#1 \\$key of function array_key_exists expects int\\|string, float\\|int\\|string given\\.$#"
 			count: 2
@@ -20,11 +15,6 @@ parameters:
 			count: 1
 			path: src/Components/AlterOperation.php
 
-		-
-			message: "#^array\\<PhpMyAdmin\\\\SqlParser\\\\Token\\>\\|string does not accept PhpMyAdmin\\\\SqlParser\\\\Token\\.$#"
-			count: 3
-			path: src/Components/AlterOperation.php
-
 		-
 			message: "#^Cannot access an offset on array\\<int\\<0, max\\>, mixed\\>\\|static\\(PhpMyAdmin\\\\SqlParser\\\\Components\\\\ArrayObj\\)\\.$#"
 			count: 1
@@ -510,11 +500,6 @@ parameters:
 			count: 2
 			path: src/Statements/CreateStatement.php
 
-		-
-			message: "#^Cannot assign new offset to array\\<PhpMyAdmin\\\\SqlParser\\\\Token\\>\\|string\\.$#"
-			count: 4
-			path: src/Statements/CreateStatement.php
-
 		-
 			message: "#^Cannot call method has\\(\\) on PhpMyAdmin\\\\SqlParser\\\\Components\\\\OptionsArray\\|null\\.$#"
 			count: 8
@@ -560,11 +545,6 @@ parameters:
 			count: 1
 			path: src/Statements/CreateStatement.php
 
-		-
-			message: "#^array\\<PhpMyAdmin\\\\SqlParser\\\\Token\\>\\|string does not accept PhpMyAdmin\\\\SqlParser\\\\Token\\.$#"
-			count: 4
-			path: src/Statements/CreateStatement.php
-
 		-
 			message: "#^Argument of an invalid type array\\<PhpMyAdmin\\\\SqlParser\\\\Components\\\\Expression\\>\\|null supplied for foreach, only iterables are supported\\.$#"
 			count: 1

diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -1153,11 +1153,6 @@
       <code><![CDATA[$this->withers]]></code>
     </PossiblyNullArrayOffset>
   </file>
-  <file src="src/TokensList.php">
-    <RedundantConditionGivenDocblockType>
-      <code>is_array($list)</code>
-    </RedundantConditionGivenDocblockType>
-  </file>
   <file src="src/Tools/ContextGenerator.php">
     <PossiblyNullArgument>
       <code><![CDATA[$options['keywords']]]></code>
@@ -1419,41 +1414,12 @@
     <InvalidArgument>
       <code>$find[$k]</code>
     </InvalidArgument>
-    <MixedArgument>
-      <code><![CDATA[$list->tokens[$j]]]></code>
-    </MixedArgument>
-    <MixedArgumentTypeCoercion>
-      <code>$newList</code>
-      <code>$newList</code>
-    </MixedArgumentTypeCoercion>
-    <MixedArrayAccess>
-      <code><![CDATA[$list->tokens[$i]]]></code>
-      <code><![CDATA[$list->tokens[$j]]]></code>
-      <code><![CDATA[$list->tokens[$j]]]></code>
-    </MixedArrayAccess>
-    <MixedAssignment>
-      <code>$newList[]</code>
-      <code>$newList[]</code>
-    </MixedAssignment>
-    <MixedPropertyFetch>
-      <code><![CDATA[$list->tokens[$i]->type]]></code>
-      <code><![CDATA[$list->tokens[$j]->type]]></code>
-    </MixedPropertyFetch>
     <PossiblyInvalidArgument>
-      <code>$list</code>
       <code><![CDATA[$pattern['value_str']]]></code>
     </PossiblyInvalidArgument>
     <PossiblyInvalidOperand>
       <code><![CDATA[$pattern['flags']]]></code>
     </PossiblyInvalidOperand>
-    <PossiblyInvalidPropertyFetch>
-      <code><![CDATA[$list->count]]></code>
-      <code><![CDATA[$list->tokens]]></code>
-    </PossiblyInvalidPropertyFetch>
-    <UndefinedPropertyFetch>
-      <code><![CDATA[$list->count]]></code>
-      <code><![CDATA[$list->tokens]]></code>
-    </UndefinedPropertyFetch>
   </file>
   <file src="tests/Builder/AlterStatementTest.php">
     <PossiblyUnusedMethod>

diff --git a/src/Components/AlterOperation.php b/src/Components/AlterOperation.php
@@ -273,10 +273,8 @@ final class AlterOperation implements Component
 
     /**
      * Unparsed tokens.
-     *
-     * @var Token[]|string
      */
-    public $unknown = [];
+    public TokensList $unknown;
 
     /**
      * @param OptionsArray               $options    options of alter operation
@@ -288,12 +286,12 @@ public function __construct(
         $options = null,
         $field = null,
         $partitions = null,
-        $unknown = []
+        array $unknown = []
     ) {
         $this->partitions = $partitions;
         $this->options = $options;
         $this->field = $field;
-        $this->unknown = $unknown;
+        $this->unknown = new TokensList($unknown);
     }
 
     /**
@@ -543,7 +541,7 @@ public static function build($component): string
             $ret .= $component->field . ' ';
         }
 
-        $ret .= $afterFieldsOptions . TokensList::build($component->unknown);
+        $ret .= $afterFieldsOptions . $component->unknown->build();
 
         if (isset($component->partitions)) {
             $ret .= PartitionDefinition::buildAll($component->partitions);

diff --git a/src/Statements/CreateStatement.php b/src/Statements/CreateStatement.php
@@ -402,9 +402,9 @@ class CreateStatement extends Statement
      * For views, it is the select statement that creates the view.
      * Used by `CREATE FUNCTION`, `CREATE PROCEDURE` and `CREATE VIEW`.
      *
-     * @var Token[]|string
+     * @var Token[]
      */
-    public $body = [];
+    public array $body = [];
 
     public function build(): string
     {
@@ -488,7 +488,7 @@ public function build(): string
                 . OptionsArray::build($this->options) . ' '
                 . Expression::build($this->name) . ' '
                 . $fields . ' AS ' . $builtStatement
-                . (! empty($this->body) ? TokensList::build($this->body) : '') . ' '
+                . TokensList::buildFromArray($this->body) . ' '
                 . OptionsArray::build($this->entityOptions);
         }
 
@@ -498,7 +498,7 @@ public function build(): string
                 . Expression::build($this->name) . ' '
                 . OptionsArray::build($this->entityOptions) . ' '
                 . 'ON ' . Expression::build($this->table) . ' '
-                . 'FOR EACH ROW ' . TokensList::build($this->body);
+                . 'FOR EACH ROW ' . TokensList::buildFromArray($this->body);
         }
 
         if ($this->options->has('PROCEDURE') || $this->options->has('FUNCTION')) {
@@ -512,13 +512,13 @@ public function build(): string
                 . Expression::build($this->name) . ' '
                 . ParameterDefinition::buildAll($this->parameters) . ' '
                 . $tmp . ' ' . OptionsArray::build($this->entityOptions) . ' '
-                . TokensList::build($this->body);
+                . TokensList::buildFromArray($this->body);
         }
 
         return 'CREATE '
             . OptionsArray::build($this->options) . ' '
             . Expression::build($this->name) . ' '
-            . TokensList::build($this->body);
+            . TokensList::buildFromArray($this->body);
     }
 
     /**

diff --git a/src/TokensList.php b/src/TokensList.php
@@ -9,7 +9,6 @@
 use function count;
 use function in_array;
 use function is_array;
-use function is_string;
 
 /**
  * Defines an array of tokens and utility functions to iterate through it.
@@ -44,24 +43,22 @@ public function __construct(public array $tokens = [])
 
     /**
      * Builds an array of tokens by merging their raw value.
-     *
-     * @param string|Token[]|TokensList $list the tokens to be built
      */
-    public static function build($list): string
+    public function build(): string
     {
-        if (is_string($list)) {
-            return $list;
-        }
-
-        if ($list instanceof self) {
-            $list = $list->tokens;
-        }
+        return static::buildFromArray($this->tokens);
+    }
 
+    /**
+     * Builds an array of tokens by merging their raw value.
+     *
+     * @param Token[] $list the tokens to be built
+     */
+    public static function buildFromArray(array $list): string
+    {
         $ret = '';
-        if (is_array($list)) {
-            foreach ($list as $tok) {
-                $ret .= $tok->token;
-            }
+        foreach ($list as $token) {
+            $ret .= $token->token;
         }
 
         return $ret;

diff --git a/src/Utils/Tokens.php b/src/Utils/Tokens.php
@@ -64,16 +64,14 @@ public static function replaceTokens(
         $isList = $list instanceof TokensList;
 
         // Parsing the tokens.
-        if (! $isList) {
+        if (! $list instanceof TokensList) {
             $list = Lexer::getTokens($list);
         }
 
         /**
          * The list to be returned.
-         *
-         * @var Token[]
          */
-        $newList = [];
+        $newList = new TokensList();
 
         /**
          * The length of the find pattern is calculated only once.
@@ -148,6 +146,6 @@ public static function replaceTokens(
             }
         }
 
-        return $isList ? new TokensList($newList) : TokensList::build($newList);
+        return $isList ? $newList : $newList->build();
     }
 }
diff --git a/tests/Builder/CreateStatementTest.php b/tests/Builder/CreateStatementTest.php
@@ -13,6 +13,7 @@
 use PhpMyAdmin\SqlParser\Parser;
 use PhpMyAdmin\SqlParser\Statements\CreateStatement;
 use PhpMyAdmin\SqlParser\Tests\TestCase;
+use PhpMyAdmin\SqlParser\Token;
 use PhpMyAdmin\SqlParser\TokensList;
 use PHPUnit\Framework\Attributes\DataProvider;
 
@@ -524,7 +525,7 @@ public function testBuilderCreateProcedure(): void
 
         $this->assertSame(
             'SELECT _var',
-            TokensList::build($stmt->body)
+            TokensList::buildFromArray($stmt->body)
         );
     }
 
@@ -652,7 +653,7 @@ public function testBuilderCreateFunction(): void
             . '      RETURN TRUE;' . "\n"
             . '    END IF;' . "\n"
             . 'END',
-            TokensList::build($stmt->body)
+            TokensList::buildFromArray($stmt->body)
         );
     }
 
@@ -664,7 +665,21 @@ public function testBuilderTrigger(): void
         $stmt->name = new Expression('ins_sum');
         $stmt->entityOptions = new OptionsArray(['BEFORE', 'INSERT']);
         $stmt->table = new Expression('account');
-        $stmt->body = 'SET @sum = @sum + NEW.amount';
+        $stmt->body = [
+            new Token('SET', Token::TYPE_KEYWORD),
+            new Token(' ', Token::TYPE_WHITESPACE),
+            new Token('@sum', Token::TYPE_NONE),
+            new Token(' ', Token::TYPE_WHITESPACE),
+            new Token('=', Token::TYPE_OPERATOR),
+            new Token(' ', Token::TYPE_WHITESPACE),
+            new Token('@sum', Token::TYPE_NONE),
+            new Token(' ', Token::TYPE_WHITESPACE),
+            new Token('+', Token::TYPE_OPERATOR),
+            new Token(' ', Token::TYPE_WHITESPACE),
+            new Token('NEW', Token::TYPE_KEYWORD),
+            new Token('.', Token::TYPE_OPERATOR),
+            new Token('amount', Token::TYPE_NONE),
+        ];
 
         $this->assertEquals(
             'CREATE TRIGGER ins_sum BEFORE INSERT ON account ' .

diff --git a/tests/Lexer/TokensListTest.php b/tests/Lexer/TokensListTest.php
@@ -45,7 +45,8 @@ public function setUp(): void
     public function testBuild(): void
     {
         $list = new TokensList($this->tokens);
-        $this->assertEquals('SELECT * FROM `test` WHERE name=fa', TokensList::build($list));
+        $this->assertEquals('SELECT * FROM `test` WHERE name=fa', $list->build());
+        $this->assertEquals('SELECT * FROM `test` WHERE name=fa', TokensList::buildFromArray($this->tokens));
     }
 
     public function testAdd(): void