BCFile::findImplementedInterfaceNames(): sync with PHPCS 4.0 / handling of namespace relative interfaces

The PHPCS `File::findImplementedInterfaceNames()` method did not handle namespace relative interfaces correctly prior to PHPCS 4.0.

The PHPCSUtils native `ObjectDeclarations::findImplementedInterfaceNames()` method **_did_** already handle this correctly.

This commit adds the PHPCS 4.x version of the `findImplementedInterfaceNames()` method to the `BCFile` class.

Includes moving related tests from the "Diff" test file to the "normal" test file and updating the docs to annotate this is no longer a difference between the PHPCS native and PHPCSUtils versions of the method.

Author: jrfnl

PHPCSUtils/BackCompat/BCFile.php

@@ -965,7 +965,7 @@ public static function findExtendedClassName(File $phpcsFile, $stackPtr)
      *
      * Changelog for the PHPCS native function:
      * - Introduced in PHPCS 2.7.0.
-     * - The upstream method has received no significant updates since PHPCS 3.13.0.
+     * - PHPCS 4.0.0: Handling of the namespace relative parent class using the namespace keyword as operator.
      *
      * @see \PHP_CodeSniffer\Files\File::findImplementedInterfaceNames()          Original source.
      * @see \PHPCSUtils\Utils\ObjectDeclarations::findImplementedInterfaceNames() PHPCSUtils native improved version.
@@ -980,6 +980,44 @@ public static function findExtendedClassName(File $phpcsFile, $stackPtr)
      */
     public static function findImplementedInterfaceNames(File $phpcsFile, $stackPtr)
     {
-        return $phpcsFile->findImplementedInterfaceNames($stackPtr);
+        $tokens = $phpcsFile->getTokens();
+
+        // Check for the existence of the token.
+        if (isset($tokens[$stackPtr]) === false) {
+            return false;
+        }
+
+        if ($tokens[$stackPtr]['code'] !== T_CLASS
+            && $tokens[$stackPtr]['code'] !== T_ANON_CLASS
+            && $tokens[$stackPtr]['code'] !== T_ENUM
+        ) {
+            return false;
+        }
+
+        if (isset($tokens[$stackPtr]['scope_closer']) === false) {
+            return false;
+        }
+
+        $classOpenerIndex = $tokens[$stackPtr]['scope_opener'];
+        $implementsIndex  = $phpcsFile->findNext(T_IMPLEMENTS, $stackPtr, $classOpenerIndex);
+        if ($implementsIndex === false) {
+            return false;
+        }
+
+        $find   = Collections::namespacedNameTokens();
+        $find[] = T_WHITESPACE;
+        $find[] = T_COMMA;
+
+        $end  = $phpcsFile->findNext($find, ($implementsIndex + 1), ($classOpenerIndex + 1), true);
+        $name = $phpcsFile->getTokensAsString(($implementsIndex + 1), ($end - $implementsIndex - 1));
+        $name = trim($name);
+
+        if ($name === '') {
+            return false;
+        } else {
+            $names = explode(',', $name);
+            $names = array_map('trim', $names);
+            return $names;
+        }
     }
 }

PHPCSUtils/Utils/ObjectDeclarations.php

@@ -277,7 +277,6 @@ public static function findExtendedClassName(File $phpcsFile, $stackPtr)
      * - Bugs fixed:
      *   - Handling of PHPCS annotations.
      *   - Handling of comments.
-     *   - Handling of the namespace keyword used as operator.
      * - Improved handling of parse errors.
      * - The returned name(s) will be clean of superfluous whitespace and/or comments.
      * - Support for PHP 8.0 tokenization of identifier/namespaced names, cross-version PHP & PHPCS.

Tests/BackCompat/BCFile/FindImplementedInterfaceNamesTest.inc

@@ -21,6 +21,9 @@ class testFIINNamespacedClass implements \PHP_CodeSniffer\Tests\Core\File\testFI
 /* testImplementsPartiallyQualified */
 class testFIINQualifiedClass implements Core\File\RelativeInterface {}
 
+/* testImplementsMultipleNamespaceRelativeInterfaces */
+class testMultiImplementedNSOperator implements namespace\testInterfaceA, namespace\testInterfaceB {}
+
 /* testClassThatExtendsAndImplements */
 class testFECNClassThatExtendsAndImplements extends testFECNClass implements InterfaceA, \NameSpaced\Cat\InterfaceB {}
 

Tests/BackCompat/BCFile/FindImplementedInterfaceNamesTest.php

@@ -130,6 +130,13 @@ public static function dataImplementedInterface()
                 'identifier' => '/* testImplementsPartiallyQualified */',
                 'expected'   => ['Core\File\RelativeInterface'],
             ],
+            'class implements multiple interfaces, namespace relative' => [
+                'identifier' => '/* testImplementsMultipleNamespaceRelativeInterfaces */',
+                'expected'   => [
+                    'namespace\testInterfaceA',
+                    'namespace\testInterfaceB',
+                ],
+            ],
             'class extends and implements' => [
                 'identifier' => '/* testClassThatExtendsAndImplements */',
                 'expected'   => [

Tests/Utils/ObjectDeclarations/FindImplementedInterfaceNamesDiffTest.inc

@@ -13,8 +13,5 @@ class testDeclarationWithComments
         // comment
         InterfaceB {}
 
-/* testDeclarationMultiImplementedNamespaceOperator */
-class testMultiImplementedNSOperator implements namespace\testInterfaceA, namespace\testInterfaceB {}
-
 /* testMultiImplementedStrayComma */
 class testMultiImplementedStrayComma implements testInterfaceA, , testInterfaceB {} // Intentional parse error.

Tests/Utils/ObjectDeclarations/FindImplementedInterfaceNamesDiffTest.php

@@ -63,13 +63,6 @@ public static function dataFindImplementedInterfaceNames()
                     'InterfaceB',
                 ],
             ],
-            'namespace-operator' => [
-                'testMarker' => '/* testDeclarationMultiImplementedNamespaceOperator */',
-                'expected'   => [
-                    'namespace\testInterfaceA',
-                    'namespace\testInterfaceB',
-                ],
-            ],
             'parse-error-stray-comma' => [
                 'testMarker' => '/* testMultiImplementedStrayComma */',
                 'expected'   => [