Merge pull request #38 from pug-php/standard-logout

kylekatarnls · web-flow · commit db55ef3ded3a · 2019-03-29T22:20:57.000+01:00
Use standard logout path/url
diff --git a/.phan/config.php b/.phan/config.php
@@ -0,0 +1,14 @@
+<?php
+
+return [
+    'directory_list' => [
+        'src',
+        'vendor',
+    ],
+
+    'exclude_file_regex' => '@^vendor/.*/(tests?|Tests?)/@',
+
+    'exclude_analysis_directory_list' => [
+        'vendor/',
+    ],
+];
diff --git a/composer.json b/composer.json
@@ -13,6 +13,7 @@
     "symfony/framework-bundle": "^2.7 || ^3.0 || ^4.0",
     "symfony/http-foundation": "^2.7 || ^3.0 || ^4.0",
     "symfony/http-kernel": "^2.7 || ^3.0 || ^4.0",
+    "symfony/security-bundle": "^2.7 || ^3.0 || ^4.0",
     "symfony/templating": "^2.7 || ^3.0 || ^4.0",
     "symfony/twig-bridge": "^2.7 || ^3.0 || ^4.0"
   },
diff --git a/src/Jade/JadeSymfonyBundle/Command/AssetsPublishCommand.php b/src/Jade/JadeSymfonyBundle/Command/AssetsPublishCommand.php
@@ -2,7 +2,6 @@
 
 namespace Jade\JadeSymfonyBundle\Command;
 
-use Jade\Jade;
 use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
diff --git a/src/Jade/JadeSymfonyEngine.php b/src/Jade/JadeSymfonyEngine.php
@@ -65,7 +65,7 @@ public function __construct($kernel)
         $container = $kernel->getContainer();
         $this->container = $container;
         $environment = $kernel->getEnvironment();
-        $appDir = $kernel->getRootDir();
+        $appDir = $this->getAppDirectory($kernel);
         $rootDir = dirname($appDir);
         $assetsDirectories = [$appDir . '/Resources/assets'];
         $viewDirectories = [$appDir . '/Resources/views'];
@@ -114,6 +114,20 @@ public function __construct($kernel)
         }
     }
 
