EnforceReadonlyPublicPropertyRule: add support for Nette Inject phpdoc and attribute.

Author: mzk

src/Rule/EnforceReadonlyPublicPropertyRule.php

@@ -2,13 +2,16 @@
 
 namespace ShipMonk\PHPStan\Rule;
 
+use LogicException;
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
 use PHPStan\Node\ClassPropertyNode;
 use PHPStan\Php\PhpVersion;
 use PHPStan\Rules\IdentifierRuleError;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
+use ReflectionException;
+use function strpos;
 
 /**
  * @implements Rule<ClassPropertyNode>
@@ -48,6 +51,24 @@ public function processNode(Node $node, Scope $scope): array
             return [];
         }
 
+        try {
+            $propertyReflection = $node->getClassReflection()->getNativeReflection()->getProperty($node->getName());
+        } catch (ReflectionException $e) {
+            throw new LogicException('Property isn\'t found in class reflection.', 0, $e);
+        }
+
+        $attributeName = 'Nette\\DI\\Attributes\\Inject';
+
+        if ($propertyReflection->getAttributes($attributeName) !== []) { // @phpstan-ignore argument.type
+            return [];
+        }
+
+        $phpdoc = $propertyReflection->getDocComment();
+
+        if ($phpdoc !== false && strpos($phpdoc, '@inject') !== false) {
+            return [];
+        }
+
         $error = RuleErrorBuilder::message("Public property `{$node->getName()}` not marked as readonly.")
             ->identifier('shipmonk.publicPropertyNotReadonly')
             ->build();

tests/Rule/EnforceReadonlyPublicPropertyRuleTest.php

@@ -43,6 +43,12 @@ public function testPhp80(): void
         $this->analyseFile(__DIR__ . '/data/EnforceReadonlyPublicPropertyRule/code-80.php');
     }
 
+    public function testNetteInject(): void
+    {
+        $this->phpVersion = $this->createPhpVersion(80_100);
+        $this->analyseFile(__DIR__ . '/data/EnforceReadonlyPublicPropertyRule/code-nette-inject.php');
+    }
+
     private function createPhpVersion(int $version): PhpVersion
     {
         return new PhpVersion($version); // @phpstan-ignore phpstanApi.constructor

tests/Rule/data/EnforceReadonlyPublicPropertyRule/code-nette-inject.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace EnforceReadonlyPublicPropertyRule84;
+
+use Nette\DI\Attributes\Inject;
+
+class MyPresenterClass {
+
+    #[Inject]
+    public int $foo;
+
+    /** @inject */
+    public int $foo2;
+
+    public int $foo3; // error: Public property `foo3` not marked as readonly.
+
+    /**
+     * @int
+     * @inject with comment
+     * @deprecated
+     */
+    public int $foo4;
+}