Upgrading to Symfony5

.travis.yml

@@ -38,9 +38,6 @@ matrix:
     - php: '7.1'
       env:
         - SYMFONY_VERSION=3.4.*
-    - php: '7.1'
-      env:
-        - SYMFONY_VERSION=4.2.*
     - php: '7.1'
       env:
         - SYMFONY_VERSION=4.3.*

DependencyInjection/Compiler/NonFunctionalFilterExceptionPass.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace Liip\ImagineBundle\DependencyInjection\Compiler;
+
+use Liip\ImagineBundle\Imagine\Filter\Loader\NonFunctionalPasteFilterLoader;
+use Liip\ImagineBundle\Imagine\Filter\Loader\NonFunctionalWatermarkFilterLoader;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+/**
+ * For transitioning from Symfony 4 to Symfony 5 with the removal
+ * of the kernel.root_dir parameter.
+ */
+class NonFunctionalFilterExceptionPass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container)
+    {
+        $canFiltersStillFunction = $container->hasParameter('kernel.root_dir');
+        $throwWarning = function(string $filterName) use ($canFiltersStillFunction) {
+            $message = sprintf(
+                'The "%s" filter %s in Symfony 5.0. Please use "%s_image" and adapt the "image" option to be relative to the "%%kernel.project_dir%%" instead of "%%kernel.root_dir%%".',
+                $filterName,
+                $canFiltersStillFunction ? 'is deprecated and will not work' : 'no longer works',
+                $filterName
+            );
+
+            if ($canFiltersStillFunction) {
+                @trigger_error($message, E_USER_DEPRECATED);
+            } else {
+                throw new \InvalidArgumentException($message);
+            }
+        };
+
+        $filterSets = $container->getParameter('liip_imagine.filter_sets');
+        foreach ($filterSets as $filterSet) {
+            foreach ($filterSet['filters'] as $filterName => $filter) {
+                if ($filterName === 'paste') {
+                    $throwWarning('paste');
+                }
+
+                if ($filterName === 'watermark') {
+                    $throwWarning('watermark');
+                }
+            }
+        }
+
+        // remove the definitions entirely if kernel.root_dir does not exist
+        if (!$canFiltersStillFunction) {
+            $container->removeDefinition('liip_imagine.filter.loader.watermark');
+            $container->removeDefinition('liip_imagine.filter.loader.paste');
+        }
+    }
+}

Imagine/Filter/Loader/PasteFilterLoader.php

@@ -25,12 +25,12 @@ class PasteFilterLoader implements LoaderInterface
     /**
      * @var string
      */
-    protected $rootPath;
+    protected $projectDir;
 
-    public function __construct(ImagineInterface $imagine, $rootPath)
+    public function __construct(ImagineInterface $imagine, $projectDir)
     {
         $this->imagine = $imagine;
-        $this->rootPath = $rootPath;
+        $this->projectDir = $projectDir;
     }
 
     /**
@@ -46,7 +46,7 @@ public function load(ImageInterface $image, array $options = [])
         $x = isset($options['start'][0]) ? $options['start'][0] : null;
         $y = isset($options['start'][1]) ? $options['start'][1] : null;
 
-        $destImage = $this->imagine->open($this->rootPath.'/'.$options['image']);
+        $destImage = $this->imagine->open($this->projectDir.'/'.$options['image']);
 
         return $image->paste($destImage, new Point($x, $y));
     }

Imagine/Filter/Loader/WatermarkFilterLoader.php

@@ -26,12 +26,12 @@ class WatermarkFilterLoader implements LoaderInterface
     /**
      * @var string
      */
-    protected $rootPath;
+    protected $projectDir;
 
