Added attibute support

Author: gsherwood

package.xml

@@ -1059,7 +1059,8 @@ http://pear.php.net/dtd/package-2.0.xsd">
        <dir name="Commenting">
         <file baseinstalldir="PHP/CodeSniffer" name="ClassCommentUnitTest.inc" role="test" />
         <file baseinstalldir="PHP/CodeSniffer" name="ClassCommentUnitTest.php" role="test" />
-        <file baseinstalldir="PHP/CodeSniffer" name="FileCommentUnitTest.inc" role="test" />
+        <file baseinstalldir="PHP/CodeSniffer" name="FileCommentUnitTest.1.inc" role="test" />
+        <file baseinstalldir="PHP/CodeSniffer" name="FileCommentUnitTest.2.inc" role="test" />
         <file baseinstalldir="PHP/CodeSniffer" name="FileCommentUnitTest.php" role="test" />
         <file baseinstalldir="PHP/CodeSniffer" name="FunctionCommentUnitTest.inc" role="test" />
         <file baseinstalldir="PHP/CodeSniffer" name="FunctionCommentUnitTest.inc.fixed" role="test" />

src/Standards/PEAR/Sniffs/Commenting/FileCommentSniff.php

@@ -138,12 +138,24 @@ public function process(File $phpcsFile, $stackPtr)
 
         $commentEnd = $tokens[$commentStart]['comment_closer'];
 
-        $nextToken = $phpcsFile->findNext(
-            T_WHITESPACE,
-            ($commentEnd + 1),
-            null,
-            true
-        );
+        for ($nextToken = ($commentEnd + 1); $nextToken < $phpcsFile->numTokens; $nextToken++) {
+            if ($tokens[$nextToken]['code'] === T_WHITESPACE) {
+                continue;
+            }
+
+            if ($tokens[$nextToken]['code'] === T_ATTRIBUTE
+                && isset($tokens[$nextToken]['attribute_closer']) === true
+            ) {
+                $nextToken = $tokens[$nextToken]['attribute_closer'];
+                continue;
+            }
+
+            break;
+        }
+
+        if ($nextToken === $phpcsFile->numTokens) {
+            $nextToken--;
+        }
 
         $ignore = [
             T_CLASS,

src/Standards/PEAR/Tests/Commenting/FileCommentUnitTest.inc renamed to src/Standards/PEAR/Tests/Commenting/FileCommentUnitTest.1.inc

@@ -0,0 +1,9 @@
+<?php
+
+/**
+ * Shows open tasks for admins
+ */
+#[Authenticate('admin_logged_in')]
+class TodoController extends AbstractController implements MustBeLoggedInInterface
+{
+}

src/Standards/PEAR/Tests/Commenting/FileCommentUnitTest.2.inc

@@ -21,27 +21,38 @@ class FileCommentUnitTest extends AbstractSniffUnitTest
      * The key of the array should represent the line number and the value
      * should represent the number of errors that should occur on that line.
      *
+     * @param string $testFile The name of the file being tested.
+     *
      * @return array<int, int>
      */
-    public function getErrorList()
+    public function getErrorList($testFile='FileCommentUnitTest.inc')
     {
-        return [
-            21 => 1,
-            23 => 2,
-            24 => 1,
-            26 => 1,
-            28 => 1,
-            29 => 1,
-            30 => 1,
-            31 => 1,
-            32 => 2,
-            33 => 1,
-            34 => 1,
-            35 => 1,
-            40 => 2,
-            41 => 2,
-            43 => 1,
-        ];
+        switch ($testFile) {
+        case 'FileCommentUnitTest.1.inc':
+            return [
+                21 => 1,
+                23 => 2,
+                24 => 1,
+                26 => 1,
+                28 => 1,
+                29 => 1,
+                30 => 1,
+                31 => 1,
+                32 => 2,
+                33 => 1,
+                34 => 1,
+                35 => 1,
+                40 => 2,
+                41 => 2,
+                43 => 1,
+            ];
+
+        case 'FileCommentUnitTest.2.inc':
+            return [1 => 1];
+
+        default:
+            return [];
+        }//end switch
 
     }//end getErrorList()
 
@@ -52,16 +63,24 @@ public function getErrorList()
      * The key of the array should represent the line number and the value
      * should represent the number of warnings that should occur on that line.
      *
+     * @param string $testFile The name of the file being tested.
+     *
      * @return array<int, int>
      */
-    public function getWarningList()
+    public function getWarningList($testFile='FileCommentUnitTest.inc')
     {
-        return [
-            29 => 1,
-            30 => 1,
-            34 => 1,
-            43 => 1,
-        ];
+        switch ($testFile) {
+        case 'FileCommentUnitTest.1.inc':
+            return [
+                29 => 1,
+                30 => 1,
+                34 => 1,
+                43 => 1,
+            ];
+
+        default:
+            return [];
+        }//end switch
 
     }//end getWarningList()