misc

Author: TomasVotruba

composer.json

@@ -17,7 +17,8 @@
         "tomasvotruba/class-leak": "^2.0",
         "rector/rector": "^2.0",
         "phpstan/extension-installer": "^1.4",
-        "symplify/phpstan-extensions": "^12.0"
+        "symplify/phpstan-extensions": "^12.0",
+        "tomasvotruba/unused-public": "^2.0"
     },
     "autoload": {
         "psr-4": {
@@ -30,17 +31,8 @@
         },
         "classmap": [
             "stubs"
-        ],
-        "files": [
         ]
     },
-    "extra": {
-        "phpstan": {
-            "includes": [
-                "config/services/services.neon"
-            ]
-        }
-    },
     "config": {
         "platform-check": false,
         "allow-plugins": {
@@ -52,5 +44,12 @@
         "fix-cs": "vendor/bin/ecs check --fix --ansi",
         "phpstan": "vendor/bin/phpstan analyse --ansi",
         "rector": "vendor/bin/rector process --dry-run --ansi"
+    },
+    "extra": {
+        "phpstan": {
+            "includes": [
+                "config/services/services.neon"
+            ]
+        }
     }
 }

phpstan.neon

@@ -23,10 +23,10 @@ parameters:
         - */Fixture/*
 
     # https://github.com/TomasVotruba/unused-public
-    # unused_public:
-    #     methods: true
-    #     properties: true
-    #     constants: true
+    unused_public:
+        methods: true
+        properties: true
+        constants: true
 
     # type_coverage:
     #     return: 99
@@ -70,3 +70,6 @@ parameters:
 
         # handle next
         - '#Method Symplify\\PHPStanRules\\Rules\\AbstractSymplifyRule\:\:processNode\(\) should return list<PHPStan\\Rules\\IdentifierRuleError> but returns array<PHPStan\\Rules\\RuleError\|string>#'
+
+        # used in tests
+        - '#Public constant "Symplify\\PHPStanRules\\(.*?)Rule\:\:ERROR_MESSAGE" is never used#'

src/Enum/ClassName.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanRules\Enum;
+
+final class ClassName
+{
+    /**
+     * @var string
+     */
+    public const ROUTE_ATTRIBUTE = 'Symfony\Component\Routing\Annotation\Route';
+}

src/Enum/RuleIdentifier.php

@@ -170,4 +170,9 @@ final class RuleIdentifier
      * @var string
      */
     public const REQUIRED_INTERFACE_CONTRACT_NAMESPACE = 'symplify.requiredInterfaceContractNamespace';
+
+    /**
+     * @var string
+     */
+    public const SYMFONY_REQUIRE_INVOKABLE_CONTROLLER = 'symfony.requireInvokableController';
 }

src/Rules/UppercaseConstantRule.php

@@ -13,6 +13,7 @@
 
 /**
  * @implements Rule<ClassConst>
+ *
  * @see \Symplify\PHPStanRules\Tests\Rules\UppercaseConstantRule\UppercaseConstantRuleTest
  */
 final class UppercaseConstantRule implements Rule

src/Symfony/NodeAnalyzer/SymfonyControllerAnalyzer.php

@@ -6,15 +6,11 @@
 
 use PhpParser\Comment\Doc;
 use PhpParser\Node\Stmt\ClassMethod;
+use Symplify\PHPStanRules\Enum\ClassName;
 use Symplify\PHPStanRules\NodeAnalyzer\AttributeFinder;
 
 final class SymfonyControllerAnalyzer
 {
-    /**
-     * @var string
-     */
-    private const ROUTE_ATTRIBUTE = 'Symfony\Component\Routing\Annotation\Route';
-
     public static function isControllerActionMethod(ClassMethod $classMethod): bool
     {
         $attributeFinder = new AttributeFinder();
@@ -23,7 +19,7 @@ public static function isControllerActionMethod(ClassMethod $classMethod): bool
             return false;
         }
 
-        if ($attributeFinder->hasAttribute($classMethod, self::ROUTE_ATTRIBUTE)) {
+        if ($attributeFinder->hasAttribute($classMethod, ClassName::ROUTE_ATTRIBUTE)) {
             return true;
         }
 

src/Symfony/Rules/RequireInvokableControllerRule.php

@@ -8,10 +8,10 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Node\InClassNode;
 use PHPStan\Rules\Rule;
-use PHPStan\Rules\RuleError;
 use PHPStan\Rules\RuleErrorBuilder;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symplify\PHPStanRules\Enum\MethodName;
+use Symplify\PHPStanRules\Enum\RuleIdentifier;
 use Symplify\PHPStanRules\Symfony\NodeAnalyzer\SymfonyControllerAnalyzer;
 
 /**
@@ -34,7 +34,6 @@ public function getNodeType(): string
 
     /**
      * @param InClassNode $node
-     * @return RuleError[]
      */
     public function processNode(Node $node, Scope $scope): array
     {
@@ -63,6 +62,7 @@ public function processNode(Node $node, Scope $scope): array
             }
 
             $ruleErrors[] = RuleErrorBuilder::message(self::ERROR_MESSAGE)
+                ->identifier(RuleIdentifier::SYMFONY_REQUIRE_INVOKABLE_CONTROLLER)
                 ->line($classMethod->getLine())
                 ->build();
         }