[BE] Support @readonly property and @immutable class PHPDoc

ondrejmirtes · ondrejmirtes · commit 375879379aa7 · 2024-09-24T17:11:23.000+02:00
diff --git a/changelog-2.0.md b/changelog-2.0.md
@@ -36,6 +36,8 @@ Major new features 🚀
 * ArrayUnpackingRule (level 3) ([#856](https://github.com/phpstan/phpstan-src/pull/856)), thanks @canvural!
 * Check unresolvable parameters (level 5) ([#1319](https://github.com/phpstan/phpstan-src/pull/1319)), thanks @rvanvelzen!
 * Enforce `@no-named-arguments` (level 5) (https://github.com/phpstan/phpstan-src/commit/74ba8c23696948f2647d880df72f375346f41010), #5968
+* Support `@readonly` property and `@immutable` class PHPDoc ([#1295](https://github.com/phpstan/phpstan-src/pull/1295), [#1335](https://github.com/phpstan/phpstan-src/pull/1335)), #4082, thanks @herndlm!
+* Add `@readonly` rule that disallows default values (level 0) ([#1391](https://github.com/phpstan/phpstan-src/pull/1391)), thanks @herndlm!
 * IncompatibleDefaultParameterTypeRule for closures (level 2) (https://github.com/phpstan/phpstan-src/commit/0264f5bc48448c7e02a23b82eef4177d0617a82f)
 * Added previously absent type checks (level 0)
   * Check existing classes in `@phpstan-self-out` (https://github.com/phpstan/phpstan-src/commit/6838669976bf20232abde36ecdd52b1770fa50c9)
@@ -67,9 +69,7 @@ Bleeding edge (TODO move to other sections)
 =====================
 
 * Rules for checking direct calls to `__construct()` (level 2) ([#1208](https://github.com/phpstan/phpstan-src/pull/1208)), #7022, thanks @muno92!
-* Support `@readonly` property and `@immutable` class PHPDoc ([#1295](https://github.com/phpstan/phpstan-src/pull/1295), [#1335](https://github.com/phpstan/phpstan-src/pull/1335)), #4082, thanks @herndlm!
 * Move IllegalConstructorMethodCallRule and IllegalConstructorStaticCallRule to phpstan-strict-rules (https://github.com/phpstan/phpstan-src/commit/124b30f98c182193187be0b9c2e151e477429b7a, https://github.com/phpstan/phpstan-strict-rules/commit/0c82c96f2a55d8b91bbc7ee6512c94f68a206b43)
-* Add `@readonly` rule that disallows default values ([#1391](https://github.com/phpstan/phpstan-src/pull/1391)), thanks @herndlm!
 * Report narrowing `PHPStan\Type\Type` interface via `@var` (https://github.com/phpstan/phpstan-src/commit/713b98fb107213c28e3d8c8b4b43c5f5fc47c144), https://github.com/nunomaduro/larastan/issues/1567#issuecomment-1460445389
 * Check invalid PHPDocs in previously unchecked statement types (https://github.com/phpstan/phpstan-src/commit/9780d352f3264aac09ac7954f691de1877db8e01)
 * InvalidPHPStanDocTagRule in StubValidator (https://github.com/phpstan/phpstan-src/commit/9c2552b7e744926d1a74c1ba8fd32c64079eed61)
diff --git a/conf/bleedingEdge.neon b/conf/bleedingEdge.neon
@@ -4,5 +4,4 @@ parameters:
 		skipCheckGenericClasses!: []
 		stricterFunctionMap: true
 
-		readOnlyByPhpDoc: true
 		pure: true
diff --git a/conf/config.level0.neon b/conf/config.level0.neon
@@ -2,10 +2,6 @@ parameters:
 	customRulesetUsed: false
 
 conditionalTags:
-	PHPStan\Rules\Properties\MissingReadOnlyByPhpDocPropertyAssignRule:
-		phpstan.rules.rule: %featureToggles.readOnlyByPhpDoc%
-	PHPStan\Rules\Properties\ReadOnlyByPhpDocPropertyRule:
-		phpstan.rules.rule: %featureToggles.readOnlyByPhpDoc%
 	PHPStan\Rules\Properties\UninitializedPropertyRule:
 		phpstan.rules.rule: %checkUninitializedProperties%
 
@@ -98,9 +94,11 @@ rules:
 	- PHPStan\Rules\Properties\AccessStaticPropertiesInAssignRule
 	- PHPStan\Rules\Properties\InvalidCallablePropertyTypeRule
 	- PHPStan\Rules\Properties\MissingReadOnlyPropertyAssignRule
+	- PHPStan\Rules\Properties\MissingReadOnlyByPhpDocPropertyAssignRule
 	- PHPStan\Rules\Properties\PropertiesInInterfaceRule
 	- PHPStan\Rules\Properties\PropertyAttributesRule
 	- PHPStan\Rules\Properties\ReadOnlyPropertyRule
+	- PHPStan\Rules\Properties\ReadOnlyByPhpDocPropertyRule
 	- PHPStan\Rules\Regexp\RegularExpressionPatternRule
 	- PHPStan\Rules\Regexp\RegularExpressionQuotingRule
 	- PHPStan\Rules\Traits\ConflictingTraitConstantsRule
@@ -203,9 +201,6 @@ services:
 		tags:
 			- phpstan.rules.rule
 
-	-
-		class: PHPStan\Rules\Properties\MissingReadOnlyByPhpDocPropertyAssignRule
-
 	-
 		class: PHPStan\Rules\Properties\OverridingPropertyRule
 		arguments:
@@ -214,9 +209,6 @@ services:
 		tags:
 			- phpstan.rules.rule
 
-	-
-		class: PHPStan\Rules\Properties\ReadOnlyByPhpDocPropertyRule
-
 	-
 		class: PHPStan\Rules\Properties\UninitializedPropertyRule
 
diff --git a/conf/config.level2.neon b/conf/config.level2.neon
@@ -37,6 +37,7 @@ rules:
 	- PHPStan\Rules\Generics\MethodTagTemplateTypeRule
 	- PHPStan\Rules\Generics\MethodTagTemplateTypeTraitRule
 	- PHPStan\Rules\Generics\MethodSignatureVarianceRule
+	- PHPStan\Rules\Generics\PropertyVarianceRule
 	- PHPStan\Rules\Generics\TraitTemplateTypeRule
 	- PHPStan\Rules\Generics\UsedTraitsRule
 	- PHPStan\Rules\Methods\CallPrivateMethodThroughStaticRule
@@ -117,12 +118,6 @@ services:
 		class: PHPStan\Rules\PhpDoc\InvalidPHPStanDocTagRule
 		tags:
 			- phpstan.rules.rule
-	-
-		class: PHPStan\Rules\Generics\PropertyVarianceRule
-		arguments:
-			readOnlyByPhpDoc: %featureToggles.readOnlyByPhpDoc%
-		tags:
-			- phpstan.rules.rule
 	-
 		class: PHPStan\Rules\Pure\PureFunctionRule
 
diff --git a/conf/config.level3.neon b/conf/config.level3.neon
@@ -1,12 +1,6 @@
 includes:
 	- config.level2.neon
 
-conditionalTags:
-	PHPStan\Rules\Properties\ReadOnlyByPhpDocPropertyAssignRefRule:
-		phpstan.rules.rule: %featureToggles.readOnlyByPhpDoc%
-	PHPStan\Rules\Properties\ReadOnlyByPhpDocPropertyAssignRule:
-		phpstan.rules.rule: %featureToggles.readOnlyByPhpDoc%
-
 rules:
 	- PHPStan\Rules\Arrays\ArrayDestructuringRule
 	- PHPStan\Rules\Arrays\ArrayUnpackingRule
@@ -23,7 +17,9 @@ rules:
 	- PHPStan\Rules\Methods\ReturnTypeRule
 	- PHPStan\Rules\Properties\DefaultValueTypesAssignedToPropertiesRule
 	- PHPStan\Rules\Properties\ReadOnlyPropertyAssignRule
+	- PHPStan\Rules\Properties\ReadOnlyByPhpDocPropertyAssignRule
 	- PHPStan\Rules\Properties\ReadOnlyPropertyAssignRefRule
+	- PHPStan\Rules\Properties\ReadOnlyByPhpDocPropertyAssignRefRule
 	- PHPStan\Rules\Properties\TypesAssignedToPropertiesRule
 	- PHPStan\Rules\Variables\ParameterOutAssignedTypeRule
 	- PHPStan\Rules\Variables\ParameterOutExecutionEndTypeRule
@@ -83,9 +79,3 @@ services:
 			reportMaybes: %reportMaybes%
 		tags:
 			- phpstan.rules.rule
-
-	-
-		class: PHPStan\Rules\Properties\ReadOnlyByPhpDocPropertyAssignRefRule
-
-	-
-		class: PHPStan\Rules\Properties\ReadOnlyByPhpDocPropertyAssignRule
diff --git a/conf/config.neon b/conf/config.neon
@@ -24,7 +24,6 @@ parameters:
 		bleedingEdge: false
 		skipCheckGenericClasses: []
 		illegalConstructorMethodCall: false
-		readOnlyByPhpDoc: false
 		stricterFunctionMap: false
 		pure: false
 	fileExtensions:
diff --git a/conf/parametersSchema.neon b/conf/parametersSchema.neon
@@ -30,7 +30,6 @@ parametersSchema:
 		bleedingEdge: bool(),
 		skipCheckGenericClasses: listOf(string()),
 		illegalConstructorMethodCall: bool(),
-		readOnlyByPhpDoc: bool()
 		stricterFunctionMap: bool()
 		pure: bool()
 	])
diff --git a/src/Rules/Generics/PropertyVarianceRule.php b/src/Rules/Generics/PropertyVarianceRule.php
@@ -18,7 +18,6 @@ final class PropertyVarianceRule implements Rule
 
 	public function __construct(
 		private VarianceCheck $varianceCheck,
-		private bool $readOnlyByPhpDoc,
 	)
 	{
 	}
@@ -42,7 +41,7 @@ public function processNode(Node $node, Scope $scope): array
 			return [];
 		}
 
-		$variance = $node->isReadOnly() || ($this->readOnlyByPhpDoc && $node->isReadOnlyByPhpDoc())
+		$variance = $node->isReadOnly() || $node->isReadOnlyByPhpDoc()
 			? TemplateTypeVariance::createCovariant()
 			: TemplateTypeVariance::createInvariant();
 
diff --git a/tests/PHPStan/Rules/Generics/PropertyVarianceRuleTest.php b/tests/PHPStan/Rules/Generics/PropertyVarianceRuleTest.php
@@ -16,7 +16,6 @@ protected function getRule(): Rule
 	{
 		return new PropertyVarianceRule(
 			self::getContainer()->getByType(VarianceCheck::class),
-			true,
 		);
 	}
 

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,6 @@ final class PropertyVarianceRule implements Rule`
`18`	`18`
`19`	`19`	`public function __construct(`
`20`	`20`	`private VarianceCheck $varianceCheck,`
`21`		`- private bool $readOnlyByPhpDoc,`
`22`	`21`	`)`
`23`	`22`	`{`
`24`	`23`	`}`
`@@ -42,7 +41,7 @@ public function processNode(Node $node, Scope $scope): array`
`42`	`41`	`return [];`
`43`	`42`	`}`
`44`	`43`
`45`		`- $variance = $node->isReadOnly() \|\| ($this->readOnlyByPhpDoc && $node->isReadOnlyByPhpDoc())`
	`44`	`+ $variance = $node->isReadOnly() \|\| $node->isReadOnlyByPhpDoc()`
`46`	`45`	`? TemplateTypeVariance::createCovariant()`
`47`	`46`	`: TemplateTypeVariance::createInvariant();`
`48`	`47`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,6 @@ protected function getRule(): Rule`
`16`	`16`	`{`
`17`	`17`	`return new PropertyVarianceRule(`
`18`	`18`	`self::getContainer()->getByType(VarianceCheck::class),`
`19`		`- true,`
`20`	`19`	`);`
`21`	`20`	`}`
`22`	`21`