Add cache adapter based on lustmored/flysystem-v2-simple-cache-adapter

Author: Lustmored

composer.json

@@ -31,6 +31,7 @@
         "async-aws/flysystem-s3": "^1.0",
         "league/flysystem-aws-s3-v3": "^2.0",
         "league/flysystem-memory": "^2.0",
+        "lustmored/flysystem-v2-simple-cache-adapter": "^0.1.0",
         "phpunit/phpunit": "^7.4",
         "symfony/dotenv": "^4.2|^5.0",
         "symfony/framework-bundle": "^4.2|^5.0",

src/Adapter/AdapterDefinitionFactory.php

@@ -31,6 +31,7 @@ public function __construct()
         $this->builders = [
             new Builder\AsyncAwsAdapterDefinitionBuilder(),
             new Builder\AwsAdapterDefinitionBuilder(),
+            new Builder\CacheAdapterDefinitionBuilder(),
             new Builder\FtpAdapterDefinitionBuilder(),
             new Builder\LocalAdapterDefinitionBuilder(),
             new Builder\MemoryAdapterDefinitionBuilder(),

src/Adapter/Builder/CacheAdapterDefinitionBuilder.php

@@ -0,0 +1,53 @@
+<?php
+
+/*
+ * This file is part of the flysystem-bundle project.
+ *
+ * (c) Titouan Galopin <galopintitouan@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace League\FlysystemBundle\Adapter\Builder;
+
+use Lustmored\Flysystem\Cache\CacheAdapter;
+use Symfony\Component\DependencyInjection\Definition;
+use Symfony\Component\DependencyInjection\Reference;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+/**
+ * @author Titouan Galopin <galopintitouan@gmail.com>
+ *
+ * @internal
+ */
+class CacheAdapterDefinitionBuilder extends AbstractAdapterDefinitionBuilder
+{
+    public function getName(): string
+    {
+        return 'cache';
+    }
+
+    protected function getRequiredPackages(): array
+    {
+        return [
+            CacheAdapter::class => 'lustmored/flysystem-v2-simple-cache-adapter',
+        ];
+    }
+
+    protected function configureOptions(OptionsResolver $resolver)
+    {
+        $resolver->setRequired('store');
+        $resolver->setAllowedTypes('store', 'string');
+
+        $resolver->setRequired('source');
+        $resolver->setAllowedTypes('source', 'string');
+    }
+
+    protected function configureDefinition(Definition $definition, array $options)
+    {
+        $definition->setClass(CacheAdapter::class);
+        $definition->setArgument(0, new Reference('flysystem.adapter.'.$options['source']));
+        $definition->setArgument(1, new Reference($options['store']));
+    }
+}

tests/Adapter/Builder/CacheAdapterDefinitionBuilderTest.php

@@ -0,0 +1,54 @@
+<?php
+/*
+ * This file is part of the flysystem-bundle project.
+ *
+ * (c) Titouan Galopin <galopintitouan@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Tests\League\FlysystemBundle\Adapter\Builder;
+
+use League\FlysystemBundle\Adapter\Builder\CacheAdapterDefinitionBuilder;
+use Lustmored\Flysystem\Cache\CacheAdapter;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\DependencyInjection\Reference;
+
+class CacheAdapterDefinitionBuilderTest extends TestCase
+{
+    public function createBuilder()
+    {
+        return new CacheAdapterDefinitionBuilder();
+    }
+
+    public function provideValidOptions()
+    {
+        yield 'minimal' => [[
+            'store' => 'my_store',
+            'source' => 'my_source',
+        ]];
+    }
+
+    /**
+     * @dataProvider provideValidOptions
+     */
+    public function testCreateDefinition($options)
+    {
+        $this->assertSame(CacheAdapter::class, $this->createBuilder()->createDefinition($options)->getClass());
+    }
+
+    public function testOptionsBehavior()
+    {
+        $definition = $this->createBuilder()->createDefinition([
+            'store' => 'my_store',
+            'source' => 'my_source',
+        ]);
+
+        $this->assertSame(CacheAdapter::class, $definition->getClass());
+        $this->assertInstanceOf(Reference::class, $definition->getArgument(0));
+        $this->assertSame('flysystem.adapter.my_source', (string) $definition->getArgument(0));
+        $this->assertInstanceOf(Reference::class, $definition->getArgument(1));
+        $this->assertSame('my_store', (string) $definition->getArgument(1));
+    }
+}

tests/Adapter/options.yaml

@@ -19,11 +19,11 @@ fs_aws:
 #        container: 'container_name'
 #        prefix: 'optional/path/prefix'
 
-#fs_cache:
-#    adapter: 'cache'
-#    options:
-#        store: 'memory'
-#        source: 'fs_local'
+fs_cache:
+    adapter: 'cache'
+    options:
+        store: 'memory'
+        source: 'fs_local'
 
 #fs_dropbox:
 #    adapter: 'dropbox'

tests/DependencyInjection/FlysystemExtensionTest.php

@@ -26,7 +26,7 @@ public function provideFilesystems()
         $fsNames = [
             'fs_aws',
 //            'fs_azure',
-//            'fs_cache',
+            'fs_cache',
 //            'fs_custom',
 //            'fs_dropbox',
             'fs_ftp',

tests/Kernel/FlysystemAppKernel.php

@@ -39,6 +39,7 @@ public function registerContainerConfiguration(LoaderInterface $loader)
             }
         });
 
+        $loader->load(__DIR__.'/config/cache.yaml', 'yaml');
         $loader->load(__DIR__.'/config/framework.yaml', 'yaml');
         $loader->load(__DIR__.'/config/flysystem.yaml', 'yaml');
         $loader->load(__DIR__.'/config/services.yaml', 'yaml');

tests/Kernel/config/cache.yaml

@@ -0,0 +1,3 @@
+framework:
+    cache:
+        app: cache.adapter.array

tests/Kernel/config/flysystem.yaml

@@ -14,11 +14,11 @@ flysystem:
 #                container: 'container_name'
 #                prefix: 'optional/path/prefix'
 
-#        fs_cache:
-#            adapter: 'cache'
-#            options:
-#                store: 'cache.app'
-#                source: 'fs_local'
+        fs_cache:
+            adapter: 'cache'
+            options:
+                store: 'cache.app'
+                source: 'fs_local'
 
 #        fs_custom:
 #            adapter: 'custom_adapter'

tests/Kernel/config/services.yaml

@@ -8,7 +8,7 @@ services:
     # Aliases used to test the services construction
     flysystem.test.fs_aws: { alias: 'fs_aws' }
 #    flysystem.test.fs_azure: { alias: 'fs_azure' }
-#    flysystem.test.fs_cache: { alias: 'fs_cache' }
+    flysystem.test.fs_cache: { alias: 'fs_cache' }
 #    flysystem.test.fs_custom: { alias: 'fs_custom' }
 #    flysystem.test.fs_dropbox: { alias: 'fs_dropbox' }
     flysystem.test.fs_ftp: { alias: 'fs_ftp' }