[Sensiolabs] Add @Template annotation to render() Rector

build/subtree-split-master-and-last-tag.sh

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+git subsplit init git@github.com:rectorphp/rector.git
+
+LAST_TAG=$(git tag -l  --sort=committerdate | tail -n1);
+
+git subsplit publish --heads="master" --tags=$LAST_TAG packages/NodeTypeResolver:git@github.com:rectorphp/node-type-resolver.git
+
+rm -rf .subsplit/
+
+# inspired by laravel: https://github.com/laravel/framework/blob/5.4/build/illuminate-split-full.sh
+# they use SensioLabs now though: https://github.com/laravel/framework/pull/17048#issuecomment-269915319

packages/NodeTraverserQueue/src/BetterNodeFinder.php

@@ -51,6 +51,19 @@ public function findFirstInstanceOf($nodes, string $type): ?Node
         return $this->nodeFinder->findFirstInstanceOf($nodes, $type);
     }
 
+    /**
+     * @param Node|Node[] $nodes
+     */
+    public function findLastInstanceOf($nodes, string $type): ?Node
+    {
+        $foundInstances = $this->nodeFinder->findInstanceOf($nodes, $type);
+        if (! $foundInstances) {
+            return null;
+        }
+
+        return array_pop($foundInstances);
+    }
+
     /**
      * @param Node|Node[] $nodes
      * @return Node[]

packages/ReflectionDocBlock/src/DocBlock/TidingSerializer.php

@@ -2,6 +2,7 @@
 
 namespace Rector\ReflectionDocBlock\DocBlock;
 
+use Nette\Utils\Strings;
 use phpDocumentor\Reflection\DocBlock;
 use Symplify\BetterReflectionDocBlock\FixedSerializer;
 
@@ -21,7 +22,9 @@ public function getDocComment(DocBlock $docBlock): string
     {
         $docComment = $this->fixedSerializer->getDocComment($docBlock);
 
-        return $this->clearUnnededPreslashes($docComment);
+        $docComment = $this->clearUnnededPreslashes($docComment);
+
+        return $this->clearUnnededSpaces($docComment);
     }
 
     /**
@@ -34,4 +37,15 @@ private function clearUnnededPreslashes(string $content): string
 
         return str_replace('@param \\', '@param ', $content);
     }
+
+    /**
+     * phpDocumentor adds extra spaces before Doctrine-Annotation based annotations
+     * starting with uppercase and followed by (, e.g. @Route('value')
+     */
+    private function clearUnnededSpaces(string $content): string
+    {
+        return Strings::replace($content, '#@[A-Z][a-z]+\s\(#', function (array $match) {
+            return str_replace(' ', '', $match[0]);
+        });
+    }
 }

phpstan.neon

@@ -36,6 +36,7 @@ parameters:
         - '#Property Rector\\NodeTypeResolver\\Tests\\PerNodeCallerTypeResolver\\MethodCallCallerTypeResolver\\NestedMethodCallTest::\$(formChainMethodCallNodes|nestedMethodCallNodes) \(array<PhpParser\\Node\\Expr\\MethodCall>\) does not accept array<PhpParser\\Node>#'
         - '#Cannot call method toString\(\) on string#'
         - '#Parameter \#1 \$node of method Rector\\NodeTypeResolver\\NodeTypeResolver::resolve\(\) expects PhpParser\\Node, PhpParser\\Node\\Expr|string given#'
+        - '#Cannot call method render\(\) on phpDocumentor\\Reflection\\DocBlock\\Tag\|string#'
 
         # known value of Name of MethodCall
         - '#Call to an undefined method PhpParser\\Node\\Expr\|PhpParser\\Node\\Name::toString\(\)#'

src/Exception/Rector/InvalidRectorConfigurationException.php

@@ -0,0 +1,9 @@
+<?php declare(strict_types=1);
+
+namespace Rector\Exception\Rector;
+
+use Exception;
+
+final class InvalidRectorConfigurationException extends Exception
+{
+}

src/Rector/Contrib/Sensio/FrameworkExtraBundle/TemplateAnnotationRector.php

