feature #60 Php templates (weaverryan)

weaverryan · weaverryan · commit d9db2dd278f2 · 2017-11-29T10:14:41.000-05:00
This PR was squashed before being merged into the 1.0-dev branch (closes #60). Discussion ---------- Php templates This depends on #59. So sorry for the messy diff until that is merged: tl;dr; This renders the templates as PHP, instead of simple `{{ foo }}` find and replace. We do not want to make the templates super dynamic and fancy, but we're already running into a few spots where we're hitting this limitation (case: `make:controller` which has *two* possible templates, because the current replace is too limiting). The only ugly part is that the `<?php` in the templates needs to be written as `//PHP_OPEN` to avoid syntax errors (we then replace this with `<?php` after including). Here is an example: https://github.com/symfony/maker-bundle/compare/master...weaverryan:php-templates?expand=1#diff-3ecc33834a0f1ec4f8e5516d71e4ad35 Btw, if you're wondering "Why not use Twig!?". We don't want to create a dependency on Twig to use the maker :). Cheers! Commits ------- 8fe5462 Php templates
diff --git a/composer.json b/composer.json
@@ -20,6 +20,7 @@
         "symfony/http-kernel": "^3.4|^4.0"
     },
     "require-dev": {
+        "friendsofphp/php-cs-fixer": "^2.8",
         "symfony/phpunit-bridge": "^3.4|^4.0",
         "symfony/process": "^3.4|^4.0"
     },
diff --git a/src/FileManager.php b/src/FileManager.php
@@ -40,13 +40,11 @@ public function setIO(SymfonyStyle $io): void
 
     public function parseTemplate(string $templatePath, array $parameters): string
     {
-        $keys = array_keys($parameters);
-        $values = array_values($parameters);
-        $placeholders = array_map(function ($name) {
-            return "{{ $name }}";
-        }, $keys);
+        ob_start();
+        extract($parameters, EXTR_SKIP);
+        include $templatePath;
 
-        return str_replace($placeholders, $values, file_get_contents($templatePath));
+        return ob_get_clean();
     }
 
     public function dumpFile(string $filename, string $content): void
diff --git a/src/Maker/MakeAuthenticator.php b/src/Maker/MakeAuthenticator.php
@@ -58,7 +58,7 @@ public function getParameters(InputInterface $input): array
     public function getFiles(array $params): array
     {
         return [
-            __DIR__.'/../Resources/skeleton/authenticator/Empty.php.txt' => 'src/Security/'.$params['class_name'].'.php',
+            __DIR__.'/../Resources/skeleton/authenticator/Empty.tpl.php' => 'src/Security/'.$params['class_name'].'.php',
         ];
     }
 
diff --git a/src/Maker/MakeCommand.php b/src/Maker/MakeCommand.php
@@ -60,7 +60,7 @@ public function getParameters(InputInterface $input): array
     public function getFiles(array $params): array
     {
         return [
-            __DIR__.'/../Resources/skeleton/command/Command.php.txt' => 'src/Command/'.$params['command_class_name'].'.php',
+            __DIR__.'/../Resources/skeleton/command/Command.tpl.php' => 'src/Command/'.$params['command_class_name'].'.php',
         ];
     }
 
