[WIP][1.0][FilterManager] Filter manager drop get method. Add ability to configure at runtime.

Controller/ImagineController.php

@@ -65,7 +65,10 @@ public function filterAction(Request $request, $path, $filter)
         $binary = $this->dataManager->find($filter, $path);
         $image = $this->imagine->load($binary->getContent());
 
-        $response = $this->filterManager->get($request, $filter, $image, $path);
+        $filteredImage = $this->filterManager->applyFilter($image, $filter, array(
+            'format' => $binary->getFormat()
+        ));
+        $response = $this->filterManager->get($request, $filter, $filteredImage, $path);
 
         return $this->cacheManager->store($response, $path, $filter);
     }

Imagine/Cache/CacheManager.php

@@ -140,21 +140,21 @@ public function getBrowserPath($path, $filter, $absolute = false)
      */
     public function generateUrl($path, $filter, $absolute = false)
     {
-        $config = $this->filterConfig->get($filter);
-
-        if (isset($config['format'])) {
-            $pathinfo = pathinfo($path);
+        $config = $this->filterConfig->get($filter, array(
+            'format' => pathinfo($path, PATHINFO_EXTENSION),
+        ));
 
-            // the extension should be forced and a directory is detected
-            if ((!isset($pathinfo['extension']) || $pathinfo['extension'] !== $config['format'])
-                && isset($pathinfo['dirname'])) {
+        $pathinfo = pathinfo($path);
 
-                if ('\\' === $pathinfo['dirname']) {
-                    $pathinfo['dirname'] = '';
-                }
+        // the extension should be forced and a directory is detected
+        if ((!isset($pathinfo['extension']) || $pathinfo['extension'] !== $config['format'])
+            && isset($pathinfo['dirname'])) {
 
-                $path = $pathinfo['dirname'].'/'.$pathinfo['filename'].'.'.$config['format'];
+            if ('\\' === $pathinfo['dirname']) {
+                $pathinfo['dirname'] = '';
             }
+
+            $path = $pathinfo['dirname'].'/'.$pathinfo['filename'].'.'.$config['format'];
         }
 
         $params = array('path' => ltrim($path, '/'));

Imagine/Filter/FilterConfiguration.php

@@ -14,25 +14,40 @@ class FilterConfiguration
      */
     public function __construct(array $filters = array())
     {
-        $this->filters = $filters;
+        foreach ($filters as $filter => $config) {
+            $this->set($filter, $config);
+        }
     }
 
     /**
      * Gets a previously configured filter.
      *
      * @param string $filter
+     * @param array  $runtimeConfig
      *
      * @return array
      *
      * @throws \RuntimeException
      */
-    public function get($filter)
+    public function get($filter, array $runtimeConfig = array())
     {
-        if (empty($this->filters[$filter])) {
-            throw new \RuntimeException('Filter not defined: '.$filter);
+        if (false == array_key_exists($filter, $this->filters)) {
+            throw new \RuntimeException(sprintf('Could not find configuration for a filter: %s', $filter));
+        }
+
+        $defaultConfig = $this->filters[$filter];
+        $config = array_replace_recursive($defaultConfig, $runtimeConfig);
+
+        // $defaultConfig['format'] means we always want to format an image to this format.
+        // So this adds BC with previous versions.
+        if ($defaultConfig['format']) {
+            $config['format'] = $defaultConfig['format'];
+        }
+        if (empty($config['format'])) {
+            $config['format'] = 'png';
         }
 
-        return $this->filters[$filter];
+        return $config;
     }
 
     /**
@@ -45,6 +60,13 @@ public function get($filter)
      */
     public function set($filter, array $config)
     {
-        return $this->filters[$filter] = $config;
+        $this->filters[$filter] = array_replace(
+            array(
+                'quality' => 100,
+                'format' => null,
+                'filters' => array(),
+            ),
+            $config
+        );
     }
 }

Imagine/Filter/FilterManager.php

@@ -3,6 +3,7 @@
 namespace Liip\ImagineBundle\Imagine\Filter;
 
 use Imagine\Image\ImageInterface;
+use Imagine\Image\ImagineInterface;
 use Liip\ImagineBundle\Imagine\Filter\Loader\LoaderInterface;
 
 use Symfony\Component\HttpFoundation\Request;
@@ -20,14 +21,20 @@ class FilterManager
      */
     protected $loaders = array();
 
+    /**
+     * @var ImagineInterface
+     */
+    protected $imagine;
+
     /**
      * Constructor.
      *
      * @param FilterConfiguration $filterConfig
      */
-    public function __construct(FilterConfiguration $filterConfig)
+    public function __construct(FilterConfiguration $filterConfig, ImagineInterface $imagine)
     {
         $this->filterConfig = $filterConfig;
+        $this->imagine = $imagine;
     }
 
     /**
@@ -52,56 +59,47 @@ public function getFilterConfiguration()
     }
 
     /**
-     * Returns a response containing the given image after applying the given filter on it.
+     * @deprecated
      *
-     * @uses FilterManager::applyFilterSet
+     * Returns a response containing the given filtered image.
      *
      * @param Request $request
      * @param string $filter
-     * @param ImageInterface $image
-     * @param string $localPath
+     * @param ImageInterface $filteredImage
+     * @param string $path
      *
      * @return Response
      */
-    public function get(Request $request, $filter, ImageInterface $image, $localPath)
+    public function get(Request $request, $filter, ImageInterface $filteredImage, $path)
     {
-        $config = $this->getFilterConfiguration()->get($filter);
+        $config = $this->getFilterConfiguration()->get($filter, array(
+            'format' => pathinfo($path, PATHINFO_EXTENSION),
+        ));
 
-        $image = $this->applyFilter($image, $filter);
+        $filteredImage = $filteredImage->get($config['format'], array('quality' => $config['quality']));
 
-        if (empty($config['format'])) {
-            $format = pathinfo($localPath, PATHINFO_EXTENSION);
-            $format = $format ?: 'png';
-        } else {
-            $format = $config['format'];
-        }
-
-        $quality = empty($config['quality']) ? 100 : $config['quality'];
-
-        $image = $image->get($format, array('quality' => $quality));
-
-        $contentType = $request->getMimeType($format);
+        $contentType = $request->getMimeType($config['format']);
         if (empty($contentType)) {
-            $contentType = 'image/'.$format;
+            $contentType = 'image/'.$config['format'];
         }
 
-        return new Response($image, 200, array('Content-Type' => $contentType));
+        return new Response($filteredImage, 200, array('Content-Type' => $contentType));
     }
 
     /**
      * Apply the provided filter set on the given Image.
      *
      * @param ImageInterface $image
      * @param string $filter
+     * @param array $runtimeConfig
      *
      * @return ImageInterface
      *
      * @throws \InvalidArgumentException
      */
-    public function applyFilter(ImageInterface $image, $filter)
+    public function applyFilter(ImageInterface $image, $filter, array $runtimeConfig = array())
     {
-        $config = $this->getFilterConfiguration()->get($filter);
-
+        $config = $this->getFilterConfiguration()->get($filter, $runtimeConfig);
         foreach ($config['filters'] as $eachFilter => $eachOptions) {
             if (!isset($this->loaders[$eachFilter])) {
                 throw new \InvalidArgumentException(sprintf(
@@ -112,6 +110,8 @@ public function applyFilter(ImageInterface $image, $filter)
             $image = $this->loaders[$eachFilter]->load($image, $eachOptions);
         }
 
-        return $image;
+        return $this->imagine->load(
+            $image->get($config['format'], array('quality' => $config['quality']))
+        );
     }
 }

Resources/config/imagine.xml

@@ -66,6 +66,7 @@
 
         <service id="liip_imagine.filter.manager" class="%liip_imagine.filter.manager.class%">
             <argument type="service" id="liip_imagine.filter.configuration" />
+            <argument type="service" id="liip_imagine" />
         </service>
 
         <service id="liip_imagine.data.manager" class="%liip_imagine.data.manager.class%">

Resources/doc/filters.md

@@ -183,7 +183,8 @@ public function filterAction(Request $request, $path, $filter)
     $config['filters']['thumbnail']['size'] = array(300, 100);
     $filterConfig->set($filter, $config);
 
-    $response = $this->filterManager->get($request, $filter, $image, $path);
+    $filteredImage = $this->filterManager->applyFilter($image, $filter);
+    $response = $this->filterManager->get($request, $filter, $filteredImage, $path);
 
     $this->cacheManager->store($response, $path, $filter);
 

Tests/Controller/ImagineControllerTest.php

@@ -102,7 +102,7 @@ public function testFilterActionLive()
 
         $filterLoader = new ThumbnailFilterLoader();
 
-        $filterManager = new FilterManager($this->configuration);
+        $filterManager = new FilterManager($this->configuration, $this->imagine);
         $filterManager->addLoader('thumbnail', $filterLoader);
 
         $webPathResolver = new WebPathResolver($this->filesystem);
@@ -146,7 +146,7 @@ public function testFilterDelegatesResolverResponse()
         $extensionGuesser = ExtensionGuesser::getInstance();
 
         $dataManager = $this->getMock('Liip\ImagineBundle\Imagine\Data\DataManager', array(), array($mimeTypeGuesser, $extensionGuesser, $this->configuration));
-        $filterManager = $this->getMock('Liip\ImagineBundle\Imagine\Filter\FilterManager', array(), array($this->configuration));
+        $filterManager = $this->getMock('Liip\ImagineBundle\Imagine\Filter\FilterManager', array(), array($this->configuration, $this->imagine));
 
         $controller = new ImagineController($dataManager, $filterManager, $cacheManager, $this->imagine);
 

Tests/Imagine/Cache/CacheManagerTest.php

@@ -3,6 +3,7 @@
 namespace Liip\ImagineBundle\Tests\Imagine\Cache;
 
 use Liip\ImagineBundle\Imagine\Cache\CacheManager;
+use Liip\ImagineBundle\Imagine\Filter\FilterConfiguration;
 use Liip\ImagineBundle\Tests\AbstractTest;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
@@ -106,6 +107,7 @@ public function testFilterActionUrlGeneratedAndReturnIfResolverReturnNullOnGetBr
             ->method('get')
             ->with('thumbnail')
             ->will($this->returnValue(array(
+                'format' => 'png',
                 'size' => array(180, 180),
                 'mode' => 'outbound',
                 'cache' => null,
@@ -242,13 +244,8 @@ public function generateUrlProvider()
      */
     public function testGenerateUrl($filterConfig, $path, $expectedPath)
     {
-        $config = $this->getMockFilterConfiguration();
-        $config
-            ->expects($this->once())
-            ->method('get')
-            ->with('thumbnail')
-            ->will($this->returnValue($filterConfig))
-        ;
+        $config = new FilterConfiguration;
+        $config->set('thumbnail', $filterConfig);
 
         $router = $this->getMockRouter();
         $router