Merge pull request #1357 from mynameisbogdan/2.x

Flysystem v2 support
liip · Feb 23, 2021 · 56924e4 · 56924e4
2 parents 7a9740c + 98ce75a
commit 56924e4
Show file tree

Hide file tree

Showing 12 changed files with 84 additions and 36 deletions.
diff --git a/Binary/Loader/FlysystemV2Loader.php b/Binary/Loader/FlysystemV2Loader.php
@@ -53,7 +53,7 @@ public function find($path)
                 $extension
             );
         } catch (FilesystemException $exception) {
-            throw new NotLoadableException(sprintf('Source image "%s" not found.', $path), null, $exception);
+            throw new NotLoadableException(sprintf('Source image "%s" not found.', $path), 0, $exception);
         }
     }
 

diff --git a/DependencyInjection/Factory/Loader/AbstractLoaderFactory.php b/DependencyInjection/Factory/Loader/AbstractLoaderFactory.php
@@ -23,11 +23,13 @@ abstract class AbstractLoaderFactory implements LoaderFactoryInterface
     protected static $namePrefix = 'liip_imagine.binary.loader';
 
     /**
+     * @param string|null $name
+     *
      * @return ChildDefinition
      */
-    final protected function getChildLoaderDefinition()
+    final protected function getChildLoaderDefinition($name = null)
     {
-        return new ChildDefinition(sprintf('%s.prototype.%s', static::$namePrefix, $this->getName()));
+        return new ChildDefinition(sprintf('%s.prototype.%s', static::$namePrefix, $name ?: $this->getName()));
     }
 
     /**

diff --git a/DependencyInjection/Factory/Loader/FlysystemLoaderFactory.php b/DependencyInjection/Factory/Loader/FlysystemLoaderFactory.php
@@ -11,6 +11,7 @@
 
 namespace Liip\ImagineBundle\DependencyInjection\Factory\Loader;
 
+use League\Flysystem\FilesystemOperator;
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Reference;
@@ -22,7 +23,7 @@ class FlysystemLoaderFactory extends AbstractLoaderFactory
      */
     public function create(ContainerBuilder $container, $loaderName, array $config)
     {
-        $definition = $this->getChildLoaderDefinition();
+        $definition = $this->getChildLoaderDefinition($this->getChildLoaderName());
 
         if ($container->hasDefinition('liip_imagine.mime_types')) {
             $mimeTypes = $container->getDefinition('liip_imagine.mime_types');
@@ -55,4 +56,16 @@ public function addConfiguration(ArrayNodeDefinition $builder)
                 ->end()
             ->end();
     }
+
+    /**
+     * @return string|null
+     */
+    private function getChildLoaderName()
+    {
+        if (interface_exists(FilesystemOperator::class)) {
+            return 'flysystem2';
+        }
+
+        return null;
+    }
 }
diff --git a/DependencyInjection/Factory/Resolver/FlysystemResolverFactory.php b/DependencyInjection/Factory/Resolver/FlysystemResolverFactory.php
@@ -11,6 +11,7 @@
 
 namespace Liip\ImagineBundle\DependencyInjection\Factory\Resolver;
 
+use League\Flysystem\FilesystemOperator;
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Reference;
@@ -22,7 +23,7 @@ class FlysystemResolverFactory extends AbstractResolverFactory
      */
     public function create(ContainerBuilder $container, $resolverName, array $config)
     {
-        $resolverDefinition = $this->getChildResolverDefinition();
+        $resolverDefinition = $this->getChildResolverDefinition($this->getChildResolverName());
         $resolverDefinition->replaceArgument(0, new Reference($config['filesystem_service']));
         $resolverDefinition->replaceArgument(2, $config['root_url']);
         $resolverDefinition->replaceArgument(3, $config['cache_prefix']);
@@ -69,4 +70,16 @@ public function addConfiguration(ArrayNodeDefinition $builder)
                 ->end()
             ->end();
     }
+
+    /**
+     * @return string|null
+     */
+    private function getChildResolverName()
+    {
+        if (interface_exists(FilesystemOperator::class)) {
+            return 'flysystem2';
+        }
+
+        return null;
+    }
 }
diff --git a/Resources/config/imagine.xml b/Resources/config/imagine.xml
@@ -302,6 +302,11 @@
             <argument><!-- will be injected by FlysystemLoaderFactory --></argument>
         </service>
 
