feature #64 Replace demo page by twig file (javiereguiluz, nicolas-grekas, weaverryan)

This PR was merged into the 1.0-dev branch.

Discussion
----------

Replace demo page by twig file

Follow up of #46

Seriously, this will make demoing Symfony a no brainer. Wow effect. Newbies <3
And for others, that's still >50% likelly OK.

<img width="773" alt="screen shot 2018-02-08 at 10 58 59 pm" src="https://user-images.githubusercontent.com/121003/36011345-74da6026-0d24-11e8-96a5-55c818b27e56.png">

Commits
-------

42665c8 using a class
27634d6 phpcs tweaks
20c3704 Finishing Twig template with make:controller
995b534 Replace demo page by twig file
0cd9d72 Remove the demo page for new controllers

Author: weaverryan

.php_cs.dist

@@ -25,5 +25,7 @@ EOF
     ->setFinder(
         PhpCsFixer\Finder::create()
             ->in(__DIR__.'/src')
+            // the PHP template files are a bit special
+            ->notName('*.tpl.php')
     )
-;
+;

src/FileManager.php

@@ -58,6 +58,13 @@ public function fileExists($path): bool
         return file_exists($this->absolutizePath($path));
     }
 
+    public function relativizePath($absolutePath): string
+    {
+        $relativePath = str_replace($this->rootDirectory, '.', $absolutePath);
+
+        return is_dir($absolutePath) ? rtrim($relativePath, '/').'/' : $relativePath;
+    }
+
     private function absolutizePath($path): string
     {
         if (0 === strpos($path, '/')) {
@@ -66,11 +73,4 @@ private function absolutizePath($path): string
 
         return sprintf('%s/%s', $this->rootDirectory, $path);
     }
-
-    private function relativizePath($absolutePath): string
-    {
-        $relativePath = str_replace($this->rootDirectory, '.', $absolutePath);
-
-        return is_dir($absolutePath) ? rtrim($relativePath, '/').'/' : $relativePath;
-    }
 }

src/Generator.php

@@ -46,7 +46,11 @@ public function generate(array $parameters, array $files)
         }
 
         foreach ($files as $fileTemplatePath => $targetPath) {
-            $fileContents = $this->fileManager->parseTemplate($fileTemplatePath, $parameters);
+            $templateParameters = array_merge($parameters, [
+                'relative_path' => $this->fileManager->relativizePath($targetPath),
+            ]);
+
+            $fileContents = $this->fileManager->parseTemplate($fileTemplatePath, $templateParameters);
             $this->fileManager->dumpFile($targetPath, $fileContents);
         }
     }

src/Maker/MakeController.php

@@ -14,6 +14,7 @@
 use Doctrine\Common\Annotations\Annotation;
 use Symfony\Bundle\MakerBundle\ConsoleStyle;
 use Symfony\Bundle\MakerBundle\DependencyBuilder;
+use Symfony\Bundle\MakerBundle\FileManager;
 use Symfony\Bundle\MakerBundle\InputConfiguration;
 use Symfony\Bundle\MakerBundle\Str;
 use Symfony\Bundle\MakerBundle\Validator;