diff --git a/src/Maker/MakeController.php b/src/Maker/MakeController.php
@@ -69,7 +69,7 @@ public function getParameters(InputInterface $input): array
 
     public function getFiles(array $params): array
     {
-        $skeletonFile = $this->isTwigInstalled() ? 'ControllerWithTwig.php.txt' : 'Controller.php.txt';
+        $skeletonFile = $this->isTwigInstalled() ? 'ControllerWithTwig.tpl.php' : 'Controller.tpl.php';
 
         return [
             __DIR__.'/../Resources/skeleton/controller/'.$skeletonFile => 'src/Controller/'.$params['controller_class_name'].'.php',
diff --git a/src/Maker/MakeEntity.php b/src/Maker/MakeEntity.php
@@ -63,8 +63,8 @@ public function getParameters(InputInterface $input): array
     public function getFiles(array $params): array
     {
         return [
-            __DIR__.'/../Resources/skeleton/doctrine/Entity.php.txt' => 'src/Entity/'.$params['entity_class_name'].'.php',
-            __DIR__.'/../Resources/skeleton/doctrine/Repository.php.txt' => 'src/Repository/'.$params['repository_class_name'].'.php',
+            __DIR__.'/../Resources/skeleton/doctrine/Entity.tpl.php' => 'src/Entity/'.$params['entity_class_name'].'.php',
+            __DIR__.'/../Resources/skeleton/doctrine/Repository.tpl.php' => 'src/Repository/'.$params['repository_class_name'].'.php',
         ];
     }
 
diff --git a/src/Maker/MakeForm.php b/src/Maker/MakeForm.php
@@ -62,7 +62,7 @@ public function getParameters(InputInterface $input): array
     public function getFiles(array $params): array
     {
         return [
-            __DIR__.'/../Resources/skeleton/form/Type.php.txt' => 'src/Form/'.$params['form_class_name'].'.php',
+            __DIR__.'/../Resources/skeleton/form/Type.tpl.php' => 'src/Form/'.$params['form_class_name'].'.php',
         ];
     }
 
diff --git a/src/Maker/MakeFunctionalTest.php b/src/Maker/MakeFunctionalTest.php
@@ -58,7 +58,7 @@ public function getParameters(InputInterface $input): array
     public function getFiles(array $params): array
     {
         return [
-            __DIR__.'/../Resources/skeleton/test/Functional.php.txt' => 'tests/'.$params['test_class_name'].'.php',
+            __DIR__.'/../Resources/skeleton/test/Functional.tpl.php' => 'tests/'.$params['test_class_name'].'.php',
         ];
     }
 
diff --git a/src/Maker/MakeSerializerEncoder.php b/src/Maker/MakeSerializerEncoder.php
@@ -61,7 +61,7 @@ public function getParameters(InputInterface $input): array
     public function getFiles(array $params): array
     {
         return [
-            __DIR__.'/../Resources/skeleton/serializer/Encoder.php.txt' => 'src/Serializer/'.$params['encoder_class_name'].'.php',
+            __DIR__.'/../Resources/skeleton/serializer/Encoder.tpl.php' => 'src/Serializer/'.$params['encoder_class_name'].'.php',
         ];
     }
 
diff --git a/src/Maker/MakeSubscriber.php b/src/Maker/MakeSubscriber.php
@@ -85,14 +85,14 @@ public function getParameters(InputInterface $input): array
             'event' => $event,
             'eventArg' => $eventShortName ? sprintf('%s $event', $eventShortName) : '$event',
             'methodName' => Str::asEventMethod($event),
-            'eventUseStatement' => $eventClass ? sprintf("use $eventClass;\n") : '',
+            'eventClass' => $eventClass,
         ];
     }
 
     public function getFiles(array $params): array
     {
         return [
-            __DIR__.'/../Resources/skeleton/event/Subscriber.php.txt' => 'src/EventSubscriber/'.$params['subscriber_class_name'].'.php',
+            __DIR__.'/../Resources/skeleton/event/Subscriber.tpl.php' => 'src/EventSubscriber/'.$params['subscriber_class_name'].'.php',
         ];
     }
 
diff --git a/src/Maker/MakeTwigExtension.php b/src/Maker/MakeTwigExtension.php
@@ -59,7 +59,7 @@ public function getParameters(InputInterface $input): array
     public function getFiles(array $params): array
     {
         return [
-            __DIR__.'/../Resources/skeleton/twig/Extension.php.txt' => 'src/Twig/'.$params['extension_class_name'].'.php',
+            __DIR__.'/../Resources/skeleton/twig/Extension.tpl.php' => 'src/Twig/'.$params['extension_class_name'].'.php',
         ];
     }
 
diff --git a/src/Maker/MakeUnitTest.php b/src/Maker/MakeUnitTest.php
@@ -58,7 +58,7 @@ public function getParameters(InputInterface $input): array
     public function getFiles(array $params): array
     {
         return [
-            __DIR__.'/../Resources/skeleton/test/Unit.php.txt' => 'tests/'.$params['test_class_name'].'.php',
+            __DIR__.'/../Resources/skeleton/test/Unit.tpl.php' => 'tests/'.$params['test_class_name'].'.php',
         ];
     }
 
diff --git a/src/Maker/MakeValidator.php b/src/Maker/MakeValidator.php
@@ -61,8 +61,8 @@ public function getParameters(InputInterface $input): array
     public function getFiles(array $params): array
     {
         return [
-            __DIR__.'/../Resources/skeleton/validator/Validator.php.txt' => 'src/Validator/Constraints/'.$params['validator_class_name'].'.php',
-            __DIR__.'/../Resources/skeleton/validator/Constraint.php.txt' => 'src/Validator/Constraints/'.$params['constraint_class_name'].'.php',
+            __DIR__.'/../Resources/skeleton/validator/Validator.tpl.php' => 'src/Validator/Constraints/'.$params['validator_class_name'].'.php',
+            __DIR__.'/../Resources/skeleton/validator/Constraint.tpl.php' => 'src/Validator/Constraints/'.$params['constraint_class_name'].'.php',
         ];
     }
 
