feature #14781 [TwigBundle] Reconfigure twig paths when they are updated (chbruyand)

fabpot · fabpot · commit 4133aadd0c0b · 2015-06-05T19:28:20.000+02:00
This PR was squashed before being merged into the 2.8 branch (closes #14781). Discussion ---------- [TwigBundle] Reconfigure twig paths when they are updated | Q | A | ------------- | --- | Bug fix? | yes | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #14771, #14768, #14262, #14778 | License | MIT Refresh twig paths upon creation and deletion. As we don't care neither about path's modification time nor path's content, a new Resource has been added in the Config Component. Full discussion in #14778. Commits ------- 3cbff05 [TwigBundle] Reconfigure twig paths when they are updated
diff --git a/src/Symfony/Bundle/TwigBundle/DependencyInjection/TwigExtension.php b/src/Symfony/Bundle/TwigBundle/DependencyInjection/TwigExtension.php
@@ -12,6 +12,7 @@
 namespace Symfony\Bundle\TwigBundle\DependencyInjection;
 
 use Symfony\Component\Config\FileLocator;
+use Symfony\Component\Config\Resource\FileExistenceResource;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
@@ -78,19 +79,25 @@ public function load(array $configs, ContainerBuilder $container)
 
         // register bundles as Twig namespaces
         foreach ($container->getParameter('kernel.bundles') as $bundle => $class) {
-            if (is_dir($dir = $container->getParameter('kernel.root_dir').'/Resources/'.$bundle.'/views')) {
+            $dir = $container->getParameter('kernel.root_dir').'/Resources/'.$bundle.'/views';
+            if (is_dir($dir)) {
                 $this->addTwigPath($twigFilesystemLoaderDefinition, $dir, $bundle);
             }
+            $container->addResource(new FileExistenceResource($dir));
 
             $reflection = new \ReflectionClass($class);
-            if (is_dir($dir = dirname($reflection->getFilename()).'/Resources/views')) {
+            $dir = dirname($reflection->getFilename()).'/Resources/views';
+            if (is_dir($dir)) {
                 $this->addTwigPath($twigFilesystemLoaderDefinition, $dir, $bundle);
             }
+            $container->addResource(new FileExistenceResource($dir));
         }
 
-        if (is_dir($dir = $container->getParameter('kernel.root_dir').'/Resources/views')) {
+        $dir = $container->getParameter('kernel.root_dir').'/Resources/views';
+        if (is_dir($dir)) {
             $twigFilesystemLoaderDefinition->addMethodCall('addPath', array($dir));
         }
+        $container->addResource(new FileExistenceResource($dir));
 
         if (!empty($config['globals'])) {
             $def = $container->getDefinition('twig');
diff --git a/src/Symfony/Bundle/TwigBundle/composer.json b/src/Symfony/Bundle/TwigBundle/composer.json
@@ -27,7 +27,7 @@
         "symfony/stopwatch": "~2.2|~3.0.0",
         "symfony/dependency-injection": "~2.6,>=2.6.6|~3.0.0",
         "symfony/expression-language": "~2.4|~3.0.0",
-        "symfony/config": "~2.2|~3.0.0",
+        "symfony/config": "~2.8|~3.0.0",
         "symfony/routing": "~2.1|~3.0.0",
         "symfony/templating": "~2.1|~3.0.0",
         "symfony/framework-bundle": "~2.7|~3.0.0"
diff --git a/src/Symfony/Component/Config/Resource/FileExistenceResource.php b/src/Symfony/Component/Config/Resource/FileExistenceResource.php
@@ -0,0 +1,78 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Config\Resource;
+
+/**
+ * FileExistenceResource represents a resource stored on the filesystem.
+ * Freshness is only evaluated against resource creation or deletion.
+ *
+ * The resource can be a file or a directory.
+ *
+ * @author Charles-Henri Bruyand <charleshenri.bruyand@gmail.com>
+ */
+class FileExistenceResource implements ResourceInterface, \Serializable
+{
+    private $resource;
+
+    private $exists;
+
+    /**
+     * Constructor.
+     *
+     * @param string $resource The file path to the resource
+     */
+    public function __construct($resource)
+    {
+        $this->resource = (string) $resource;
+        $this->exists = file_exists($resource);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function __toString()
+    {
+        return $this->resource;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getResource()
+    {
+        return $this->resource;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function isFresh($timestamp)
+    {
+        return file_exists($this->resource) === $this->exists;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function serialize()
+    {
+        return serialize(array($this->resource, $this->exists));
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function unserialize($serialized)
+    {
+        list($this->resource, $this->exists) = unserialize($serialized);
+    }
+}
diff --git a/src/Symfony/Component/Config/Tests/Resource/FileExistenceResourceTest.php b/src/Symfony/Component/Config/Tests/Resource/FileExistenceResourceTest.php
@@ -0,0 +1,70 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Config\Tests\Resource;
+
+use Symfony\Component\Config\Resource\FileExistenceResource;
+
+class FileExistenceResourceTest extends \PHPUnit_Framework_TestCase
+{
+    protected $resource;
+    protected $file;
+    protected $time;
+
+    protected function setUp()
+    {
+        $this->file = realpath(sys_get_temp_dir()).'/tmp.xml';
+        $this->time = time();
+        $this->resource = new FileExistenceResource($this->file);
+    }
+
+    protected function tearDown()
+    {
+        if (file_exists($this->file)) {
+            unlink($this->file);
+        }
+    }
+
+    public function testToString()
+    {
+        $this->assertSame($this->file, (string) $this->resource);
+    }
+
+    public function testGetResource()
+    {
+        $this->assertSame($this->file, $this->resource->getResource(), '->getResource() returns the path to the resource');
+    }
+
+    public function testIsFreshWithExistingResource()
+    {
+        touch($this->file, $this->time);
+        $serialized = serialize(new FileExistenceResource($this->file));
+
+        $resource = unserialize($serialized);
+        $this->assertTrue($resource->isFresh($this->time), '->isFresh() returns true if the resource is still present');
+
+        unlink($this->file);
+        $resource = unserialize($serialized);
+        $this->assertFalse($resource->isFresh($this->time), '->isFresh() returns false if the resource has been deleted');
+    }
+
+    public function testIsFreshWithAbsentResource()
+    {
+        $serialized = serialize(new FileExistenceResource($this->file));
+
+        $resource = unserialize($serialized);
+        $this->assertTrue($resource->isFresh($this->time), '->isFresh() returns true if the resource is still absent');
+
+        touch($this->file, $this->time);
+        $resource = unserialize($serialized);
+        $this->assertFalse($resource->isFresh($this->time), '->isFresh() returns false if the resource has been created');
+    }
+}
