feat: refacto required packages by a builder

Author: maxhelias

src/Adapter/AdapterDefinitionFactory.php

@@ -12,6 +12,7 @@
 namespace League\FlysystemBundle\Adapter;
 
 use League\FlysystemBundle\Adapter\Builder\AdapterDefinitionBuilderInterface;
+use League\FlysystemBundle\Exception\MissingPackageException;
 use Symfony\Component\DependencyInjection\Definition;
 
 /**
@@ -46,11 +47,31 @@ public function __construct()
     public function createDefinition(string $name, array $options, ?string $defaultVisibilityForDirectories = null): ?Definition
     {
         foreach ($this->builders as $builder) {
-            if ($builder->getName() === $name) {
-                return $builder->createDefinition($options, $defaultVisibilityForDirectories);
+            if ($builder->getName() !== $name) {
+                continue;
             }
+
+            $this->ensureRequiredPackagesBuilderAvailable($builder);
+
+            return $builder->createDefinition($options, $defaultVisibilityForDirectories);
         }
 
         return null;
     }
+
+    private function ensureRequiredPackagesBuilderAvailable(AdapterDefinitionBuilderInterface $builder): void
+    {
+        $missingPackages = [];
+        foreach ($builder->getRequiredPackages() as $requiredClass => $packageName) {
+            if (!class_exists($requiredClass)) {
+                $missingPackages[] = $packageName;
+            }
+        }
+
+        if (!$missingPackages) {
+            return;
+        }
+
+        throw new MissingPackageException(sprintf("Missing package%s, to use the \"%s\" adapter, run:\n\ncomposer require %s", \count($missingPackages) > 1 ? 's' : '', $this->getName(), implode(' ', $missingPackages)));
+    }
 }

src/Adapter/Builder/AbstractAdapterDefinitionBuilder.php

@@ -23,8 +23,6 @@ abstract class AbstractAdapterDefinitionBuilder implements AdapterDefinitionBuil
 {
     final public function createDefinition(array $options, ?string $defaultVisibilityForDirectories): Definition
     {
-        $this->ensureRequiredPackagesAvailable();
-
         $resolver = new OptionsResolver();
         $this->configureOptions($resolver);
 
@@ -35,7 +33,7 @@ final public function createDefinition(array $options, ?string $defaultVisibilit
         return $definition;
     }
 
-    abstract protected function getRequiredPackages(): array;
+    abstract public function getRequiredPackages(): array;
 
     abstract protected function configureOptions(OptionsResolver $resolver);
 

src/Adapter/Builder/AdapterDefinitionBuilderInterface.php

@@ -22,6 +22,8 @@ interface AdapterDefinitionBuilderInterface
 {
     public function getName(): string;
 
+    public function getRequiredPackages(): array;
+
     /**
      * Create the definition for this builder's adapter given an array of options.
      */

src/Adapter/Builder/AsyncAwsAdapterDefinitionBuilder.php

@@ -31,7 +31,7 @@ public function getName(): string
         return 'asyncaws';
     }
 
-    protected function getRequiredPackages(): array
+    public function getRequiredPackages(): array
     {
         return [
             AsyncAwsS3Adapter::class => 'league/flysystem-async-aws-s3',

src/Adapter/Builder/AwsAdapterDefinitionBuilder.php

@@ -30,7 +30,7 @@ public function getName(): string
         return 'aws';
     }
 
-    protected function getRequiredPackages(): array
+    public function getRequiredPackages(): array
     {
         return [
             AwsS3V3Adapter::class => 'league/flysystem-aws-s3-v3',

src/Adapter/Builder/AzureAdapterDefinitionBuilder.php

@@ -28,7 +28,7 @@ public function getName(): string
         return 'azure';
     }
 
-    protected function getRequiredPackages(): array
+    public function getRequiredPackages(): array
     {
         return [
             AzureBlobStorageAdapter::class => 'league/flysystem-azure-blob-storage',

src/Adapter/Builder/BunnyCDNAdapterDefinitionBuilder.php

@@ -26,7 +26,7 @@ public function getName(): string
         return 'bunnycdn';
     }
 
-    protected function getRequiredPackages(): array
+    public function getRequiredPackages(): array
     {
         return [
             BunnyCDNAdapter::class => 'platformcommunity/flysystem-bunnycdn',

src/Adapter/Builder/FtpAdapterDefinitionBuilder.php

@@ -32,7 +32,7 @@ public function getName(): string
         return 'ftp';
     }
 
-    protected function getRequiredPackages(): array
+    public function getRequiredPackages(): array
     {
         return [
             FtpAdapter::class => 'league/flysystem-ftp',

src/Adapter/Builder/GcloudAdapterDefinitionBuilder.php

@@ -28,7 +28,7 @@ public function getName(): string
         return 'gcloud';
     }
 
-    protected function getRequiredPackages(): array
+    public function getRequiredPackages(): array
     {
         return [
             GoogleCloudStorageAdapter::class => 'league/flysystem-google-cloud-storage',

src/Adapter/Builder/GridFSAdapterDefinitionBuilder.php

@@ -32,7 +32,7 @@ public function getName(): string
         return 'gridfs';
     }
 
-    protected function getRequiredPackages(): array
+    public function getRequiredPackages(): array
     {
         return [
             GridFSAdapter::class => 'league/flysystem-gridfs',