Add missing package detection

Author: tgalopin

src/Adapter/Builder/AbstractAdapterDefinitionBuilder.php

@@ -12,6 +12,7 @@
 namespace League\FlysystemBundle\Adapter\Builder;
 
 use League\FlysystemBundle\Adapter\AdapterDefinitionFactory;
+use League\FlysystemBundle\Exception\MissingPackageException;
 use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
@@ -31,6 +32,8 @@ public function __construct(AdapterDefinitionFactory $definitionFactory)
 
     final public function createDefinition(array $options): Definition
     {
+        $this->ensureRequiredPackagesAvailable();
+
         $resolver = new OptionsResolver();
         $this->configureOptions($resolver);
 
@@ -41,7 +44,30 @@ final public function createDefinition(array $options): Definition
         return $definition;
     }
 
+    abstract protected function getRequiredPackages(): array;
+
     abstract protected function configureOptions(OptionsResolver $resolver);
 
     abstract protected function configureDefinition(Definition $definition, array $options);
+
+    private function ensureRequiredPackagesAvailable()
+    {
+        $missingPackages = [];
+        foreach ($this->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/AwsAdapterDefinitionBuilder.php

@@ -28,6 +28,13 @@ public function getName(): string
         return 'aws';
     }
 
+    protected function getRequiredPackages(): array
+    {
+        return [
+            AwsS3Adapter::class => 'league/flysystem-aws-s3-v3',
+        ];
+    }
+
     protected function configureOptions(OptionsResolver $resolver)
     {
         $resolver->setRequired('client');

src/Adapter/Builder/AzureAdapterDefinitionBuilder.php

@@ -28,6 +28,13 @@ public function getName(): string
         return 'azure';
     }
 
+    protected function getRequiredPackages(): array
+    {
+        return [
+            AzureBlobStorageAdapter::class => 'league/flysystem-azure-blob-storage',
+        ];
+    }
+
     protected function configureOptions(OptionsResolver $resolver)
     {
         $resolver->setRequired('client');

src/Adapter/Builder/CacheAdapterDefinitionBuilder.php

@@ -29,6 +29,13 @@ public function getName(): string
         return 'cache';
     }
 
+    protected function getRequiredPackages(): array
+    {
+        return [
+            CachedAdapter::class => 'league/flysystem-cached-adapter',
+        ];
+    }
+
     protected function configureOptions(OptionsResolver $resolver)
     {
         $resolver->setRequired('store');

src/Adapter/Builder/DropboxAdapterDefinitionBuilder.php

@@ -28,6 +28,13 @@ public function getName(): string
         return 'dropbox';
     }
 
+    protected function getRequiredPackages(): array
+    {
+        return [
+            DropboxAdapter::class => 'spatie/flysystem-dropbox',
+        ];
+    }
+
     protected function configureOptions(OptionsResolver $resolver)
     {
         $resolver->setRequired('client');

src/Adapter/Builder/FtpAdapterDefinitionBuilder.php

@@ -27,6 +27,11 @@ public function getName(): string
         return 'ftp';
     }
 
+    protected function getRequiredPackages(): array
+    {
+        return [];
+    }
+
     protected function configureOptions(OptionsResolver $resolver)
     {
         $resolver->setRequired('host');

src/Adapter/Builder/GcloudAdapterDefinitionBuilder.php

@@ -28,6 +28,13 @@ public function getName(): string
         return 'gcloud';
     }
 
+    protected function getRequiredPackages(): array
+    {
+        return [
+            GoogleStorageAdapter::class => 'superbalist/flysystem-google-storage',
+        ];
+    }
+
     protected function configureOptions(OptionsResolver $resolver)
     {
         $resolver->setRequired('client');

src/Adapter/Builder/LocalAdapterDefinitionBuilder.php

@@ -27,6 +27,11 @@ public function getName(): string
         return 'local';
     }
 
+    protected function getRequiredPackages(): array
+    {
+        return [];
+    }
+
     protected function configureOptions(OptionsResolver $resolver)
     {
         $resolver->setRequired('directory');

src/Adapter/Builder/MemoryAdapterDefinitionBuilder.php

@@ -27,6 +27,13 @@ public function getName(): string
         return 'memory';
     }
 
+    protected function getRequiredPackages(): array
+    {
+        return [
+            MemoryAdapter::class => 'league/flysystem-memory',
+        ];
+    }
+
     protected function configureOptions(OptionsResolver $resolver)
     {
     }

src/Adapter/Builder/NullAdapterDefinitionBuilder.php

@@ -27,6 +27,11 @@ public function getName(): string
         return 'null';
     }
 
+    protected function getRequiredPackages(): array
+    {
+        return [];
+    }
+
     protected function configureOptions(OptionsResolver $resolver)
     {
     }