Add SingleRequiredMethodRule to spot multiple @required methods in Symfony projects (#163)

* split identifiers by group to easily search through them

* 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

phpstan.neon

@@ -48,5 +48,4 @@ parameters:
         - '#Public constant "Symplify\\PHPStanRules\\(.*?)Rule\:\:ERROR_MESSAGE" is never used#'
 
         - '#Although PHPStan\\Node\\InClassNode is covered by backward compatibility promise, this instanceof assumption might break because (.*?) not guaranteed to always stay the same#'
-
         - '#PHPStan\\DependencyInjection\\NeonAdapter#'

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/Enum/DoctrineRuleIdentifier.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanRules\Enum;
+
+final class DoctrineRuleIdentifier
+{
+    public const DOCTRINE_NO_GET_REPOSITORY_OUTSIDE_SERVICE = 'doctrine.noGetRepositoryOutsideService';
+
+    public const DOCTRINE_NO_REPOSITORY_CALL_IN_DATA_FIXTURES = 'doctrine.noRepositoryCallInDataFixtures';
+
+    public const DOCTRINE_NO_PARENT_REPOSITORY = 'doctrine.noParentRepository';
+
+    public const NO_ENTITY_MOCKING = 'doctrine.noEntityMocking';
+
+    public const REQUIRE_QUERY_BUILDER_ON_REPOSITORY = 'doctrine.requireQueryBuilderOnRepository';
+}

src/Enum/PHPUnitRuleIdentifier.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanRules\Enum;
+
+final class PHPUnitRuleIdentifier
+{
+    public const NO_DOCUMENT_MOCKING = 'phpunit.noDocumentMocking';
+
+    public const NO_MOCK_ONLY = 'phpunit.noMockOnly';
+
+    public const PUBLIC_STATIC_DATA_PROVIDER = 'phpunit.publicStaticDataProvider';
+}

src/Enum/RectorRuleIdentifier.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanRules\Enum;
+
+final class RectorRuleIdentifier
+{
+    public const NO_INSTANCE_OF_STATIC_REFLECTION = 'rector.noInstanceOfStaticReflection';
+
+    public const UPGRADE_DOWNGRADE_REGISTERED_IN_SET = 'rector.upgradeDowngradeRegisteredInSet';
+
+    public const PHP_RULE_IMPLEMENTS_MIN_VERSION = 'rector.phpRuleImplementsMinVersion';
+
+    public const NO_CLASS_REFLECTION_STATIC_REFLECTION = 'rector.noClassReflectionStaticReflection';
+}

src/Enum/RuleIdentifier.php

@@ -12,16 +12,8 @@ final class RuleIdentifier
 
     public const REQUIRE_ATTRIBUTE_NAME = 'symplify.requireAttributeName';
 
-    public const RECTOR_PHP_RULE_IMPLEMENTS_MIN_VERSION = 'rector.phpRuleImplementsMinVersion';
-
-    public const RECTOR_UPGRADE_DOWNGRADE_REGISTERED_IN_SET = 'rector.upgradeDowngradeRegisteredInSet';
-
     public const PHP_PARSER_NO_LEADING_BACKSLASH_IN_NAME = 'phpParser.noLeadingBackslashInName';
 
-    public const RECTOR_NO_INSTANCE_OF_STATIC_REFLECTION = 'rector.noInstanceOfStaticReflection';
-
-    public const RECTOR_NO_CLASS_REFLECTION_STATIC_REFLECTION = 'rector.noClassReflectionStaticReflection';
-
     public const PARENT_METHOD_VISIBILITY_OVERRIDE = 'symplify.parentMethodVisibilityOverride';
 
     public const NO_RETURN_SETTER_METHOD = 'symplify.noReturnSetterMethod';
@@ -62,47 +54,15 @@ final class RuleIdentifier
 
     public const REQUIRED_INTERFACE_CONTRACT_NAMESPACE = 'symplify.requiredInterfaceContractNamespace';
 
-    public const SYMFONY_REQUIRE_INVOKABLE_CONTROLLER = 'symfony.requireInvokableController';
-
     public const NO_VALUE_OBJECT_IN_SERVICE_CONSTRUCTOR = 'symplify.noValueObjectInServiceConstructor';
 
-    public const DOCTRINE_NO_REPOSITORY_CALL_IN_DATA_FIXTURES = 'doctrine.noRepositoryCallInDataFixtures';
-
-    public const PHPUNIT_NO_DOCUMENT_MOCKING = 'phpunit.noDocumentMocking';
-
     public const NO_DYNAMIC_NAME = 'symplify.noDynamicName';
 
     public const NO_REFERENCE = 'symplify.noReference';
 
-    public const PHPUNIT_NO_MOCK_ONLY = 'phpunit.noMockOnly';
-
-    public const SINGLE_ARG_EVENT_DISPATCH = 'symfony.singleArgEventDispatch';
-
-    public const NO_ENTITY_MOCKING = 'doctrine.noEntityMocking';
-
-    public const NO_STRING_IN_GET_SUBSCRIBED_EVENTS = 'symfony.noStringInGetSubscribedEvents';
-
-    public const NO_LISTENER_WITHOUT_CONTRACT = 'symfony.noListenerWithoutContract';
-
-    public const DOCTRINE_NO_PARENT_REPOSITORY = 'doctrine.noParentRepository';
-
-    public const DOCTRINE_NO_GET_REPOSITORY_OUTSIDE_SERVICE = 'doctrine.noGetRepositoryOutsideService';
-
-    public const SYMFONY_NO_REQUIRED_OUTSIDE_CLASS = 'symfony.noRequiredOutsideClass';
-
     public const NO_CONSTRUCTOR_OVERRIDE = 'symplify.noConstructorOverride';
 
-    public const SYMFONY_NO_ABSTRACT_CONTROLLER_CONSTRUCTOR = 'symfony.noAbstractControllerConstructor';
-
-    public const PHPUNIT_PUBLIC_STATIC_DATA_PROVIDER = 'phpunit.publicStaticDataProvider';
-
     public const FORBIDDEN_NEW_INSTANCE = 'symplify.forbiddenNewInstance';
 
-    public const REQUIRE_QUERY_BUILDER_ON_REPOSITORY = 'doctrine.requireQueryBuilderOnRepository';
-
-    public const NO_GET_IN_CONTROLLER = 'symfony.noGetInController';
-
-    public const NO_GET_DOCTRINE_IN_CONTROLLER = 'symfony.noGetDoctrineInController';
-
     public const MAXIMUM_IGNORED_ERROR_COUNT = 'symplify.maximumIgnoredErrorCount';
 }

