Support more attribute targets: properties, class constants, params

Close #224
spaze · Dec 6, 2023 · 0f5c4e1 · 0f5c4e1
1 parent f0a6f69
commit 0f5c4e1
Show file tree

Hide file tree

Showing 5 changed files with 83 additions and 6 deletions.
diff --git a/src/Usages/AttributeUsages.php b/src/Usages/AttributeUsages.php
@@ -7,7 +7,10 @@
 use PhpParser\Node\Attribute;
 use PhpParser\Node\AttributeGroup;
 use PhpParser\Node\FunctionLike;
+use PhpParser\Node\Param;
+use PhpParser\Node\Stmt\ClassConst;
 use PhpParser\Node\Stmt\ClassLike;
+use PhpParser\Node\Stmt\Property;
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
 use Spaze\PHPStan\Rules\Disallowed\DisallowedAttribute;
@@ -72,6 +75,12 @@ public function processNode(Node $node, Scope $scope): array
 			$this->addAttrs(array_values($node->attrGroups));
 		} elseif ($node instanceof FunctionLike) {
 			$this->addAttrs(array_values($node->getAttrGroups()));
+		} elseif ($node instanceof Property) {
+			$this->addAttrs(array_values($node->attrGroups));
+		} elseif ($node instanceof ClassConst) {
+			$this->addAttrs(array_values($node->attrGroups));
+		} elseif ($node instanceof Param) {
+			$this->addAttrs(array_values($node->attrGroups));
 		} else {
 			return [];
 		}

diff --git a/tests/Usages/AttributeUsagesAllowParamsMultipleTest.php b/tests/Usages/AttributeUsagesAllowParamsMultipleTest.php
@@ -71,9 +71,25 @@ public function testRule(): void
 				// on this line:
 				8,
 			],
+			[
+				'Attribute Attributes\AttributeEntity is forbidden.',
+				12,
+			],
+			[
+				'Attribute Attributes\AttributeEntity is forbidden.',
+				15,
+			],
+			[
+				'Attribute Attributes\AttributeEntity is forbidden.',
+				18,
+			],
 			[
 				'Attribute Attributes\AttributeClass is forbidden.',
-				30,
+				40,
+			],
+			[
+				'Attribute Attributes\AttributeEntity is forbidden.',
+				41,
 			],
 		]);
 		$this->analyse([__DIR__ . '/../src/disallowed-allow/ClassWithAttributesAllow.php'], [
@@ -85,10 +101,26 @@ public function testRule(): void
 				'Attribute Attributes\AttributeEntity is forbidden.',
 				12,
 			],
+			[
+				'Attribute Attributes\AttributeEntity is forbidden.',
+				15,
+			],
 			[
 				'Attribute Attributes\AttributeEntity is forbidden.',
 				18,
 			],
+			[
+				'Attribute Attributes\AttributeEntity is forbidden.',
+				22,
+			],
+			[
+				'Attribute Attributes\AttributeEntity is forbidden.',
+				28,
+			],
+			[
+				'Attribute Attributes\AttributeEntity is forbidden.',
+				41,
+			],
 		]);
 	}
 

diff --git a/tests/Usages/AttributeUsagesTest.php b/tests/Usages/AttributeUsagesTest.php
@@ -63,9 +63,25 @@ public function testRule(): void
 				// on this line:
 				8,
 			],
+			[
+				'Attribute Attributes\AttributeEntity is forbidden.',
+				12,
+			],
+			[
+				'Attribute Attributes\AttributeEntity is forbidden.',
+				15,
+			],
+			[
+				'Attribute Attributes\AttributeEntity is forbidden.',
+				18,
+			],
 			[
 				'Attribute Attributes\AttributeClass is forbidden.',
-				30,
+				40,
+			],
+			[
+				'Attribute Attributes\AttributeEntity is forbidden.',
+				41,
 			],
 		]);
 		$this->analyse([__DIR__ . '/../src/disallowed-allow/ClassWithAttributesAllow.php'], []);

diff --git a/tests/src/disallowed-allow/ClassWithAttributesAllow.php b/tests/src/disallowed-allow/ClassWithAttributesAllow.php
@@ -9,6 +9,16 @@
 class ClassWithAttributesAllow
 {
 
+	#[AttributeEntity] // allowed by path in all tests
+	private const MAYO = true;
+
+	#[AttributeEntity] // allowed by path in all tests
+	public $cheddar = 'plz';
+
+	#[AttributeEntity] // disallowed
+	public static $pepper = 'ofc';
+
+
 	#[\Attributes\AttributeEntity(repositoryClass: \Attributes\UserRepository::class, readOnly: false)] // allowed by path in AttributeUsagesTest, disallowed in AttributeUsagesAllowParamsMultipleTest because $repositoryClass has other value
 	public function hasAvocado(): bool
 	{
@@ -27,8 +37,8 @@ public function hasKetchup(): bool
 	}
 
 
-	#[AttributeClass()] // allowed by path in all tests
-	public function hasPineapple(): bool
+	#[AttributeClass()] // both the method and the param attributes allowed by path in all tests
+	public function hasPineapple(#[AttributeEntity] bool $really): bool
 	{
 	}
 

diff --git a/tests/src/disallowed/ClassWithAttributes.php b/tests/src/disallowed/ClassWithAttributes.php
@@ -9,6 +9,16 @@
 class ClassWithAttributes
 {
 
+	#[AttributeEntity] // disallowed
+	private const MAYO = true;
+
+	#[AttributeEntity] // disallowed
+	public $cheddar = 'plz';
+
+	#[AttributeEntity] // disallowed
+	public static $pepper = 'ofc';
+
+
 	#[AttributeEntity(repositoryClass: UserRepository::class, readOnly: false)] // disallowed, $repositoryClass present with any value
 	public function hasAvocado(): bool
 	{
@@ -27,8 +37,8 @@ public function hasKetchup(): bool
 	}
 
 
-	#[AttributeClass()] // disallowed
-	public function hasPineapple(): bool
+	#[AttributeClass()] // both the method and the param attributes disallowed
+	public function hasPineapple(#[AttributeEntity] bool $really): bool
 	{
 	}