Merge pull request #916 from PHPCSStandards/feature/tokenizer-php-goto-is-terminating-statement

Tokenizer/PHP: goto is a switch case/default terminating statement

Author: jrfnl

src/Files/File.php

@@ -2558,6 +2558,7 @@ public function findStartOfStatement($start, $ignore=null)
                 && $this->tokens[$i]['code'] !== T_CONTINUE
                 && $this->tokens[$i]['code'] !== T_THROW
                 && $this->tokens[$i]['code'] !== T_EXIT
+                && $this->tokens[$i]['code'] !== T_GOTO
             ) {
                 // Found the end of the previous scope block.
                 return $lastNotEmpty;

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

@@ -380,6 +380,7 @@ private function findNestedTerminator($phpcsFile, $stackPtr, $end)
                 T_CONTINUE => T_CONTINUE,
                 T_THROW    => T_THROW,
                 T_EXIT     => T_EXIT,
+                T_GOTO     => T_GOTO,
             ];
 
             $terminator = $phpcsFile->findStartOfStatement(($lastToken - 1));

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

@@ -596,3 +596,16 @@ switch (rand()) {
     default:
         break;
 }
+
+// Fix: goto should be recognized as terminating statement.
+switch ( $a ) {
+    case 1:
+        doSomething();
+        goto jumpOut;
+    default:
+        $other = $code;
+        break;
+}
+
+jumpOut:
+doSomething();

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

@@ -591,3 +591,16 @@ switch (rand()) {
     default:
         break;
 }
+
+// Fix: goto should be recognized as terminating statement.
+switch ( $a ) {
+    case 1:
+        doSomething();
+        goto jumpOut;
+    default:
+        $other = $code;
+        break;
+}
+
+jumpOut:
+doSomething();

src/Standards/Squiz/Sniffs/ControlStructures/SwitchDeclarationSniff.php

@@ -153,6 +153,7 @@ public function process(File $phpcsFile, $stackPtr)
                 || $tokens[$nextBreak]['code'] === T_CONTINUE
                 || $tokens[$nextBreak]['code'] === T_THROW
                 || $tokens[$nextBreak]['code'] === T_EXIT
+                || $tokens[$nextBreak]['code'] === T_GOTO
             ) {
                 if ($tokens[$nextBreak]['scope_condition'] === $nextCase) {
                     // Only need to check a couple of things once, even if the

src/Standards/Squiz/Tests/ControlStructures/SwitchDeclarationUnitTest.inc

@@ -331,3 +331,16 @@ $foo = $foo ?
         }
     } :
     null;
+
+// Fix: goto should be recognized as terminating statement.
+switch ( $a ) {
+    case 1:
+        doSomething();
+        goto jumpOut;
+    default:
+        $other = $code;
+        goto jumpOut;
+}
+
+jumpOut:
+doSomething();

src/Standards/Squiz/Tests/ControlStructures/SwitchDeclarationUnitTest.inc.fixed

@@ -340,3 +340,17 @@ $foo = $foo ?
         }
     } :
     null;
+
+// Fix: goto should be recognized as terminating statement.
+switch ( $a ) {
+    case 1:
+        doSomething();
+    goto jumpOut;
+
+    default:
+        $other = $code;
+    goto jumpOut;
+}
+
+jumpOut:
+doSomething();

src/Standards/Squiz/Tests/ControlStructures/SwitchDeclarationUnitTest.php

@@ -80,6 +80,8 @@ public function getErrorList($testFile='')
                 327 => 1,
                 329 => 1,
                 330 => 1,
+                339 => 2,
+                342 => 1,
             ];
 
         case 'SwitchDeclarationUnitTest.js':

src/Tokenizers/PHP.php

@@ -231,6 +231,7 @@ class PHP extends Tokenizer
                 T_CONTINUE => T_CONTINUE,
                 T_THROW    => T_THROW,
                 T_EXIT     => T_EXIT,
+                T_GOTO     => T_GOTO,
             ],
             'strict' => true,
             'shared' => true,
@@ -251,6 +252,7 @@ class PHP extends Tokenizer
                 T_CONTINUE => T_CONTINUE,
                 T_THROW    => T_THROW,
                 T_EXIT     => T_EXIT,
+                T_GOTO     => T_GOTO,
             ],
             'strict' => true,
             'shared' => true,

tests/Core/File/FindStartOfStatementTest.inc

@@ -157,12 +157,20 @@ switch ($foo) {
         /* testInsideCaseThrowStatement */
         throw new Exception();
 
+    case 6:
+        $var = doSomething();
+        /* testInsideCaseGotoStatement */
+        goto myLabel;
+
     /* testDefaultStatement */
     default:
         /* testInsideDefaultContinueStatement */
         continue $var;
 }
 
+myLabel:
+do_something();
+
 match ($var) {
     true =>
         /* test437ClosureDeclaration */