src/Enum/SymfonyRuleIdentifier.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanRules\Enum;
+
+final class SymfonyRuleIdentifier
+{
+    public const NO_GET_IN_CONTROLLER = 'symfony.noGetInController';
+
+    public const NO_GET_DOCTRINE_IN_CONTROLLER = 'symfony.noGetDoctrineInController';
+
+    public const SINGLE_ARG_EVENT_DISPATCH = 'symfony.singleArgEventDispatch';
+
+    public const NO_LISTENER_WITHOUT_CONTRACT = 'symfony.noListenerWithoutContract';
+
+    public const SYMFONY_REQUIRE_INVOKABLE_CONTROLLER = 'symfony.requireInvokableController';
+
+    public const SYMFONY_NO_REQUIRED_OUTSIDE_CLASS = 'symfony.noRequiredOutsideClass';
+
+    public const NO_STRING_IN_GET_SUBSCRIBED_EVENTS = 'symfony.noStringInGetSubscribedEvents';
+
+    public const SYMFONY_NO_ABSTRACT_CONTROLLER_CONSTRUCTOR = 'symfony.noAbstractControllerConstructor';
+
+    public const SINGLE_REQUIRED_METHOD = 'symfony.singleRequiredMethod';
+}

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/Doctrine/NoDocumentMockingRule.php

@@ -10,7 +10,7 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
-use Symplify\PHPStanRules\Enum\RuleIdentifier;
+use Symplify\PHPStanRules\Enum\PHPUnitRuleIdentifier;
 
 /**
  * @implements Rule<MethodCall>
@@ -53,7 +53,7 @@ public function processNode(Node $node, Scope $scope): array
             }
 
             $ruleError = RuleErrorBuilder::message(self::ERROR_MESSAGE)
-                ->identifier(RuleIdentifier::PHPUNIT_NO_DOCUMENT_MOCKING)
+                ->identifier(PHPUnitRuleIdentifier::NO_DOCUMENT_MOCKING)
                 ->build();
 
             return [$ruleError];