Add SingleRequiredMethodRule

Author: TomasVotruba

README.md

@@ -794,6 +794,17 @@ class SomeClass extends SomeParentClass
 
 <br>
 
+### SingleRequiredMethodRule
+
+There must be maximum 1 @required method in the class. Merge it to one to avoid possible injection collision or duplicated injects.
+
+```yaml
+rules:
+    - Symplify\PHPStanRules\Rules\Symfony\SingleRequiredMethodRule
+```
+
+<br>
+
 ### RequireAttributeNameRule
 
 Attribute must have all names explicitly defined

src/Enum/ClassName.php

@@ -80,4 +80,9 @@ final class ClassName
      * @var string
      */
     public const MOCK_OBJECT_CLASS = 'PHPUnit\Framework\MockObject\MockObject';
+
+    /**
+     * @var string
+     */
+    public const REQUIRED_ATTRIBUTE = 'Symfony\Contracts\Service\Attribute\Required';
 }

src/NodeAnalyzer/SymfonyRequiredMethodAnalyzer.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanRules\NodeAnalyzer;
+
+use PhpParser\Comment\Doc;
+use PhpParser\Node\Stmt\ClassMethod;
+use Symplify\PHPStanRules\Enum\ClassName;
+
+final class SymfonyRequiredMethodAnalyzer
+{
+    public static function detect(ClassMethod $classMethod): bool
+    {
+        // speed up
+        if (! $classMethod->isPublic()) {
+            return false;
+        }
+
+        if ($classMethod->isMagic()) {
+            return false;
+        }
+
+        foreach ($classMethod->getAttrGroups() as $attributeGroup) {
+            foreach ($attributeGroup->attrs as $attr) {
+                if ($attr->name->toString() === ClassName::REQUIRED_ATTRIBUTE) {
+                    return true;
+                }
+            }
+        }
+
+        $docComment = $classMethod->getDocComment();
+        if (! $docComment instanceof Doc) {
+            return false;
+        }
+
+        return str_contains($docComment->getText(), '@required');
+    }
+}

src/Rules/Symfony/NoRequiredOutsideClassRule.php

@@ -4,14 +4,13 @@
 
 namespace Symplify\PHPStanRules\Rules\Symfony;
 
-use PhpParser\Comment\Doc;
 use PhpParser\Node;
-use PhpParser\Node\Stmt\ClassMethod;
 use PhpParser\Node\Stmt\Trait_;
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
 use Symplify\PHPStanRules\Enum\SymfonyRuleIdentifier;
+use Symplify\PHPStanRules\NodeAnalyzer\SymfonyRequiredMethodAnalyzer;
 
 /**
  * @see \Symplify\PHPStanRules\Tests\Rules\Symfony\NoRequiredOutsideClassRule\NoRequiredOutsideClassRuleTest
@@ -25,11 +24,6 @@ final class NoRequiredOutsideClassRule implements Rule
      */
     public const ERROR_MESSAGE = 'Symfony #[Require]/@required should be used only in classes to avoid misuse';
 
-    /**
-     * @var string
-     */
-    private const REQUIRED_ATTRIBUTE = 'Symfony\Contracts\Service\Attribute\Required';
-
     public function getNodeType(): string
     {
         return Trait_::class;
@@ -43,29 +37,17 @@ public function processNode(Node $node, Scope $scope): array
         $ruleErrors = [];
 
         foreach ($node->getMethods() as $classMethod) {
-            if ($this->isAutowiredClassMethod($classMethod)) {
-                $ruleErrors[] = RuleErrorBuilder::message(self::ERROR_MESSAGE)
-                    ->file($scope->getFile())
-                    ->identifier(SymfonyRuleIdentifier::SYMFONY_NO_REQUIRED_OUTSIDE_CLASS)
-                    ->line($classMethod->getLine())
-                    ->build();
+            if (! SymfonyRequiredMethodAnalyzer::detect($classMethod)) {
+                continue;
             }
-        }
 
-        return $ruleErrors;
-    }
-
-    private function isAutowiredClassMethod(ClassMethod $classMethod): bool
-    {
-        foreach ($classMethod->getAttrGroups() as $attributeGroup) {
-            foreach ($attributeGroup->attrs as $attr) {
-                if ($attr->name->toString() === self::REQUIRED_ATTRIBUTE) {
-                    return true;
-                }
-            }
+            $ruleErrors[] = RuleErrorBuilder::message(self::ERROR_MESSAGE)
+                ->file($scope->getFile())
+                ->identifier(SymfonyRuleIdentifier::SYMFONY_NO_REQUIRED_OUTSIDE_CLASS)
+                ->line($classMethod->getLine())
+                ->build();
         }
 
-        $docComment = $classMethod->getDocComment();
-        return $docComment instanceof Doc && str_contains($docComment->getText(), '@required');
+        return $ruleErrors;
     }
 }

