PHP 8.2 | Squiz/ClassComment: allow for readonly classes

Includes improving the accuracy of the tokens to skip over. Includes unit test. Ref: * https://wiki.php.net/rfc/readonly_classes
squizlabs · May 18, 2023 · 81f322e · 81f322e
1 parent 358c476
commit 81f322e
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 7 deletions.
diff --git a/src/Standards/Squiz/Sniffs/Commenting/ClassCommentSniff.php b/src/Standards/Squiz/Sniffs/Commenting/ClassCommentSniff.php
@@ -19,7 +19,6 @@
 
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Sniffs\Sniff;
-use PHP_CodeSniffer\Util\Tokens;
 
 class ClassCommentSniff implements Sniff
 {
@@ -49,8 +48,12 @@ public function register()
     public function process(File $phpcsFile, $stackPtr)
     {
         $tokens = $phpcsFile->getTokens();
-        $find   = Tokens::$methodPrefixes;
-        $find[T_WHITESPACE] = T_WHITESPACE;
+        $find   = [
+            T_ABSTRACT   => T_ABSTRACT,
+            T_FINAL      => T_FINAL,
+            T_READONLY   => T_READONLY,
+            T_WHITESPACE => T_WHITESPACE,
+        ];
 
         $previousContent = null;
         for ($commentEnd = ($stackPtr - 1); $commentEnd >= 0; $commentEnd--) {

diff --git a/src/Standards/Squiz/Tests/Commenting/ClassCommentUnitTest.inc b/src/Standards/Squiz/Tests/Commenting/ClassCommentUnitTest.inc
@@ -131,3 +131,15 @@ class Space_At_end
 class AllGood
 {
 }
+
+/**
+ * Docblock
+ */
+abstract readonly class AbstractReadonlyWithDocblock {}
+
+/*
+ * Docblock
+ */
+readonly class ReadonlyWrongStyle {}
+
+readonly final class ReadonlyFinalWithoutDocblock {}
diff --git a/src/Standards/Squiz/Tests/Commenting/ClassCommentUnitTest.php b/src/Standards/Squiz/Tests/Commenting/ClassCommentUnitTest.php
@@ -26,10 +26,12 @@ class ClassCommentUnitTest extends AbstractSniffUnitTest
     public function getErrorList()
     {
         return [
-            2  => 1,
-            15 => 1,
-            31 => 1,
-            54 => 1,
+            2   => 1,
+            15  => 1,
+            31  => 1,
+            54  => 1,
+            143 => 1,
+            145 => 1,
         ];
 
     }//end getErrorList()
-Original file line number
+Diff line change
@@ Expand Up / @@ -26,10 +26,12 @@ class ClassCommentUnitTest extends AbstractSniffUnitTest @@
         public function getErrorList()
         {
             return [
-=> 1,
-=> 1,
-=> 1,
-=> 1,
+=> 1,
+=> 1,
+=> 1,
+=> 1,
+=> 1,
+=> 1,
             ];
         }//end getErrorList()
@@ Expand Down @@