[symfony] Add RequireIsGrantedEnumRule (#213)

* [symfony] kick of require is granted rule

* [symfony] Add RequireIsGrantedEnumRule

Author: TomasVotruba

config/symfony-rules.neon

@@ -23,3 +23,6 @@ rules:
     - Symplify\PHPStanRules\Rules\Symfony\SingleRequiredMethodRule
     - Symplify\PHPStanRules\Rules\Symfony\RequiredOnlyInAbstractRule
     - Symplify\PHPStanRules\Rules\Symfony\NoConstructorAndRequiredTogetherRule
+
+    # attributes
+    - Symplify\PHPStanRules\Rules\Symfony\RequireIsGrantedEnumRule

phpunit.xml

@@ -12,5 +12,6 @@
         <exclude>tests/Rules/ClassNameRespectsParentSuffixRule/Fixture/</exclude>
         <exclude>tests/Rules/PHPUnit/PublicStaticDataProviderRule</exclude>
         <exclude>tests/Rules/PHPUnit/NoAssertFuncCallInTestsRule/Fixture</exclude>
+        <exclude>tests/Rules/PHPUnit/NoMockOnlyTestRule/Fixture/SkipConstraintValidatorTest.php</exclude>
     </testsuite>
 </phpunit>

src/Enum/RuleIdentifier/SymfonyRuleIdentifier.php

@@ -53,4 +53,6 @@ final class SymfonyRuleIdentifier
     public const NO_DUPLICATE_ARG_AUTOWIRE_BY_TYPE = 'symfony.noDuplicateArgAutowireByType';
 
     public const NO_SERVICE_SAME_NAME_SET_CLASS = 'symfony.noServiceSameNameSetClass';
+
+    public const REQUIRED_IS_GRANTED_ENUM = 'symfony.requiredIsGrantedEnum';
 }

src/Enum/SensioClass.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanRules\Enum;
+
+final class SensioClass
+{
+    public const IS_GRANTED = 'Sensio\Bundle\FrameworkExtraBundle\Configuration\IsGranted';
+}

src/Enum/SymfonyClass.php

@@ -42,4 +42,6 @@ final class SymfonyClass
     public const VALIDATOR_TEST_CASE = 'Symfony\Component\Validator\Test\ConstraintValidatorTestCase';
 
     public const CONTAINER_CONFIGURATOR = 'Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator';
+
+    public const IS_GRANTED = 'Symfony\Component\Security\Http\Attribute\IsGranted';
 }

src/Rules/Doctrine/NoDocumentMockingRule.php

@@ -6,7 +6,6 @@
 
 use PhpParser\Node;
 use PhpParser\Node\Expr\MethodCall;
-use PhpParser\Node\Identifier;
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;

src/Rules/Doctrine/NoGetRepositoryOnServiceRepositoryEntityRule.php

@@ -7,7 +7,6 @@
 use Nette\Utils\Strings;
 use PhpParser\Node;
 use PhpParser\Node\Expr\MethodCall;
-use PhpParser\Node\Identifier;
 use PHPStan\Analyser\Scope;
 use PHPStan\Reflection\ClassReflection;
 use PHPStan\Reflection\ReflectionProvider;

src/Rules/Symfony/NoFindTaggedServiceIdsCallRule.php

@@ -6,7 +6,6 @@
 
 use PhpParser\Node;
 use PhpParser\Node\Expr\MethodCall;
-use PhpParser\Node\Identifier;
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\IdentifierRuleError;
 use PHPStan\Rules\Rule;

src/Rules/Symfony/RequireIsGrantedEnumRule.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanRules\Rules\Symfony;
+
+use PhpParser\Node;
+use PhpParser\Node\Attribute;
+use PhpParser\Node\Scalar\String_;
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+use Symplify\PHPStanRules\Enum\RuleIdentifier\SymfonyRuleIdentifier;
+use Symplify\PHPStanRules\Enum\SensioClass;
+use Symplify\PHPStanRules\Enum\SymfonyClass;
+
+/**
+ * @see \Symplify\PHPStanRules\Tests\Rules\Symfony\RequireIsGrantedEnumRule\RequireIsGrantedEnumRuleTest
+ *
+ * @implements Rule<Attribute>
+ */
+final class RequireIsGrantedEnumRule implements Rule
+{
+    public const ERROR_MESSAGE = 'Instead of "%s" string, use enum constant for #[IsGranted]';
+
+    public function getNodeType(): string
+    {
+        return Attribute::class;
+    }
+
+    /**
+     * @param Attribute $node
+     */
+    public function processNode(Node $node, Scope $scope): array
+    {
+        if (! in_array($node->name->toString(), [SensioClass::IS_GRANTED, SymfonyClass::IS_GRANTED], true)) {
+            return [];
+        }
+
+        $isGrantedExpr = $node->args[0]->value;
+        if (! $isGrantedExpr instanceof String_) {
+            return [];
+        }
+
+        $identifierRuleError = RuleErrorBuilder::message(sprintf(self::ERROR_MESSAGE, $isGrantedExpr->value))
+            ->identifier(SymfonyRuleIdentifier::REQUIRED_IS_GRANTED_ENUM)
+            ->build();
+
+        return [$identifierRuleError];
+    }
+}

src/TypeAnalyzer/CallableTypeAnalyzer.php

@@ -6,8 +6,6 @@
 
 use PhpParser\Node\Expr;
 use PHPStan\Analyser\Scope;
-use PHPStan\Type\CallableType;
-use PHPStan\Type\ClosureType;
 use PHPStan\Type\ObjectType;
 use PHPStan\Type\Type;
 use PHPStan\Type\TypeCombinator;