Allow enum suffix omission when in Enum namespace (#428)

Relax the ValidEnumNameSniff to allow omitting the "Enum" suffix when
the enum is in a namespace containing "Enum" as a segment (e.g.,
`App\Model\Enum\Status` is now valid without the suffix).

This avoids redundant naming like `App\Model\Enum\FooBarEnum`.

Refs #425

Author: dereuromark

CakePHP/Sniffs/NamingConventions/ValidEnumNameSniff.php

@@ -1,4 +1,6 @@
 <?php
+declare(strict_types=1);
+
 /**
  * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
  * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
@@ -38,9 +40,37 @@ public function process(File $phpcsFile, $stackPtr)
     {
         $enumName = $phpcsFile->getDeclarationName($stackPtr);
 
-        if (!str_ends_with($enumName, 'Enum')) {
-            $error = 'Enums must have an "Enum" suffix.';
+        if (!str_ends_with($enumName, 'Enum') && !$this->isInEnumNamespace($phpcsFile)) {
+            $error = 'Enums must have an "Enum" suffix (or be in an Enum namespace).';
             $phpcsFile->addError($error, $stackPtr, 'InvalidEnumName');
         }
     }
+
+    /**
+     * Check if the file's namespace contains "Enum" as a segment.
+     *
+     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
+     * @return bool
+     */
+    protected function isInEnumNamespace(File $phpcsFile): bool
+    {
+        $tokens = $phpcsFile->getTokens();
+        $namespacePtr = $phpcsFile->findNext(T_NAMESPACE, 0);
+
+        if ($namespacePtr === false) {
+            return false;
+        }
+
+        $namespaceEnd = $phpcsFile->findNext([T_SEMICOLON, T_OPEN_CURLY_BRACKET], $namespacePtr);
+        $namespace = '';
+
+        for ($i = $namespacePtr + 1; $i < $namespaceEnd; $i++) {
+            if ($tokens[$i]['code'] === T_STRING || $tokens[$i]['code'] === T_NAME_QUALIFIED) {
+                $namespace .= $tokens[$i]['content'];
+            }
+        }
+
+        // Check if namespace ends with \Enum or contains \Enum\
+        return (bool)preg_match('/\\\\Enum(\\\\|$)/', $namespace);
+    }
 }

…ingConventions/ValidEnumNameUnitTest.inc …gConventions/ValidEnumNameUnitTest.1.incCakePHP/Tests/NamingConventions/ValidEnumNameUnitTest.inc renamed to CakePHP/Tests/NamingConventions/ValidEnumNameUnitTest.1.inc CakePHP/Tests/NamingConventions/ValidEnumNameUnitTest.inc renamed to CakePHP/Tests/NamingConventions/ValidEnumNameUnitTest.1.inc

@@ -0,0 +1,12 @@
+<?php
+namespace App\Model\Enum;
+
+// Valid: no suffix needed when in Enum namespace
+enum Status: string {
+    case Draft = 'draft';
+}
+
+// Also valid: suffix is still allowed
+enum StatusEnum: string {
+    case Published = 'published';
+}

CakePHP/Tests/NamingConventions/ValidEnumNameUnitTest.2.inc

@@ -9,17 +9,27 @@ class ValidEnumNameUnitTest extends AbstractSniffTestCase
     /**
      * @inheritDoc
      */
-    public function getErrorList()
+    public function getErrorList($testFile = '')
     {
-        return [
-            2 => 1,
-        ];
+        switch ($testFile) {
+            case 'ValidEnumNameUnitTest.1.inc':
+                return [
+                    2 => 1,
+                ];
+
+            case 'ValidEnumNameUnitTest.2.inc':
+                // No errors - enums in Enum namespace don't need suffix
+                return [];
+
+            default:
+                return [];
+        }
     }
 
     /**
      * @inheritDoc
      */
-    public function getWarningList()
+    public function getWarningList($testFile = '')
     {
         return [];
     }