diff --git a/src/Maker/MakeVoter.php b/src/Maker/MakeVoter.php
@@ -59,7 +59,7 @@ public function getParameters(InputInterface $input): array
     public function getFiles(array $params): array
     {
         return [
-            __DIR__.'/../Resources/skeleton/security/Voter.php.txt' => 'src/Security/Voter/'.$params['voter_class_name'].'.php',
+            __DIR__.'/../Resources/skeleton/security/Voter.tpl.php' => 'src/Security/Voter/'.$params['voter_class_name'].'.php',
         ];
     }
 
diff --git a/src/MakerInterface.php b/src/MakerInterface.php
@@ -71,9 +71,11 @@ public function getParameters(InputInterface $input): array;
      * For example:
      *
      *    return array(
-     *        __DIR__.'/../Resources/skeleton/command/Command.php.txt' => 'src/Command/'.$params['command_class_name'].'.php',
+     *        __DIR__.'/../Resources/skeleton/command/Command.tpl.php' => 'src/Command/'.$params['command_class_name'].'.php',
      *    );
      *
+     * These files are parsed as PHP.
+     *
      * @param array $params The parameters returned from getParameters()
      *
      * @return array
diff --git a/src/Resources/skeleton/authenticator/Empty.tpl.php b/src/Resources/skeleton/authenticator/Empty.tpl.php
@@ -1,4 +1,4 @@
-<?php
+<?= "<?php\n" ?>
 
 namespace App\Security;
 
@@ -9,45 +9,45 @@
 use Symfony\Component\Security\Core\User\UserProviderInterface;
 use Symfony\Component\Security\Guard\GuardAuthenticator;
 
-class {{ class_name }} extends GuardAuthenticator
+class <?= $class_name ?> extends GuardAuthenticator
 {
     public function supports(Request $request)
     {
-
+        // todo
     }
 
     public function getCredentials(Request $request)
     {
-
+        // todo
     }
 
     public function getUser($credentials, UserProviderInterface $userProvider)
     {
-
+        // todo
     }
 
     public function checkCredentials($credentials, UserInterface $user)
     {
-
+        // todo
     }
 
     public function onAuthenticationFailure(Request $request, AuthenticationException $exception)
     {
-
+        // todo
     }
 
     public function onAuthenticationSuccess(Request $request, TokenInterface $token, $providerKey)
     {
-
+        // todo
     }
 
-    public function supportsRememberMe()
+    public function start(Request $request, AuthenticationException $authException = null)
     {
-
+        // todo
     }
 
-    public function start(Request $request, AuthenticationException $authException = null)
+    public function supportsRememberMe()
     {
-
+        // todo
     }
-}
+}
diff --git a/src/Resources/skeleton/command/Command.tpl.php b/src/Resources/skeleton/command/Command.tpl.php
@@ -1,4 +1,4 @@
-<?php
+<?= "<?php\n" ?>
 
 namespace App\Command;
 
@@ -9,9 +9,9 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Style\SymfonyStyle;
 
