Fixed bug squizlabs#1932 : Generic.ControlStructures.InlineControlStructure fixer moves new PHPCS annotations

Author: gsherwood

package.xml

@@ -129,6 +129,7 @@ http://pear.php.net/dtd/package-2.0.xsd">
   - Fixed bug #1922 : Equal sign alignment check broken when list syntax used before assignment operator
   - Fixed bug #1925 : Generic.Formatting.MultipleStatementAlignment skipping assignments within closures
   - Fixed bug #1931 : Generic opening brace placement sniffs do not correctly support function return types
+  - Fixed bug #1932 : Generic.ControlStructures.InlineControlStructure fixer moves new PHPCS annotations
   - Fixed bug #1938 : Generic opening brace placement sniffs incorrectly move PHPCS annotations
     -- Thanks to Juliette Reinders Folmer for the patch
   - Fixed bug #1939 : phpcs:set annotations do not cause the line they are on to be ignored

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

@@ -215,30 +215,34 @@ public function process(File $phpcsFile, $stackPtr)
             $end = $lastNonEmpty;
         }
 
-        $next = $phpcsFile->findNext(Tokens::$emptyTokens, ($end + 1), null, true);
-
-        if ($next === false || $tokens[$next]['line'] !== $tokens[$end]['line']) {
+        $nextContent = $phpcsFile->findNext(Tokens::$emptyTokens, ($end + 1), null, true);
+        if ($nextContent === false || $tokens[$nextContent]['line'] !== $tokens[$end]['line']) {
             // Looks for completely empty statements.
             $next = $phpcsFile->findNext(T_WHITESPACE, ($closer + 1), ($end + 1), true);
-
-            // Account for a comment on the end of the line.
-            for ($endLine = $end; $endLine < $phpcsFile->numTokens; $endLine++) {
-                if (isset($tokens[($endLine + 1)]) === false
-                    || $tokens[$endLine]['line'] !== $tokens[($endLine + 1)]['line']
-                ) {
-                    break;
-                }
-            }
-
-            if ($tokens[$endLine]['code'] !== T_COMMENT) {
-                $endLine = $end;
-            }
         } else {
             $next    = ($end + 1);
             $endLine = $end;
         }
 
         if ($next !== $end) {
+            if ($nextContent === false || $tokens[$nextContent]['line'] !== $tokens[$end]['line']) {
+                // Account for a comment on the end of the line.
+                for ($endLine = $end; $endLine < $phpcsFile->numTokens; $endLine++) {
+                    if (isset($tokens[($endLine + 1)]) === false
+                        || $tokens[$endLine]['line'] !== $tokens[($endLine + 1)]['line']
+                    ) {
+                        break;
+                    }
+                }
+
+                if (isset(Tokens::$commentTokens[$tokens[$endLine]['code']]) === false
+                    && ($tokens[$endLine]['code'] !== T_WHITESPACE
+                    || isset(Tokens::$commentTokens[$tokens[($endLine - 1)]['code']]) === false)
+                ) {
+                    $endLine = $end;
+                }
+            }
+
             if ($endLine !== $end) {
                 $endToken     = $endLine;
                 $addedContent = '';
@@ -262,9 +266,7 @@ public function process(File $phpcsFile, $stackPtr)
             } else {
                 $indent = '';
                 for ($first = $stackPtr; $first > 0; $first--) {
-                    if ($first === 1
-                        || $tokens[($first - 1)]['line'] !== $tokens[$first]['line']
-                    ) {
+                    if ($tokens[$first]['column'] === 1) {
                         break;
                     }
                 }
@@ -285,6 +287,24 @@ public function process(File $phpcsFile, $stackPtr)
                 $phpcsFile->fixer->addContent($endToken, $addedContent);
             }//end if
         } else {
+            if ($nextContent === false || $tokens[$nextContent]['line'] !== $tokens[$end]['line']) {
+                // Account for a comment on the end of the line.
+                for ($endLine = $end; $endLine < $phpcsFile->numTokens; $endLine++) {
+                    if (isset($tokens[($endLine + 1)]) === false
+                        || $tokens[$endLine]['line'] !== $tokens[($endLine + 1)]['line']
+                    ) {
+                        break;
+                    }
+                }
+
+                if ($tokens[$endLine]['code'] !== T_COMMENT
+                    && ($tokens[$endLine]['code'] !== T_WHITESPACE
+                    || $tokens[($endLine - 1)]['code'] !== T_COMMENT)
+                ) {
+                    $endLine = $end;
+                }
+            }
+
             if ($endLine !== $end) {
                 $phpcsFile->fixer->replaceToken($end, '');
                 $phpcsFile->fixer->addNewlineBefore($endLine);

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

@@ -222,3 +222,16 @@ if ($this) {
     if ($that)
         foo(${$a[$b]});
 }
+
+while (!$this->readLine($tokens, $tag)); //phpcs:ignore Standard.Category.Sniff
+
+while (!$this->readLine($tokens, $tag)); // comment
+
+while (!$this->readLine($tokens, $tag)); /* comment */
+
+foreach ($stringParade as $hit)
+    $hitParade[] = $hit + 0; // phpcs:ignore Standard.Category.Sniff
+
+if ($bar)
+    if ($foo) echo 'hi'; /* @phpcs:ignore Standard.Category.Sniff */
+

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

@@ -253,3 +253,19 @@ if ($this) {
         foo(${$a[$b]});
     }
 }
+
+while (!$this->readLine($tokens, $tag)) {} //phpcs:ignore Standard.Category.Sniff
+
+while (!$this->readLine($tokens, $tag)) { 
+// comment
+}
+while (!$this->readLine($tokens, $tag)) { /* comment */
+
+}
+foreach ($stringParade as $hit) {
+    $hitParade[] = $hit + 0; // phpcs:ignore Standard.Category.Sniff
+}
+if ($bar) {
+    if ($foo) { echo 'hi'; /* @phpcs:ignore Standard.Category.Sniff */
+    }
+}

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

@@ -68,6 +68,12 @@ public function getErrorList($testFile='InlineControlStructureUnitTest.inc')
                 198 => 1,
                 206 => 1,
                 222 => 1,
+                226 => 1,
+                228 => 1,
+                230 => 1,
+                232 => 1,
+                235 => 1,
+                236 => 1,
             ];
             break;
         case 'InlineControlStructureUnitTest.js':