PHP 8.1: Added enum support to sniffs

package.xml

@@ -1012,6 +1012,7 @@ http://pear.php.net/dtd/package-2.0.xsd">
         <file baseinstalldir="PHP/CodeSniffer" name="ClassCommentUnitTest.php" 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.3.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" />
@@ -1100,6 +1101,7 @@ http://pear.php.net/dtd/package-2.0.xsd">
        <dir name="Classes">
         <file baseinstalldir="PHP/CodeSniffer" name="ClassDeclarationUnitTest.1.inc" role="test" />
         <file baseinstalldir="PHP/CodeSniffer" name="ClassDeclarationUnitTest.2.inc" role="test" />
+        <file baseinstalldir="PHP/CodeSniffer" name="ClassDeclarationUnitTest.3.inc" role="test" />
         <file baseinstalldir="PHP/CodeSniffer" name="ClassDeclarationUnitTest.php" role="test" />
        </dir>
        <dir name="Files">
@@ -1651,6 +1653,7 @@ http://pear.php.net/dtd/package-2.0.xsd">
         <file baseinstalldir="PHP/CodeSniffer" name="FileCommentUnitTest.6.inc" role="test" />
         <file baseinstalldir="PHP/CodeSniffer" name="FileCommentUnitTest.7.inc" role="test" />
         <file baseinstalldir="PHP/CodeSniffer" name="FileCommentUnitTest.8.inc" role="test" />
+        <file baseinstalldir="PHP/CodeSniffer" name="FileCommentUnitTest.9.inc" role="test" />
         <file baseinstalldir="PHP/CodeSniffer" name="FileCommentUnitTest.1.js" role="test" />
         <file baseinstalldir="PHP/CodeSniffer" name="FileCommentUnitTest.1.js.fixed" role="test" />
         <file baseinstalldir="PHP/CodeSniffer" name="FileCommentUnitTest.2.js" role="test" />
@@ -1768,6 +1771,7 @@ http://pear.php.net/dtd/package-2.0.xsd">
         <file baseinstalldir="PHP/CodeSniffer" name="FileExtensionUnitTest.2.inc" role="test" />
         <file baseinstalldir="PHP/CodeSniffer" name="FileExtensionUnitTest.3.inc" role="test" />
         <file baseinstalldir="PHP/CodeSniffer" name="FileExtensionUnitTest.4.inc" role="test" />
+        <file baseinstalldir="PHP/CodeSniffer" name="FileExtensionUnitTest.5.inc" role="test" />
         <file baseinstalldir="PHP/CodeSniffer" name="FileExtensionUnitTest.php" role="test" />
        </dir>
        <dir name="Formatting">

src/Files/File.php

@@ -1223,7 +1223,7 @@ public function getFilename()
 
 
     /**
-     * Returns the declaration names for classes, interfaces, traits, and functions.
+     * Returns the declaration name for classes, interfaces, traits, enums, and functions.
      *
      * @param int $stackPtr The position of the declaration token which
      *                      declared the class, interface, trait, or function.
@@ -1232,7 +1232,7 @@ public function getFilename()
      *                     or NULL if the function or class is anonymous.
      * @throws \PHP_CodeSniffer\Exceptions\RuntimeException If the specified token is not of type
      *                                                      T_FUNCTION, T_CLASS, T_ANON_CLASS,
-     *                                                      T_CLOSURE, T_TRAIT, or T_INTERFACE.
+     *                                                      T_CLOSURE, T_TRAIT, T_ENUM, or T_INTERFACE.
      */
     public function getDeclarationName($stackPtr)
     {
@@ -1246,8 +1246,9 @@ public function getDeclarationName($stackPtr)
             && $tokenCode !== T_CLASS
             && $tokenCode !== T_INTERFACE
             && $tokenCode !== T_TRAIT
+            && $tokenCode !== T_ENUM
         ) {
-            throw new RuntimeException('Token type "'.$this->tokens[$stackPtr]['type'].'" is not T_FUNCTION, T_CLASS, T_INTERFACE or T_TRAIT');
+            throw new RuntimeException('Token type "'.$this->tokens[$stackPtr]['type'].'" is not T_FUNCTION, T_CLASS, T_INTERFACE, T_TRAIT or T_ENUM');
         }
 
         if ($tokenCode === T_FUNCTION

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

@@ -53,6 +53,7 @@ public function process(File $phpcsFile, $stackPtr)
             T_CLASS,
             T_INTERFACE,
             T_TRAIT,
+            T_ENUM,
             T_NAMESPACE,
             T_CLOSE_TAG,
         ];

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

