Fixed bug #778 : PHPCBF creates invalid PHP for inline FOREACH containing multiple control structures

Author: gsherwood

CodeSniffer/Standards/Generic/Sniffs/ControlStructures/InlineControlStructureSniff.php

@@ -161,14 +161,38 @@ public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
                 }
 
                 if (isset($tokens[$end]['scope_opener']) === true) {
-                    $end = $tokens[$end]['scope_closer'];
+                    $type = $tokens[$end]['code'];
+                    $end  = $tokens[$end]['scope_closer'];
+                    if ($type === T_DO || $type === T_IF || $type === T_ELSEIF) {
+                        $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($end + 1), null, true);
+                        if ($next === false) {
+                            break;
+                        }
+
+                        $nextType = $tokens[$next]['code'];
+
+                        // Let additional conditions loop and find their ending.
+                        if (($type === T_IF
+                            || $type === T_ELSEIF)
+                            && ($nextType === T_ELSEIF
+                            || $nextType === T_ELSE)
+                        ) {
+                            continue;
+                        }
+
+                        // Account for DO... WHILE conditions.
+                        if ($type === T_DO && $nextType === T_WHILE) {
+                            $end = $phpcsFile->findNext(T_SEMICOLON, ($next + 1));
+                        }
+                    }//end if
+
                     break;
-                }
+                }//end if
 
                 if ($tokens[$end]['code'] !== T_WHITESPACE) {
                     $lastNonEmpty = $end;
                 }
-            }
+            }//end for
 
             $next = $phpcsFile->findNext(T_WHITESPACE, ($closer + 1), ($end + 1), true);
 

CodeSniffer/Standards/Generic/Tests/ControlStructures/InlineControlStructureUnitTest.inc

@@ -115,3 +115,26 @@ switch($response = \Bar::baz('bat', function ($foo) {
     case 2:
         return 'other';
 }
+
+$stuff = [1,2,3];
+foreach($stuff as $num)
+    if ($num %2 ) {
+        echo "even";
+    } else {
+        echo "odd";
+    }
+
+$i = 0;
+foreach($stuff as $num)
+    do {
+        echo $i;
+        $i++;
+    } while ($i < 5);
+
+foreach($stuff as $num)
+    if (true) {
+        echo "true1\n";
+    }
+    if (true) {
+        echo "true2\n";
+    }

CodeSniffer/Standards/Generic/Tests/ControlStructures/InlineControlStructureUnitTest.inc.fixed

@@ -116,3 +116,26 @@ switch($response = \Bar::baz('bat', function ($foo) {
     case 2:
         return 'other';
 }
+
+$stuff = [1,2,3];
+foreach($stuff as $num) {
+    if ($num %2 ) {
+        echo "even";
+    } else {
+        echo "odd";
+    } }
+
+$i = 0;
+foreach($stuff as $num) {
+    do {
+        echo $i;
+        $i++;
+    } while ($i < 5); }
+
+foreach($stuff as $num) {
+    if (true) {
+        echo "true1\n";
+    } }
+    if (true) {
+        echo "true2\n";
+    }

CodeSniffer/Standards/Generic/Tests/ControlStructures/InlineControlStructureUnitTest.php

@@ -47,21 +47,24 @@ public function getErrorList($testFile='InlineControlStructureUnitTest.inc')
         switch ($testFile) {
         case 'InlineControlStructureUnitTest.inc':
             return array(
-                    3  => 1,
-                    7  => 1,
-                    11 => 1,
-                    13 => 1,
-                    15 => 1,
-                    17 => 1,
-                    23 => 1,
-                    42 => 1,
-                    43 => 1,
-                    45 => 1,
-                    46 => 1,
-                    49 => 1,
-                    62 => 1,
-                    66 => 1,
-                    78 => 1,
+                    3   => 1,
+                    7   => 1,
+                    11  => 1,
+                    13  => 1,
+                    15  => 1,
+                    17  => 1,
+                    23  => 1,
+                    42  => 1,
+                    43  => 1,
+                    45  => 1,
+                    46  => 1,
+                    49  => 1,
+                    62  => 1,
+                    66  => 1,
+                    78  => 1,
+                    120 => 1,
+                    128 => 1,
+                    134 => 1,
                    );
             break;
         case 'InlineControlStructureUnitTest.js':

package.xml

@@ -73,6 +73,7 @@ http://pear.php.net/dtd/package-2.0.xsd">
   - Fixed bug #769 : Incorrect detection of variable reference operator when used with short array syntax
     -- Thanks to Klaus Purer for the patch
   - Fixed bug #772 : Syntax error when using PHPCBF on alternative style foreach loops
+  - Fixed bug #778 : PHPCBF creates invalid PHP for inline FOREACH containing multiple control structures
   - Fixed bug #781 : Incorrect checking for PHP7 return types on multi-line function declartions
   - Fixed bug #782 : Conditional function declarations cause fixing conflicts in Squiz standard
     -- Squiz.ControlStructures.ControlSignature no longer enforces a single newline after open brace