Extract introduced Property Hooks-related functionalities into their own rules

Author: jakubtobiasz

conf/config.level0.neon

@@ -98,6 +98,8 @@ rules:
 	- PHPStan\Rules\Properties\PropertyAttributesRule
 	- PHPStan\Rules\Properties\ReadOnlyPropertyRule
 	- PHPStan\Rules\Properties\ReadOnlyByPhpDocPropertyRule
+	- PHPStan\Rules\PropertyHooks\NonEmptyPropertyHookRule
+	- PHPStan\Rules\PropertyHooks\NonPublicPropertyHookRule
 	- PHPStan\Rules\Regexp\RegularExpressionPatternRule
 	- PHPStan\Rules\Traits\ConflictingTraitConstantsRule
 	- PHPStan\Rules\Traits\ConstantsInTraitsRule

src/Analyser/NodeScopeResolver.php

@@ -899,7 +899,6 @@ private function processStmtNode(
 				}
 				$propStmt = clone $stmt;
 				$propStmt->setAttributes($prop->getAttributes());
-				rd($propStmt);
 				$nodeCallback(
 					new ClassPropertyNode(
 						$propertyName,

src/Node/ClassPropertyNode.php

@@ -142,4 +142,20 @@ public function getSubNodeNames(): array
 		return [];
 	}
 
+	public function isPropertyHook(): bool
+	{
+		return $this->originalNode->hooks !== [];
+	}
+
+	public function areHooksBodiesEmpty(): bool
+	{
+		foreach ($this->originalNode->hooks as $hook) {
+			if ($hook->body !== null) {
+				return false;
+			}
+		}
+
+		return true;
+	}
+
 }

src/Php/PhpVersion.php

@@ -379,4 +379,5 @@ public function substrReturnFalseInsteadOfEmptyString(): bool
 	{
 		return $this->versionId < 80000;
 	}
+
 }

src/Rules/Properties/PropertiesInInterfaceRule.php

@@ -5,7 +5,6 @@
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
 use PHPStan\Node\ClassPropertyNode;
-use PHPStan\Php\PhpVersion;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
 