+        <service id="liip_imagine.binary.loader.prototype.flysystem2" class="Liip\ImagineBundle\Binary\Loader\FlysystemV2Loader" abstract="true">
+            <argument type="service" id="liip_imagine.extension_guesser" />
+            <argument><!-- will be injected by FlysystemV2LoaderFactory --></argument>
+        </service>
+
         <service id="liip_imagine.binary.loader.prototype.chain" class="Liip\ImagineBundle\Binary\Loader\ChainLoader" abstract="true">
             <argument><!-- will be injected by ChainLoaderFactory --></argument>
         </service>
@@ -350,6 +355,14 @@
             <argument><!-- will be injected by a ResolverFactory --></argument>
         </service>
 
+        <service id="liip_imagine.cache.resolver.prototype.flysystem2" class="Liip\ImagineBundle\Imagine\Cache\Resolver\FlysystemV2Resolver" public="true" abstract="true">
+            <argument><!-- will be injected by a ResolverFactory --></argument>
+            <argument type="service" id="router.request_context" />
+            <argument><!-- will be injected by a ResolverFactory --></argument>
+            <argument><!-- will be injected by a ResolverFactory --></argument>
+            <argument><!-- will be injected by a ResolverFactory --></argument>
+        </service>
+
         <service id="liip_imagine.cache.resolver.prototype.proxy" class="Liip\ImagineBundle\Imagine\Cache\Resolver\ProxyResolver" public="true" abstract="true">
             <argument><!-- will be injected by AwsS3ResolverFactory --></argument>
             <argument><!-- will be injected by AwsS3ResolverFactory --></argument>

