[symfony] Add RequireIsGrantedEnumRule

Author: TomasVotruba

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/Symfony/RequireIsGrantedEnumRule.php

@@ -10,10 +10,19 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
-use Sensio\Bundle\FrameworkExtraBundle\Configuration\IsGranted;
+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;
@@ -24,7 +33,7 @@ public function getNodeType(): string
      */
     public function processNode(Node $node, Scope $scope): array
     {
-        if ($node->name->toString() !== IsGranted::class) {
+        if (! in_array($node->name->toString(), [SensioClass::IS_GRANTED, SymfonyClass::IS_GRANTED], true)) {
             return [];
         }
 
@@ -33,12 +42,10 @@ public function processNode(Node $node, Scope $scope): array
             return [];
         }
 
-        return [
-            RuleErrorBuilder::message(
-                sprintf('Instead of "%s" string, use enum constant for #[IsGranted]', $isGrantedExpr->value)
-            )
-                ->identifier('symfony.requiredIsGrantedEnum')
-                ->build(),
-        ];
+        $ruleError = RuleErrorBuilder::message(sprintf(self::ERROR_MESSAGE, $isGrantedExpr->value))
+            ->identifier(SymfonyRuleIdentifier::REQUIRED_IS_GRANTED_ENUM)
+            ->build();
+
+        return [$ruleError];
     }
 }

stubs/Sensio/Bundle/FrameworkExtraBundle/Configuration/IsGranted.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Sensio\Bundle\FrameworkExtraBundle\Configuration;
+
+#[\Attribute]
+class IsGranted
+{
+    public function __construct(string $resource)
+    {
+    }
+}

tests/Rules/Symfony/RequireIsGrantedEnumRule/Fixture/SkipConstantResource.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanRules\Tests\Rules\Symfony\RequireIsGrantedEnumRule\Fixture;
+
+use Sensio\Bundle\FrameworkExtraBundle\Configuration\IsGranted;
+use Symplify\PHPStanRules\Tests\Rules\Symfony\RequireIsGrantedEnumRule\Source\SomePermission;
+
+#[IsGranted(SomePermission::ACCESS)]
+final class SkipConstantResource
+{
+    public function run()
+    {
+    }
+}

tests/Rules/Symfony/RequireIsGrantedEnumRule/Fixture/SomeControllerWithStringyAttribute.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanRules\Tests\Rules\Symfony\RequireIsGrantedEnumRule\Fixture;
+
+use Sensio\Bundle\FrameworkExtraBundle\Configuration\IsGranted;
+
+#[IsGranted('some_resource')]
+final class SomeControllerWithStringyAttribute
+{
+    public function run()
+    {
+    }
+}

tests/Rules/Symfony/RequireIsGrantedEnumRule/RequireIsGrantedEnumRuleTest.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanRules\Tests\Rules\Symfony\RequireIsGrantedEnumRule;
+
+use Iterator;
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Symplify\PHPStanRules\Rules\Symfony\RequireIsGrantedEnumRule;
+
+final class RequireIsGrantedEnumRuleTest extends RuleTestCase
+{
+    /**
+     * @param mixed[] $expectedErrorMessagesWithLines
+     */
+    #[DataProvider('provideData')]
+    public function testRule(string $filePath, array $expectedErrorMessagesWithLines): void
+    {
+        $this->analyse([$filePath], $expectedErrorMessagesWithLines);
+    }
+
+    public static function provideData(): Iterator
+    {
+        yield [__DIR__ . '/Fixture/SkipConstantResource.php', []];
+
+        yield [__DIR__ . '/Fixture/SomeControllerWithStringyAttribute.php', [
+            [sprintf(RequireIsGrantedEnumRule::ERROR_MESSAGE, 'some_resource'), 9],
+        ]];
+    }
+
+    protected function getRule(): Rule
+    {
+        return new RequireIsGrantedEnumRule();
+    }
+}

tests/Rules/Symfony/RequireIsGrantedEnumRule/Source/SomePermission.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Symplify\PHPStanRules\Tests\Rules\Symfony\RequireIsGrantedEnumRule\Source;
+
+final class SomePermission
+{
+    public const ACCESS = 'access';
+}