[symfony] Add RouteGenerateControllerClassRequireNameRule (#180)

* [symfony] Add RouteGenerateControllerClassRequireNameRule

* move symfony classes ot own enum SymfonyClass

Author: TomasVotruba

README.md

@@ -875,6 +875,17 @@ rules:
 
 <br>
 
+### RequireRouteNameToGenerateControllerRouteRule
+
+To pass a controller class to generate() method, the controller must have "#[Route(name: self::class)]" above the __invoke() method
+
+```yaml
+rules:
+    - Symplify\PHPStanRules\Rules\Symfony\RequireRouteNameToGenerateControllerRouteRule
+```
+
+<br>
+
 ### SingleRequiredMethodRule
 
 There must be maximum 1 @required method in the class. Merge it to one to avoid possible injection collision or duplicated injects.

config/symfony-rules.neon

@@ -11,6 +11,7 @@ rules:
     - Symplify\PHPStanRules\Rules\Symfony\NoRoutingPrefixRule
     - Symplify\PHPStanRules\Rules\Symfony\NoClassLevelRouteRule
     - Symplify\PHPStanRules\Rules\Symfony\NoRouteTrailingSlashPathRule
+    - Symplify\PHPStanRules\Rules\Symfony\RequireRouteNameToGenerateControllerRouteRule
 
     # dependency injection
     - Symplify\PHPStanRules\Rules\Symfony\NoGetDoctrineInControllerRule

phpstan.neon

@@ -9,7 +9,7 @@ parameters:
     level: 8
 
     # custom configuration
-    maximumIgnoredErrorCount: 10
+    maximumIgnoredErrorCount: 12
 
     paths:
         - src
@@ -49,3 +49,6 @@ parameters:
 
         - '#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#'
+
+        # not useful
+        - '#with generic class ReflectionAttribute (but )?does not specify its types#'

src/Enum/ClassName.php

@@ -6,37 +6,11 @@
 
 final class ClassName
 {
-    /**
-     * @var string
-     */
-    public const ROUTE_ATTRIBUTE = 'Symfony\Component\Routing\Attribute\Route';
-
-    /**
-     * @api
-     * @var string
-     */
-    public const ROUTE_ANNOTATION = 'Symfony\Component\Routing\Annotation\Route';
-
-    /**
-     * @var string
-     */
-    public const SYMFONY_ABSTRACT_CONTROLLER = 'Symfony\Bundle\FrameworkBundle\Controller\AbstractController';
-
     /**
      * @var string
      */
     public const PHPUNIT_TEST_CASE = 'PHPUnit\Framework\TestCase';
 
-    /**
-     * @var string
-     */
-    public const EVENT_DISPATCHER_INTERFACE = 'Symfony\Component\EventDispatcher\EventDispatcherInterface';
-
-    /**
-     * @var string
-     */
-    public const EVENT_SUBSCRIBER_INTERFACE = 'Symfony\Component\EventDispatcher\EventSubscriberInterface';
-
     /**
      * @var string
      */
@@ -62,21 +36,6 @@ final class ClassName
      */
     public const RECTOR_ATTRIBUTE_KEY = 'Rector\NodeTypeResolver\Node\AttributeKey';
 
-    /**
-     * @var string
-     */
-    public const FORM_EVENTS = 'Symfony\Component\Form\FormEvents';
-
-    /**
-     * @var string
-     */
-    public const FORM_TYPE = 'Symfony\Component\Form\AbstractType';
-
-    /**
-     * @var string
-     */
-    public const SYMFONY_CONTROLLER = 'Symfony\Bundle\FrameworkBundle\Controller\Controller';
-
     /**
      * @var string
      */
@@ -91,14 +50,4 @@ 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';
-
-    /**
-     * @var string
-     */
-    public const SYMFONY_ROUTE_IMPORT_CONFIGURATOR = 'Symfony\Component\Routing\Loader\Configurator\ImportConfigurator';
 }

src/Enum/SymfonyClass.php

@@ -0,0 +1,64 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanRules\Enum;
+
+final class SymfonyClass
+{
+    /**
+     * @var string
+     */
+    public const ROUTE_ATTRIBUTE = 'Symfony\Component\Routing\Attribute\Route';
+
+    /**
+     * @api
+     * @var string
+     */
+    public const ROUTE_ANNOTATION = 'Symfony\Component\Routing\Annotation\Route';
+
+    /**
+     * @var string
+     */
+    public const SYMFONY_CONTROLLER = 'Symfony\Bundle\FrameworkBundle\Controller\Controller';
+
+    /**
+     * @var string
+     */
+    public const REQUIRED_ATTRIBUTE = 'Symfony\Contracts\Service\Attribute\Required';
+
+    /**
+     * @var string
+     */
+    public const SYMFONY_ABSTRACT_CONTROLLER = 'Symfony\Bundle\FrameworkBundle\Controller\AbstractController';
+
+    /**
+     * @var string
+     */
+    public const EVENT_SUBSCRIBER_INTERFACE = 'Symfony\Component\EventDispatcher\EventSubscriberInterface';
+
+    /**
+     * @var string
+     */
+    public const EVENT_DISPATCHER_INTERFACE = 'Symfony\Component\EventDispatcher\EventDispatcherInterface';
+
+    /**
+     * @var string
+     */
+    public const FORM_TYPE = 'Symfony\Component\Form\AbstractType';
+
+    /**
+     * @var string
+     */
+    public const ROUTE_IMPORT_CONFIGURATOR = 'Symfony\Component\Routing\Loader\Configurator\ImportConfigurator';
+
+    /**
+     * @var string
+     */
+    public const FORM_EVENTS = 'Symfony\Component\Form\FormEvents';
+
+    /**
+     * @var string
+     */
+    public const URL_GENERATOR = 'Symfony\Component\Routing\Generator\UrlGeneratorInterface';
+}

src/Enum/SymfonyRuleIdentifier.php

@@ -37,4 +37,6 @@ final class SymfonyRuleIdentifier
     public const NO_ROUTE_TRAILING_SLASH_PATH = 'symfony.noRouteTrailingSlashPath';
 
     public const NO_FIND_TAGGED_SERVICE_IDS_CALL = 'symfony.noFindTaggedServiceIdsCall';
+
+    public const REQUIRE_ROUTE_NAME_TO_GENERATE_CONTROLLER_ROUTE = 'symfony.requireRouteNameToGenerateControllerRoute';
 }