@@ -27,6 +27,7 @@ public function register()
             T_CLASS,
             T_INTERFACE,
             T_TRAIT,
+            T_ENUM,
         ];
 
     }//end register()

src/Standards/Generic/Sniffs/Files/OneObjectStructurePerFileSniff.php

@@ -27,6 +27,7 @@ public function register()
             T_CLASS,
             T_INTERFACE,
             T_TRAIT,
+            T_ENUM,
         ];
 
     }//end register()

src/Standards/Generic/Sniffs/PHP/LowerCaseKeywordSniff.php

@@ -50,6 +50,7 @@ public function register()
             T_ENDIF,
             T_ENDSWITCH,
             T_ENDWHILE,
+            T_ENUM,
             T_EVAL,
             T_EXIT,
             T_EXTENDS,

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

@@ -5,7 +5,10 @@ interface MyInterface {}
 interface YourInterface {}
 trait MyTrait {}
 trait YourTrait {}
+enum MyEnum {}
+enum YourEnum {}
 class MyClass {}
 interface MyInterface {}
 trait MyTrait {}
-?>
+enum MyEnum {}
+?>

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

@@ -2,4 +2,5 @@
 class MyClass {}
 interface MyInterface {}
 trait MyTrait {}
+enum MyEnum {}
 ?>

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

@@ -45,16 +45,18 @@ public function getWarningList($testFile='')
         switch ($testFile) {
         case 'DuplicateClassNameUnitTest.1.inc':
             return [
-                8  => 1,
-                9  => 1,
                 10 => 1,
+                11 => 1,
+                12 => 1,
+                13 => 1,
             ];
             break;
         case 'DuplicateClassNameUnitTest.2.inc':
             return [
                 2 => 1,
                 3 => 1,
                 4 => 1,
+                5 => 1,
             ];
             break;
         case 'DuplicateClassNameUnitTest.5.inc':

src/Standards/Generic/Tests/Classes/OpeningBraceSameLineUnitTest.inc

@@ -89,3 +89,7 @@ class Test_Class_Bad_G
     /*some comment*/
 {
 }
+
+enum Test_Enum
+{
+}

src/Standards/Generic/Tests/Classes/OpeningBraceSameLineUnitTest.inc.fixed

@@ -89,3 +89,7 @@ class Test_Class_Bad_G
     /*some comment*/ {
 
 }
+
+enum Test_Enum {
+
+}

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

@@ -38,6 +38,7 @@ public function getErrorList()
             70 => 1,
             79 => 1,
             90 => 1,
+            94 => 1,
         ];
 
     }//end getErrorList()

src/Standards/Generic/Tests/Files/OneObjectStructurePerFileUnitTest.inc

@@ -12,10 +12,15 @@ class baz {
 }
 
 trait barTrait {
-    
+
 }
 
 interface barInterface {
 
 }
-?>
+
+enum barEnum {
+
+}
+
+?>

src/Standards/Generic/Tests/Files/OneObjectStructurePerFileUnitTest.php

@@ -30,6 +30,7 @@ public function getErrorList()
             10 => 1,
             14 => 1,
             18 => 1,
+            22 => 1,
         ];
 
     }//end getErrorList()

src/Standards/Generic/Tests/NamingConventions/CamelCapsFunctionNameUnitTest.inc

@@ -165,3 +165,21 @@ abstract class My_Class {
     public function my_class() {}
     public function _MY_CLASS() {}
 }
+
+enum Suit: string implements Colorful, CardGame {
+    // Magic methods.
+    function __call($name, $args) {}
+    static function __callStatic($name, $args) {}
+    function __invoke() {}
+
+    // Valid Method Name.
+    public function getSomeValue() {}
+
+    // Double underscore non-magic methods not allowed.
+    function __myFunction() {}
+    function __my_function() {}
+
+    // Non-camelcase.
+    public function parseMyDSN() {}
+    public function get_some_value() {}
+}

src/Standards/Generic/Tests/NamingConventions/CamelCapsFunctionNameUnitTest.php

@@ -63,6 +63,10 @@ public function getErrorList()
             147 => 2,
             158 => 1,
             159 => 1,
+            179 => 1,
+            180 => 2,
+            183 => 1,
+            184 => 1,
         ];
 
         return $errors;

src/Standards/Generic/Tests/PHP/LowerCaseKeywordUnitTest.inc

@@ -39,5 +39,8 @@ class Reading {
     Public READOnly int $var;
 }
 
+EnuM Enum {
+}
+
 __HALT_COMPILER(); // An exception due to phar support.
 function

src/Standards/Generic/Tests/PHP/LowerCaseKeywordUnitTest.inc.fixed