src/Rules/Symfony/SingleRequiredMethodRule.php

@@ -2,20 +2,22 @@
 
 namespace Symplify\PHPStanRules\Rules\Symfony;
 
-use PhpParser\Comment\Doc;
 use PhpParser\Node;
 use PhpParser\Node\Stmt\Class_;
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleError;
 use PHPStan\Rules\RuleErrorBuilder;
 use Symplify\PHPStanRules\Enum\SymfonyRuleIdentifier;
+use Symplify\PHPStanRules\NodeAnalyzer\SymfonyRequiredMethodAnalyzer;
 
 /**
  * @implements Rule<Class_>
  */
 final class SingleRequiredMethodRule implements Rule
 {
+    public const ERROR_MESSAGE = 'Found %d @required methods. Use only one method to avoid unexpected behavior.';
+
     public function getNodeType(): string
     {
         return Class_::class;
@@ -30,31 +32,18 @@ public function processNode(Node $node, Scope $scope): array
         $requiredClassMethodCount = 0;
 
         foreach ($node->getMethods() as $classMethod) {
-            if (! $classMethod->getDocComment() instanceof Doc) {
-                continue;
-            }
-
-            $doc = $classMethod->getDocComment();
-
-            if (! str_contains($doc->getText(), '@required')) {
+            if (! SymfonyRequiredMethodAnalyzer::detect($classMethod)) {
                 continue;
             }
 
             ++$requiredClassMethodCount;
         }
 
-        if ($requiredClassMethodCount === 0) {
-            return [];
-        }
-
         if ($requiredClassMethodCount < 2) {
             return [];
         }
 
-        $errorMessage = sprintf(
-            'Found %d @required methods. Use only one method to avoid unexpected behavior.',
-            $requiredClassMethodCount
-        );
+        $errorMessage = sprintf(self::ERROR_MESSAGE, $requiredClassMethodCount);
 
         $ruleError = RuleErrorBuilder::message($errorMessage)
             ->identifier(SymfonyRuleIdentifier::SINGLE_REQUIRED_METHOD)

tests/Rules/CheckRequiredInterfaceInContractNamespaceRule/CheckRequiredInterfaceInContractNamespaceRuleTest.php

@@ -12,9 +12,6 @@
 
 final class CheckRequiredInterfaceInContractNamespaceRuleTest extends RuleTestCase
 {
-    /**
-     * @param mixed[] $expectedErrorsWithLines
-     */
     #[DataProvider('provideData')]
     public function testRule(string $filePath, array $expectedErrorsWithLines): void
     {

tests/Rules/Explicit/ExplicitClassPrefixSuffixRule/ExplicitClassPrefixSuffixRuleTest.php

@@ -12,9 +12,6 @@
 
 final class ExplicitClassPrefixSuffixRuleTest extends RuleTestCase
 {
-    /**
-     * @param mixed[] $expectedErrorsWithLines
-     */
     #[DataProvider('provideData')]
     public function testRule(string $filePath, array $expectedErrorsWithLines): void
     {

tests/Rules/NoReturnSetterMethodRule/NoReturnSetterMethodRuleTest.php

@@ -12,9 +12,6 @@
 
 final class NoReturnSetterMethodRuleTest extends RuleTestCase
 {
-    /**
-     * @param mixed[] $expectedErrorsWithLines
-     */
     #[DataProvider('provideData')]
     public function testRule(string $filePath, array $expectedErrorsWithLines): void
     {

tests/Rules/Rector/NoClassReflectionStaticReflectionRule/NoClassReflectionStaticReflectionRuleTest.php

@@ -12,9 +12,6 @@
 
 final class NoClassReflectionStaticReflectionRuleTest extends RuleTestCase
 {
-    /**
-     * @param mixed[] $expectedErrorsWithLines
-     */
     #[DataProvider('provideData')]
     public function testRule(string $filePath, array $expectedErrorsWithLines): void
     {

tests/Rules/Rector/NoInstanceOfStaticReflectionRule/NoInstanceOfStaticReflectionRuleTest.php

@@ -12,9 +12,6 @@
 
 final class NoInstanceOfStaticReflectionRuleTest extends RuleTestCase
 {
-    /**
-     * @param mixed[] $expectedErrorsWithLines
-     */
     #[DataProvider('provideData')]
     public function testRule(string $filePath, array $expectedErrorsWithLines): void
     {