Merge pull request #2698 from rectorphp/cakephp-controller-render

composer.json

@@ -111,7 +111,8 @@
             "Rector\\Phalcon\\": "packages/Phalcon/src",
             "Rector\\DoctrineGedmoToKnplabs\\": "packages/DoctrineGedmoToKnplabs/src",
             "Rector\\MinimalScope\\": "packages/MinimalScope/src",
-            "Rector\\Polyfill\\": "packages/Polyfill/src"
+            "Rector\\Polyfill\\": "packages/Polyfill/src",
+            "Rector\\CakePHPToSymfony\\": "packages/CakePHPToSymfony/src"
         }
     },
     "autoload-dev": {
@@ -174,7 +175,8 @@
             "Rector\\DoctrineGedmoToKnplabs\\Tests\\": "packages/DoctrineGedmoToKnplabs/tests",
             "Rector\\MinimalScope\\Tests\\": "packages/MinimalScope/tests",
             "Rector\\Utils\\PHPStanStaticTypeMapperChecker\\": "utils/PHPStanStaticTypeMapperChecker/src",
-            "Rector\\Polyfill\\Tests\\": "packages/Polyfill/tests"
+            "Rector\\Polyfill\\Tests\\": "packages/Polyfill/tests",
+            "Rector\\CakePHPToSymfony\\Tests\\": "packages/CakePHPToSymfony/tests"
         },
         "classmap": [
             "packages/CakePHP/tests/Rector/Name/ImplicitShortClassNameUseStatementRector/Source",
@@ -188,7 +190,8 @@
             "tests/Issues/Issue1243/Source",
             "packages/Autodiscovery/tests/Rector/FileSystem/MoveInterfacesToContractNamespaceDirectoryRector/Expected",
             "packages/Autodiscovery/tests/Rector/FileSystem/MoveServicesBySuffixToDirectoryRector/Expected",
-            "packages/CakePHP/tests/Rector/StaticCall/AppUsesStaticCallToUseStatementRector/Source"
+            "packages/CakePHP/tests/Rector/StaticCall/AppUsesStaticCallToUseStatementRector/Source",
+            "packages/CakePHPToSymfony/tests/Rector/Class_/CakePHPControllerComponentToSymfonyRector/Source"
         ],
         "files": [
             "packages/DeadCode/tests/Rector/MethodCall/RemoveDefaultArgumentValueRector/Source/UserDefined.php",

config/set/cakephp-to-symfony/cakephp-24-to-symfony-50.yaml

@@ -0,0 +1,7 @@
+services:
+    Rector\CakePHPToSymfony\Rector\Class_\CakePHPControllerToSymfonyControllerRector: null
+    Rector\CakePHPToSymfony\Rector\ClassMethod\CakePHPControllerActionToSymfonyControllerActionRector: null
+    Rector\CakePHPToSymfony\Rector\Class_\CakePHPControllerHelperToSymfonyRector: null
+    Rector\CakePHPToSymfony\Rector\Class_\CakePHPControllerComponentToSymfonyRector: null
+    Rector\CakePHPToSymfony\Rector\ClassMethod\CakePHPControllerRedirectToSymfonyRector: null
+    Rector\CakePHPToSymfony\Rector\ClassMethod\CakePHPControllerRenderToSymfonyRector: null

docs/AllRectorsOverview.md

@@ -1,4 +1,4 @@
-# All 432 Rectors Overview
+# All 438 Rectors Overview
 
 - [Projects](#projects)
 - [General](#general)
@@ -8,6 +8,7 @@
 - [Architecture](#architecture)
 - [Autodiscovery](#autodiscovery)
 - [CakePHP](#cakephp)
+- [CakePHPToSymfony](#cakephptosymfony)
 - [Celebrity](#celebrity)
 - [CodeQuality](#codequality)
 - [CodingStyle](#codingstyle)
@@ -283,6 +284,144 @@ services:
 
 <br>
 
+## CakePHPToSymfony
+
+### `CakePHPControllerActionToSymfonyControllerActionRector`
+
+- class: `Rector\CakePHPToSymfony\Rector\ClassMethod\CakePHPControllerActionToSymfonyControllerActionRector`
+
+Migrate CakePHP 2.4 Controller action to Symfony 5
+
+```diff
++use Symfony\Component\HttpFoundation\Response;
++
+ class HomepageController extends \AppController
+ {
+-    public function index()
++    public function index(): Response
+     {
+         $value = 5;
+     }
+ }
+```
+
+<br>
+
+### `CakePHPControllerComponentToSymfonyRector`
+
+- class: `Rector\CakePHPToSymfony\Rector\Class_\CakePHPControllerComponentToSymfonyRector`
+
+Migrate CakePHP 2.4 Controller $components property to Symfony 5
+
+```diff
+ class MessagesController extends \AppController
+ {
+-    public $components = ['Overview'];
++    private function __construct(OverviewComponent $overviewComponent)
++    {
++        $this->overviewComponent->filter();
++    }
+
+     public function someAction()
+     {
+-        $this->Overview->filter();
++        $this->overviewComponent->filter();
+     }
+ }
+
+ class OverviewComponent extends \Component
+ {
+     public function filter()
+     {
+     }
+ }
+```
+
+<br>
+
+### `CakePHPControllerHelperToSymfonyRector`
+
+- class: `Rector\CakePHPToSymfony\Rector\Class_\CakePHPControllerHelperToSymfonyRector`
+
+Migrate CakePHP 2.4 Controller $helpers and $components property to Symfony 5
+
+```diff
+ class HomepageController extends AppController
+ {
+-    public $helpers = ['Flash'];
+-
+     public function index()
+     {
+-        $this->Flash->success(__('Your post has been saved.'));
+-        $this->Flash->error(__('Unable to add your post.'));
++        $this->addFlash('success', __('Your post has been saved.'));
++        $this->addFlash('error', __('Unable to add your post.'));
+     }
+ }
+```
+
+<br>
+
+### `CakePHPControllerRedirectToSymfonyRector`
+
+- class: `Rector\CakePHPToSymfony\Rector\ClassMethod\CakePHPControllerRedirectToSymfonyRector`
+
+Migrate CakePHP 2.4 Controller redirect() to Symfony 5
+
+```diff
+ class RedirectController extends \AppController
+ {
+     public function index()
+     {
+-        $this->redirect('boom');
++        return $this->redirect('boom');
+     }
+ }
+```
+
+<br>
+
+### `CakePHPControllerRenderToSymfonyRector`
+
+- class: `Rector\CakePHPToSymfony\Rector\ClassMethod\CakePHPControllerRenderToSymfonyRector`
+
+Migrate CakePHP 2.4 Controller render() to Symfony 5
+
+```diff
+ class RedirectController extends \AppController
+ {
+     public function index()
+     {
+-        $this->render('custom_file');
++        return $this->render('redirect/custom_file.twig');
+     }
+ }
+```
+
+<br>
+
+### `CakePHPControllerToSymfonyControllerRector`
+
+- class: `Rector\CakePHPToSymfony\Rector\Class_\CakePHPControllerToSymfonyControllerRector`
+
+Migrate CakePHP 2.4 Controller to Symfony 5
+
+```diff
+-class HomepageController extends AppController
++use Symfony\Component\HttpFoundation\Response;
++use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
++
++class HomepageController extends AbstractController
+ {
+-    public function index()
++    public function index(): Response
+     {
+     }
+ }
+```
+
+<br>
+
 ## Celebrity
 
 ### `CommonNotEqualRector`
@@ -8724,7 +8863,7 @@ services:
     Rector\Rector\Visibility\ChangeMethodVisibilityRector:
         $methodToVisibilityByClass:
             FrameworkClass:
-            someMethod: protected
+                someMethod: protected
 ```
 
 ↓

packages/CakePHPToSymfony/config/config.yaml

@@ -0,0 +1,9 @@
+services:
+    _defaults:
+        autowire: true
+        public: true
+
+    Rector\CakePHPToSymfony\:
+        resource: '../src'
+        exclude:
+            - '../src/Rector/**/*Rector.php'

packages/CakePHPToSymfony/src/Rector/AbstractCakePHPRector.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\CakePHPToSymfony\Rector;
+
+use PhpParser\Node;
+use Rector\NodeTypeResolver\Node\AttributeKey;
+use Rector\Rector\AbstractRector;
+
+abstract class AbstractCakePHPRector extends AbstractRector
+{
+    protected function isInCakePHPController(Node $node): bool
+    {
+        if ($this->isObjectType($node, 'AppController')) {
+            return true;
+        }
+
+        $class = $node->getAttribute(AttributeKey::CLASS_NODE);
+        if ($class !== null) {
+            return true;
+        }
+
+        return false;
+    }
+}

packages/CakePHPToSymfony/src/Rector/ClassMethod/CakePHPControllerActionToSymfonyControllerActionRector.php

@@ -0,0 +1,80 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\CakePHPToSymfony\Rector\ClassMethod;
+
+use PhpParser\Node;
+use PhpParser\Node\Name\FullyQualified;
+use PhpParser\Node\Stmt\ClassMethod;
+use Rector\CakePHPToSymfony\Rector\AbstractCakePHPRector;
+use Rector\RectorDefinition\CodeSample;
+use Rector\RectorDefinition\RectorDefinition;
+
+/**
+ * @see https://book.cakephp.org/2/en/tutorials-and-examples/blog/part-two.html
+ * @see https://symfony.com/doc/5.0/controller.html
+ * @see https://symfony.com/doc/5.0/controller.html#rendering-templates
+ *
+ * @see https://stackoverflow.com/a/21647715/1348344 for $this->view
+ *
+ * @see \Rector\CakePHPToSymfony\Tests\Rector\ClassMethod\CakePHPControllerActionToSymfonyControllerActionRector\CakePHPControllerActionToSymfonyControllerActionRectorTest
+ */
+final class CakePHPControllerActionToSymfonyControllerActionRector extends AbstractCakePHPRector
+{
+    public function getDefinition(): RectorDefinition
+    {
+        return new RectorDefinition('Migrate CakePHP 2.4 Controller action to Symfony 5', [
+            new CodeSample(
+                <<<'PHP'
+class HomepageController extends \AppController
+{
+    public function index()
+    {
+        $value = 5;
+    }
+}
+PHP
+,
+                <<<'PHP'
+use Symfony\Component\HttpFoundation\Response;
+
+class HomepageController extends \AppController
+{
+    public function index(): Response
+    {
+        $value = 5;
+    }
+}
+PHP
+
+            ),
+        ]);
+    }
+
+    /**
+     * @return string[]
+     */
+    public function getNodeTypes(): array
+    {
+        return [ClassMethod::class];
+    }
+
+    /**
+     * @param ClassMethod $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        if (! $this->isInCakePHPController($node)) {
+            return null;
+        }
+
+        if (! $node->isPublic()) {
+            return null;
+        }
+
+        $node->returnType = new FullyQualified('Symfony\Component\HttpFoundation\Response');
+
+        return $node;
+    }
+}