Avoid multiple loops when fixing whitespace error

Author: fredden

src/Standards/PSR12/Sniffs/Functions/ReturnTypeDeclarationSniff.php

@@ -69,23 +69,24 @@ public function process(File $phpcsFile, int $stackPtr)
 
         if ($tokens[($returnType - 1)]['code'] !== T_WHITESPACE
             || $tokens[($returnType - 1)]['content'] !== ' '
-            || $tokens[($returnType - 2)]['code'] !== T_COLON
+            || ($returnType - 2) !== $colon
         ) {
             $error = 'There must be a single space between the colon and type in a return type declaration';
-            if ($tokens[($returnType - 1)]['code'] === T_WHITESPACE
-                && $tokens[($returnType - 2)]['code'] === T_COLON
-            ) {
-                $fix = $phpcsFile->addFixableError($error, $returnType, 'SpaceBeforeReturnType');
-                if ($fix === true) {
-                    $phpcsFile->fixer->replaceToken(($returnType - 1), ' ');
-                }
-            } elseif ($tokens[($returnType - 1)]['code'] === T_COLON) {
+
+            $nonWhitespaceToken = $phpcsFile->findNext(T_WHITESPACE, ($colon + 1), $returnType, true);
+            if ($nonWhitespaceToken !== false) {
+                $phpcsFile->addError($error, $returnType, 'SpaceBeforeReturnType');
+            } else {
                 $fix = $phpcsFile->addFixableError($error, $returnType, 'SpaceBeforeReturnType');
                 if ($fix === true) {
+                    $phpcsFile->fixer->beginChangeset();
+                    for ($i = ($returnType - 1); $i > $colon; $i--) {
+                        $phpcsFile->fixer->replaceToken($i, '');
+                    }
+
                     $phpcsFile->fixer->addContentBefore($returnType, ' ');
+                    $phpcsFile->fixer->endChangeset();
                 }
-            } else {
-                $phpcsFile->addError($error, $returnType, 'SpaceBeforeReturnType');
             }
         }
 

src/Standards/PSR12/Tests/Functions/ReturnTypeDeclarationUnitTest.1.inc

@@ -64,3 +64,11 @@ function functionName(?string $arg1, ?int &$arg2):
 fn (?\DateTime $arg) : ?\DateTime => $arg;
 
 return (!$a ? [ new class { public function b(): c {} } ] : []);
+
+// This should be fixed in one fixer loop iteration.
+function multipleWhitespaceTokens():
+
+
+
+
+    ?int {}

src/Standards/PSR12/Tests/Functions/ReturnTypeDeclarationUnitTest.1.inc.fixed

@@ -60,3 +60,6 @@ function functionName(?string $arg1, ?int &$arg2): ?string {}
 fn (?\DateTime $arg): ?\DateTime => $arg;
 
 return (!$a ? [ new class { public function b(): c {} } ] : []);
+
+// This should be fixed in one fixer loop iteration.
+function multipleWhitespaceTokens(): ?int {}

src/Standards/PSR12/Tests/Functions/ReturnTypeDeclarationUnitTest.php

@@ -48,6 +48,7 @@ protected function getErrorList($testFile = '')
                     60 => 1,
                     62 => 1,
                     64 => 1,
+                    74 => 1,
                 ];
             default:
                 return [];