diff --git a/Tests/DependencyInjection/Factory/Loader/ChainLoaderFactoryTest.php b/Tests/DependencyInjection/Factory/Loader/ChainLoaderFactoryTest.php
@@ -21,7 +21,7 @@
 use Symfony\Component\DependencyInjection\Reference;
 
 /**
- * @covers \Liip\ImagineBundle\DependencyInjection\Factory\Loader\ChainLoaderFactory
+ * @covers \Liip\ImagineBundle\DependencyInjection\Factory\Loader\ChainLoaderFactory<extended>
  */
 class ChainLoaderFactoryTest extends FactoryTestCase
 {

diff --git a/Tests/DependencyInjection/Factory/Loader/FileSystemLoaderFactoryTest.php b/Tests/DependencyInjection/Factory/Loader/FileSystemLoaderFactoryTest.php
@@ -22,7 +22,7 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 
 /**
- * @covers \Liip\ImagineBundle\DependencyInjection\Factory\Loader\FileSystemLoaderFactory
+ * @covers \Liip\ImagineBundle\DependencyInjection\Factory\Loader\FileSystemLoaderFactory<extended>
  */
 class FileSystemLoaderFactoryTest extends FactoryTestCase
 {

diff --git a/Tests/DependencyInjection/Factory/Loader/FlysystemLoaderFactoryTest.php b/Tests/DependencyInjection/Factory/Loader/FlysystemLoaderFactoryTest.php
@@ -11,7 +11,8 @@
 
 namespace Liip\ImagineBundle\Tests\DependencyInjection\Factory\Loader;
 
-use League\Flysystem\Filesystem;
+use League\Flysystem\FilesystemInterface;
+use League\Flysystem\FilesystemOperator;
 use Liip\ImagineBundle\DependencyInjection\Factory\Loader\FlysystemLoaderFactory;
 use Liip\ImagineBundle\DependencyInjection\Factory\Loader\LoaderFactoryInterface;
 use PHPUnit\Framework\TestCase;
@@ -21,15 +22,17 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 
 /**
- * @covers \Liip\ImagineBundle\DependencyInjection\Factory\Loader\FlysystemLoaderFactory
+ * @covers \Liip\ImagineBundle\DependencyInjection\Factory\Loader\FlysystemLoaderFactory<extended>
  */
 class FlysystemLoaderFactoryTest extends TestCase
 {
     protected function setUp(): void
     {
         parent::setUp();
 
-        if (!class_exists(Filesystem::class)) {
+        if (!interface_exists(FilesystemInterface::class)
+            && !interface_exists(FilesystemOperator::class)
+        ) {
             $this->markTestSkipped('Requires the league/flysystem package.');
         }
     }
@@ -69,7 +72,12 @@ public function testCreateLoaderDefinitionOnCreate(): void
 
         $loaderDefinition = $container->getDefinition('liip_imagine.binary.loader.the_loader_name');
         $this->assertInstanceOf(ChildDefinition::class, $loaderDefinition);
-        $this->assertSame('liip_imagine.binary.loader.prototype.flysystem', $loaderDefinition->getParent());
+        if (interface_exists(FilesystemOperator::class)) {
+            $loaderName = 'liip_imagine.binary.loader.prototype.flysystem2';
+        } else {
+            $loaderName = 'liip_imagine.binary.loader.prototype.flysystem';
+        }
+        $this->assertSame($loaderName, $loaderDefinition->getParent());
 
         $reference = $loaderDefinition->getArgument(1);
         $this->assertSame('flyfilesystemservice', (string) $reference);

diff --git a/Tests/DependencyInjection/Factory/Loader/StreamLoaderFactoryTest.php b/Tests/DependencyInjection/Factory/Loader/StreamLoaderFactoryTest.php
@@ -20,7 +20,7 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 
 /**
- * @covers \Liip\ImagineBundle\DependencyInjection\Factory\Loader\StreamLoaderFactory
+ * @covers \Liip\ImagineBundle\DependencyInjection\Factory\Loader\StreamLoaderFactory<extended>
  */
 class StreamLoaderFactoryTest extends TestCase
 {

diff --git a/Tests/DependencyInjection/Factory/Resolver/FlysystemResolverFactoryTest.php b/Tests/DependencyInjection/Factory/Resolver/FlysystemResolverFactoryTest.php
@@ -11,7 +11,8 @@
 
 namespace Liip\ImagineBundle\Tests\DependencyInjection\Factory\Resolver;
 
-use League\Flysystem\Filesystem;
+use League\Flysystem\FilesystemInterface;
+use League\Flysystem\FilesystemOperator;
 use Liip\ImagineBundle\DependencyInjection\Factory\Resolver\FlysystemResolverFactory;
 use Liip\ImagineBundle\DependencyInjection\Factory\Resolver\ResolverFactoryInterface;
 use PHPUnit\Framework\TestCase;
@@ -29,7 +30,9 @@ protected function setUp(): void
     {
         parent::setUp();
 
-        if (!class_exists(Filesystem::class)) {
+        if (!interface_exists(FilesystemInterface::class)
+            && !interface_exists(FilesystemOperator::class)
+        ) {
             $this->markTestSkipped('Requires the league/flysystem package.');
         }
     }
@@ -72,7 +75,12 @@ public function testCreateResolverDefinitionOnCreate(): void
 
         $resolverDefinition = $container->getDefinition('liip_imagine.cache.resolver.the_resolver_name');
         $this->assertInstanceOf(ChildDefinition::class, $resolverDefinition);
-        $this->assertSame('liip_imagine.cache.resolver.prototype.flysystem', $resolverDefinition->getParent());
+        if (interface_exists(FilesystemOperator::class)) {
+            $resolverName = 'liip_imagine.cache.resolver.prototype.flysystem2';
+        } else {
+            $resolverName = 'liip_imagine.cache.resolver.prototype.flysystem';
+        }
+        $this->assertSame($resolverName, $resolverDefinition->getParent());
 
         $this->assertSame('http://images.example.com', $resolverDefinition->getArgument(2));
         $this->assertSame('theCachePrefix', $resolverDefinition->getArgument(3));

diff --git a/Tests/Imagine/Cache/Resolver/FlysystemV2ResolverTest.php b/Tests/Imagine/Cache/Resolver/FlysystemV2ResolverTest.php
@@ -77,8 +77,7 @@ public function testCreateObjectInAdapter(): void
         $fs = $this->createFlySystemMock();
         $fs
             ->expects($this->once())
-            ->method('write')
-            ->willReturn(true);
+            ->method('write');
 
         $resolver = new FlysystemV2Resolver($fs, new RequestContext(), 'http://images.example.com');
 
@@ -136,8 +135,7 @@ public function testRemoveCacheForPathAndFilterOnRemove(): void
         $fs
             ->expects($this->once())
             ->method('delete')
-            ->with('media/cache/thumb/some-folder/path.jpg')
-            ->willReturn(true);
+            ->with('media/cache/thumb/some-folder/path.jpg');
 
         $resolver = new FlysystemV2Resolver($fs, new RequestContext(), 'http://images.example.com');
         $resolver->remove(['some-folder/path.jpg'], ['thumb']);
@@ -154,8 +152,7 @@ public function testRemoveCacheForSomePathsAndFilterOnRemove(): void
         $fs
             ->expects($this->at(1))
             ->method('delete')
-            ->with('media/cache/thumb/pathOne.jpg')
-            ->willReturn(true);
+            ->with('media/cache/thumb/pathOne.jpg');
         $fs
             ->expects($this->at(2))
             ->method('fileExists')
@@ -164,8 +161,7 @@ public function testRemoveCacheForSomePathsAndFilterOnRemove(): void
         $fs
             ->expects($this->at(3))
             ->method('delete')
-            ->with('media/cache/thumb/pathTwo.jpg')
-            ->willReturn(true);
+            ->with('media/cache/thumb/pathTwo.jpg');
 
         $resolver = new FlysystemV2Resolver($fs, new RequestContext(), 'http://images.example.com');
         $resolver->remove(
@@ -185,8 +181,7 @@ public function testRemoveCacheForSomePathsAndSomeFiltersOnRemove(): void
         $fs
             ->expects($this->at(1))
             ->method('delete')
-            ->with('media/cache/filterOne/pathOne.jpg')
-            ->willReturn(true);
+            ->with('media/cache/filterOne/pathOne.jpg');
         $fs
             ->expects($this->at(2))
             ->method('fileExists')
@@ -195,8 +190,7 @@ public function testRemoveCacheForSomePathsAndSomeFiltersOnRemove(): void
         $fs
             ->expects($this->at(3))
             ->method('delete')
-            ->with('media/cache/filterTwo/pathOne.jpg')
-            ->willReturn(true);
+            ->with('media/cache/filterTwo/pathOne.jpg');
         $fs
             ->expects($this->at(4))
             ->method('fileExists')
@@ -205,8 +199,7 @@ public function testRemoveCacheForSomePathsAndSomeFiltersOnRemove(): void
         $fs
             ->expects($this->at(5))
             ->method('delete')
-            ->with('media/cache/filterOne/pathTwo.jpg')
-            ->willReturn(true);
+            ->with('media/cache/filterOne/pathTwo.jpg');
         $fs
             ->expects($this->at(6))
             ->method('fileExists')
@@ -215,8 +208,7 @@ public function testRemoveCacheForSomePathsAndSomeFiltersOnRemove(): void
         $fs
             ->expects($this->at(7))
             ->method('delete')
-            ->with('media/cache/filterTwo/pathTwo.jpg')
-            ->willReturn(true);
+            ->with('media/cache/filterTwo/pathTwo.jpg');
 
         $resolver = new FlysystemV2Resolver($fs, new RequestContext(), 'http://images.example.com');
         $resolver->remove(
@@ -230,7 +222,7 @@ public function testDoNothingWhenObjectNotExistForPathAndFilterOnRemove(): void
         $fs = $this->createFlySystemMock();
         $fs
             ->expects($this->once())
-            ->method('has')
+            ->method('fileExists')
             ->with('media/cache/thumb/some-folder/path.jpg')
             ->willReturn(false);
         $fs
@@ -263,11 +255,11 @@ public function testRemoveCacheForSomeFiltersOnRemove(): void
         $fs = $this->createFlySystemMock();
         $fs
             ->expects($this->at(0))
-            ->method('deleteDir')
+            ->method('deleteDirectory')
             ->with('media/cache/theFilterOne');
         $fs
             ->expects($this->at(1))
-            ->method('deleteDir')
+            ->method('deleteDirectory')
             ->with('media/cache/theFilterTwo');
 
         $resolver = new FlysystemV2Resolver($fs, new RequestContext(), 'http://images.example.com');

diff --git a/composer.json b/composer.json
@@ -44,8 +44,7 @@
         "symfony/phpunit-bridge": "^5.2",
         "symfony/templating": "^3.4|^4.3|^5.0",
         "symfony/validator": "^3.4|^4.3|^5.0",
-        "symfony/yaml": "^3.4|^4.3|^5.0",
-        "friendsofphp/php-cs-fixer": "*"
+        "symfony/yaml": "^3.4|^4.3|^5.0"
     },
     "suggest": {
         "ext-exif": "required to read EXIF metadata from images",