Merge pull request #554 from PHPCSStandards/feature/552-generic-uselessoverridingmethod-bugfix-close-tag

Generic/UselessOverridingMethod: improve handling of PHP open/close tags between statements

Author: jrfnl

src/Standards/Generic/Sniffs/CodeAnalysis/UselessOverridingMethodSniff.php

@@ -153,15 +153,20 @@ public function process(File $phpcsFile, $stackPtr)
         }//end for
 
         $next = $phpcsFile->findNext(Tokens::$emptyTokens, ($next + 1), null, true);
-        if ($tokens[$next]['code'] !== T_SEMICOLON) {
+        if ($tokens[$next]['code'] !== T_SEMICOLON && $tokens[$next]['code'] !== T_CLOSE_TAG) {
             return;
         }
 
+        // This list deliberately does not include the `T_OPEN_TAG_WITH_ECHO` as that token implicitly is an echo statement, i.e. content.
+        $nonContent = Tokens::$emptyTokens;
+        $nonContent[T_OPEN_TAG]  = T_OPEN_TAG;
+        $nonContent[T_CLOSE_TAG] = T_CLOSE_TAG;
+
         // Check rest of the scope.
         for (++$next; $next <= $end; ++$next) {
             $code = $tokens[$next]['code'];
             // Skip for any other content.
-            if (isset(Tokens::$emptyTokens[$code]) === false) {
+            if (isset($nonContent[$code]) === false) {
                 return;
             }
         }

src/Standards/Generic/Tests/CodeAnalysis/UselessOverridingMethodUnitTest.1.inc

@@ -148,3 +148,26 @@ function foo() {
         }
     };
 }
+
+class SniffShouldHandlePHPOpenCloseTagsCorrectly {
+    public function thisIsStillAUselessOverride($a, $b) {
+        return parent::thisIsStillAUselessOverride($a, $b) ?><?php
+        // Even with a comment here.
+    }
+
+    public function butNotWithANewLineBetweenThePHPTagsAsThenWeEchoOutTheNewLine($a, $b) {
+        parent::butNotWithANewLineBetweenThePHPTagsAsThenWeEchoOutTheNewLine($a, $b) ?>
+        <?php
+    }
+
+    public function embeddedHTMLAfterCallingParent() {
+        parent::embeddedHTMLAfterCallingParent() ?>
+        <div>HTML</div>
+        <?php
+    }
+
+    public function contentAfterUselessEmbedBlock() {
+        parent::contentAfterUselessEmbedBlock() ?><?php
+        return 1;
+    }
+}

src/Standards/Generic/Tests/CodeAnalysis/UselessOverridingMethodUnitTest.php

@@ -60,6 +60,7 @@ public function getWarningList($testFile='')
                 116 => 1,
                 134 => 1,
                 146 => 1,
+                153 => 1,
             ];
         default:
             return [];