[symfony] Add NoGetInCommandRule (#184)

Author: TomasVotruba

README.md

@@ -1379,6 +1379,19 @@ rules:
 <br>
 
 
+### NoGetInCommandRule
+
+Prevents using `$this->get(...)` in commands, to promote dependency injection.
+
+
+```yaml
+rules:
+    - Symplify\PHPStanRules\Rules\Symfony\NoGetInCommandRule
+```
+
+<br>
+
+
 ### NoAbstractControllerConstructorRule
 
 Abstract controller should not have constructor, as it can lead to tight coupling. Use @required annotation instead

config/symfony-rules.neon

@@ -14,8 +14,9 @@ rules:
     - Symplify\PHPStanRules\Rules\Symfony\RequireRouteNameToGenerateControllerRouteRule
 
     # dependency injection
-    - Symplify\PHPStanRules\Rules\Symfony\NoGetDoctrineInControllerRule
     - Symplify\PHPStanRules\Rules\Symfony\NoGetInControllerRule
+    - Symplify\PHPStanRules\Rules\Symfony\NoGetInCommandRule
+    - Symplify\PHPStanRules\Rules\Symfony\NoGetDoctrineInControllerRule
     - Symplify\PHPStanRules\Rules\Symfony\NoFindTaggedServiceIdsCallRule
 
     # magic required inject

src/Enum/SymfonyClass.php

@@ -6,59 +6,30 @@
 
 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';
+    public const 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';
+    public const 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';
+
+    public const COMMAND = 'Symfony\Component\Console\Command\Command';
 }

src/Enum/SymfonyRuleIdentifier.php

@@ -8,6 +8,8 @@ final class SymfonyRuleIdentifier
 {
     public const NO_GET_IN_CONTROLLER = 'symfony.noGetInController';
 
+    public const NO_GET_IN_COMMAND = 'symfony.noGetInCommand';
+
     public const NO_GET_DOCTRINE_IN_CONTROLLER = 'symfony.noGetDoctrineInController';
 
     public const SINGLE_ARG_EVENT_DISPATCH = 'symfony.singleArgEventDispatch';

src/Rules/ClassNameRespectsParentSuffixRule.php

@@ -34,9 +34,9 @@ final class ClassNameRespectsParentSuffixRule implements Rule
      * @var string[]
      */
     private const DEFAULT_PARENT_CLASSES = [
-        'Symfony\Component\Console\Command\Command',
+        SymfonyClass::COMMAND,
         SymfonyClass::EVENT_SUBSCRIBER_INTERFACE,
-        SymfonyClass::SYMFONY_ABSTRACT_CONTROLLER,
+        SymfonyClass::ABSTRACT_CONTROLLER,
         ClassName::SNIFF,
         TestClassName::PHPUNIT_TEST_CASE,
         Exception::class,

src/Rules/Symfony/NoGetDoctrineInControllerRule.php

@@ -41,12 +41,10 @@ public function processNode(Node $node, Scope $scope): array
             return [];
         }
 
-        $ruleError = RuleErrorBuilder::message(self::ERROR_MESSAGE)
-            ->file($scope->getFile())
-            ->line($node->getStartLine())
+        $identifierRuleError = RuleErrorBuilder::message(self::ERROR_MESSAGE)
             ->identifier(SymfonyRuleIdentifier::NO_GET_DOCTRINE_IN_CONTROLLER)
             ->build();
 
-        return [$ruleError];
+        return [$identifierRuleError];
     }
 }

src/Rules/Symfony/NoGetInCommandRule.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanRules\Rules\Symfony;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\MethodCall;
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+use Symplify\PHPStanRules\Enum\SymfonyRuleIdentifier;
+use Symplify\PHPStanRules\NodeAnalyzer\MethodCallNameAnalyzer;
+use Symplify\PHPStanRules\Symfony\NodeAnalyzer\SymfonyCommandAnalyzer;
+
+/**
+ * @implements Rule<MethodCall>
+ */
+final class NoGetInCommandRule implements Rule
+{
+    /**
+     * @var string
+     */
+    public const ERROR_MESSAGE = 'Do not use $this->get(Type::class) method in commands to get services. Use __construct(Type $type) instead';
+
+    public function getNodeType(): string
+    {
+        return MethodCall::class;
+    }
+
+    /**
+     * @param MethodCall $node
+     */
+    public function processNode(Node $node, Scope $scope): array
+    {
+        if (! MethodCallNameAnalyzer::isThisMethodCall($node, 'get')) {
+            return [];
+        }
+
+        if (! SymfonyCommandAnalyzer::isCommandScope($scope)) {
+            return [];
+        }
+
+        $identifierRuleError = RuleErrorBuilder::message(self::ERROR_MESSAGE)
+            ->identifier(SymfonyRuleIdentifier::NO_GET_IN_COMMAND)
+            ->build();
+
+        return [$identifierRuleError];
+    }
+}

src/Rules/Symfony/NoGetInControllerRule.php

@@ -41,12 +41,10 @@ public function processNode(Node $node, Scope $scope): array
             return [];
         }
 
-        $ruleError = RuleErrorBuilder::message(self::ERROR_MESSAGE)
-            ->file($scope->getFile())
-            ->line($node->getStartLine())
+        $identifierRuleError = RuleErrorBuilder::message(self::ERROR_MESSAGE)
             ->identifier(SymfonyRuleIdentifier::NO_GET_IN_CONTROLLER)
             ->build();
 
-        return [$ruleError];
+        return [$identifierRuleError];
     }
 }

src/Rules/Symfony/NoRequiredOutsideClassRule.php

@@ -42,7 +42,6 @@ public function processNode(Node $node, Scope $scope): array
             }
 
             $ruleErrors[] = RuleErrorBuilder::message(self::ERROR_MESSAGE)
-                ->file($scope->getFile())
                 ->identifier(SymfonyRuleIdentifier::SYMFONY_NO_REQUIRED_OUTSIDE_CLASS)
                 ->line($classMethod->getLine())
                 ->build();

src/Rules/Symfony/RequireInvokableControllerRule.php

@@ -40,8 +40,8 @@ public function processNode(Node $node, Scope $scope): array
     {
         $classReflection = $node->getClassReflection();
         if (
-            ! $classReflection->isSubclassOf(SymfonyClass::SYMFONY_ABSTRACT_CONTROLLER) &&
-            ! $classReflection->isSubclassOf(SymfonyClass::SYMFONY_CONTROLLER)
+            ! $classReflection->isSubclassOf(SymfonyClass::ABSTRACT_CONTROLLER) &&
+            ! $classReflection->isSubclassOf(SymfonyClass::CONTROLLER)
         ) {
             return [];
         }