+    protected function getAppDirectory($kernel)
+    {
+        /* @var KernelInterface $kernel */
+        if (method_exists($kernel, 'getProjectDir') &&
+            ($directory = $kernel->getProjectDir()) &&
+            file_exists($directory = "$directory/app")
+        ) {
+            return realpath($directory);
+        }
+
+        /* @var Kernel $kernel */
+        return $kernel->getRootDir(false); // @codeCoverageIgnore
+    }
+
     protected function getEngineClassName()
     {
         $engineName = class_exists('\\Pug\\Pug') ? 'Pug' : 'Jade';
diff --git a/src/Jade/Symfony/Logout.php b/src/Jade/Symfony/Logout.php
diff --git a/src/Jade/Symfony/MixedLoader.php b/src/Jade/Symfony/MixedLoader.php
@@ -7,7 +7,14 @@
 
 class MixedLoader implements Twig_LoaderInterface
 {
+    /**
+     * @var Twig_LoaderInterface
+     */
     protected $base;
+
+    /**
+     * @var array
+     */
     protected $extraTemplates = [];
 
     public function __construct(Twig_LoaderInterface $base)
diff --git a/src/Jade/Symfony/Traits/Filters.php b/src/Jade/Symfony/Traits/Filters.php
@@ -3,9 +3,9 @@
 namespace Jade\Symfony\Traits;
 
 /**
- * @internal
- *
  * Trait Filters.
+ *
+ * @property-read \Pug\Pug $jade
  */
 trait Filters
 {
diff --git a/src/Jade/Symfony/Traits/HelpersHandler.php b/src/Jade/Symfony/Traits/HelpersHandler.php
@@ -3,15 +3,14 @@
 namespace Jade\Symfony\Traits;
 
 use Jade\Symfony\Css;
-use Jade\Symfony\Logout;
 use Jade\Symfony\MixedLoader;
 use Symfony\Bridge\Twig\Extension\HttpFoundationExtension;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
- * @internal
- *
  * Trait HelpersHandler.
+ *
+ * @property-read \Pug\Pug $jade
  */
 trait HelpersHandler
 {
@@ -38,7 +37,6 @@ trait HelpersHandler
         'assets',
         'code',
         'form',
-        'logout_url',
         'request',
         'router',
         'security',
@@ -55,8 +53,30 @@ protected function getTemplatingHelper($name)
         return isset($this->helpers[$name]) ? $this->helpers[$name] : null;
     }
 
+    protected function compileTwigCallable(\Twig_Environment $twig, $name)
+    {
+        $callable = function () use ($twig, $name) {
+            $variables = [];
+            foreach (func_get_args() as $index => $argument) {
+                $variables['arg' . $index] = $argument;
+            }
+
+            /* @var MixedLoader $loader */
+            $loader = $twig->getLoader();
+
+            $template = $loader->uniqueTemplate(
+                '{{' . $name . '(' . implode(', ', array_keys($variables)) . ') }}'
+            );
+
+            return $twig->render($template, $variables);
+        };
+
+        return $callable->bindTo($twig);
+    }
+
     protected function getTwigCallable(\Twig_Environment $twig, $function, $name)
     {
+        /* @var \Twig_Function $function */
         $callable = $function->getCallable();
 
         if (!$callable ||
@@ -65,19 +85,7 @@ protected function getTwigCallable(\Twig_Environment $twig, $function, $name)
             is_string($callable[0]) && is_string($callable[1]) &&
             !(new \ReflectionMethod($callable[0], $callable[1]))->isStatic()
         ) {
-            $callable = function () use ($twig, $name) {
-                $variables = [];
-                foreach (func_get_args() as $index => $argument) {
-                    $variables['arg' . $index] = $argument;
-                }
-
-                $template = $twig->getLoader()->uniqueTemplate(
-                    '{{' . $name . '(' . implode(', ', array_keys($variables)) . ') }}'
-                );
-
-                return $twig->render($template, $variables);
-            };
-            $callable = $callable->bindTo($twig);
+            $callable = $this->compileTwigCallable($twig, $name);
         }
 
         return $callable;
@@ -103,6 +111,7 @@ protected function copyTwigFunction(\Twig_Environment $twig, $function)
     protected function copyTwigFunctions(ContainerInterface $services)
     {
         $this->twigHelpers = [];
+
         if ($services->has('twig') &&
             ($twig = $services->get('twig')) instanceof \Twig_Environment
         ) {
@@ -112,6 +121,7 @@ protected function copyTwigFunctions(ContainerInterface $services)
             $loader = new MixedLoader($twig->getLoader());
             $twig->setLoader($loader);
             $this->share('twig', $twig);
+
             foreach ($twig->getExtensions() as $extension) {
                 /* @var \Twig_Extension $extension */
                 foreach ($extension->getFunctions() as $function) {
@@ -135,9 +145,6 @@ protected function copyStandardHelpers(ContainerInterface $services)
 
     protected function copySpecialHelpers(ContainerInterface $services)
     {
-        if ($helper = $this->getTemplatingHelper('logout_url')) {
-            $this->helpers['logout'] = new Logout($helper);
-        }
         $this->helpers['css'] = new Css($this->getTemplatingHelper('assets'));
         /* @var \Symfony\Component\HttpFoundation\RequestStack $stack */
         $stack = $services->get('request_stack');
@@ -167,8 +174,6 @@ protected function storeReplacements()
             'csrf_token'    => ['form', 'csrfToken'],
             'url'           => ['router', 'url'],
             'path'          => ['router', 'path'],
-            'logout_url'    => ['logout', 'url'],
-            'logout_path'   => ['logout', 'path'],
             'absolute_url'  => ['http', 'generateAbsoluteUrl'],
             'relative_path' => ['http', 'generateRelativePath'],
             'is_granted'    => ['security', 'isGranted'],
diff --git a/src/Jade/Symfony/Traits/Installer.php b/src/Jade/Symfony/Traits/Installer.php
@@ -6,8 +6,6 @@
 use Jade\Symfony\Contracts\InstallerInterface;
 
 /**
- * @internal
- *
  * Trait Installer.
  */
 trait Installer
diff --git a/src/Jade/Symfony/Traits/Options.php b/src/Jade/Symfony/Traits/Options.php
@@ -5,9 +5,9 @@
 use Pug\Pug;
 
 /**
- * @internal
- *
  * Trait Options.
+ *
+ * @property-read \Pug\Pug $jade
  */
 trait Options
 {
diff --git a/tests/Pug/AssetsHelper.php b/tests/Pug/AssetsHelper.php
@@ -0,0 +1,11 @@
+<?php
+
+namespace Symfony\Bundle\FrameworkBundle\Templating\Helper;
+
+class AssetsHelper
+{
+    public function getUrl($url)
+    {
+        return "fake:$url";
+    }
+}
diff --git a/tests/Pug/LogoutUrlHelper.php b/tests/Pug/LogoutUrlHelper.php
@@ -0,0 +1,9 @@
+<?php
+
+namespace Pug\Tests;
+
+use Symfony\Bundle\SecurityBundle\Templating\Helper\LogoutUrlHelper as BaseLogoutUrlHelper;
+
+class LogoutUrlHelper extends BaseLogoutUrlHelper
+{
+}
diff --git a/tests/Pug/PugSymfonyEngineTest.php b/tests/Pug/PugSymfonyEngineTest.php
@@ -5,13 +5,15 @@
 use Composer\Composer;
 use Composer\Script\Event;
 use Jade\JadeSymfonyEngine;
+use Jade\Symfony\Css;
 use Jade\Symfony\MixedLoader;
 use Pug\Filter\AbstractFilter;
 use Pug\Pug;
 use Pug\PugSymfonyEngine;
+use Symfony\Bridge\Twig\Extension\LogoutUrlExtension;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Bundle\FrameworkBundle\Templating\Helper\AssetsHelper;
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
-use Symfony\Bundle\SecurityBundle\Templating\Helper\LogoutUrlHelper as BaseLogoutUrlHelper;
 use Symfony\Component\Config\Loader\LoaderInterface;
 use Symfony\Component\DependencyInjection\Container;
 use Symfony\Component\Filesystem\Filesystem;
@@ -61,14 +63,6 @@ public function getLogoutPath($key = null)
     }
 }
 
-class LogoutUrlHelper extends BaseLogoutUrlHelper
-{
-    public function __construct()
-    {
-        parent::__construct(new LogoutUrlGenerator());
-    }
-}
-
 class TestKernel extends \AppKernel
 {
     /**
@@ -319,8 +313,26 @@ public function testSecurityToken()
 
     public function testLogoutHelper()
     {
-        $logoutUrlHelper = new LogoutUrlHelper(new LogoutUrlGenerator());
-        self::$kernel->getContainer()->set('templating.helper.logout_url', $logoutUrlHelper);
+        $generator = new LogoutUrlGenerator();
+        /* @var \Twig_Environment $twig */
+        $twig = self::$kernel->getContainer()->get('twig');
+
+        foreach ($twig->getExtensions() as $extension) {
+            if ($extension instanceof LogoutUrlExtension) {
+                $reflectionClass = new \ReflectionClass('Symfony\Bridge\Twig\Extension\LogoutUrlExtension');
+                $reflectionProperty = $reflectionClass->getProperty('generator');
+                $reflectionProperty->setAccessible(true);
+                $reflectionProperty->setValue($extension, $generator);
+                $generator = null;
+            }
+        }
+
+        if ($generator) {
+            include_once __DIR__ . '/LogoutUrlHelper.php';
+            $logoutUrlHelper = new LogoutUrlHelper($generator);
+            self::$kernel->getContainer()->set('templating.helper.logout_url', $logoutUrlHelper);
+        }
+
         $pugSymfony = new PugSymfonyEngine(self::$kernel);
 
         self::assertSame('<a href="logout-url"></a><a href="logout-path"></a>', trim($pugSymfony->render('logout.pug')));
@@ -895,7 +907,10 @@ public function testOptionDefaultingOnException()
 
     public function testMixedLoader()
     {
-        $loader = new MixedLoader(new ArrayLoader());
+        $loader = new MixedLoader(new ArrayLoader([
+            'fozz' => 'fozz template',
+            'bazz' => 'bazz template',
+        ]));
 
         $loader->setTemplate('foo', 'bar');
         $loader->setTemplateSource('bar', 'biz');
@@ -905,5 +920,17 @@ public function testMixedLoader()
         self::assertTrue($loader->exists('bar'));
         self::assertTrue($loader->isFresh('bar', 1));
         self::assertFalse($loader->exists('biz'));
+
+        self::assertSame('fozz template', $loader->getSourceContext('fozz')->getCode());
+        self::assertSame('bazz:bazz template', $loader->getCacheKey('bazz'));
+    }
+
+    public function testCssWithCustomAssetsHelper()
+    {
+        include_once __DIR__ . '/AssetsHelper.php';
+        $helper = new AssetsHelper();
+        $css = new Css($helper);
+
+        self::assertSame("url('fake:foo')", $css->getUrl('foo'));
     }
 }
diff --git a/tests/project-s4/config/packages/security.yaml b/tests/project-s4/config/packages/security.yaml
@@ -0,0 +1,9 @@
+security:
+  providers:
+    in_memory: { memory: ~ }
+  firewalls:
+    main:
+      anonymous: ~
+      logout:
+        path:   /logout
+        target: /
diff --git a/tests/project-s4/config/routes.yaml b/tests/project-s4/config/routes.yaml
@@ -0,0 +1,2 @@
+logout:
+  path: /logout
diff --git a/tests/project/app/AppKernel.php b/tests/project/app/AppKernel.php
@@ -9,6 +9,7 @@ public function registerBundles()
     {
         $bundles = [
             new Symfony\Bundle\FrameworkBundle\FrameworkBundle(),
+            new Symfony\Bundle\SecurityBundle\SecurityBundle(),
             new Symfony\Bundle\TwigBundle\TwigBundle(),
             new TestBundle\TestBundle(),
             new Pug\PugSymfonyBundle\PugSymfonyBundle(),
diff --git a/tests/project/app/config.yml b/tests/project/app/config.yml
@@ -20,3 +20,13 @@ services:
         public: true
         class: Pug\PugSymfonyEngine
         arguments: ["@kernel"]
+
+security:
+    providers:
+        in_memory: { memory: ~ }
+    firewalls:
+        main:
+            anonymous: ~
+            logout:
+                path:   /logout
+                target: /
diff --git a/tests/project/app/config/config.yml b/tests/project/app/config/config.yml
diff --git a/tests/project/app/routing.yml b/tests/project/app/routing.yml
