[code-quality] Add RequestIsMasterRector (#708)

Author: TomasVotruba

config/sets/symfony/symfony-code-quality.php

@@ -3,6 +3,7 @@
 declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
+use Rector\Symfony\CodeQuality\Rector\BinaryOp\RequestIsMainRector;
 use Rector\Symfony\CodeQuality\Rector\BinaryOp\ResponseStatusCodeRector;
 use Rector\Symfony\CodeQuality\Rector\Class_\EventListenerToEventSubscriberRector;
 use Rector\Symfony\CodeQuality\Rector\Class_\InlineClassRoutePrefixRector;
@@ -29,6 +30,9 @@
         ActionSuffixRemoverRector::class,
         LoadValidatorMetadataToAnnotationRector::class,
 
+        // request method
+        RequestIsMainRector::class,
+
         // tests
         AssertSameResponseCodeWithDebugContentsRector::class,
 

rules-tests/CodeQuality/Rector/BinaryOp/RequestIsMainRector/Fixture/fixture.php.inc

@@ -0,0 +1,43 @@
+<?php
+
+namespace Rector\Symfony\Tests\CodeQuality\Rector\BinaryOp\RequestIsMainRector\Fixture;
+
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\HttpKernel;
+
+final class SomeController
+{
+    public function index(Request $request)
+    {
+        return $request->getRequestType() === HttpKernel::MASTER_REQUEST;
+    }
+
+    public function second(Request $request)
+    {
+        return $request->getRequestType() === HttpKernel::MAIN_REQUEST;
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Symfony\Tests\CodeQuality\Rector\BinaryOp\RequestIsMainRector\Fixture;
+
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\HttpKernel;
+
+final class SomeController
+{
+    public function index(Request $request)
+    {
+        return $request->isMainRequest();
+    }
+
+    public function second(Request $request)
+    {
+        return $request->isMainRequest();
+    }
+}
+
+?>

rules-tests/CodeQuality/Rector/BinaryOp/RequestIsMainRector/Fixture/skip_different_type.php.inc

@@ -0,0 +1,13 @@
+<?php
+
+namespace Rector\Symfony\Tests\CodeQuality\Rector\BinaryOp\RequestIsMainRector\Fixture;
+
+use Symfony\Component\HttpKernel\HttpKernel;
+
+final class SkipDifferentType
+{
+    public function index(object $request)
+    {
+        return $request->getRequestType() === HttpKernel::MASTER_REQUEST;
+    }
+}

rules-tests/CodeQuality/Rector/BinaryOp/RequestIsMainRector/RequestIsMainRectorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Symfony\Tests\CodeQuality\Rector\BinaryOp\RequestIsMainRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class RequestIsMainRectorTest extends AbstractRectorTestCase
+{
+    #[DataProvider('provideData')]
+    public function test(string $filePath): void
+    {
+        $this->doTestFile($filePath);
+    }
+
+    public static function provideData(): Iterator
+    {
+        return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}

rules-tests/CodeQuality/Rector/BinaryOp/RequestIsMainRector/config/configured_rule.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\Symfony\CodeQuality\Rector\BinaryOp\RequestIsMainRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->rule(RequestIsMainRector::class);
+};

rules/CodeQuality/Rector/BinaryOp/RequestIsMainRector.php

@@ -0,0 +1,115 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Symfony\CodeQuality\Rector\BinaryOp;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr;
+use PhpParser\Node\Expr\BinaryOp;
+use PhpParser\Node\Expr\ClassConstFetch;
+use PhpParser\Node\Expr\MethodCall;
+use PHPStan\Reflection\ReflectionProvider;
+use PHPStan\Type\ObjectType;
+use Rector\Rector\AbstractRector;
+use Rector\Symfony\Enum\SymfonyClass;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see \Rector\Symfony\Tests\CodeQuality\Rector\BinaryOp\RequestIsMainRector\RequestIsMainRectorTest
+ */
+final class RequestIsMainRector extends AbstractRector
+{
+    public function __construct(
+        private readonly ReflectionProvider $reflectionProvider
+    ) {
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Turns status code numbers to constants', [
+            new CodeSample(
+                <<<'CODE_SAMPLE'
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\HttpKernel;
+
+class SomeController
+{
+    public function index(Request $request): bool
+    {
+        return $request->getRequestType() === HttpKernel::MASTER_REQUEST;
+    }
+}
+CODE_SAMPLE
+                ,
+                <<<'CODE_SAMPLE'
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\HttpKernel;
+
+class SomeController
+{
+    public function index(Request $request): bool
+    {
+        return $request->isMasterRequestType();
+    }
+}
+CODE_SAMPLE
+            ),
+        ]);
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [BinaryOp::class];
+    }
+
+    /**
+     * @param BinaryOp $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        if (! $node->left instanceof MethodCall) {
+            return null;
+        }
+
+        $methodCall = $node->left;
+        if (! $this->isRequestGetRequestType($methodCall)) {
+            return null;
+        }
+
+        if (! $this->isHttpKernelMainRequestClassConstFetch($node->right)) {
+            return null;
+        }
+
+        $requestClassReflection = $this->reflectionProvider->getClass(SymfonyClass::REQUEST);
+        $methodName = $requestClassReflection->hasMethod('isMainRequest') ? 'isMainRequest' : 'isMasterRequest';
+
+        return new MethodCall($methodCall->var, $methodName);
+    }
+
+    private function isRequestGetRequestType(MethodCall $methodCall): bool
+    {
+        if (! $this->isName($methodCall->name, 'getRequestType')) {
+            return false;
+        }
+
+        return $this->isObjectType($methodCall->var, new ObjectType(SymfonyClass::REQUEST));
+    }
+
+    private function isHttpKernelMainRequestClassConstFetch(Expr $expr): bool
+    {
+        if (! $expr instanceof ClassConstFetch) {
+            return false;
+        }
+
+        if (! $this->isNames($expr->class, [SymfonyClass::HTTP_KERNEL_INTERFACE, SymfonyClass::HTTP_KERNEL])) {
+            return false;
+        }
+
+        return $this->isNames($expr->name, ['MASTER_REQUEST', 'MAIN_REQUEST']);
+    }
+}

src/Enum/SymfonyClass.php

@@ -75,4 +75,19 @@ final class SymfonyClass
      * @var string
      */
     public const TOKEN_STORAGE_INTERFACE = 'Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface';
+
+    /**
+     * @var string
+     */
+    public const HTTP_KERNEL_INTERFACE = 'Symfony\Component\HttpKernel\HttpKernelInterface';
+
+    /**
+     * @var string
+     */
+    public const HTTP_KERNEL = 'Symfony\Component\HttpKernel\HttpKernel';
+
+    /**
+     * @var string
+     */
+    public const REQUEST = 'Symfony\Component\HttpFoundation\Request';
 }

stubs/Symfony/Component/HttpFoundation/Request.php

@@ -10,5 +10,16 @@
 
 final class Request
 {
+    public function getRequestType()
+    {
+    }
 
+    // newer version
+    public function isMainRequest()
+    {
+    }
+
+    public function isMasterRequest()
+    {
+    }
 }