Use ReadWritePropertiesExtensions in MissingReadOnlyPropertyAssignRule

phpstan · May 29, 2022 · 735c822 · 735c822
1 parent 4d3ada0
commit 735c822
Show file tree

Hide file tree

Showing 8 changed files with 80 additions and 2 deletions.
diff --git a/build/ignore-by-php-version.neon.php b/build/ignore-by-php-version.neon.php
@@ -13,6 +13,7 @@
 	$includes[] = __DIR__ . '/baseline-8.1.neon';
 } else {
 	$includes[] = __DIR__ . '/enums.neon';
+	$includes[] = __DIR__ . '/readonly-property.neon';
 }
 
 if (PHP_VERSION_ID >= 70400) {

diff --git a/build/readonly-property.neon b/build/readonly-property.neon
@@ -0,0 +1,3 @@
+parameters:
+	excludePaths:
+		- ../tests/PHPStan/Rules/Properties/MissingReadOnlyPropertyAssignRuleTest.php
diff --git a/src/Rules/Properties/MissingReadOnlyByPhpDocPropertyAssignRule.php b/src/Rules/Properties/MissingReadOnlyByPhpDocPropertyAssignRule.php
@@ -19,6 +19,7 @@ class MissingReadOnlyByPhpDocPropertyAssignRule implements Rule
 
 	public function __construct(
 		private ConstructorsHelper $constructorsHelper,
+		private ReadWritePropertiesExtensionProvider $extensionProvider,
 	)
 	{
 	}
@@ -34,7 +35,7 @@ public function processNode(Node $node, Scope $scope): array
 			throw new ShouldNotHappenException();
 		}
 		$classReflection = $scope->getClassReflection();
-		[$properties, $prematureAccess, $additionalAssigns] = $node->getUninitializedProperties($scope, $this->constructorsHelper->getConstructors($classReflection), []);
+		[$properties, $prematureAccess, $additionalAssigns] = $node->getUninitializedProperties($scope, $this->constructorsHelper->getConstructors($classReflection), $this->extensionProvider->getExtensions());
 
 		$errors = [];
 		foreach ($properties as $propertyName => $propertyNode) {

diff --git a/src/Rules/Properties/MissingReadOnlyPropertyAssignRule.php b/src/Rules/Properties/MissingReadOnlyPropertyAssignRule.php
@@ -19,6 +19,7 @@ class MissingReadOnlyPropertyAssignRule implements Rule
 
 	public function __construct(
 		private ConstructorsHelper $constructorsHelper,
+		private ReadWritePropertiesExtensionProvider $extensionProvider,
 	)
 	{
 	}
@@ -34,7 +35,7 @@ public function processNode(Node $node, Scope $scope): array
 			throw new ShouldNotHappenException();
 		}
 		$classReflection = $scope->getClassReflection();
-		[$properties, $prematureAccess, $additionalAssigns] = $node->getUninitializedProperties($scope, $this->constructorsHelper->getConstructors($classReflection), []);
+		[$properties, $prematureAccess, $additionalAssigns] = $node->getUninitializedProperties($scope, $this->constructorsHelper->getConstructors($classReflection), $this->extensionProvider->getExtensions());
 
 		$errors = [];
 		foreach ($properties as $propertyName => $propertyNode) {

diff --git a/tests/PHPStan/Rules/Properties/MissingReadOnlyByPhpDocPropertyAssignRuleTest.php b/tests/PHPStan/Rules/Properties/MissingReadOnlyByPhpDocPropertyAssignRuleTest.php
@@ -3,8 +3,10 @@
 namespace PHPStan\Rules\Properties;
 
 use PHPStan\Reflection\ConstructorsHelper;
+use PHPStan\Reflection\PropertyReflection;
 use PHPStan\Rules\Rule;
 use PHPStan\Testing\RuleTestCase;
+use function in_array;
 use const PHP_VERSION_ID;
 
 /**
@@ -19,6 +21,32 @@ protected function getRule(): Rule
 			new ConstructorsHelper([
 				'MissingReadOnlyPropertyAssignPhpDoc\\TestCase::setUp',
 			]),
+			new DirectReadWritePropertiesExtensionProvider([
+				new class() implements ReadWritePropertiesExtension {
+
+					public function isAlwaysRead(PropertyReflection $property, string $propertyName): bool
+					{
+						return $this->isEntityId($property, $propertyName);
+					}
+
+					public function isAlwaysWritten(PropertyReflection $property, string $propertyName): bool
+					{
+						return $this->isEntityId($property, $propertyName);
+					}
+
+					public function isInitialized(PropertyReflection $property, string $propertyName): bool
+					{
+						return $this->isEntityId($property, $propertyName);
+					}
+
+					private function isEntityId(PropertyReflection $property, string $propertyName): bool
+					{
+						return $property->getDeclaringClass()->getName() === 'MissingReadOnlyPropertyAssignPhpDoc\\Entity'
+							&& in_array($propertyName, ['id'], true);
+					}
+
+				},
+			]),
 		);
 	}
 

diff --git a/tests/PHPStan/Rules/Properties/MissingReadOnlyPropertyAssignRuleTest.php b/tests/PHPStan/Rules/Properties/MissingReadOnlyPropertyAssignRuleTest.php
@@ -3,8 +3,10 @@
 namespace PHPStan\Rules\Properties;
 
 use PHPStan\Reflection\ConstructorsHelper;
+use PHPStan\Reflection\PropertyReflection;
 use PHPStan\Rules\Rule;
 use PHPStan\Testing\RuleTestCase;
+use function in_array;
 use const PHP_VERSION_ID;
 
 /**
@@ -19,6 +21,32 @@ protected function getRule(): Rule
 			new ConstructorsHelper([
 				'MissingReadOnlyPropertyAssign\\TestCase::setUp',
 			]),
+			new DirectReadWritePropertiesExtensionProvider([
+				new class() implements ReadWritePropertiesExtension {
+
+					public function isAlwaysRead(PropertyReflection $property, string $propertyName): bool
+					{
+						return $this->isEntityId($property, $propertyName);
+					}
+
+					public function isAlwaysWritten(PropertyReflection $property, string $propertyName): bool
+					{
+						return $this->isEntityId($property, $propertyName);
+					}
+
+					public function isInitialized(PropertyReflection $property, string $propertyName): bool
+					{
+						return $this->isEntityId($property, $propertyName);
+					}
+
+					private function isEntityId(PropertyReflection $property, string $propertyName): bool
+					{
+						return $property->getDeclaringClass()->getName() === 'MissingReadOnlyPropertyAssign\\Entity'
+							&& in_array($propertyName, ['id'], true);
+					}
+
+				},
+			]),
 		);
 	}
 

diff --git a/tests/PHPStan/Rules/Properties/data/missing-readonly-property-assign-phpdoc.php b/tests/PHPStan/Rules/Properties/data/missing-readonly-property-assign-phpdoc.php
@@ -196,3 +196,12 @@ public function __construct()
 	}
 
 }
+
+
+class Entity
+{
+
+	/** @readonly */
+	private int $id; // does not complain about being uninitialized because of a ReadWritePropertiesExtension
+
+}
diff --git a/tests/PHPStan/Rules/Properties/data/missing-readonly-property-assign.php b/tests/PHPStan/Rules/Properties/data/missing-readonly-property-assign.php
@@ -153,3 +153,10 @@ public function __construct(
 	}
 
 }
+
+class Entity
+{
+
+	private readonly int $id; // does not complain about being uninitialized because of a ReadWritePropertiesExtension
+
+}