@@ -0,0 +1,199 @@
+<?php declare(strict_types=1);
+
+namespace Rector\Rector\Contrib\Sensio\FrameworkExtraBundle;
+
+use Nette\Utils\Strings;
+use PhpParser\Node;
+use PhpParser\Node\Arg;
+use PhpParser\Node\Expr\Array_;
+use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Stmt\ClassMethod;
+use PhpParser\Node\Stmt\Return_;
+use Rector\Exception\Rector\InvalidRectorConfigurationException;
+use Rector\Node\MethodCallNodeFactory;
+use Rector\Node\NodeFactory;
+use Rector\NodeTraverserQueue\BetterNodeFinder;
+use Rector\Rector\AbstractRector;
+use Rector\Rector\Contrib\Sensio\Helper\TemplateGuesser;
+use Rector\ReflectionDocBlock\NodeAnalyzer\DocBlockAnalyzer;
+
+/**
+ * Converts all:
+ * - @Template()
+ * - public function indexAction() { }
+ *
+ * into:
+ * - public function indexAction() {
+ * -     return $this->render('index.html.twig');
+ * - }
+ */
+final class TemplateAnnotationRector extends AbstractRector
+{
+    /**
+     * @var DocBlockAnalyzer
+     */
+    private $docBlockAnalyzer;
+
+    /**
+     * @var MethodCallNodeFactory
+     */
+    private $methodCallNodeFactory;
+
+    /**
+     * @var NodeFactory
+     */
+    private $nodeFactory;
+
+    /**
+     * @var BetterNodeFinder
+     */
+    private $betterNodeFinder;
+
+    /**
+     * @var TemplateGuesser
+     */
+    private $templateGuesser;
+
+    /**
+     * @var int
+     */
+    private $version;
+
+    /**
+     * @param mixed[] $config
+     */
+    public function __construct(
+        array $config,
+        DocBlockAnalyzer $docBlockAnalyzer,
+        MethodCallNodeFactory $methodCallNodeFactory,
+        NodeFactory $nodeFactory,
+        BetterNodeFinder $betterNodeFinder,
+        TemplateGuesser $templateGuesser
+    ) {
+        $this->setConfig($config);
+        $this->docBlockAnalyzer = $docBlockAnalyzer;
+        $this->methodCallNodeFactory = $methodCallNodeFactory;
+        $this->nodeFactory = $nodeFactory;
+        $this->betterNodeFinder = $betterNodeFinder;
+        $this->templateGuesser = $templateGuesser;
+    }
+
+    public function isCandidate(Node $node): bool
+    {
+        if (! $node instanceof ClassMethod) {
+            return false;
+        }
+
+        return $this->docBlockAnalyzer->hasAnnotation($node, 'Template');
+    }
+
+    /**
+     * @param ClassMethod $classMethodNode
+     */
+    public function refactor(Node $classMethodNode): ?Node
+    {
+        /** @var Return_|null $returnNode */
+        $returnNode = $this->betterNodeFinder->findLastInstanceOf((array) $classMethodNode->stmts, Return_::class);
+
+        // create "$this->render('template.file.twig.html', ['key' => 'value']);" method call
+        $renderArguments = $this->resolveRenderArguments($classMethodNode, $returnNode);
+        $thisRenderMethodCall = $this->methodCallNodeFactory->createWithVariableNameMethodNameAndArguments(
+            'this',
+            'render',
+            $renderArguments
+        );
+
+        if (! $returnNode) {
+            // or add as last statement in the method
+            $classMethodNode->stmts[] = new Return_($thisRenderMethodCall);
+        }
+
+        // replace Return_ node value if exists and is not already in correct format
+        if ($returnNode && ! $returnNode->expr instanceof MethodCall) {
+            $returnNode->expr = $thisRenderMethodCall;
+        }
+
+        // remove annotation
+        $this->docBlockAnalyzer->removeAnnotationFromNode($classMethodNode, 'Template');
+
+        return $classMethodNode;
+    }
+
+    /**
+     * @return Arg[]
+     */
+    private function resolveRenderArguments(ClassMethod $classMethodNode, ?Return_ $returnNode): array
+    {
+        $arguments = [$this->resolveTemplateName($classMethodNode)];
+        if (! $returnNode) {
+            return $this->nodeFactory->createArgs($arguments);
+        }
+
+        if ($returnNode->expr instanceof Array_ && count($returnNode->expr->items)) {
+            $arguments[] = $returnNode->expr;
+        }
+
+        $arguments = array_merge($arguments, $this->resolveArgumentsFromMethodCall($returnNode));
+
+        return $this->nodeFactory->createArgs($arguments);
+    }
+
+    private function resolveTemplateName(ClassMethod $classMethodNode): string
+    {
+        $templateAnnotation = $this->docBlockAnalyzer->getTagsByName($classMethodNode, 'Template')[0];
+        $content = $templateAnnotation->render();
+
+        // @todo consider using sth similar to offical parsing
+        $annotationContent = Strings::match($content, '#\("(?<filename>.*?)"\)#');
+
+        if (isset($annotationContent['filename'])) {
+            return $annotationContent['filename'];
+        }
+
+        return $this->templateGuesser->resolveFromClassMethodNode($classMethodNode, $this->version);
+    }
+
+    /**
+     * Already existing method call
+     * @return mixed[]
+     */
+    private function resolveArgumentsFromMethodCall(Return_ $returnNode): array
+    {
+        $arguments = [];
+        if ($returnNode->expr instanceof MethodCall) {
+            foreach ($returnNode->expr->args as $arg) {
+                if ($arg->value instanceof Array_) {
+                    $arguments[] = $arg->value;
+                }
+            }
+        }
+
+        return $arguments;
+    }
+
+    /**
+     * @param mixed[] $config
+     */
+    private function setConfig(array $config): void
+    {
+        $this->ensureConfigHasVersion($config);
+        $this->version = $config['version'];
+    }
+
+    /**
+     * @param mixed[] $config
+     */
+    private function ensureConfigHasVersion(array $config): void
+    {
+        if (isset($config['version'])) {
+            return;
+        }
+
+        throw new InvalidRectorConfigurationException(sprintf(
+            'Rector "%s" is missing "%s" configuration. Add it as "%s" to config.yml under its key"',
+            self::class,
+            'version',
+            'version: <value>'
+        ));
+    }
+}

