Generic/DuplicateClassName: bug fix - ignore comments in namespace declarations

A comment in a namespace declaration statement would throw the sniff off, leading to false positives and false negatives.

Fixed now.

Includes unit tests. Additionally, a unit test for classes declared within a scoped global namespace has also been added.

Author: jrfnl

src/Standards/Generic/Sniffs/Classes/DuplicateClassNameSniff.php

@@ -71,19 +71,24 @@ public function process(File $phpcsFile, $stackPtr)
             if ($tokens[$stackPtr]['code'] === T_NAMESPACE) {
                 $nextNonEmpty = $phpcsFile->findNext(Tokens::$emptyTokens, ($stackPtr + 1), null, true);
                 if ($nextNonEmpty !== false) {
-                    $find   = Tokens::$emptyTokens;
-                    $find[] = T_STRING;
-                    $find[] = T_NAME_QUALIFIED;
-
-                    $nsEnd = $phpcsFile->findNext(
-                        $find,
-                        ($stackPtr + 1),
-                        null,
-                        true
-                    );
-
-                    $namespace = trim($phpcsFile->getTokensAsString(($stackPtr + 1), ($nsEnd - $stackPtr - 1)));
-                    $stackPtr  = $nsEnd;
+                    $namespace = '';
+                    for ($i = $nextNonEmpty; $i < $phpcsFile->numTokens; $i++) {
+                        if (isset(Tokens::$emptyTokens[$tokens[$i]['code']]) === true) {
+                            continue;
+                        }
+
+                        if ($tokens[$i]['code'] !== T_NAME_QUALIFIED
+                            // Allow for pre-PHP 8.0 style declarations containing comments and whitespace.
+                            && $tokens[$i]['code'] !== T_STRING
+                            && $tokens[$i]['code'] !== T_NS_SEPARATOR
+                        ) {
+                            break;
+                        }
+
+                        $namespace .= $tokens[$i]['content'];
+                    }
+
+                    $stackPtr = $i;
                 }
             } else {
                 $nameToken = $phpcsFile->findNext(T_STRING, $stackPtr);

src/Standards/Generic/Tests/Classes/DuplicateClassNameUnitTest.7.inc

@@ -7,3 +7,7 @@ interface YourInterface {}
 namespace F;
 namespace\functionCall();
 class MyClass {}
+
+namespace /*comment*/ G;
+namespace\functionCall();
+class MyClass {}

src/Standards/Generic/Tests/Classes/DuplicateClassNameUnitTest.8.inc

@@ -0,0 +1,8 @@
+<?php
+namespace Foo\Bar;
+class MyClass {}
+interface YourInterface {}
+
+namespace Foo /*comment*/ \ /*comment*/ Bar;
+class MyClass {}
+interface YourInterface {}

src/Standards/Generic/Tests/Classes/DuplicateClassNameUnitTest.9.inc

@@ -0,0 +1,5 @@
+<?php
+namespace {
+	class MyClass {}
+	trait YourTrait {}
+}

src/Standards/Generic/Tests/Classes/DuplicateClassNameUnitTest.php

@@ -73,6 +73,18 @@ public function getWarningList($testFile='')
         case 'DuplicateClassNameUnitTest.6.inc':
             return [10 => 1];
 
+        case 'DuplicateClassNameUnitTest.8.inc':
+            return [
+                7 => 1,
+                8 => 1,
+            ];
+
+        case 'DuplicateClassNameUnitTest.9.inc':
+            return [
+                3 => 1,
+                4 => 1,
+            ];
+
         default:
             return [];
         }//end switch