Avoid changing the interface

symfony · bnw · Sep 3, 2015 · Sep 4, 2015 · Sep 4, 2015 · Sep 4, 2015
commit aae0a78e8776c2cbd60bc534549a390010640a2d
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Command/CacheClearCommand/CacheClearCommandTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Command/CacheClearCommand/CacheClearCommandTest.php
@@ -5,9 +5,9 @@
 use Symfony\Bundle\FrameworkBundle\Console\Application;
 use Symfony\Bundle\FrameworkBundle\Tests\Command\CacheClearCommand\Fixture\TestAppKernel;
 use Symfony\Bundle\FrameworkBundle\Tests\TestCase;
-use Symfony\Component\Config\ConfigCache;
+use Symfony\Component\Config\ConfigCacheFactory;
+use Symfony\Component\Config\ConfigCacheInterface;
 use Symfony\Component\Config\Resource\ResourceInterface;
-use Symfony\Component\Config\Resource\ResourceInterfaceValidator;
 use Symfony\Component\Console\Input\ArrayInput;
 use Symfony\Component\Console\Output\NullOutput;
 use Symfony\Component\Filesystem\Filesystem;
@@ -48,15 +48,13 @@ public function testCacheIsFreshAfterCacheClearedWithWarmup()
         $metaFiles = $finder->files()->in($this->kernel->getCacheDir())->name('*.php.meta');
         // simply check that cache is warmed up
         $this->assertGreaterThanOrEqual(1, count($metaFiles));
+        $configCacheFactory = new ConfigCacheFactory(true);
+        $that = $this;
+
         foreach ($metaFiles as $file) {
-            $configCache = new ConfigCache(substr($file, 0, -5), true);
-            $this->assertTrue(
-                $configCache->isFresh(array(new ResourceInterfaceValidator())),
-                sprintf(
-                    'Meta file "%s" is not fresh',
-                    (string) $file
-                )
-            );
+            $configCacheFactory->cache(substr($file, 0, -5), function () use ($that, $file) {
+                $that->fail(sprintf('Meta file "%s" is not fresh', (string) $file));
+            });
         }
 
         // check that app kernel file present in meta file of container's cache