@@ -15,10 +14,6 @@
 final class PropertiesInInterfaceRule implements Rule
 {
 
-	public function __construct (private PhpVersion $phpVersion)
-	{
-	}
-
 	public function getNodeType(): string
 	{
 		return ClassPropertyNode::class;
@@ -30,7 +25,11 @@ public function processNode(Node $node, Scope $scope): array
 			return [];
 		}
 
-		if ($node->isPublic() && $this->phpVersion->supportsPublicPropertiesInInterfaces()) {
+		if (!$node instanceof ClassPropertyNode) {
+			return [];
+		}
+
+		if ($node->isPropertyHook()) {
 			return [];
 		}
 

src/Rules/PropertyHooks/NonEmptyPropertyHookRule.php

@@ -0,0 +1,53 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\PropertyHooks;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Node\ClassPropertyNode;
+use PHPStan\Php\PhpVersion;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+
+/**
+ * @implements Rule<ClassPropertyNode>
+ */
+final class NonEmptyPropertyHookRule implements Rule
+{
+
+	public function __construct(private PhpVersion $phpVersion)
+	{
+	}
+
+	public function getNodeType(): string
+	{
+		return ClassPropertyNode::class;
+	}
+
+	public function processNode(Node $node, Scope $scope): array
+	{
+		if (!$node->getClassReflection()->isInterface()) {
+			return [];
+		}
+
+		if (!$node instanceof ClassPropertyNode) {
+			return [];
+		}
+
+		if (!$this->phpVersion->supportsPublicPropertiesInInterfaces() || !$node->isPropertyHook()) {
+			return [];
+		}
+
+		if ($node->areHooksBodiesEmpty()) {
+			return [];
+		}
+
+		return [
+			RuleErrorBuilder::message('Property hook must not be empty.')
+				->nonIgnorable()
+				->identifier('propertyHook.nonEmpty')
+				->build(),
+		];
+	}
+
+}

src/Rules/PropertyHooks/NonPublicPropertyHookRule.php

@@ -0,0 +1,53 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\PropertyHooks;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Node\ClassPropertyNode;
+use PHPStan\Php\PhpVersion;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+
+/**
+ * @implements Rule<ClassPropertyNode>
+ */
+final class NonPublicPropertyHookRule implements Rule
+{
+
+	public function __construct(private PhpVersion $phpVersion)
+	{
+	}
+
+	public function getNodeType(): string
+	{
+		return ClassPropertyNode::class;
+	}
+
+	public function processNode(Node $node, Scope $scope): array
+	{
+		if (!$node->getClassReflection()->isInterface()) {
+			return [];
+		}
+
+		if (!$node instanceof ClassPropertyNode) {
+			return [];
+		}
+
+		if (!$this->phpVersion->supportsPublicPropertiesInInterfaces() || !$node->isPropertyHook()) {
+			return [];
+		}
+
+		if ($node->isPublic()) {
+			return [];
+		}
+
+		return [
+			RuleErrorBuilder::message('Property hook must be public.')
+				->nonIgnorable()
+				->identifier('propertyHook.nonPublic')
+				->build(),
+		];
+	}
+
+}

tests/PHPStan/Rules/Properties/NonEmptyPropertyHookRuleTest.php

@@ -0,0 +1,40 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Properties;
+
+use PHPStan\Php\PhpVersion;
+use PHPStan\Rules\PropertyHooks\NonEmptyPropertyHookRule;
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+use const PHP_VERSION_ID;
+
+/**
+ * @extends RuleTestCase<NonEmptyPropertyHookRule>
+ */
+class NonEmptyPropertyHookRuleTest extends RuleTestCase
+{
+
+	protected function getRule(): Rule
+	{
+		return new NonEmptyPropertyHookRule(new PhpVersion(PHP_VERSION_ID));
+	}
+
+	public function testRule(): void
+	{
+		if (PHP_VERSION_ID < 80400) {
+			$this->markTestSkipped('This test requires at least PHP 8.4.');
+		}
+
+		$this->analyse([__DIR__ . '/data/non-empty-property-hook.php'], [
+			[
+				'Property hook must not be empty.',
+				7,
+			],
+			[
+				'Property hook must not be empty.',
+				14,
+			],
+		]);
+	}
+
+}

tests/PHPStan/Rules/Properties/NonPublicPropertyHookRuleTest.php

@@ -0,0 +1,41 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Properties;
+
+use PHPStan\Php\PhpVersion;
+use PHPStan\Rules\PropertyHooks\NonEmptyPropertyHookRule;
+use PHPStan\Rules\PropertyHooks\NonPublicPropertyHookRule;
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+use const PHP_VERSION_ID;
+
+/**
+ * @extends RuleTestCase<NonEmptyPropertyHookRule>
+ */
+class NonPublicPropertyHookRuleTest extends RuleTestCase
+{
+
+	protected function getRule(): Rule
+	{
+		return new NonPublicPropertyHookRule(new PhpVersion(PHP_VERSION_ID));
+	}
+
+	public function testRule(): void
+	{
+		if (PHP_VERSION_ID < 80400) {
+			$this->markTestSkipped('This test requires at least PHP 8.4.');
+		}
+
+		$this->analyse([__DIR__ . '/data/non-public-property-hook.php'], [
+			[
+				'Property hook must be public.',
+				7,
+			],
+			[
+				'Property hook must be public.',
+				9,
+			],
+		]);
+	}
+
+}

tests/PHPStan/Rules/Properties/PropertiesInInterfaceRuleTest.php

@@ -27,12 +27,6 @@ protected function getRule(): Rule
 
 	public function testRule(): void
 	{
-		if ($this->phpVersion->supportsPublicPropertiesInInterfaces()) {
-			$this->analyse([__DIR__ . '/data/properties-in-interface.php'], []);
-
-			return;
-		}
-
 		$this->analyse([__DIR__ . '/data/properties-in-interface.php'], [
 			[
 				'Interfaces may not include properties.',