Merge pull request #817 from PHPCSStandards/feature/squiz-validclassname-bug-fix-comment-handling

Squiz/ValidClassName: bug fix - improve comment handling

Author: jrfnl

src/Standards/Squiz/Sniffs/Classes/ValidClassNameSniff.php

@@ -12,6 +12,7 @@
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Sniffs\Sniff;
 use PHP_CodeSniffer\Util\Common;
+use PHP_CodeSniffer\Util\Tokens;
 
 class ValidClassNameSniff implements Sniff
 {
@@ -58,8 +59,8 @@ public function process(File $phpcsFile, $stackPtr)
         // simply look for the first T_STRING because a class name
         // starting with the number will be multiple tokens.
         $opener    = $tokens[$stackPtr]['scope_opener'];
-        $nameStart = $phpcsFile->findNext(T_WHITESPACE, ($stackPtr + 1), $opener, true);
-        $nameEnd   = $phpcsFile->findNext([T_WHITESPACE, T_COLON], $nameStart, $opener);
+        $nameStart = $phpcsFile->findNext(Tokens::$emptyTokens, ($stackPtr + 1), $opener, true);
+        $nameEnd   = $phpcsFile->findNext((Tokens::$emptyTokens + [T_COLON => T_COLON]), $nameStart, $opener);
         if ($nameEnd === false) {
             $name = $tokens[$nameStart]['content'];
         } else {
@@ -75,7 +76,7 @@ public function process(File $phpcsFile, $stackPtr)
                 $type,
                 $name,
             ];
-            $phpcsFile->addError($error, $stackPtr, 'NotCamelCaps', $data);
+            $phpcsFile->addError($error, $nameStart, 'NotCamelCaps', $data);
             $phpcsFile->recordMetric($stackPtr, 'PascalCase class name', 'no');
         } else {
             $phpcsFile->recordMetric($stackPtr, 'PascalCase class name', 'yes');

src/Standards/Squiz/Tests/Classes/ValidClassNameUnitTest.inc

@@ -189,3 +189,13 @@ $foo = new class(
     }
 ) extends DateTime {
 };
+
+class /*comment*/ CommentsShouldBeIgnoredValidName {}
+trait //comment
+    commentsshouldbeignoredInvalidName {}
+interface // phpcs:ignore Stnd.Cat.SniffName -- just testing
+    annotationshouldbeignored_InvalidName {}
+
+class CommentsShouldBeIgnoredValid/*comment*/ {}
+interface annotations_should_be_ignored_InvalidName// phpcs:ignore Stnd.Cat.SniffName -- just testing
+{}

src/Standards/Squiz/Tests/Classes/ValidClassNameUnitTest.php

@@ -57,6 +57,9 @@ public function getErrorList()
             150 => 1,
             151 => 1,
             156 => 1,
+            195 => 1,
+            197 => 1,
+            200 => 1,
         ];
 
     }//end getErrorList()