Bleeding edge - ParamAttributesRule - promoted property attribute nee…

…ds to target both parameters and properties
phpstan · Dec 15, 2023 · 25d1552 · 25d1552
1 parent 154cc40
commit 25d1552
Show file tree

Hide file tree

Showing 6 changed files with 73 additions and 11 deletions.
diff --git a/conf/bleedingEdge.neon b/conf/bleedingEdge.neon
@@ -24,6 +24,7 @@ parameters:
 		missingMagicSerializationRule: true
 		nullContextForVoidReturningFunctions: true
 		unescapeStrings: true
+		promotedPropertyAttribute: true
 		alwaysCheckTooWideReturnTypeFinalMethods: true
 		duplicateStubs: true
 		logicalXor: true

diff --git a/conf/config.level0.neon b/conf/config.level0.neon
@@ -75,7 +75,6 @@ rules:
 	- PHPStan\Rules\Functions\FunctionAttributesRule
 	- PHPStan\Rules\Functions\InnerFunctionRule
 	- PHPStan\Rules\Functions\InvalidLexicalVariablesInClosureUseRule
-	- PHPStan\Rules\Functions\ParamAttributesRule
 	- PHPStan\Rules\Functions\PrintfParametersRule
 	- PHPStan\Rules\Functions\RedefinedParametersRule
 	- PHPStan\Rules\Functions\ReturnNullsafeByRefRule
@@ -152,6 +151,13 @@ services:
 		arguments:
 			checkFunctionNameCase: %checkFunctionNameCase%
 
+	-
+		class: PHPStan\Rules\Functions\ParamAttributesRule
+		tags:
+			- phpstan.rules.rule
+		arguments:
+			checkPromotedPropertyAttribute: %featureToggles.promotedPropertyAttribute%
+
 	-
 		class: PHPStan\Rules\Constants\OverridingConstantRule
 		arguments:

diff --git a/conf/config.neon b/conf/config.neon
@@ -59,6 +59,7 @@ parameters:
 		missingMagicSerializationRule: false
 		nullContextForVoidReturningFunctions: false
 		unescapeStrings: false
+		promotedPropertyAttribute: false
 		alwaysCheckTooWideReturnTypeFinalMethods: false
 		duplicateStubs: false
 		logicalXor: false

diff --git a/conf/parametersSchema.neon b/conf/parametersSchema.neon
@@ -54,6 +54,7 @@ parametersSchema:
 		missingMagicSerializationRule: bool()
 		nullContextForVoidReturningFunctions: bool()
 		unescapeStrings: bool()
+		promotedPropertyAttribute: bool()
 		alwaysCheckTooWideReturnTypeFinalMethods: bool()
 		duplicateStubs: bool()
 		logicalXor: bool()

diff --git a/src/Rules/Functions/ParamAttributesRule.php b/src/Rules/Functions/ParamAttributesRule.php
@@ -15,7 +15,7 @@
 class ParamAttributesRule implements Rule
 {
 
-	public function __construct(private AttributesCheck $attributesCheck)
+	public function __construct(private AttributesCheck $attributesCheck, private bool $checkPromotedPropertyAttribute)
 	{
 	}
 
@@ -28,17 +28,30 @@ public function processNode(Node $node, Scope $scope): array
 	{
 		$targetName = 'parameter';
 		if ($node->flags !== 0) {
-			$targetName = 'parameter or property';
+			if ($this->checkPromotedPropertyAttribute) {
+				$propertyTargetErrors = $this->attributesCheck->check(
+					$scope,
+					$node->attrGroups,
+					Attribute::TARGET_PROPERTY,
+					'property',
+				);
 
-			$propertyTargetErrors = $this->attributesCheck->check(
-				$scope,
-				$node->attrGroups,
-				Attribute::TARGET_PROPERTY,
-				$targetName,
-			);
+				if (count($propertyTargetErrors) > 0) {
+					return $propertyTargetErrors;
+				}
+			} else {
+				$targetName = 'parameter or property';
 
-			if (count($propertyTargetErrors) === 0) {
-				return $propertyTargetErrors;
+				$propertyTargetErrors = $this->attributesCheck->check(
+					$scope,
+					$node->attrGroups,
+					Attribute::TARGET_PROPERTY,
+					$targetName,
+				);
+
+				if (count($propertyTargetErrors) === 0) {
+					return $propertyTargetErrors;
+				}
 			}
 		}
 

diff --git a/tests/PHPStan/Rules/Functions/ParamAttributesRuleTest.php b/tests/PHPStan/Rules/Functions/ParamAttributesRuleTest.php
@@ -19,6 +19,8 @@
 class ParamAttributesRuleTest extends RuleTestCase
 {
 
+	private bool $checkPromotedPropertyAttribute;
+
 	protected function getRule(): Rule
 	{
 		$reflectionProvider = $this->createReflectionProvider();
@@ -40,11 +42,13 @@ protected function getRule(): Rule
 				new ClassCaseSensitivityCheck($reflectionProvider, false),
 				true,
 			),
+			$this->checkPromotedPropertyAttribute,
 		);
 	}
 
 	public function testRule(): void
 	{
+		$this->checkPromotedPropertyAttribute = false;
 		$this->analyse([__DIR__ . '/data/param-attributes.php'], [
 			[
 				'Attribute class ParamAttributes\Foo does not have the parameter target.',
@@ -61,8 +65,44 @@ public function testRule(): void
 		]);
 	}
 
+	public function testRuleCheckPromotedPropertyAttribute(): void
+	{
+		$this->checkPromotedPropertyAttribute = true;
+		$this->analyse([__DIR__ . '/data/param-attributes.php'], [
+			[
+				'Attribute class ParamAttributes\Foo does not have the parameter target.',
+				33,
+			],
+			[
+				'Attribute class ParamAttributes\Foo does not have the property target.',
+				72,
+			],
+			[
+				'Attribute class ParamAttributes\Bar does not have the property target.',
+				74,
+			],
+			[
+				'Attribute class ParamAttributes\Qux does not have the parameter target.',
+				76,
+			],
+			[
+				'Attribute class ParamAttributes\Qux does not have the parameter target.',
+				78,
+			],
+			[
+				'Attribute class ParamAttributes\Qux does not have the parameter target.',
+				80,
+			],
+			[
+				'Attribute class ParamAttributes\Qux does not have the parameter target.',
+				82,
+			],
+		]);
+	}
+
 	public function testSensitiveParameterAttribute(): void
 	{
+		$this->checkPromotedPropertyAttribute = false;
 		$this->analyse([__DIR__ . '/data/sensitive-parameter.php'], []);
 	}