From 6902f4ac546b4f0785f5c0c6c5c90f1e2b35844c Mon Sep 17 00:00:00 2001 From: Tomas Votruba Date: Sun, 22 Dec 2024 17:20:55 +0100 Subject: [PATCH] add no getDoctrine() rule (#159) * add no getDoctrine() rule * misc --- config/symfony-rules.neon | 4 + src/Enum/RuleIdentifier.php | 101 +----------------- src/NodeAnalyzer/MethodCallNameAnalyzer.php | 34 ++++++ src/Rules/Doctrine/NoEntityMockingRule.php | 17 +-- .../NoAbstractControllerConstructorRule.php | 2 +- .../Symfony/NoGetDoctrineInControllerRule.php | 52 +++++++++ src/Rules/Symfony/NoGetInControllerRule.php | 55 +--------- .../SymfonyControllerAnalyzer.php | 25 +++++ 8 files changed, 124 insertions(+), 166 deletions(-) create mode 100644 src/NodeAnalyzer/MethodCallNameAnalyzer.php create mode 100644 src/Rules/Symfony/NoGetDoctrineInControllerRule.php diff --git a/config/symfony-rules.neon b/config/symfony-rules.neon index 59b85ec3..a853d524 100644 --- a/config/symfony-rules.neon +++ b/config/symfony-rules.neon @@ -5,3 +5,7 @@ rules: - Symplify\PHPStanRules\Rules\Symfony\NoListenerWithoutContractRule - Symplify\PHPStanRules\Rules\Symfony\NoStringInGetSubscribedEventsRule - Symplify\PHPStanRules\Rules\Symfony\RequireInvokableControllerRule + + # dependency injection + - Symplify\PHPStanRules\Rules\Symfony\NoGetDoctrineInControllerRule + - Symplify\PHPStanRules\Rules\Symfony\NoGetInControllerRule diff --git a/src/Enum/RuleIdentifier.php b/src/Enum/RuleIdentifier.php index 0eca9974..90365b3a 100644 --- a/src/Enum/RuleIdentifier.php +++ b/src/Enum/RuleIdentifier.php @@ -6,169 +6,70 @@ final class RuleIdentifier { - /** - * @var string - */ public const UPPERCASE_CONSTANT = 'symplify.uppercaseConstant'; - /** - * @var string - */ public const SEE_ANNOTATION_TO_TEST = 'symplify.seeAnnotationToTest'; - /** - * @var string - */ public const REQUIRE_ATTRIBUTE_NAME = 'symplify.requireAttributeName'; - /** - * @var string - */ public const RECTOR_PHP_RULE_IMPLEMENTS_MIN_VERSION = 'rector.phpRuleImplementsMinVersion'; - /** - * @var string - */ public const RECTOR_UPGRADE_DOWNGRADE_REGISTERED_IN_SET = 'rector.upgradeDowngradeRegisteredInSet'; - /** - * @var string - */ public const PHP_PARSER_NO_LEADING_BACKSLASH_IN_NAME = 'phpParser.noLeadingBackslashInName'; - /** - * @var string - */ public const RECTOR_NO_INSTANCE_OF_STATIC_REFLECTION = 'rector.noInstanceOfStaticReflection'; - /** - * @var string - */ public const RECTOR_NO_CLASS_REFLECTION_STATIC_REFLECTION = 'rector.noClassReflectionStaticReflection'; - /** - * @var string - */ public const PARENT_METHOD_VISIBILITY_OVERRIDE = 'symplify.parentMethodVisibilityOverride'; - /** - * @var string - */ public const NO_RETURN_SETTER_METHOD = 'symplify.noReturnSetterMethod'; - /** - * @var string - */ public const FORBIDDEN_STATIC_CLASS_CONST_FETCH = 'symplify.forbiddenStaticClassConstFetch'; - /** - * @var string - */ public const PREFERRED_CLASS = 'symplify.preferredClass'; - /** - * @var string - */ public const NO_TEST_MOCKS = 'symplify.noTestMocks'; - /** - * @var string - */ public const NO_GLOBAL_CONST = 'symplify.noGlobalConst'; - /** - * @var string - */ public const NO_ENTITY_OUTSIDE_ENTITY_NAMESPACE = 'symplify.noEntityOutsideEntityNamespace'; - /** - * @var string - */ public const FORBIDDEN_NODE = 'symplify.forbiddenNode'; - /** - * @var string - */ public const MULTIPLE_CLASS_LIKE_IN_FILE = 'symplify.multipleClassLikeInFile'; - /** - * @var string - */ public const FORBIDDEN_FUNC_CALL = 'symplify.forbiddenFuncCall'; - /** - * @var string - */ public const REQUIRE_ATTRIBUTE_NAMESPACE = 'symplify.requireAttributeNamespace'; - /** - * @var string - */ public const FORBIDDEN_ARRAY_METHOD_CALL = 'symplify.forbiddenArrayMethodCall'; - /** - * @var string - */ public const FORBIDDEN_EXTEND_OF_NON_ABSTRACT_CLASS = 'symplify.forbiddenExtendOfNonAbstractClass'; - /** - * @var string - */ public const EXPLICIT_ABSTRACT_PREFIX_NAME = 'symplify.explicitAbstractPrefixName'; - /** - * @var string - */ public const EXPLICIT_INTERFACE_SUFFIX_NAME = 'symplify.explicitInterfaceSuffixName'; - /** - * @var string - */ public const EXPLICIT_TRAIT_SUFFIX_NAME = 'symplify.explicitTraitSuffixName'; - /** - * @var string - */ public const REQUIRE_UNIQUE_ENUM_CONSTANT = 'symplify.requireUniqueEnumConstant'; - /** - * @var string - */ public const REQUIRE_EXCEPTION_NAMESPACE = 'symplify.requireExceptionNamespace'; - /** - * @var string - */ public const CLASS_NAME_RESPECTS_PARENT_SUFFIX = 'symplify.classNameRespectsParentSuffix'; - /** - * @var string - */ public const REQUIRED_INTERFACE_CONTRACT_NAMESPACE = 'symplify.requiredInterfaceContractNamespace'; - /** - * @var string - */ public const SYMFONY_REQUIRE_INVOKABLE_CONTROLLER = 'symfony.requireInvokableController'; - /** - * @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'; - /** - * @var string - */ public const NO_DYNAMIC_NAME = 'symplify.noDynamicName'; public const NO_REFERENCE = 'symplify.noReference'; @@ -200,4 +101,6 @@ final class RuleIdentifier 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'; } diff --git a/src/NodeAnalyzer/MethodCallNameAnalyzer.php b/src/NodeAnalyzer/MethodCallNameAnalyzer.php new file mode 100644 index 00000000..732b4df2 --- /dev/null +++ b/src/NodeAnalyzer/MethodCallNameAnalyzer.php @@ -0,0 +1,34 @@ +name instanceof Identifier) { + return false; + } + + if ($methodCall->name->toString() !== $methodName) { + return false; + } + + // is "$this"? + if (! $methodCall->var instanceof Variable) { + return false; + } + + if (! is_string($methodCall->var->name)) { + return false; + } + + return $methodCall->var->name === 'this'; + } +} diff --git a/src/Rules/Doctrine/NoEntityMockingRule.php b/src/Rules/Doctrine/NoEntityMockingRule.php index 2ac35889..a3de40c7 100644 --- a/src/Rules/Doctrine/NoEntityMockingRule.php +++ b/src/Rules/Doctrine/NoEntityMockingRule.php @@ -13,6 +13,7 @@ use PHPStan\Rules\RuleErrorBuilder; use Symplify\PHPStanRules\Doctrine\DoctrineEntityDocumentAnalyser; use Symplify\PHPStanRules\Enum\RuleIdentifier; +use Symplify\PHPStanRules\NodeAnalyzer\MethodCallNameAnalyzer; /** * The ORM entities and ODM documents should never be mocked, as it leads to typeless code. @@ -44,7 +45,7 @@ public function getNodeType(): string */ public function processNode(Node $node, Scope $scope): array { - if (! $this->isCreateMockMethod($node)) { + if (! MethodCallNameAnalyzer::isThisMethodCall($node, 'createMock')) { return []; } @@ -70,18 +71,4 @@ public function processNode(Node $node, Scope $scope): array return []; } - - private function isCreateMockMethod(MethodCall $methodCall): bool - { - if ($methodCall->isFirstClassCallable()) { - return false; - } - - if (! $methodCall->name instanceof Identifier) { - return false; - } - - $methodName = $methodCall->name->toString(); - return $methodName === 'createMock'; - } } diff --git a/src/Rules/Symfony/NoAbstractControllerConstructorRule.php b/src/Rules/Symfony/NoAbstractControllerConstructorRule.php index 08c333f4..cfa82021 100644 --- a/src/Rules/Symfony/NoAbstractControllerConstructorRule.php +++ b/src/Rules/Symfony/NoAbstractControllerConstructorRule.php @@ -16,7 +16,7 @@ * Check if abstract controller has constructor, as it should use * #[Require] instead to avoid parent constructor override * - * @see \Symplify\PHPStanRules\Tests\PHPStan\Rule\NoAbstractControllerConstructorRule\NoAbstractControllerConstructorRuleTest + * @see \Symplify\PHPStanRules\Tests\Rules\Symfony\NoAbstractControllerConstructorRule\NoAbstractControllerConstructorRuleTest * * @implements Rule */ diff --git a/src/Rules/Symfony/NoGetDoctrineInControllerRule.php b/src/Rules/Symfony/NoGetDoctrineInControllerRule.php new file mode 100644 index 00000000..0d3c39a9 --- /dev/null +++ b/src/Rules/Symfony/NoGetDoctrineInControllerRule.php @@ -0,0 +1,52 @@ + + */ +final class NoGetDoctrineInControllerRule implements Rule +{ + /** + * @var string + */ + private const ERROR_MESSAGE = 'Do not use $this->getDoctrine() method in controller. Use __construct(EntityManagerInterface $entityManager) instead'; + + public function getNodeType(): string + { + return MethodCall::class; + } + + /** + * @param MethodCall $node + */ + public function processNode(Node $node, Scope $scope): array + { + if (! MethodCallNameAnalyzer::isThisMethodCall($node, 'getDoctrine')) { + return []; + } + + if (! SymfonyControllerAnalyzer::isControllerScope($scope)) { + return []; + } + + $ruleError = RuleErrorBuilder::message(self::ERROR_MESSAGE) + ->file($scope->getFile()) + ->line($node->getStartLine()) + ->identifier(RuleIdentifier::NO_GET_DOCTRINE_IN_CONTROLLER) + ->build(); + + return [$ruleError]; + } +} diff --git a/src/Rules/Symfony/NoGetInControllerRule.php b/src/Rules/Symfony/NoGetInControllerRule.php index 4e0a6f66..f6bef823 100644 --- a/src/Rules/Symfony/NoGetInControllerRule.php +++ b/src/Rules/Symfony/NoGetInControllerRule.php @@ -6,27 +6,18 @@ use PhpParser\Node; use PhpParser\Node\Expr\MethodCall; -use PhpParser\Node\Expr\Variable; -use PhpParser\Node\Identifier; use PHPStan\Analyser\Scope; use PHPStan\Rules\Rule; use PHPStan\Rules\RuleErrorBuilder; -use Symplify\PHPStanRules\Enum\ClassName; use Symplify\PHPStanRules\Enum\RuleIdentifier; +use Symplify\PHPStanRules\NodeAnalyzer\MethodCallNameAnalyzer; +use Symplify\PHPStanRules\Symfony\NodeAnalyzer\SymfonyControllerAnalyzer; /** * @implements Rule */ final class NoGetInControllerRule implements Rule { - /** - * @var string[] - */ - private const CONTROLLER_TYPES = [ - ClassName::SYMFONY_CONTROLLER, - ClassName::SYMFONY_ABSTRACT_CONTROLLER, - ]; - /** * @var string */ @@ -42,11 +33,11 @@ public function getNodeType(): string */ public function processNode(Node $node, Scope $scope): array { - if (! $this->isThisGetMethodCall($node)) { + if (! MethodCallNameAnalyzer::isThisMethodCall($node, 'get')) { return []; } - if (! $this->isInControllerClass($scope)) { + if (! SymfonyControllerAnalyzer::isControllerScope($scope)) { return []; } @@ -58,42 +49,4 @@ public function processNode(Node $node, Scope $scope): array return [$ruleError]; } - - private function isInControllerClass(Scope $scope): bool - { - if (! $scope->isInClass()) { - return false; - } - - $classReflection = $scope->getClassReflection(); - foreach (self::CONTROLLER_TYPES as $controllerType) { - if ($classReflection->isSubclassOf($controllerType)) { - return true; - } - } - - return false; - } - - private function isThisGetMethodCall(MethodCall $methodCall): bool - { - if (! $methodCall->name instanceof Identifier) { - return false; - } - - if ($methodCall->name->toString() !== 'get') { - return false; - } - - // is "$this"? - if (! $methodCall->var instanceof Variable) { - return false; - } - - if (! is_string($methodCall->var->name)) { - return false; - } - - return $methodCall->var->name === 'this'; - } } diff --git a/src/Symfony/NodeAnalyzer/SymfonyControllerAnalyzer.php b/src/Symfony/NodeAnalyzer/SymfonyControllerAnalyzer.php index 9167a200..76f048dc 100644 --- a/src/Symfony/NodeAnalyzer/SymfonyControllerAnalyzer.php +++ b/src/Symfony/NodeAnalyzer/SymfonyControllerAnalyzer.php @@ -6,11 +6,36 @@ use PhpParser\Comment\Doc; use PhpParser\Node\Stmt\ClassMethod; +use PHPStan\Analyser\Scope; use Symplify\PHPStanRules\Enum\ClassName; use Symplify\PHPStanRules\NodeAnalyzer\AttributeFinder; final class SymfonyControllerAnalyzer { + /** + * @var string[] + */ + private const CONTROLLER_TYPES = [ + ClassName::SYMFONY_CONTROLLER, + ClassName::SYMFONY_ABSTRACT_CONTROLLER, + ]; + + public static function isControllerScope(Scope $scope): bool + { + if (! $scope->isInClass()) { + return false; + } + + $classReflection = $scope->getClassReflection(); + foreach (self::CONTROLLER_TYPES as $controllerType) { + if ($classReflection->isSubclassOf($controllerType)) { + return true; + } + } + + return false; + } + public static function isControllerActionMethod(ClassMethod $classMethod): bool { $attributeFinder = new AttributeFinder();