-class {{ command_class_name }} extends Command
+class <?= $command_class_name ?> extends Command
 {
-    protected static $defaultName = '{{ command_name }}';
+    protected static $defaultName = '<?= $command_name ?>';
 
     protected function configure()
     {
diff --git a/src/Resources/skeleton/controller/Controller.tpl.php b/src/Resources/skeleton/controller/Controller.tpl.php
@@ -1,15 +1,15 @@
-<?php
+<?= "<?php\n" ?>
 
 namespace App\Controller;
 
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\Response;
 
-class {{ controller_class_name }} extends AbstractController
+class <?= $controller_class_name ?> extends AbstractController
 {
     /**
-     * @Route("{{ route_path }}", name="{{ route_name }}")
+     * @Route("<?= $route_path ?>", name="<?= $route_name ?>")
      */
     public function index()
     {
diff --git a/src/Resources/skeleton/controller/ControllerWithTwig.tpl.php b/src/Resources/skeleton/controller/ControllerWithTwig.tpl.php
@@ -1,15 +1,15 @@
-<?php
+<?= "<?php\n" ?>
 
 namespace App\Controller;
 
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\Response;
 
-class {{ controller_class_name }} extends AbstractController
+class <?= $controller_class_name ?> extends AbstractController
 {
     /**
-     * @Route("{{ route_path }}", name="{{ route_name }}")
+     * @Route("<?= $route_path ?>", name="<?= $route_name ?>")
      */
     public function index()
     {
diff --git a/src/Resources/skeleton/doctrine/Entity.tpl.php b/src/Resources/skeleton/doctrine/Entity.tpl.php
@@ -1,13 +1,13 @@
-<?php
+<?= "<?php\n" ?>
 
 namespace App\Entity;
 
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * @ORM\Entity(repositoryClass="App\Repository\{{ repository_class_name }}")
+ * @ORM\Entity(repositoryClass="App\Repository\<?= $repository_class_name ?>")
  */
-class {{ entity_class_name }}
+class <?= $entity_class_name."\n" ?>
 {
     /**
      * @ORM\Id
diff --git a/src/Resources/skeleton/doctrine/Repository.php.txt b/src/Resources/skeleton/doctrine/Repository.php.txt
diff --git a/src/Resources/skeleton/doctrine/Repository.tpl.php b/src/Resources/skeleton/doctrine/Repository.tpl.php
@@ -0,0 +1,28 @@
+<?= "<?php\n" ?>
+
+namespace App\Repository;
+
+use App\Entity\<?= $entity_class_name ?>;
+use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository;
+use Symfony\Bridge\Doctrine\RegistryInterface;
+
+class <?= $repository_class_name ?> extends ServiceEntityRepository
+{
+    public function __construct(RegistryInterface $registry)
+    {
+        parent::__construct($registry, <?= $entity_class_name ?>::class);
+    }
+
+    /*
+    public function findBySomething($value)
+    {
+        return $this->createQueryBuilder('<?= $entity_alias ?>')
+            ->where('<?= $entity_alias ?>.something = :value')->setParameter('value', $value)
+            ->orderBy('<?= $entity_alias ?>.id', 'ASC')
+            ->setMaxResults(10)
+            ->getQuery()
+            ->getResult()
+        ;
+    }
+    */
+}
diff --git a/src/Resources/skeleton/event/Subscriber.php.txt b/src/Resources/skeleton/event/Subscriber.php.txt
diff --git a/src/Resources/skeleton/event/Subscriber.tpl.php b/src/Resources/skeleton/event/Subscriber.tpl.php
@@ -0,0 +1,21 @@
+<?= "<?php\n" ?>
+
+namespace App\EventSubscriber;
+
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+<?= $eventClass ? "use $eventClass;\n" : '' ?>
+
+class <?= $subscriber_class_name ?> implements EventSubscriberInterface
+{
+    public function <?= $methodName ?>(<?= $eventArg ?>)
+    {
+        // ...
+    }
+
+    public static function getSubscribedEvents()
+    {
+        return [
+           '<?= $event ?>' => '<?= $methodName ?>',
+        ];
+    }
+}
diff --git a/src/Resources/skeleton/form/Type.tpl.php b/src/Resources/skeleton/form/Type.tpl.php
diff --git a/src/Resources/skeleton/security/Voter.tpl.php b/src/Resources/skeleton/security/Voter.tpl.php
diff --git a/src/Resources/skeleton/serializer/Encoder.tpl.php b/src/Resources/skeleton/serializer/Encoder.tpl.php
diff --git a/src/Resources/skeleton/test/Functional.tpl.php b/src/Resources/skeleton/test/Functional.tpl.php
diff --git a/src/Resources/skeleton/test/Unit.tpl.php b/src/Resources/skeleton/test/Unit.tpl.php
diff --git a/src/Resources/skeleton/twig/Extension.tpl.php b/src/Resources/skeleton/twig/Extension.tpl.php
diff --git a/src/Resources/skeleton/validator/Constraint.tpl.php b/src/Resources/skeleton/validator/Constraint.tpl.php
diff --git a/src/Resources/skeleton/validator/Validator.tpl.php b/src/Resources/skeleton/validator/Validator.tpl.php
diff --git a/tests/Command/FunctionalTest.php b/tests/Command/FunctionalTest.php

Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ public function getParameters(InputInterface $input): array`
`58`	`58`	`public function getFiles(array $params): array`
`59`	`59`	`{`
`60`	`60`	`return [`
`61`		`- __DIR__.'/../Resources/skeleton/authenticator/Empty.php.txt' => 'src/Security/'.$params['class_name'].'.php',`
	`61`	`+ __DIR__.'/../Resources/skeleton/authenticator/Empty.tpl.php' => 'src/Security/'.$params['class_name'].'.php',`
`62`	`62`	`];`
`63`	`63`	`}`
`64`	`64`
Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@ public function getParameters(InputInterface $input): array`
`60`	`60`	`public function getFiles(array $params): array`
`61`	`61`	`{`
`62`	`62`	`return [`
`63`		`- __DIR__.'/../Resources/skeleton/command/Command.php.txt' => 'src/Command/'.$params['command_class_name'].'.php',`
	`63`	`+ __DIR__.'/../Resources/skeleton/command/Command.tpl.php' => 'src/Command/'.$params['command_class_name'].'.php',`
`64`	`64`	`];`
`65`	`65`	`}`
`66`	`66`
Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@ public function getParameters(InputInterface $input): array`
`69`	`69`
`70`	`70`	`public function getFiles(array $params): array`
`71`	`71`	`{`
`72`		`- $skeletonFile = $this->isTwigInstalled() ? 'ControllerWithTwig.php.txt' : 'Controller.php.txt';`
	`72`	`+ $skeletonFile = $this->isTwigInstalled() ? 'ControllerWithTwig.tpl.php' : 'Controller.tpl.php';`
`73`	`73`
`74`	`74`	`return [`
`75`	`75`	`__DIR__.'/../Resources/skeleton/controller/'.$skeletonFile => 'src/Controller/'.$params['controller_class_name'].'.php',`
Original file line number	Diff line number	Diff line change
`@@ -63,8 +63,8 @@ public function getParameters(InputInterface $input): array`
`63`	`63`	`public function getFiles(array $params): array`
`64`	`64`	`{`
`65`	`65`	`return [`
`66`		`- __DIR__.'/../Resources/skeleton/doctrine/Entity.php.txt' => 'src/Entity/'.$params['entity_class_name'].'.php',`
`67`		`- __DIR__.'/../Resources/skeleton/doctrine/Repository.php.txt' => 'src/Repository/'.$params['repository_class_name'].'.php',`
	`66`	`+ __DIR__.'/../Resources/skeleton/doctrine/Entity.tpl.php' => 'src/Entity/'.$params['entity_class_name'].'.php',`
	`67`	`+ __DIR__.'/../Resources/skeleton/doctrine/Repository.tpl.php' => 'src/Repository/'.$params['repository_class_name'].'.php',`
`68`	`68`	`];`
`69`	`69`	`}`
`70`	`70`
Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ public function getParameters(InputInterface $input): array`
`62`	`62`	`public function getFiles(array $params): array`
`63`	`63`	`{`
`64`	`64`	`return [`
`65`		`- __DIR__.'/../Resources/skeleton/form/Type.php.txt' => 'src/Form/'.$params['form_class_name'].'.php',`
	`65`	`+ __DIR__.'/../Resources/skeleton/form/Type.tpl.php' => 'src/Form/'.$params['form_class_name'].'.php',`
`66`	`66`	`];`
`67`	`67`	`}`
`68`	`68`
Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ public function getParameters(InputInterface $input): array`
`61`	`61`	`public function getFiles(array $params): array`
`62`	`62`	`{`
`63`	`63`	`return [`
`64`		`- __DIR__.'/../Resources/skeleton/serializer/Encoder.php.txt' => 'src/Serializer/'.$params['encoder_class_name'].'.php',`
	`64`	`+ __DIR__.'/../Resources/skeleton/serializer/Encoder.tpl.php' => 'src/Serializer/'.$params['encoder_class_name'].'.php',`
`65`	`65`	`];`
`66`	`66`	`}`
`67`	`67`
Original file line number	Diff line number	Diff line change
`@@ -85,14 +85,14 @@ public function getParameters(InputInterface $input): array`
`85`	`85`	`'event' => $event,`
`86`	`86`	`'eventArg' => $eventShortName ? sprintf('%s $event', $eventShortName) : '$event',`
`87`	`87`	`'methodName' => Str::asEventMethod($event),`
`88`		`- 'eventUseStatement' => $eventClass ? sprintf("use $eventClass;\n") : '',`
	`88`	`+ 'eventClass' => $eventClass,`
`89`	`89`	`];`
`90`	`90`	`}`
`91`	`91`
`92`	`92`	`public function getFiles(array $params): array`
`93`	`93`	`{`
`94`	`94`	`return [`
`95`		`- __DIR__.'/../Resources/skeleton/event/Subscriber.php.txt' => 'src/EventSubscriber/'.$params['subscriber_class_name'].'.php',`
	`95`	`+ __DIR__.'/../Resources/skeleton/event/Subscriber.tpl.php' => 'src/EventSubscriber/'.$params['subscriber_class_name'].'.php',`
`96`	`96`	`];`
`97`	`97`	`}`
`98`	`98`