Fix SpecifyArgSeparatorFixer incompatible with php-cs-fixer 3.0

Author: OndraM

CHANGELOG.md

@@ -5,6 +5,7 @@
 <!-- There is always Unreleased section on the top. Subsections (Added, Changed, Fixed, Removed) should be added as needed. -->
 
 ## Unreleased
+- Fix SpecifyArgSeparatorFixer not compatible with php-cs-fixer 3.0.
 
 ## 3.1.0 - 2021-05-13
 - Use php-cs-fixer 3.0.

phpstan.neon

@@ -7,8 +7,6 @@ parameters:
         - vendor/symplify/easy-coding-standard/vendor/squizlabs/php_codesniffer/autoload.php
         - vendor/symplify/easy-coding-standard/vendor/squizlabs/php_codesniffer/src/Util/Tokens.php
     ignoreErrors:
-        - message: '#Parameter \#(2|3) \$(argumentStart|argumentEnd) of method PhpCsFixer\\Tokenizer\\Analyzer\\ArgumentsAnalyzer::getArgumentInfo\(\) expects int#'
-          path: %currentWorkingDirectory%/src/Fixer/SpecifyArgSeparatorFixer.php
         - message: '#Parameter \#1 \$code of static method PhpCsFixer\\Tokenizer\\Tokens::fromCode\(\) expects string, string\|false given#'
           path: %currentWorkingDirectory%/tests/Fixer/SpecifyArgSeparatorFixerTest.php
         - message: '#Parameter \#1 \$filename of function file_get_contents expects string, string\|false given.#'

src/Fixer/SpecifyArgSeparatorFixer.php

@@ -6,7 +6,6 @@
 use PhpCsFixer\FixerDefinition\CodeSample;
 use PhpCsFixer\FixerDefinition\FixerDefinition;
 use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
-use PhpCsFixer\Tokenizer\Analyzer\Analysis\TypeAnalysis;
 use PhpCsFixer\Tokenizer\Analyzer\ArgumentsAnalyzer;
 use PhpCsFixer\Tokenizer\CT;
 use PhpCsFixer\Tokenizer\Token;
@@ -91,13 +90,14 @@ private function fixFunction(Tokens $tokens, int $functionIndex): void
 
         // When third argument is already present and it is null, override its value.
         if ($argumentCount >= 3) {
-            $thirdArgumentType = $this->getThirdArgumentInfo($tokens, $openParenthesisIndex, $closeParenthesisIndex);
-            if ($thirdArgumentType === null) {
+            $thirdArgumentTuple = $this->getThirdArgumentTokenTuple($tokens, $openParenthesisIndex, $closeParenthesisIndex);
+            if ($thirdArgumentTuple === []) {
                 return;
             }
 
-            if ($thirdArgumentType->getName() === 'null') {
-                $this->setArgumentValueToAmp($tokens, $thirdArgumentType->getStartIndex());
+            $thirdArgumentToken = reset($thirdArgumentTuple);
+            if ($thirdArgumentToken->getContent() === 'null') {
+                $this->setArgumentValueToAmp($tokens, key($thirdArgumentTuple));
             }
 
             return;
@@ -112,7 +112,7 @@ private function fixFunction(Tokens $tokens, int $functionIndex): void
             $tokensToInsert[] = new Token([T_STRING, 'null']);
         }
 
-        // Add third argument (arg separator): ", &"
+        // Add third argument (arg separator): ", '&'"
         $tokensToInsert[] = new Token(',');
         $tokensToInsert[] = new Token([T_WHITESPACE, ' ']);
         $tokensToInsert[] = new Token([T_STRING, "'&'"]);
@@ -139,19 +139,28 @@ private function isFunctionCall(Tokens $tokens, int $index): bool
 
     /**
      * @param Tokens<Token> $tokens
+     * @return array<int, Token>
      */
-    private function getThirdArgumentInfo(
+    private function getThirdArgumentTokenTuple(
         Tokens $tokens,
         int $openParenthesisIndex,
         int $closeParenthesisIndex
-    ): ?TypeAnalysis {
+    ): array {
         $argumentsAnalyzer = new ArgumentsAnalyzer();
+        $allArguments = $argumentsAnalyzer->getArguments($tokens, $openParenthesisIndex, $closeParenthesisIndex);
+        $thirdArgumentIndex = array_slice($allArguments, 2, 1, true);
 
-        $arguments = $argumentsAnalyzer->getArguments($tokens, $openParenthesisIndex, $closeParenthesisIndex);
-        $argumentIndex = array_slice($arguments, 2, 1, true);
-        $argumentInfo = $argumentsAnalyzer->getArgumentInfo($tokens, key($argumentIndex), reset($argumentIndex));
+        for ($index = key($thirdArgumentIndex); $index <= reset($thirdArgumentIndex); $index++) {
+            /** @var int $index */
+            /** @var Token $token */
+            $token = $tokens[$index];
 
-        return $argumentInfo->getTypeAnalysis();
+            if (!$token->isWhitespace() && !$token->isComment()) {
+                return [$index => $token];
+            }
+        }
+
+        return [];
     }
 
     /**

tests/Fixer/Fixtures/Correct.php.inc

@@ -8,6 +8,10 @@ class Correct
     {
         $queryString1 = http_build_query(['foo' => 'bar'], null, '&');
 
+        $queryString1WithMultipleWhitespaces = http_build_query(['foo' => 'bar'], null,   '&');
+
+        $queryString1WithWhitespacesAndComments = http_build_query(['foo' => 'bar'], null, /* comment */  '&' /* x */);
+
         $queryString1WithComment = http_build_query(['foo' => 'bar'], /* Comment, with commas, */ null ,  '&');
 
         $queryString1WithObject = http_build_query((object) ['foo' => 'bar'], null, '&');