Merge pull request #30 from Phauthentic/attribute-rule

Implement Attribute Rule for PHP 8+ attributes validation

Author: floriankraemer

README.md

@@ -18,18 +18,19 @@ See individual rule documentation for detailed configuration examples. A [full c
 
 ### Architecture Rules
 
-- [Dependency Constraints Rule](docs/rules/Dependency-Constraints-Rule.md)
-- [Modular Architecture Rule](docs/rules/Modular-Architecture-Rule.md)
+- [Attribute Rule](docs/rules/Attribute-Rule.md)
+- [Catch Exception Of Type Not Allowed Rule](docs/rules/Catch-Exception-Of-Type-Not-Allowed-Rule.md)
 - [Circular Module Dependency Rule](docs/rules/Circular-Module-Dependency-Rule.md)
-- [Forbidden Namespaces Rule](docs/rules/Forbidden-Namespaces-Rule.md)
-- [Class Must Be Readonly Rule](docs/rules/Class-Must-Be-Readonly-Rule.md)
 - [Class Must Be Final Rule](docs/rules/Class-Must-Be-Final-Rule.md)
-- [Classname Must Match Pattern Rule](docs/rules/Classname-Must-Match-Pattern-Rule.md)
-- [Catch Exception Of Type Not Allowed Rule](docs/rules/Catch-Exception-Of-Type-Not-Allowed-Rule.md)
+- [Class Must Be Readonly Rule](docs/rules/Class-Must-Be-Readonly-Rule.md)
 - [Class Must Have Specification Docblock Rule](docs/rules/Class-Must-Have-Specification-Docblock-Rule.md)
-- [Methods Returning Bool Must Follow Naming Convention Rule](docs/rules/Methods-Returning-Bool-Must-Follow-Naming-Convention-Rule.md)
-- [Method Signature Must Match Rule](docs/rules/Method-Signature-Must-Match-Rule.md)
+- [Classname Must Match Pattern Rule](docs/rules/Classname-Must-Match-Pattern-Rule.md)
+- [Dependency Constraints Rule](docs/rules/Dependency-Constraints-Rule.md)
+- [Forbidden Namespaces Rule](docs/rules/Forbidden-Namespaces-Rule.md)
 - [Method Must Return Type Rule](docs/rules/Method-Must-Return-Type-Rule.md)
+- [Method Signature Must Match Rule](docs/rules/Method-Signature-Must-Match-Rule.md)
+- [Methods Returning Bool Must Follow Naming Convention Rule](docs/rules/Methods-Returning-Bool-Must-Follow-Naming-Convention-Rule.md)
+- [Modular Architecture Rule](docs/rules/Modular-Architecture-Rule.md)
 
 ### Clean Code Rules
 

data/AttributeRule/AllowedClassAttributes.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Controller;
+
+use Symfony\Component\Routing\Annotation\Route;
+
+/**
+ * Class with allowed attributes - should pass.
+ */
+#[Route('/api')]
+class AllowedClassAttributes
+{
+}

data/AttributeRule/CombinedClassMethodPattern.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Domain\Service;
+
+use App\Attribute\FrameworkAttribute;
+use App\Attribute\DomainAttribute;
+
+/**
+ * Class in Domain layer - framework attributes should be forbidden on methods.
+ */
+class CombinedClassMethodPattern
+{
+    /**
+     * Method with forbidden framework attribute in domain - should fail.
+     */
+    #[FrameworkAttribute]
+    public function processData(): void
+    {
+    }
+
+    /**
+     * Method with allowed domain attribute - should pass.
+     */
+    #[DomainAttribute]
+    public function handleDomain(): void
+    {
+    }
+}

data/AttributeRule/CombinedClassPropertyPattern.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Domain\Entity;
+
+use App\Attribute\FrameworkAttribute;
+use App\Attribute\DomainAttribute;
+
+/**
+ * Entity in Domain layer - framework attributes should be forbidden on properties.
+ */
+class CombinedClassPropertyPattern
+{
+    /**
+     * Property with forbidden framework attribute in domain - should fail.
+     */
+    #[FrameworkAttribute]
+    private string $forbiddenProperty;
+
+    /**
+     * Property with allowed domain attribute - should pass.
+     */
+    #[DomainAttribute]
+    private string $allowedProperty;
+}

data/AttributeRule/ForbiddenClassAttributes.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Controller;
+
+use App\Attribute\Deprecated;
+
+/**
+ * Class with forbidden attributes - should fail.
+ */
+#[Deprecated]
+class ForbiddenClassAttributes
+{
+}

data/AttributeRule/MethodAttributes.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Controller;
+
+use Symfony\Component\Routing\Annotation\Route;
+use App\Attribute\Deprecated;
+use App\Attribute\CustomAttribute;
+
+/**
+ * Class with method attributes for testing.
+ */
+class MethodAttributes
+{
+    /**
+     * Method with allowed attribute - should pass.
+     */
+    #[Route('/users')]
+    public function allowedAction(): void
+    {
+    }
+
+    /**
+     * Method with forbidden attribute - should fail.
+     */
+    #[Deprecated]
+    public function forbiddenAction(): void
+    {
+    }
+
+    /**
+     * Method with attribute not in allowed list - should fail.
+     */
+    #[CustomAttribute]
+    public function notAllowedAction(): void
+    {
+    }
+}

data/AttributeRule/NoAttributesClass.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Service;
+
+/**
+ * Class without any attributes - should always pass.
+ */
+class NoAttributesClass
+{
+    private string $property;
+
+    public function doSomething(): void
+    {
+    }
+}

data/AttributeRule/NotAllowedClassAttributes.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Controller;
+
+use App\Attribute\CustomAttribute;
+
+/**
+ * Class with attributes not in allowed list - should fail.
+ */
+#[CustomAttribute]
+class NotAllowedClassAttributes
+{
+}

data/AttributeRule/PropertyAttributes.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Entity;
+
+use Doctrine\ORM\Mapping\Column;
+use Doctrine\ORM\Mapping\Id;
+use App\Attribute\Deprecated;
+use App\Attribute\CustomAttribute;
+
+/**
+ * Class with property attributes for testing.
+ */
+class PropertyAttributes
+{
+    /**
+     * Property with allowed attribute - should pass.
+     */
+    #[Id]
+    #[Column]
+    private int $id;
+
+    /**
+     * Property with forbidden attribute - should fail.
+     */
+    #[Deprecated]
+    private string $forbiddenProperty;
+
+    /**
+     * Property with attribute not in allowed list - should fail.
+     */
+    #[CustomAttribute]
+    private string $notAllowedProperty;
+}

data/AttributeRule/RequiredClassAttribute.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Controller;
+
+/**
+ * Class missing required attribute - should fail.
+ */
+class RequiredClassAttribute
+{
+}