-    public function __construct(ImagineInterface $imagine, $rootPath)
+    public function __construct(ImagineInterface $imagine, $projectDir)
     {
         $this->imagine = $imagine;
-        $this->rootPath = $rootPath;
+        $this->projectDir = $projectDir;
     }
 
     /**
@@ -53,7 +53,7 @@ public function load(ImageInterface $image, array $options = [])
             $options['size'] = mb_substr($options['size'], 0, -1) / 100;
         }
 
-        $watermark = $this->imagine->open($this->rootPath.'/'.$options['image']);
+        $watermark = $this->imagine->open($this->projectDir.'/'.$options['image']);
 
         $size = $image->getSize();
         $watermarkSize = $watermark->getSize();

LiipImagineBundle.php

@@ -17,6 +17,7 @@
 use Liip\ImagineBundle\DependencyInjection\Compiler\FiltersCompilerPass;
 use Liip\ImagineBundle\DependencyInjection\Compiler\LoadersCompilerPass;
 use Liip\ImagineBundle\DependencyInjection\Compiler\MetadataReaderCompilerPass;
+use Liip\ImagineBundle\DependencyInjection\Compiler\NonFunctionalFilterExceptionPass;
 use Liip\ImagineBundle\DependencyInjection\Compiler\PostProcessorsCompilerPass;
 use Liip\ImagineBundle\DependencyInjection\Compiler\ResolversCompilerPass;
 use Liip\ImagineBundle\DependencyInjection\Factory\Loader\ChainLoaderFactory;
@@ -39,6 +40,7 @@ public function build(ContainerBuilder $container)
     {
         parent::build($container);
 
+        $container->addCompilerPass(new NonFunctionalFilterExceptionPass());
         $container->addCompilerPass(new DriverCompilerPass());
         $container->addCompilerPass(new LoadersCompilerPass());
         $container->addCompilerPass(new FiltersCompilerPass());

Resources/config/imagine.xml

@@ -209,17 +209,31 @@
             <tag name="liip_imagine.filter.loader" loader="grayscale" />
         </service>
 
+        <service id="liip_imagine.filter.loader.paste_image" class="Liip\ImagineBundle\Imagine\Filter\Loader\PasteFilterLoader">
+            <tag name="liip_imagine.filter.loader" loader="paste_image" />
+            <argument type="service" id="liip_imagine" />
+            <argument>%kernel.project_dir%</argument>
+        </service>
+
+        <!-- deprecated -->
+        <!-- not officially deprecated because they are still injected and appear "used" -->
         <service id="liip_imagine.filter.loader.paste" class="Liip\ImagineBundle\Imagine\Filter\Loader\PasteFilterLoader">
             <tag name="liip_imagine.filter.loader" loader="paste" />
             <argument type="service" id="liip_imagine" />
             <argument>%kernel.root_dir%</argument>
         </service>
-
         <service id="liip_imagine.filter.loader.watermark" class="Liip\ImagineBundle\Imagine\Filter\Loader\WatermarkFilterLoader">
             <tag name="liip_imagine.filter.loader" loader="watermark" />
             <argument type="service" id="liip_imagine" />
             <argument>%kernel.root_dir%</argument>
         </service>
+        <!-- end deprecated -->
+
+        <service id="liip_imagine.filter.loader.watermark_image" class="Liip\ImagineBundle\Imagine\Filter\Loader\WatermarkFilterLoader">
+            <tag name="liip_imagine.filter.loader" loader="watermark_image" />
+            <argument type="service" id="liip_imagine" />
+            <argument>%kernel.project_dir%</argument>
+        </service>
 
         <service id="liip_imagine.filter.loader.background" class="Liip\ImagineBundle\Imagine\Filter\Loader\BackgroundFilterLoader">
             <tag name="liip_imagine.filter.loader" loader="background" />

Resources/doc/filters/general.rst

@@ -163,7 +163,7 @@ Example configuration:
 Watermark
 ---------
 
-The built-in ``watermark`` filter adds a watermark to an existing image
+The built-in ``watermark_image`` filter adds a watermark to an existing image
 (which includes creating and merging image operations). This
 filter exposes a number of `watermark options`_ which may be used
 to configure its behavior.
@@ -181,11 +181,11 @@ Example configuration:
             my_watermark_filter:
                 filters:
 
-                    # use and setup the "watermark" filter
-                    watermark:
+                    # use and setup the "watermark_image" filter
+                    watermark_image:
 
-                        # path to the watermark file (prepended with "%kernel.root_dir%")
-                        image: Resources/data/watermark.png
+                        # path to the watermark file (prepended with "%kernel.project_dir%")
+                        image: assets/watermark.png
 
                         # size of the water mark relative to the input image
                         size: 0.5
@@ -199,7 +199,7 @@ Watermark Options
 
 :strong:`image:` ``string``
     Sets the location of the watermark image. The value of this option is prepended
-    with the resolved value of the ``%kernel.root_dir%`` parameter.
+    with the resolved value of the ``%kernel.project_dir%`` parameter.
 
 :strong:`size:` ``float``
     Sets the size of the watermark as a relative ration, relative to the original

Tests/AbstractTest.php

@@ -51,7 +51,7 @@ abstract class AbstractTest extends TestCase
      */
     protected $temporaryPath;
 
-    protected function setUp()
+    protected function setUp(): void
     {
         $this->fixturesPath = realpath(__DIR__.DIRECTORY_SEPARATOR.'Fixtures');
         $this->temporaryPath = sys_get_temp_dir().DIRECTORY_SEPARATOR.'liip_imagine_test';
@@ -64,7 +64,7 @@ protected function setUp()
         $this->filesystem->mkdir($this->temporaryPath);
     }
 
