improve symfony rules location

Author: TomasVotruba

README.md

@@ -876,7 +876,7 @@ Use invokable controller with `__invoke()` method instead of named action method
 
 ```yaml
 rules:
-    - Symplify\PHPStanRules\Symfony\Rules\RequireInvokableControllerRule
+    - Symplify\PHPStanRules\Rules\Symfony\RequireInvokableControllerRule
 ```
 
 ```php

composer.json

@@ -26,7 +26,10 @@
     "autoload": {
         "psr-4": {
             "Symplify\\PHPStanRules\\": "src"
-        }
+        },
+        "files": [
+            "src/functions/fast-functions.php"
+        ]
     },
     "autoload-dev": {
         "psr-4": {

config/symfony-rules.neon

@@ -1,4 +1,7 @@
 rules:
-    - Symplify\PHPStanRules\PHPStan\Rule\NoAbstractControllerConstructorRule
-    - Symplify\PHPStanRules\PHPStan\Rule\NoRequiredOutsideClassRule
-    - Symplify\PHPStanRules\PHPStan\Rule\SingleArgEventDispatchRule
+    - Symplify\PHPStanRules\Rules\Symfony\NoAbstractControllerConstructorRule
+    - Symplify\PHPStanRules\Rules\Symfony\NoRequiredOutsideClassRule
+    - Symplify\PHPStanRules\Rules\Symfony\SingleArgEventDispatchRule
+    - Symplify\PHPStanRules\Rules\Symfony\NoListenerWithoutContractRule
+    - Symplify\PHPStanRules\Rules\Symfony\NoStringInGetSubscribedEventsRule
+    - Symplify\PHPStanRules\Rules\Symfony\RequireInvokableControllerRule

phpstan.neon

@@ -22,41 +22,26 @@ parameters:
         - */stubs/*
         - */Fixture/*
 
-    # https://github.com/TomasVotruba/unused-public
-    unused_public:
-        methods: true
-        properties: true
-        constants: true
-
-    type_coverage:
-        return: 99
-        param: 99
-        property: 99
-
     ignoreErrors:
         # needless generics
-        - '#Class Symplify\\PHPStanRules\\(.*?)Rule implements generic interface PHPStan\\Rules\\Rule but does not specify its types\: TNodeType#'
+#        - '#Class Symplify\\PHPStanRules\\(.*?)Rule implements generic interface PHPStan\\Rules\\Rule but does not specify its types\: TNodeType#'
 
         - '#Method Symplify\\PHPStanRules\\Reflection\\ReflectionParser\:\:parseNativeClassReflection\(\) has parameter \$reflectionClass with generic class ReflectionClass but does not specify its types\: T#'
 
         # overly detailed
         - '#Class Symplify\\PHPStanRules\\(.*?) extends generic class PHPStan\\Testing\\RuleTestCase but does not specify its types\: TRule#'
         - '#Method Symplify\\PHPStanRules\\(.*?)\:\:getRule\(\) return type with generic interface PHPStan\\Rules\\Rule does not specify its types\: TNodeType#'
+        - '#Parameter \#2 \$expectedErrors of method PHPStan\\Testing\\RuleTestCase<PHPStan\\Rules\\Rule>\:\:analyse\(\) expects list<array\{0\: string, 1\: int, 2\?\: string\|null\}>, (.*?) given#'
 
         # part of public contract
-        - '#Method Symplify\\PHPStanRules\\Tests\\Rules\\PHPUnit\\(.*?)\\(.*?)Test\:\:testRule\(\) has parameter \$expectedErrorMessagesWithLines with no value type specified in iterable type array#'
+        - '#Method Symplify\\PHPStanRules\\Tests\\Rules\\(.*?)\\(.*?)Test\:\:testRule\(\) has parameter \$(expectedError(.*?)|expectedErrors) with no value type specified in iterable type array#'
 
         # overly detailed
         - '#Class Symplify\\PHPStanRules\\Collector\\(.*?) implements generic interface PHPStan\\Collectors\\Collector but does not specify its types\: TNodeType, TValue#'
 
         # useful to have IDE know the types
         - identifier: phpstanApi.instanceofType
 
-        # overly detailed
-        -
-            message: '#Parameter \#2 \$expectedErrors of method PHPStan\\Testing\\RuleTestCase<(.*?)>::analyse\(\) expects list<array\{0: string, 1: int, 2\?: string\|null\}>, (.*?) given#'
-            path: tests
-
         # fast effective check
         -
             message: '#Function is_a\(\) is a runtime reflection concept that might not work in PHPStan because it uses fully static reflection engine#'

src/Enum/ClassName.php

@@ -50,4 +50,19 @@ final class ClassName
      * @var string
      */
     public const RECTOR_ATTRIBUTE_KEY = 'Rector\NodeTypeResolver\Node\AttributeKey';
+
+    /**
+     * @var string
+     */
+    public const FORM_EVENTS = 'Symfony\Component\Form\FormEvents';
+
+    /**
+     * @var string
+     */
+    public const SYMFONY_CONTROLLER = 'Symfony\Bundle\FrameworkBundle\Controller\Controller';
+
+    /**
+     * @var string
+     */
+    public const DOCTRINE_FIXTURE_INTERFACE = 'Doctrine\Common\DataFixtures\FixtureInterface';
 }

src/Enum/RuleIdentifier.php

@@ -160,4 +160,14 @@ final class RuleIdentifier
      * @var string
      */
     public const NO_VALUE_OBJECT_IN_SERVICE_CONSTRUCTOR = 'symplify.noValueObjectInServiceConstructor';
+
+    /**
+     * @var string
+     */
+    public const DOCTRINE_NO_REPOSITORY_CALL_IN_DATA_FIXTURES = 'doctrine.noRepositoryCallInDataFixtures';
+
+    /**
+     * @var string
+     */
+    public const PHPUNIT_NO_DOCUMENT_MOCKING = 'phpunit.noDocumentMocking';
 }

src/PHPStan/Rules/Doctrine/NoRepositoryCallInDataFixtureRule.php

@@ -8,10 +8,15 @@
 use PhpParser\Node\Expr\MethodCall;
 use PhpParser\Node\Identifier;
 use PHPStan\Analyser\Scope;
+use PHPStan\Rules\IdentifierRuleError;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+use Symplify\PHPStanRules\Enum\ClassName;
+use Symplify\PHPStanRules\Enum\RuleIdentifier;
+use Symplify\PHPStanRules\Tests\Rules\Doctrine\NoRepositoryCallInDataFixtureRule\NoRepositoryCallInDataFixtureRuleTest;
 
 /**
- * @see \Symplify\PHPStanRules\Tests\PHPStan\Rule\NoRepositoryCallInDataFixtureRule\NoRepositoryCallInDataFixtureRuleTest
+ * @see NoRepositoryCallInDataFixtureRuleTest
  *
  * @implements Rule<MethodCall>
  */
@@ -22,19 +27,14 @@ final class NoRepositoryCallInDataFixtureRule implements Rule
      */
     public const ERROR_MESSAGE = 'Refactor read-data fixtures to write-only, make use of references';
 
-    /**
-     * @var string
-     */
-    private const FIXTURE_INTERFACE = 'Doctrine\Common\DataFixtures\FixtureInterface';
-
     public function getNodeType(): string
     {
         return MethodCall::class;
     }
 
     /**
      * @param MethodCall $node
-     * @return string[]
+     * @return IdentifierRuleError[]
      */
     public function processNode(Node $node, Scope $scope): array
     {
@@ -55,7 +55,11 @@ public function processNode(Node $node, Scope $scope): array
             return [];
         }
 
-        return [self::ERROR_MESSAGE];
+        $ruleError = RuleErrorBuilder::message(self::ERROR_MESSAGE)
+            ->identifier(RuleIdentifier::DOCTRINE_NO_REPOSITORY_CALL_IN_DATA_FIXTURES)
+            ->build();
+
+        return [$ruleError];
     }
 
     private function isDataFixtureClass(Scope $scope): bool
@@ -65,6 +69,6 @@ private function isDataFixtureClass(Scope $scope): bool
         }
 
         $classReflection = $scope->getClassReflection();
-        return $classReflection->isSubclassOf(self::FIXTURE_INTERFACE);
+        return $classReflection->isSubclassOf(ClassName::DOCTRINE_FIXTURE_INTERFACE);
     }
 }

src/Rules/Complexity/NoConstructorOverrideRule.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Symplify\PHPStanRules\PHPStan\Rule;
+namespace Symplify\PHPStanRules\Rules\Complexity;
 
 use PhpParser\Node;
 use PhpParser\Node\Expr\StaticCall;

src/Rules/Doctrine/NoDocumentMockingRule.php

@@ -9,6 +9,8 @@
 use PhpParser\Node\Identifier;
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+use Symplify\PHPStanRules\Enum\RuleIdentifier;
 
 /**
  * @implements Rule<MethodCall>
@@ -27,7 +29,6 @@ public function getNodeType(): string
 
     /**
      * @param MethodCall $node
-     * @return string[]
      */
     public function processNode(Node $node, Scope $scope): array
     {
@@ -51,7 +52,11 @@ public function processNode(Node $node, Scope $scope): array
                 continue;
             }
 
-            return [self::ERROR_MESSAGE];
+            $ruleError = RuleErrorBuilder::message(self::ERROR_MESSAGE)
+                ->identifier(RuleIdentifier::PHPUNIT_NO_DOCUMENT_MOCKING)
+                ->build();
+
+            return [$ruleError];
         }
 
         return [];

src/Rules/NoSingleInterfaceImplementerRule.php

@@ -18,6 +18,8 @@
 
 /**
  * @see \Symplify\PHPStanRules\Tests\Rules\NoSingleInterfaceImplementerRule\NoSingleInterfaceImplementerRuleTest
+ *
+ * @implements Rule<CollectedDataNode>
  */
 final readonly class NoSingleInterfaceImplementerRule implements Rule
 {