Implement TraitAttributesRule

Author: staabm

conf/config.level0.neon

@@ -117,6 +117,7 @@ rules:
 	- PHPStan\Rules\Properties\ReadOnlyPropertyRule
 	- PHPStan\Rules\Traits\ConflictingTraitConstantsRule
 	- PHPStan\Rules\Traits\ConstantsInTraitsRule
+	- PHPStan\Rules\Traits\TraitAttributesRule
 	- PHPStan\Rules\Types\InvalidTypesInUnionRule
 	- PHPStan\Rules\Variables\UnsetRule
 	- PHPStan\Rules\Whitespace\FileWhitespaceRule

src/Rules/Traits/TraitAttributesRule.php

@@ -0,0 +1,61 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Traits;
+
+use Attribute;
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\ReflectionProvider;
+use PHPStan\Rules\AttributesCheck;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+use function count;
+
+/**
+ * @implements Rule<Node\Stmt\Trait_>
+ */
+final class TraitAttributesRule implements Rule
+{
+
+	public function __construct(
+		private AttributesCheck $attributesCheck,
+		private ReflectionProvider $reflectionProvider,
+	)
+	{
+	}
+
+	public function getNodeType(): string
+	{
+		return Node\Stmt\Trait_::class;
+	}
+
+	public function processNode(Node $node, Scope $scope): array
+	{
+		$traitName = $node->namespacedName;
+		if ($traitName === null) {
+			return [];
+		}
+
+		if (!$this->reflectionProvider->hasClass($traitName->toString())) {
+			return [];
+		}
+
+		$errors = $this->attributesCheck->check(
+			$scope,
+			$node->attrGroups,
+			Attribute::TARGET_ALL, // there is no dedicated trait target
+			'trait',
+		);
+
+		$classReflection = $this->reflectionProvider->getClass($traitName->toString());
+		if (count($classReflection->getNativeReflection()->getAttributes('AllowDynamicProperties')) > 0) {
+			$errors[] = RuleErrorBuilder::message('Attribute class AllowDynamicProperties cannot be used with trait.')
+				->identifier('class.allowDynamicPropertiesTrait')
+				->nonIgnorable()
+				->build();
+		}
+
+		return $errors;
+	}
+
+}

tests/PHPStan/Rules/Traits/TraitAttributesRuleTest.php

@@ -0,0 +1,79 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Traits;
+
+use PHPStan\Php\PhpVersion;
+use PHPStan\Rules\AttributesCheck;
+use PHPStan\Rules\ClassCaseSensitivityCheck;
+use PHPStan\Rules\Classes\ClassAttributesRule;
+use PHPStan\Rules\ClassForbiddenNameCheck;
+use PHPStan\Rules\ClassNameCheck;
+use PHPStan\Rules\FunctionCallParametersCheck;
+use PHPStan\Rules\NullsafeCheck;
+use PHPStan\Rules\PhpDoc\UnresolvableTypeHelper;
+use PHPStan\Rules\Properties\PropertyReflectionFinder;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleLevelHelper;
+use PHPStan\Rules\Traits\TraitAttributesRule;
+use PHPStan\Testing\RuleTestCase;
+use const PHP_VERSION_ID;
+
+/**
+ * @extends RuleTestCase<TraitAttributesRule>
+ */
+class TraitAttributesRuleTest extends RuleTestCase
+{
+
+	private bool $checkExplicitMixed = false;
+
+	private bool $checkImplicitMixed = false;
+
+	protected function getRule(): Rule
+	{
+		$reflectionProvider = $this->createReflectionProvider();
+		return new TraitAttributesRule(
+			new AttributesCheck(
+				$reflectionProvider,
+				new FunctionCallParametersCheck(
+					new RuleLevelHelper($reflectionProvider, true, false, true, $this->checkExplicitMixed, $this->checkImplicitMixed, true, false),
+					new NullsafeCheck(),
+					new PhpVersion(80000),
+					new UnresolvableTypeHelper(),
+					new PropertyReflectionFinder(),
+					true,
+					true,
+					true,
+					true,
+					true,
+				),
+				new ClassNameCheck(
+					new ClassCaseSensitivityCheck($reflectionProvider, false),
+					new ClassForbiddenNameCheck(self::getContainer()),
+				),
+				true,
+			),
+			$reflectionProvider,
+		);
+	}
+
+	public function testRule(): void
+	{
+		$this->analyse([__DIR__ . '/data/trait-attributes.php'], [
+			[
+				'Attribute class TraitAttributes\AbstractAttribute is abstract.',
+				8,
+			],
+		]);
+	}
+
+	public function testBug12281(): void
+	{
+		$this->analyse([__DIR__ . '/data/bug-12281.php'], [
+			[
+				'Attribute class AllowDynamicProperties cannot be used with trait.',
+				11,
+			],
+		]);
+	}
+
+}

tests/PHPStan/Rules/Traits/data/bug-12281.php

@@ -0,0 +1,12 @@
+<?php // lint >= 8.2
+
+namespace Bug12281Traits;
+
+#[\AllowDynamicProperties]
+enum BlogDataEnum { /* … */ } // reported by ClassAttributesRule
+
+#[\AllowDynamicProperties]
+interface BlogDataInterface { /* … */ } // reported by ClassAttributesRule
+
+#[\AllowDynamicProperties]
+trait BlogDataTrait { /* … */ }

tests/PHPStan/Rules/Traits/data/trait-attributes.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace TraitAttributes;
+
+#[\Attribute]
+abstract class AbstractAttribute {}
+
+#[AbstractAttribute]
+trait MyTrait {}
+
+#[\Attribute]
+class MyAttribute {}
+
+#[MyAttribute]
+trait MyTrait2 {}
+
+#[\Attribute(\Attribute::TARGET_PROPERTY)]
+class MyTargettedAttribute {}
+
+#[MyTargettedAttribute]
+trait MyTrait3 {}