@@ -39,5 +39,8 @@ class Reading {
     public readonly int $var;
 }
 
+enum Enum {
+}
+
 __HALT_COMPILER(); // An exception due to phar support.
 function

src/Standards/Generic/Tests/PHP/LowerCaseKeywordUnitTest.php

@@ -41,6 +41,7 @@ public function getErrorList()
             32 => 1,
             35 => 1,
             39 => 2,
+            42 => 1,
         ];
 
     }//end getErrorList()

src/Standards/PEAR/Sniffs/Classes/ClassDeclarationSniff.php

@@ -27,6 +27,7 @@ public function register()
             T_CLASS,
             T_INTERFACE,
             T_TRAIT,
+            T_ENUM,
         ];
 
     }//end register()

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

@@ -27,6 +27,7 @@ public function register()
             T_CLASS,
             T_INTERFACE,
             T_TRAIT,
+            T_ENUM,
         ];
 
     }//end register()

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

@@ -161,6 +161,7 @@ public function process(File $phpcsFile, $stackPtr)
             T_CLASS,
             T_INTERFACE,
             T_TRAIT,
+            T_ENUM,
             T_FUNCTION,
             T_CLOSURE,
             T_PUBLIC,

src/Standards/PEAR/Sniffs/NamingConventions/ValidClassNameSniff.php

@@ -27,6 +27,7 @@ public function register()
             T_CLASS,
             T_INTERFACE,
             T_TRAIT,
+            T_ENUM,
         ];
 
     }//end register()

src/Standards/PEAR/Tests/Classes/ClassDeclarationUnitTest.1.inc

@@ -110,3 +110,5 @@ if (!class_exists('ClassOpeningBraceTooMuchIndentation')) {
         {
         }
 }
+
+enum IncorrectBracePlacement {}

src/Standards/PEAR/Tests/Classes/ClassDeclarationUnitTest.1.inc.fixed

@@ -119,3 +119,7 @@ if (!class_exists('ClassOpeningBraceTooMuchIndentation')) {
     {
         }
 }
+
+enum IncorrectBracePlacement
+{
+}

src/Standards/PEAR/Tests/Classes/ClassDeclarationUnitTest.php

@@ -61,6 +61,7 @@ public function getErrorList($testFile='')
                 99  => 1,
                 104 => 1,
                 110 => 1,
+                114 => 1,
             ];
 
         default:

src/Standards/PEAR/Tests/Commenting/ClassCommentUnitTest.inc

@@ -120,6 +120,16 @@ trait Empty_Trait_Doc
 }//end trait
 
 
+/**
+ *
+ *
+ */
+enum Empty_Enum_Doc
+{
+
+}//end enum
+
+
 /**
  * Sample class comment
  *

src/Standards/PEAR/Tests/Commenting/ClassCommentUnitTest.php

@@ -44,6 +44,7 @@ public function getErrorList()
             96  => 5,
             106 => 5,
             116 => 5,
+            126 => 5,
         ];
 
     }//end getErrorList()

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

@@ -0,0 +1,8 @@
+<?php
+
+/**
+ * Some comment
+ */
+enum SomeEnum
+{
+}

src/Standards/PEAR/Tests/Commenting/FileCommentUnitTest.php

@@ -50,6 +50,9 @@ public function getErrorList($testFile='FileCommentUnitTest.inc')
         case 'FileCommentUnitTest.2.inc':
             return [1 => 1];
 
+        case 'FileCommentUnitTest.3.inc':
+            return [1 => 1];
+
         default:
             return [];
         }//end switch

src/Standards/PEAR/Tests/NamingConventions/ValidClassNameUnitTest.inc

@@ -66,3 +66,25 @@ trait _Invalid_Name {}
 trait ___ {}
 
 trait Invalid__Name {}
+
+enum Valid_Name: string {}
+
+enum invalid_Name : String {}
+
+enum invalid_name {}
+
+enum Invalid_name: Int {}
+
+enum VALID_Name {}
+
+enum VALID_NAME {}
+
+enum VALID_Name : int {}
+
+enum ValidName {}
+
+enum _Invalid_Name {}
+
+enum ___ {}
+
+enum Invalid__Name {}

src/Standards/PEAR/Tests/NamingConventions/ValidClassNameUnitTest.php

@@ -44,6 +44,12 @@ public function getErrorList()
             64 => 1,
             66 => 2,
             68 => 1,
+            72 => 1,
+            74 => 2,
+            76 => 1,
+            86 => 1,
+            88 => 2,
+            90 => 1,
         ];
 
     }//end getErrorList()