src/NodeAnalyzer/SymfonyRequiredMethodAnalyzer.php

@@ -6,7 +6,7 @@
 
 use PhpParser\Comment\Doc;
 use PhpParser\Node\Stmt\ClassMethod;
-use Symplify\PHPStanRules\Enum\ClassName;
+use Symplify\PHPStanRules\Enum\SymfonyClass;
 
 final class SymfonyRequiredMethodAnalyzer
 {
@@ -23,7 +23,7 @@ public static function detect(ClassMethod $classMethod): bool
 
         foreach ($classMethod->getAttrGroups() as $attributeGroup) {
             foreach ($attributeGroup->attrs as $attr) {
-                if ($attr->name->toString() === ClassName::REQUIRED_ATTRIBUTE) {
+                if ($attr->name->toString() === SymfonyClass::REQUIRED_ATTRIBUTE) {
                     return true;
                 }
             }

src/Reflection/InvokeClassMethodResolver.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Symplify\PHPStanRules\Reflection;
+
+use PHPStan\Reflection\ClassReflection;
+use ReflectionMethod;
+
+final class InvokeClassMethodResolver
+{
+    public static function resolve(ClassReflection $controllerClassReflection): null|ReflectionMethod
+    {
+        if (! $controllerClassReflection->hasMethod('__invoke')) {
+            return null;
+        }
+
+        $nativeReflectionClass = $controllerClassReflection->getNativeReflection();
+        return $nativeReflectionClass->getMethod('__invoke');
+    }
+}

src/Rules/ClassNameRespectsParentSuffixRule.php

@@ -15,6 +15,7 @@
 use PHPStan\Rules\RuleErrorBuilder;
 use Symplify\PHPStanRules\Enum\ClassName;
 use Symplify\PHPStanRules\Enum\RuleIdentifier;
+use Symplify\PHPStanRules\Enum\SymfonyClass;
 use Symplify\PHPStanRules\Naming\ClassToSuffixResolver;
 
 /**
@@ -33,8 +34,8 @@ final class ClassNameRespectsParentSuffixRule implements Rule
      */
     private const DEFAULT_PARENT_CLASSES = [
         'Symfony\Component\Console\Command\Command',
-        ClassName::EVENT_SUBSCRIBER_INTERFACE,
-        ClassName::SYMFONY_ABSTRACT_CONTROLLER,
+        SymfonyClass::EVENT_SUBSCRIBER_INTERFACE,
+        SymfonyClass::SYMFONY_ABSTRACT_CONTROLLER,
         ClassName::SNIFF,
         ClassName::PHPUNIT_TEST_CASE,
         Exception::class,

src/Rules/Symfony/FormTypeClassNameRule.php

@@ -12,7 +12,7 @@
 use PHPStan\Rules\RuleError;
 use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\Type\ObjectType;
-use Symplify\PHPStanRules\Enum\ClassName;
+use Symplify\PHPStanRules\Enum\SymfonyClass;
 use Symplify\PHPStanRules\Enum\SymfonyRuleIdentifier;
 
 /**
@@ -45,14 +45,14 @@ public function processNode(Node $node, Scope $scope): array
 
         $currentObjectType = new ObjectType($className);
 
-        $parentObjectType = new ObjectType(ClassName::FORM_TYPE);
+        $parentObjectType = new ObjectType(SymfonyClass::FORM_TYPE);
         if (! $parentObjectType->isSuperTypeOf($currentObjectType)->yes()) {
             return [];
         }
 
         $errorMessage = sprintf(
             'Class extends "%s" must have "FormType" suffix to make form explicit, "%s" given',
-            ClassName::FORM_TYPE,
+            SymfonyClass::FORM_TYPE,
             $className
         );