@@ -30,10 +31,12 @@
 final class MakeController extends AbstractMaker
 {
     private $router;
+    private $fileManager;
 
-    public function __construct(RouterInterface $router)
+    public function __construct(RouterInterface $router, FileManager $fileManager)
     {
         $this->router = $router;
+        $this->fileManager = $fileManager;
     }
 
     public static function getCommandName(): string
@@ -54,21 +57,30 @@ public function getParameters(InputInterface $input): array
     {
         $controllerClassName = Str::asClassName($input->getArgument('controller-class'), 'Controller');
         Validator::validateClassName($controllerClassName);
+        $baseLayoutExists = $this->fileManager->fileExists('templates/base.html.twig');
 
         return [
             'controller_class_name' => $controllerClassName,
+            'controller_class_file' => 'src/Controller/'.$controllerClassName.'.php',
             'route_path' => Str::asRoutePath(str_replace('Controller', '', $controllerClassName)),
             'route_name' => Str::asRouteName(str_replace('Controller', '', $controllerClassName)),
+            'twig_file' => Str::asFilePath(str_replace('Controller', '', $controllerClassName)).'.html.twig',
+            'base_layout_exists' => $baseLayoutExists,
+            'twig_installed' => $this->isTwigInstalled(),
         ];
     }
 
     public function getFiles(array $params): array
     {
-        $skeletonFile = $this->isTwigInstalled() ? 'ControllerWithTwig.tpl.php' : 'Controller.tpl.php';
+        $dir = __DIR__.'/../Resources/skeleton/controller';
 
-        return [
-            __DIR__.'/../Resources/skeleton/controller/'.$skeletonFile => 'src/Controller/'.$params['controller_class_name'].'.php',
-        ];
+        $paths = [$dir.'/Controller.tpl.php' => $params['controller_class_file']];
+
+        if ($params['twig_installed']) {
+            $paths[$dir.'/twig_template.tpl.php'] = 'templates/'.$params['twig_file'];
+        }
+
+        return $paths;
     }
 
     public function writeSuccessMessage(array $params, ConsoleStyle $io)

src/Resources/config/makers.xml

@@ -17,6 +17,7 @@
 
             <service id="maker.maker.make_controller" class="Symfony\Bundle\MakerBundle\Maker\MakeController">
                 <argument type="service" id="router" />
+                <argument type="service" id="maker.file_manager" />
                 <tag name="maker.command" />
             </service>
 

src/Resources/skeleton/controller/Controller.tpl.php

@@ -4,7 +4,6 @@
 
 use Symfony\Component\Routing\Annotation\Route;
 use Symfony\Bundle\FrameworkBundle\Controller\Controller;
-use Symfony\Component\HttpFoundation\Response;
 
 class <?= $controller_class_name ?> extends Controller
 {
@@ -13,6 +12,15 @@ class <?= $controller_class_name ?> extends Controller
      */
     public function index()
     {
-        return new Response('Welcome to your new controller!');
+<?php if ($twig_installed) { ?>
+        return $this->render('<?= $twig_file ?>', [
+            'controller_name' => '<?= $controller_class_name ?>',
+        ]);
+<?php } else { ?>
+        return $this->json([
+            'message' => 'Welcome to your new controller!',
+            'path' => '<?= $relative_path; ?>',
+        ]);
+<?php } ?>
     }
 }

src/Resources/skeleton/controller/ControllerWithTwig.tpl.php

@@ -0,0 +1,26 @@
+<?php if ($base_layout_exists): ?>
+{% extends 'base.html.twig' %}
+
+{% block title %}Hello {{ controller_name }}!{% endblock %}
+<?php else: ?>
+<!DOCTYPE html>
+
+<title>Hello {{ controller_name }}!</title>
+<?php endif; ?>
+
+{% block body %}
+<style>
+    .example-wrapper { margin: 1em auto; max-width: 800px; width: 95%; font: 18px/1.5 sans-serif; }
+    .example-wrapper code { background: #F5F5F5; padding: 2px 6px; }
+</style>
+
+<div class="example-wrapper">
+    <h1>Hello {{ controller_name }}! ✅</h1>
+
+    This friendly message is coming from:
+    <ul>
+        <li>Your controller at <code><?= $controller_class_file; ?></code></li>
+        <li>Your template at <code><?= $relative_path ?></code></li>
+    </ul>
+</div>
+{% endblock %}

src/Resources/skeleton/controller/twig_template.tpl.php

@@ -11,6 +11,8 @@
 
 namespace Symfony\Bundle\MakerBundle;
 
+use Symfony\Component\DependencyInjection\Container;
+
 /**
  * @author Javier Eguiluz <[email protected]>
  * @author Ryan Weaver <[email protected]>
@@ -97,6 +99,14 @@ public static function asEventMethod(string $eventName): string
         return sprintf('on%s', self::asClassName($eventName));
     }
 
+    public static function asFilePath(string $value): string
+    {
+        $value = Container::underscore(trim($value));
+        $value = str_replace('\\', '/', $value);
+
+        return $value;
+    }
+
     public static function getRandomTerm(): string
     {
         $adjectives = [