Merge pull request #620 from fredden/feature/fixer-conflict/PSR12/Squiz.Functions.FunctionDeclarationArgumentSpacing

Fix fixer conflict: `PSR12` / `Squiz.Functions.FunctionDeclarationArgumentSpacing`

Author: jrfnl

src/Standards/Squiz/Sniffs/Functions/FunctionDeclarationArgumentSpacingSniff.php

@@ -11,6 +11,7 @@
 
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Sniffs\Sniff;
+use PHP_CodeSniffer\Util\Common;
 use PHP_CodeSniffer\Util\Tokens;
 
 class FunctionDeclarationArgumentSpacingSniff implements Sniff
@@ -235,26 +236,37 @@ public function processBracket($phpcsFile, $openBracket)
             if ($param['type_hint_token'] !== false) {
                 $typeHintToken = $param['type_hint_end_token'];
 
-                $gap = 0;
-                if ($tokens[($typeHintToken + 1)]['code'] === T_WHITESPACE) {
-                    $gap = $tokens[($typeHintToken + 1)]['length'];
+                $gap = '';
+                $i   = $typeHintToken;
+                while ($tokens[++$i]['code'] === T_WHITESPACE) {
+                    $gap .= $tokens[$i]['content'];
                 }
 
-                if ($gap !== 1) {
+                if ($gap !== ' ') {
                     $error = 'Expected 1 space between type hint and argument "%s"; %s found';
                     $data  = [
                         $param['name'],
-                        $gap,
                     ];
-                    $fix   = $phpcsFile->addFixableError($error, $typeHintToken, 'SpacingAfterHint', $data);
+                    if (trim($gap, ' ') === '') {
+                        // Gap contains only space characters: report the number of spaces.
+                        $data[] = strlen($gap);
+                    } else {
+                        // Gap contains more than just spaces: render these for better clarity.
+                        $data[] = '"'.Common::prepareForOutput($gap).'"';
+                    }
+
+                    $fix = $phpcsFile->addFixableError($error, $typeHintToken, 'SpacingAfterHint', $data);
                     if ($fix === true) {
-                        if ($gap === 0) {
-                            $phpcsFile->fixer->addContent($typeHintToken, ' ');
-                        } else {
-                            $phpcsFile->fixer->replaceToken(($typeHintToken + 1), ' ');
+                        $phpcsFile->fixer->beginChangeset();
+                        $phpcsFile->fixer->addContent($typeHintToken, ' ');
+
+                        for ($i = ($typeHintToken + 1); $tokens[$i]['code'] === T_WHITESPACE; $i++) {
+                            $phpcsFile->fixer->replaceToken($i, '');
                         }
+
+                        $phpcsFile->fixer->endChangeset();
                     }
-                }
+                }//end if
             }//end if
 
             $commaToken = false;

src/Standards/Squiz/Tests/Functions/FunctionDeclarationArgumentSpacingUnitTest.inc

@@ -109,3 +109,7 @@ $a = function ($var1, $var2=false) use (
 ) {};
 
 fn ($a,$b = null) => $a($b);
+
+function multipleWhitespaceTokensAfterType(int
+
+    $number) {}

src/Standards/Squiz/Tests/Functions/FunctionDeclarationArgumentSpacingUnitTest.inc.fixed

@@ -109,3 +109,5 @@ $a = function ($var1, $var2=false) use (
 ) {};
 
 fn ($a, $b=null) => $a($b);
+
+function multipleWhitespaceTokensAfterType(int $number) {}

src/Standards/Squiz/Tests/Functions/FunctionDeclarationArgumentSpacingUnitTest.php

@@ -68,6 +68,7 @@ public function getErrorList()
             106 => 1,
             107 => 2,
             111 => 3,
+            113 => 1,
         ];
 
     }//end getErrorList()