Upgrade to league/flysystem v3

README.md

@@ -1,5 +1,6 @@
 # Storage Factories for Flysystem
 
+[![CI](https://github.com/php-collective/file-storage-factories/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/php-collective/file-storage-factories/actions/workflows/ci.yml)
 [![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)
 
 In the underlying Flysystem implementation some adapters are more or less complex to build. Sometimes you have to compose multiple objects and feed them to an adapter. The factories take this burden away from you and provide you the same interface for all adapters. Just their config array options differ.

composer.json

@@ -30,25 +30,21 @@
     "prefer-stable": true,
     "require": {
         "php": ">=8.1",
-        "league/flysystem": "^1.0",
+        "league/flysystem": "^3.22",
         "psr/container": "^1.0|^2.0"
     },
     "require-dev": {
         "phpunit/phpunit": "^10.3",
         "phpstan/phpstan": "^1.10",
         "php-collective/code-sniffer": "^0.2.1",
         "instituteweb/composer-scripts": "^1.1",
-        "league/flysystem-aws-s3-v3": "^1.0.29",
-        "league/flysystem-azure": "^1.0",
-        "league/flysystem-azure-blob-storage": "^1.0",
-        "league/flysystem-gridfs": "^1.0",
-        "league/flysystem-memory": "^1.0",
-        "league/flysystem-rackspace": "^1.0",
-        "league/flysystem-replicate-adapter": "^1.0",
-        "league/flysystem-sftp": "^1.0",
-        "league/flysystem-webdav": "^1.0",
-        "league/flysystem-ziparchive": "^1.0",
-        "spatie/flysystem-dropbox": "^1.2"
+        "league/flysystem-aws-s3-v3": "^3.22",
+        "league/flysystem-azure-blob-storage": "^3.22",
+        "league/flysystem-memory": "^3.0",
+        "league/flysystem-sftp": "^3.22",
+        "league/flysystem-webdav": "^3.21",
+        "league/flysystem-ziparchive": "^3.21",
+        "spatie/flysystem-dropbox": "^3.0.1"
     },
     "autoload": {
         "psr-4": {

phpstan.neon

@@ -5,4 +5,3 @@ parameters:
 	checkMissingIterableValueType: false
 	checkGenericClassInNonGenericObjectType: false
 	ignoreErrors:
-		- '#Call to an undefined static method .+BlobRestProxy::createBlobService\(\).#'

src/Adapter/NullFilesystemAdapter.php

@@ -0,0 +1,188 @@
+<?php
+
+namespace PhpCollective\Infrastructure\Storage\Adapter;
+
+use League\Flysystem\Config;
+use League\Flysystem\FileAttributes;
+use League\Flysystem\FilesystemAdapter;
+
+class NullFilesystemAdapter implements FilesystemAdapter
+{
+    /**
+     * @param string $path
+     *
+     * @return bool
+     */
+    public function fileExists(string $path): bool
+    {
+        return false;
+    }
+
+    /**
+     * @param string $path
+     * @param string $contents
+     * @param \League\Flysystem\Config $config
+     *
+     * @return void
+     */
+    public function write(string $path, string $contents, Config $config): void
+    {
+    }
+
+    /**
+     * @param string $path
+     * @param $contents
+     * @param \League\Flysystem\Config $config
+     *
+     * @return void
+     */
+    public function writeStream(string $path, $contents, Config $config): void
+    {
+    }
+
+    /**
+     * @param string $path
+     *
+     * @return string
+     */
+    public function read(string $path): string
+    {
+        return '';
+    }
+
+    /**
+     * @param string $path
+     *
+     * @return resource
+     */
+    public function readStream(string $path)
+    {
+        /** @var resource $stream */
+        $stream = fopen('php://temp', 'w+b');
+        fwrite($stream, '');
+        rewind($stream);
+
+        return $stream;
+    }
+
+    /**
+     * @param string $path
+     *
+     * @return void
+     */
+    public function delete(string $path): void
+    {
+    }
+
+    /**
+     * @param string $path
+     *
+     * @return void
+     */
+    public function deleteDirectory(string $path): void
+    {
+    }
+
+    /**
+     * @param string $path
+     * @param \League\Flysystem\Config $config
+     *
+     * @return void
+     */
+    public function createDirectory(string $path, Config $config): void
+    {
+    }
+
+    /**
+     * @param string $path
+     * @param string $visibility
+     *
+     * @return void
+     */
+    public function setVisibility(string $path, string $visibility): void
+    {
+    }
+
+    /**
+     * @param string $path
+     *
+     * @return \League\Flysystem\FileAttributes
+     */
+    public function visibility(string $path): FileAttributes
+    {
+        return new FileAttributes('');
+    }
+
+    /**
+     * @param string $path
+     *
+     * @return \League\Flysystem\FileAttributes
+     */
+    public function mimeType(string $path): FileAttributes
+    {
+        return new FileAttributes('');
+    }
+
+    /**
+     * @param string $path
+     *
+     * @return \League\Flysystem\FileAttributes
+     */
+    public function lastModified(string $path): FileAttributes
+    {
+        return new FileAttributes('');
+    }
+
+    /**
+     * @param string $path
+     *
+     * @return \League\Flysystem\FileAttributes
+     */
+    public function fileSize(string $path): FileAttributes
+    {
+        return new FileAttributes('');
+    }
+
+    /**
+     * @param string $path
+     * @param bool $deep
+     *
+     * @return iterable
+     */
+    public function listContents(string $path, bool $deep): iterable
+    {
+        return [];
+    }
+
+    /**
+     * @param string $source
+     * @param string $destination
+     * @param \League\Flysystem\Config $config
+     *
+     * @return void
+     */
+    public function move(string $source, string $destination, Config $config): void
+    {
+    }
+
+    /**
+     * @param string $source
+     * @param string $destination
+     * @param \League\Flysystem\Config $config
+     *
+     * @return void
+     */
+    public function copy(string $source, string $destination, Config $config): void
+    {
+    }
+
+    /**
+     * @param string $path
+     *
+     * @return bool
+     */
+    public function directoryExists(string $path): bool
+    {
+        return true;
+    }
+}

src/Factories/AbstractFactory.php

@@ -14,8 +14,8 @@
 
 namespace PhpCollective\Infrastructure\Storage\Factories;
 
-use League\Flysystem\Adapter\Local;
-use League\Flysystem\AdapterInterface;
+use League\Flysystem\FilesystemAdapter;
+use League\Flysystem\Local\LocalFilesystemAdapter;
 use PhpCollective\Infrastructure\Storage\Exception\PackageRequiredException;
 
 /**
@@ -36,7 +36,7 @@ abstract class AbstractFactory implements FactoryInterface
     /**
      * @var string
      */
-    protected string $className = Local::class;
+    protected string $className = LocalFilesystemAdapter::class;
 
     /**
      * @return string
@@ -72,5 +72,5 @@ public function availabilityCheck(): void
     /**
      * @inheritDoc
      */
-    abstract public function build(array $config): AdapterInterface;
+    abstract public function build(array $config): FilesystemAdapter;
 }

src/Factories/AwsS3v3Factory.php

@@ -15,8 +15,7 @@
 namespace PhpCollective\Infrastructure\Storage\Factories;
 
 use Aws\S3\S3Client;
-use League\Flysystem\AdapterInterface;
-use League\Flysystem\AwsS3v3\AwsS3Adapter;
+use League\Flysystem\AwsS3V3\AwsS3V3Adapter;
 
 /**
  * AwsS3Factory
@@ -27,10 +26,10 @@ class AwsS3v3Factory extends AbstractFactory
 
     protected string $package = 'league/flysystem-aws-s3-v3';
 
-    protected string $className = AwsS3Adapter::class;
+    protected string $className = AwsS3V3Adapter::class;
 
     protected array $defaults = [
-        'bucket' => null,
+        'bucket' => '',
         'prefix' => '',
         'client' => [
             'region' => 'eu',
@@ -41,18 +40,17 @@ class AwsS3v3Factory extends AbstractFactory
     /**
      * @inheritDoc
      */
-    public function build(array $config): AdapterInterface
+    public function build(array $config): AwsS3V3Adapter
     {
         $this->availabilityCheck();
         $config += $this->defaults;
 
-        return new AwsS3Adapter(
+        return new AwsS3V3Adapter(
             S3Client::factory(
                 $config['client'],
             ),
             $config['bucket'],
             $config['prefix'],
-            $config,
         );
     }
 }

src/Factories/AzureFactory.php

@@ -14,8 +14,8 @@
 
 namespace PhpCollective\Infrastructure\Storage\Factories;
 
-use League\Flysystem\AdapterInterface;
 use League\Flysystem\AzureBlobStorage\AzureBlobStorageAdapter;
+use League\Flysystem\FilesystemAdapter;
 use MicrosoftAzure\Storage\Blob\BlobRestProxy;
 use PhpCollective\Infrastructure\Storage\Factories\Exception\FactoryConfigException;
 
@@ -40,7 +40,7 @@ class AzureFactory extends AbstractFactory
     /**
      * @inheritDoc
      */
-    public function build($config): AdapterInterface
+    public function build($config): FilesystemAdapter
     {
         $this->availabilityCheck();
         $this->checkConfig($config);
@@ -57,7 +57,7 @@ public function build($config): AdapterInterface
     }
 
     /**
-     * @param array $config
+     * @param array<string, mixed> $config
      *
      * @throws \PhpCollective\Infrastructure\Storage\Factories\Exception\FactoryConfigException
      *

src/Factories/DropboxFactory.php

@@ -14,7 +14,7 @@
 
 namespace PhpCollective\Infrastructure\Storage\Factories;
 
-use League\Flysystem\AdapterInterface;
+use League\Flysystem\FilesystemAdapter;
 use Spatie\Dropbox\Client;
 use Spatie\FlysystemDropbox\DropboxAdapter;
 
@@ -36,7 +36,7 @@ class DropboxFactory extends AbstractFactory
     /**
      * @inheritDoc
      */
-    public function build(array $config): AdapterInterface
+    public function build(array $config): FilesystemAdapter
     {
         $config += $this->defaults;
         $client = new Client($config['authToken']);

src/Factories/FactoryInterface.php

@@ -14,7 +14,7 @@
 
 namespace PhpCollective\Infrastructure\Storage\Factories;
 
-use League\Flysystem\AdapterInterface;
+use League\Flysystem\FilesystemAdapter;
 
 /**
  * Factory Interface
@@ -34,9 +34,9 @@ public function alias(): string;
     /**
      * @param array<string, mixed> $config
      *
-     * @return \League\Flysystem\AdapterInterface
+     * @return \League\Flysystem\FilesystemAdapter
      */
-    public function build(array $config): AdapterInterface;
+    public function build(array $config): FilesystemAdapter;
 
     /**
      * @return void