Merge branch 'hotfix/2411-allow-spaces-after-opening-bracket-control-structures' of https://github.com/webimpress/PHP_CodeSniffer

Author: gsherwood

src/Standards/PSR2/Sniffs/ControlStructures/ControlStructureSpacingSniff.php

@@ -11,6 +11,7 @@
 
 use PHP_CodeSniffer\Sniffs\Sniff;
 use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Util\Tokens;
 
 class ControlStructureSpacingSniff implements Sniff
 {
@@ -75,37 +76,42 @@ public function process(File $phpcsFile, $stackPtr)
             return;
         }
 
-        $parenOpener    = $tokens[$stackPtr]['parenthesis_opener'];
-        $parenCloser    = $tokens[$stackPtr]['parenthesis_closer'];
-        $spaceAfterOpen = 0;
-        if ($tokens[($parenOpener + 1)]['code'] === T_WHITESPACE) {
-            if (strpos($tokens[($parenOpener + 1)]['content'], $phpcsFile->eolChar) !== false) {
-                $spaceAfterOpen = 'newline';
-            } else {
-                $spaceAfterOpen = $tokens[($parenOpener + 1)]['length'];
+        $parenOpener = $tokens[$stackPtr]['parenthesis_opener'];
+        $parenCloser = $tokens[$stackPtr]['parenthesis_closer'];
+        $nextContent = $phpcsFile->findNext(T_WHITESPACE, ($parenOpener + 1), null, true);
+        if (false === in_array($tokens[$nextContent]['code'], Tokens::$commentTokens, true)) {
+            $spaceAfterOpen = 0;
+            if ($tokens[($parenOpener + 1)]['code'] === T_WHITESPACE) {
+                if (strpos($tokens[($parenOpener + 1)]['content'], $phpcsFile->eolChar) !== false) {
+                    $spaceAfterOpen = 'newline';
+                } else {
+                    $spaceAfterOpen = $tokens[($parenOpener + 1)]['length'];
+                }
             }
-        }
 
-        $phpcsFile->recordMetric($stackPtr, 'Spaces after control structure open parenthesis', $spaceAfterOpen);
-
-        if ($spaceAfterOpen !== $this->requiredSpacesAfterOpen) {
-            $error = 'Expected %s spaces after opening bracket; %s found';
-            $data  = [
-                $this->requiredSpacesAfterOpen,
-                $spaceAfterOpen,
-            ];
-            $fix   = $phpcsFile->addFixableError($error, ($parenOpener + 1), 'SpacingAfterOpenBrace', $data);
-            if ($fix === true) {
-                $padding = str_repeat(' ', $this->requiredSpacesAfterOpen);
-                if ($spaceAfterOpen === 0) {
-                    $phpcsFile->fixer->addContent($parenOpener, $padding);
-                } else if ($spaceAfterOpen === 'newline') {
-                    $phpcsFile->fixer->replaceToken(($parenOpener + 1), '');
-                } else {
-                    $phpcsFile->fixer->replaceToken(($parenOpener + 1), $padding);
+            $phpcsFile->recordMetric($stackPtr, 'Spaces after control structure open parenthesis', $spaceAfterOpen);
+
+            if ($spaceAfterOpen !== $this->requiredSpacesAfterOpen) {
+                $error = 'Expected %s spaces after opening bracket; %s found';
+                $data  = [
+                    $this->requiredSpacesAfterOpen,
+                    $spaceAfterOpen,
+                ];
+                $fix   = $phpcsFile->addFixableError($error, ($parenOpener + 1), 'SpacingAfterOpenBrace', $data);
+                if ($fix === true) {
+                    $padding = str_repeat(' ', $this->requiredSpacesAfterOpen);
+                    if ($spaceAfterOpen === 0) {
+                        $phpcsFile->fixer->addContent($parenOpener, $padding);
+                    } else {
+                        if ($spaceAfterOpen === 'newline') {
+                            $phpcsFile->fixer->replaceToken(($parenOpener + 1), '');
+                        } else {
+                            $phpcsFile->fixer->replaceToken(($parenOpener + 1), $padding);
+                        }
+                    }
                 }
             }
-        }
+        }//end if
 
         if ($tokens[$parenOpener]['line'] === $tokens[$parenCloser]['line']) {
             $spaceBeforeClose = 0;

src/Standards/PSR2/Tests/ControlStructures/ControlStructureSpacingUnitTest.inc

@@ -36,6 +36,16 @@ if (
     $settingsUpdated = FALSE;
 }
 
+if ( // comment
+    $something
+) {
+}
+
+while ( /* comment */
+    true
+) {
+}
+
 // phpcs:set PSR2.ControlStructures.ControlStructureSpacing requiredSpacesAfterOpen 1
 // phpcs:set PSR2.ControlStructures.ControlStructureSpacing requiredSpacesBeforeClose 1
 foreach ($something as $blah => $that) {}

src/Standards/PSR2/Tests/ControlStructures/ControlStructureSpacingUnitTest.inc.fixed

@@ -35,6 +35,16 @@ if ($defaultPageDesign === 0
     $settingsUpdated = FALSE;
 }
 
+if ( // comment
+    $something
+) {
+}
+
+while ( /* comment */
+    true
+) {
+}
+
 // phpcs:set PSR2.ControlStructures.ControlStructureSpacing requiredSpacesAfterOpen 1
 // phpcs:set PSR2.ControlStructures.ControlStructureSpacing requiredSpacesBeforeClose 1
 foreach ( $something as $blah => $that ) {}

src/Standards/PSR2/Tests/ControlStructures/ControlStructureSpacingUnitTest.php

@@ -31,8 +31,8 @@ public function getErrorList()
             26 => 2,
             27 => 2,
             31 => 1,
-            41 => 2,
-            43 => 2,
+            51 => 2,
+            53 => 2,
         ];
 
     }//end getErrorList()