ReadOnlyPropertyRule - support for readonly classes

ondrejmirtes · ondrejmirtes · commit c52eb5792c6e · 2022-09-29T11:37:47.000+02:00
diff --git a/src/Analyser/NodeScopeResolver.php b/src/Analyser/NodeScopeResolver.php
@@ -503,6 +503,9 @@ private function processStmtNode(
 					if ($param->getDocComment() !== null) {
 						$phpDoc = $param->getDocComment()->getText();
 					}
+					if (!$scope->isInClass()) {
+						throw new ShouldNotHappenException();
+					}
 					$nodeCallback(new ClassPropertyNode(
 						$param->var->name,
 						$param->flags,
@@ -513,6 +516,7 @@ private function processStmtNode(
 						$param,
 						false,
 						$scope->isInTrait(),
+						$scope->getClassReflection()->isReadOnly(),
 					), $methodScope);
 				}
 			}
@@ -657,6 +661,9 @@ private function processStmtNode(
 			foreach ($stmt->props as $prop) {
 				$this->processStmtNode($prop, $scope, $nodeCallback);
 				[,,,,,,,,,,$isReadOnly, $docComment] = $this->getPhpDocs($scope, $stmt);
+				if (!$scope->isInClass()) {
+					throw new ShouldNotHappenException();
+				}
 				$nodeCallback(
 					new ClassPropertyNode(
 						$prop->name->toString(),
@@ -668,6 +675,7 @@ private function processStmtNode(
 						$prop,
 						$isReadOnly,
 						$scope->isInTrait(),
+						$scope->getClassReflection()->isReadOnly(),
 					),
 					$scope,
 				);
diff --git a/src/Node/ClassPropertyNode.php b/src/Node/ClassPropertyNode.php
@@ -23,6 +23,7 @@ public function __construct(
 		Node $originalNode,
 		private bool $isReadonlyByPhpDoc,
 		private bool $isDeclaredInTrait,
+		private bool $isReadonlyClass,
 	)
 	{
 		parent::__construct($originalNode->getAttributes());
@@ -76,7 +77,7 @@ public function isStatic(): bool
 
 	public function isReadOnly(): bool
 	{
-		return (bool) ($this->flags & Class_::MODIFIER_READONLY);
+		return (bool) ($this->flags & Class_::MODIFIER_READONLY) || $this->isReadonlyClass;
 	}
 
 	public function isReadOnlyByPhpDoc(): bool
diff --git a/src/Reflection/ClassReflection.php b/src/Reflection/ClassReflection.php
@@ -584,6 +584,11 @@ public function isEnum(): bool
 		return $this->reflection->isEnum();
 	}
 
+	public function isReadOnly(): bool
+	{
+		return $this->reflection->isReadOnly();
+	}
+
 	public function isBackedEnum(): bool
 	{
 		if (!$this->reflection instanceof ReflectionEnum) {
diff --git a/tests/PHPStan/Rules/Properties/ReadOnlyPropertyRuleTest.php b/tests/PHPStan/Rules/Properties/ReadOnlyPropertyRuleTest.php
@@ -89,4 +89,14 @@ public function testRule(int $phpVersionId, array $errors): void
 		$this->analyse([__DIR__ . '/data/read-only-property.php'], $errors);
 	}
 
+	/**
+	 * @dataProvider dataRule
+	 * @param mixed[] $errors
+	 */
+	public function testRuleReadonlyClass(int $phpVersionId, array $errors): void
+	{
+		$this->phpVersionId = $phpVersionId;
+		$this->analyse([__DIR__ . '/data/read-only-property-readonly-class.php'], $errors);
+	}
+
 }
diff --git a/tests/PHPStan/Rules/Properties/data/read-only-property-readonly-class.php b/tests/PHPStan/Rules/Properties/data/read-only-property-readonly-class.php
@@ -0,0 +1,24 @@
+<?php // lint >= 8.2
+
+namespace ReadOnlyPropertyReadonlyClass;
+
+readonly class Foo
+{
+
+	private int $foo;
+	private $bar;
+	private int $baz = 0;
+
+}
+
+readonly final class ErrorResponse
+{
+	public function __construct(public string $message = '')
+	{
+	}
+}
+
+readonly class StaticReadonlyProperty
+{
+	private static int $foo;
+}

Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,7 @@ public function __construct(`
`23`	`23`	`Node $originalNode,`
`24`	`24`	`private bool $isReadonlyByPhpDoc,`
`25`	`25`	`private bool $isDeclaredInTrait,`
	`26`	`+ private bool $isReadonlyClass,`
`26`	`27`	`)`
`27`	`28`	`{`
`28`	`29`	`parent::__construct($originalNode->getAttributes());`
`@@ -76,7 +77,7 @@ public function isStatic(): bool`
`76`	`77`
`77`	`78`	`public function isReadOnly(): bool`
`78`	`79`	`{`
`79`		`- return (bool) ($this->flags & Class_::MODIFIER_READONLY);`
	`80`	`+ return (bool) ($this->flags & Class_::MODIFIER_READONLY) \|\| $this->isReadonlyClass;`
`80`	`81`	`}`
`81`	`82`
`82`	`83`	`public function isReadOnlyByPhpDoc(): bool`
Original file line number	Diff line number	Diff line change
`@@ -584,6 +584,11 @@ public function isEnum(): bool`
`584`	`584`	`return $this->reflection->isEnum();`
`585`	`585`	`}`
`586`	`586`
	`587`	`+ public function isReadOnly(): bool`
	`588`	`+ {`
	`589`	`+ return $this->reflection->isReadOnly();`
	`590`	`+ }`
	`591`	`+`
`587`	`592`	`public function isBackedEnum(): bool`
`588`	`593`	`{`
`589`	`594`	`if (!$this->reflection instanceof ReflectionEnum) {`
Original file line number	Diff line number	Diff line change
`@@ -89,4 +89,14 @@ public function testRule(int $phpVersionId, array $errors): void`
`89`	`89`	`$this->analyse([__DIR__ . '/data/read-only-property.php'], $errors);`
`90`	`90`	`}`
`91`	`91`
	`92`	`+ /**`
	`93`	`+ * @dataProvider dataRule`
	`94`	`+ * @param mixed[] $errors`
	`95`	`+ */`
	`96`	`+ public function testRuleReadonlyClass(int $phpVersionId, array $errors): void`
	`97`	`+ {`
	`98`	`+ $this->phpVersionId = $phpVersionId;`
	`99`	`+ $this->analyse([__DIR__ . '/data/read-only-property-readonly-class.php'], $errors);`
	`100`	`+ }`
	`101`	`+`
`92`	`102`	`}`