-    protected function tearDown()
+    protected function tearDown(): void
     {
         if (!$this->filesystem) {
             return;

Tests/Async/CacheResolvedTest.php

@@ -20,7 +20,7 @@
  */
 class CacheResolvedTest extends TestCase
 {
-    public static function setUpBeforeClass()
+    public static function setUpBeforeClass(): void
     {
         if (!class_exists(EnqueueBundle::class)) {
             self::markTestSkipped('The tests are run without enqueue integration. Skip them');

Tests/Async/ResolveCacheProcessorTest.php

@@ -35,7 +35,7 @@
  */
 class ResolveCacheProcessorTest extends AbstractTest
 {
-    public static function setUpBeforeClass()
+    public static function setUpBeforeClass(): void
     {
         if (!class_exists(EnqueueBundle::class)) {
             self::markTestSkipped('The tests are run without enqueue integration. Skip them');

Tests/Async/ResolveCacheTest.php

@@ -20,7 +20,7 @@
  */
 class ResolveCacheTest extends TestCase
 {
-    public static function setUpBeforeClass()
+    public static function setUpBeforeClass(): void
     {
         if (!class_exists(EnqueueBundle::class)) {
             self::markTestSkipped('The tests are run without enqueue integration. Skip them');

Tests/Binary/Loader/AbstractDoctrineLoaderTest.php

@@ -32,7 +32,7 @@ class AbstractDoctrineLoaderTest extends TestCase
      */
     private $loader;
 
-    public function setUp()
+    public function setUp(): void
     {
         if (!interface_exists(ObjectManager::class)) {
             $this->markTestSkipped('Requires the doctrine/orm package.');

Tests/Binary/Loader/FlysystemLoaderTest.php

@@ -28,7 +28,7 @@ class FlysystemLoaderTest extends AbstractTest
 {
     private $flyFilesystem;
 
-    public function setUp()
+    public function setUp(): void
     {
         parent::setUp();
 

Tests/Config/FilterSetBuilderTest.php

@@ -41,7 +41,7 @@ class FilterSetBuilderTest extends TestCase
      */
     private $model;
 
-    protected function setUp()
+    protected function setUp(): void
     {
         $this->filterSetFactoryMock = $this->createMock(StackFactoryInterface::class);
         $this->filterFactoryCollectionMock = $this->createMock(FilterFactoryCollection::class);

Tests/DependencyInjection/Factory/Loader/FlysystemLoaderFactoryTest.php

@@ -25,7 +25,7 @@
  */
 class FlysystemLoaderFactoryTest extends TestCase
 {
-    public function setUp()
+    public function setUp(): void
     {
         parent::setUp();
 

Tests/DependencyInjection/Factory/Resolver/FlysystemResolverFactoryTest.php

@@ -25,7 +25,7 @@
  */
 class FlysystemResolverFactoryTest extends TestCase
 {
-    public function setUp()
+    public function setUp(): void
     {
         parent::setUp();
 

Tests/Events/CacheResolveEventTest.php

@@ -19,10 +19,6 @@
  */
 class CacheResolveEventTest extends TestCase
 {
-    protected function setUp()
-    {
-    }
-
     public function testShouldAllowSetPathInConstruct(): void
     {
         $event = new CacheResolveEvent('default_path', 'default_filter');

Tests/Form/Type/ImageTypeTest.php

@@ -24,7 +24,7 @@
  */
 class ImageTypeTest extends AbstractTest
 {
-    protected function setUp()
+    protected function setUp(): void
     {
         if (!class_exists(AbstractType::class)) {
             $this->markTestSkipped('Requires the symfony/form package.');

Tests/Functional/AbstractSetupWebTestCase.php

@@ -39,7 +39,7 @@ class AbstractSetupWebTestCase extends AbstractWebTestCase
      */
     protected $cacheRoot;
 
-    public function setUp()
+    public function setUp(): void
     {
         parent::setUp();
 

Tests/Imagine/Cache/CacheManagerTest.php

@@ -731,6 +731,8 @@ private function getDispatcherCallbackWithBC(EventDispatcherInterface $dispatche
             } else {
                 $callable($name, $event);
             }
+
+            return $event;
         };
     }
 

Tests/Imagine/Cache/Resolver/CacheResolverTest.php

@@ -26,7 +26,7 @@ class CacheResolverTest extends AbstractTest
     protected $path = 'MadCat2.jpeg';
     protected $webPath = '/media/cache/thumbnail/MadCat2.jpeg';
 
-    protected function setUp()
+    protected function setUp(): void
     {
         if (!class_exists(ArrayCache::class)) {
             $this->markTestSkipped('Requires the doctrine/cache package.');
@@ -194,7 +194,12 @@ public function testRemoveAllFilterCacheOnRemove(): void
      */
     private function getCacheEntries(ArrayCache $cache): array
     {
-        $cacheEntries = $this->readAttribute($cache, 'data');
+        $reflector = new \ReflectionObject($cache);
+        $attribute = $reflector->getProperty('data');
+        $attribute->setAccessible(true);
+        $cacheEntries = $attribute->getValue($cache);
+        $attribute->setAccessible(false);
+
         unset($cacheEntries['DoctrineNamespaceCacheKey[]']);
 
         return $cacheEntries;

Tests/Imagine/Cache/Resolver/FlysystemResolverTest.php

@@ -24,7 +24,7 @@
  */
 class FlysystemResolverTest extends AbstractTest
 {
-    public function setUp()
+    public function setUp(): void
     {
         parent::setUp();
 

Tests/Imagine/Cache/Resolver/ProxyResolverTest.php

@@ -32,7 +32,7 @@ class ProxyResolverTest extends AbstractTest
      */
     private $resolver;
 
-    public function setUp()
+    public function setUp(): void
     {
         $this->primaryResolver = $this->createObjectMock(ResolverInterface::class);
         $this->resolver = new ProxyResolver($this->primaryResolver, ['http://images.example.com']);