src/Rector/Contrib/Sensio/Helper/TemplateGuesser.php

@@ -0,0 +1,78 @@
+<?php declare(strict_types=1);
+
+namespace Rector\Rector\Contrib\Sensio\Helper;
+
+use Nette\Utils\Strings;
+use PhpParser\Node\Stmt\ClassMethod;
+use Rector\Exception\ShouldNotHappenException;
+use Rector\Node\Attribute;
+
+final class TemplateGuesser
+{
+    public function resolveFromClassMethodNode(ClassMethod $classMethodNode, int $version = 5): string
+    {
+        $namespace = (string) $classMethodNode->getAttribute(Attribute::NAMESPACE_NAME);
+        $class = (string) $classMethodNode->getAttribute(Attribute::CLASS_NAME);
+        $method = $classMethodNode->name->toString();
+
+        if ($version === 3) {
+            return $this->resolveForVersion3($namespace, $class, $method);
+        }
+
+        if ($version === 5) {
+            return $this->resolveForVersion5($namespace, $class, $method);
+        }
+
+        throw new ShouldNotHappenException(sprintf(
+            'Version "%d" is not supported in "%s". Add it.',
+            $version,
+            self::class
+        ));
+    }
+
+    /**
+     * Mimics https://github.com/sensiolabs/SensioFrameworkExtraBundle/blob/v3.0.0/Templating/TemplateGuesser.php
+     */
+    private function resolveForVersion3(string $namespace, string $class, string $method): string
+    {
+        // AppBundle\SomeNamespace\ => AppBundle
+        // App\OtherBundle\SomeNamespace\ => OtherBundle
+        $bundle = Strings::match($namespace, '/(?<bundle>[A-Za-z]*Bundle)/')['bundle'] ?? '';
+
+        // SomeSuper\ControllerClass => ControllerClass
+        $controller = Strings::match($class, '/(?<controller>[A-Za-z0-9]*)Controller$/')['controller'] ?? '';
+
+        // indexAction => index
+        $action = Strings::match($method, '/(?<method>[A-Za-z]*)Action$/')['method'] ?? '';
+
+        return sprintf('%s:%s:%s.html.twig', $bundle, $controller, $action);
+    }
+
+    /**
+     * Mimics https://github.com/sensiolabs/SensioFrameworkExtraBundle/blob/v5.0.0/Templating/TemplateGuesser.php
+     */
+    private function resolveForVersion5(string $namespace, string $class, string $method): string
+    {
+        $bundle = Strings::match($namespace, '/(?<bundle>[A-Za-z]*Bundle)/')['bundle'] ?? '';
+        $bundle = preg_replace('/Bundle$/', '', $bundle);
+        $bundle = $bundle ? '@' . $bundle . '/' : '';
+
+        $controller = $this->resolveControllerVersion5($class);
+        $action = preg_replace('/Action$/', '', $method);
+
+        return sprintf('%s%s%s.html.twig', $bundle, $controller, $action);
+    }
+
+    private function resolveControllerVersion5(string $class): string
+    {
+        if (! preg_match('/Controller\\\(.+)Controller$/', $class, $tempMatch)) {
+            return '';
+        }
+
+        $controller = str_replace('\\', '/', strtolower(
+            preg_replace('/([a-z\d])([A-Z])/', '\\1_\\2', $tempMatch[1])
+        ));
+
+        return $controller ? $controller . '/' : '';
+    }
+}

src/config/level/sensio/framework-extra-bundle-30.yml

@@ -0,0 +1,3 @@
+rectors:
+    Rector\Rector\Contrib\Sensio\FrameworkExtraBundle\TemplateAnnotationRector:
+        version: 3

src/config/level/sensio/framework-extra-bundle-50.yml

@@ -0,0 +1,3 @@
+rectors:
+    Rector\Rector\Contrib\Sensio\FrameworkExtraBundle\TemplateAnnotationRector:
+        version: 5

src/config/services.yml

@@ -5,7 +5,7 @@ services:
 
     Rector\:
         resource: '../'
-        exclude: '../{Node/Attribute.php,Rector/Contrib,Rector/Dynamic,Rector/MagicDisclosure,Testing}'
+        exclude: '../{Node/Attribute.php,Rector/Contrib/**/*Rector.php,Rector/Dynamic,Rector/MagicDisclosure,Testing}'
 
     Rector\Rector\Contrib\Symfony\Form\Helper\FormTypeStringToTypeProvider: ~