diff --git a/src/Symfony/Component/Config/ConfigCache.php b/src/Symfony/Component/Config/ConfigCache.php
@@ -16,12 +16,13 @@
 use Symfony\Component\Filesystem\Filesystem;
 
 /**
- * ConfigCache manages PHP cache files.
+ * ConfigCache caches arbitrary content in files on disk.
  *
- * When debug is enabled, it knows when to flush the cache
- * thanks to an array of ResourceInterface instances.
+ * Metadata can be stored alongside the cache and can later be
+ * used by MetadataValidators to check if the cache is still fresh.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ * @author Matthias Pigulla <mp@webfactory.de>
  */
 class ConfigCache implements ConfigCacheInterface
 {
@@ -68,25 +69,37 @@ public function getPath()
      * This method always returns true when debug is off and the
      * cache file exists.
      *
-     * @param MetadataValidatorInterface[] $validators List of validators the metadata is checked against. The first validator that supports a resource is considered authoritative.
-     *
      * @return bool true if the cache is fresh, false otherwise
+     *
+     * @deprecated since version 2.8, to be removed in 3.0.
      */
-    public function isFresh(array $validators = null)
+    public function isFresh()
     {
-        if (null === $validators) {
-            @trigger_error('ConfigCache::isFresh requires the $validators parameter as of version 2.8.', E_USER_DEPRECATED);
-            $validators = array(new ResourceInterfaceValidator());
+        @trigger_error(__NAMESPACE__.'\ConfigCache::isFresh() is deprecated since version 2.8 and will be removed in 3.0. Use the isValid() method instead and pass the appropriate MetadataValidators, or even better use a \Symfony\Component\Config\ConfigCacheFactoryInterface implementation to create and validate the cache.', E_USER_DEPRECATED);
+
+        if (!$this->debug && is_file($this->file)) {
+            return true;
         }
 
+        return $this->isValid(array(new ResourceInterfaceValidator()));
+    }
+
+    /**
+     * Use MetadataValidators to check if the cache is still valid.
+     *
+     * The first MetadataValidator that supports a given resource is considered authoritative.
+     * Resources with no matching MetadataValidators will silently be ignored.
+     *
+     * @param MetadataValidatorInterface[] $validators List of validators the metadata is checked against. The first validator that supports a resource is considered authoritative.
+     *
+     * @return bool True if all supported resources and valid, false otherwise
+     */
+    public function isValid(array $validators = null)
+    {
         if (!is_file($this->file)) {
             return false;
         }
 
-        if (!$this->debug) {
-            return true;
-        }
-
         $metadata = $this->getMetaFile();
         if (!is_file($metadata)) {
             return false;

diff --git a/src/Symfony/Component/Config/ConfigCacheFactory.php b/src/Symfony/Component/Config/ConfigCacheFactory.php
@@ -45,7 +45,7 @@ public function cache($file, $callback)
         }
 
         $cache = new ConfigCache($file, $this->debug);
-        if (!$cache->isFresh(array(new ResourceInterfaceValidator()))) {
+        if (!$cache->isValid(array(new ResourceInterfaceValidator()))) {
             call_user_func($callback, $cache);
         }
 

diff --git a/src/Symfony/Component/Config/ConfigCacheInterface.php b/src/Symfony/Component/Config/ConfigCacheInterface.php
@@ -32,11 +32,9 @@ public function getPath();
      *
      * This check should take the metadata passed to the write() method into consideration.
      *
-     * @param MetadataValidatorInterface[] $validators List of validators the metadata is checked against.
-     *
      * @return bool Whether the cache is still fresh.
      */
-    public function isFresh(array $validators = null);
+    public function isFresh();
 
     /**
      * Writes the given content into the cache file. Metadata will be stored

diff --git a/src/Symfony/Component/Config/MetadataValidatorInterface.php b/src/Symfony/Component/Config/MetadataValidatorInterface.php
@@ -27,7 +27,7 @@ interface MetadataValidatorInterface
      * Queries the MetadataValidator whether it can validate a given
      * resource or not.
      *
-     * @param $metadata The resource to be checked for freshness
+     * @param object $metadata The resource to be checked for freshness
      *
      * @return bool True if the MetadataValidator can handle this resource type, false if not
      */
@@ -36,8 +36,8 @@ public function supports($metadata);
     /**
      * Validates the resource.
      *
-     * @param $metadata The resource to be validated.
-     * @param $timestamp The timestamp at which the cache associated with this resource was created.
+     * @param object $metadata  The resource to be validated.
+     * @param int    $timestamp The timestamp at which the cache associated with this resource was created.
      *
      * @return bool True if the resource has not changed since the given timestamp, false otherwise.
      */

diff --git a/src/Symfony/Component/Config/Tests/ConfigCacheTest.php b/src/Symfony/Component/Config/Tests/ConfigCacheTest.php
@@ -57,7 +57,7 @@ public function testCacheIsNotFreshIfFileDoesNotExist()
 
         $cache = new ConfigCache($this->cacheFile, false);
 
-        $this->assertFalse($this->callIsFreshWithResourceValidator($cache));
+        $this->assertFalse($this->isCacheValid($cache));
     }
 
     public function testCacheIsAlwaysFreshIfFileExistsWithDebugDisabled()
@@ -66,7 +66,7 @@ public function testCacheIsAlwaysFreshIfFileExistsWithDebugDisabled()
 
         $cache = new ConfigCache($this->cacheFile, false);
 
-        $this->assertTrue($this->callIsFreshWithResourceValidator($cache));
+        $this->assertTrue($this->isCacheValid($cache));
     }
 
     public function testCacheIsNotFreshWithoutMetaFile()
@@ -75,14 +75,14 @@ public function testCacheIsNotFreshWithoutMetaFile()
 
         $cache = new ConfigCache($this->cacheFile, true);
 
-        $this->assertFalse($this->callIsFreshWithResourceValidator($cache));
+        $this->assertFalse($this->isCacheValid($cache));
     }
 
     public function testCacheIsFreshIfResourceIsFresh()
     {
         $cache = new ConfigCache($this->cacheFile, true);
 
-        $this->assertTrue($this->callIsFreshWithResourceValidator($cache));
+        $this->assertTrue($this->isCacheValid($cache));
     }
 
     public function testCacheIsNotFreshIfOneOfTheResourcesIsNotFresh()
@@ -91,7 +91,7 @@ public function testCacheIsNotFreshIfOneOfTheResourcesIsNotFresh()
 
         $cache = new ConfigCache($this->cacheFile, true);
 
-        $this->assertFalse($this->callIsFreshWithResourceValidator($cache));
+        $this->assertFalse($this->isCacheValid($cache));
     }
 
     public function testWriteDumpsFile()
@@ -122,9 +122,9 @@ public function testWriteDumpsMetaFileWithDebugEnabled()
         $this->assertSame(serialize($metadata), file_get_contents($this->metaFile));
     }
 
-    private function callIsFreshWithResourceValidator(ConfigCache $cache)
+    private function isCacheValid(ConfigCache $cache)
     {
-        return $cache->isFresh(array(new ResourceInterfaceValidator()));
+        return $cache->isValid(array(new ResourceInterfaceValidator()));
     }
 
     private function makeCacheFresh()

diff --git a/src/Symfony/Component/Config/ValidatorConfigCacheFactory.php b/src/Symfony/Component/Config/ValidatorConfigCacheFactory.php
@@ -55,7 +55,7 @@ public function cache($file, $callback)
         }
 
         $cache = new ConfigCache($file, $this->debug);
-        if (!$cache->isFresh($this->validators)) {
+        if (!$cache->isValid($this->validators)) {
             call_user_func($callback, $cache);
         }
 

diff --git a/src/Symfony/Component/HttpKernel/Kernel.php b/src/Symfony/Component/HttpKernel/Kernel.php
@@ -548,7 +548,12 @@ protected function initializeContainer()
         $class = $this->getContainerClass();
         $cache = new ConfigCache($this->getCacheDir().'/'.$class.'.php', $this->debug);
         $fresh = true;
-        if (!$cache->isFresh(array(new ResourceInterfaceValidator()))) {
+
+        /* We probably should use the ConfigCacheFactory here, but that would require
+         * some wrapper methods because we cannot call protected methods from closures
+         * prior to PHP 5.4. Let's do this change later when we can require PHP 5.4.
+         */
+        if (!$cache->isValid(array(new ResourceInterfaceValidator()))) {
             $container = $this->buildContainer();
             $container->compile();
             $this->dumpContainer($cache, $container, $class, $this->getContainerBaseClass());