Make sure we validate options and dependencies in build time

Author: Nyholm

src/DependencyInjection/CacheAdapterExtension.php

@@ -44,6 +44,9 @@ public function load(array $configs, ContainerBuilder $container)
                 $first = $name;
             }
 
+            $factoryClass = $container->getDefinition($arguments['factory'])->getClass();
+            $factoryClass::validate($arguments['options'], $name);
+
             $def = $container->register('cache.provider.'.$name, DummyAdapter::class);
             $def->setFactory([new Reference($arguments['factory']), 'createAdapter'])
                 ->addArgument($arguments['options']);

src/Exception/ConfigurationException.php

@@ -0,0 +1,19 @@
+<?php
+
+/*
+ * This file is part of php-cache\adapter-bundle package.
+ *
+ * (c) 2015-2015 Aaron Scherer <[email protected]>, Tobias Nyholm <[email protected]>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Cache\AdapterBundle\Exception;
+
+/**
+ * @author Tobias Nyholm <[email protected]>
+ */
+class ConfigurationException extends \Exception
+{
+}

src/Factory/AbstractAdapterFactory.php

@@ -11,6 +11,7 @@
 
 namespace Cache\AdapterBundle\Factory;
 
+use Cache\AdapterBundle\Exception\ConfigurationException;
 use Psr\Cache\CacheItemPoolInterface;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
@@ -19,10 +20,7 @@
  */
 abstract class AbstractAdapterFactory implements AdapterFactoryInterface
 {
-    /**
-     * @param OptionsResolver $resolver
-     */
-    abstract protected function configureOptionResolver(OptionsResolver $resolver);
+    protected static $dependencies = [];
 
     /**
      * @param array $config
@@ -32,55 +30,70 @@ abstract protected function configureOptionResolver(OptionsResolver $resolver);
     abstract protected function getAdapter(array $config);
 
     /**
-     * Get the class name that is required for this adapter. This should more often than not be the cache pool.
-     *
-     * @return string
+     * {@inheritdoc}
      */
-    abstract protected function getRequiredClass();
+    public function createAdapter(array $options = [])
+    {
+        $this->verifyDependencies();
 
-    /**
-     * Get the name of the package where require class lives.
-     *
-     * @return string
-     */
-    abstract protected function getPackageName();
+        $resolver = new OptionsResolver();
+        static::configureOptionResolver($resolver);
+        $config = $resolver->resolve($options);
 
-    /**
-     * Get the name of the adapter.
-     *
-     * @return string
-     */
-    abstract protected function getName();
+        return $this->getAdapter($config);
+    }
 
     /**
      * {@inheritdoc}
      */
-    public function createAdapter(array $options = [])
+    public static function validate(array $options = [], $adapterName)
     {
-        $this->verifyDependencies();
+        static::verifyDependencies();
 
         $resolver = new OptionsResolver();
-        $this->configureOptionResolver($resolver);
-        $config = $resolver->resolve($options);
+        static::configureOptionResolver($resolver);
 
-        return $this->getAdapter($config);
+        try {
+            $resolver->resolve($options);
+        } catch (\Exception $e) {
+            $message = sprintf(
+                'Error while configure adapter %s. Verify your options under "cache_adapter.providers.%s.options". %s',
+                $adapterName,
+                $adapterName,
+                $e->getMessage()
+            );
+
+            throw new ConfigurationException($message, $e->getCode(), $e);
+        }
     }
 
     /**
      * Make sure that we have the required class and throws and exception if we dont.
      *
      * @throws \LogicException
      */
-    protected function verifyDependencies()
+    protected static function verifyDependencies()
     {
-        if (!class_exists($this->getRequiredClass())) {
-            throw new \LogicException(
-                sprintf(
-                    'You must install the "%s" package to use the "%s" provider.',
-                    $this->getPackageName(),
-                    $this->getName()
-                )
-            );
+        foreach (static::$dependencies as $dependency) {
+            if (!class_exists($dependency['requiredClass'])) {
+                throw new \LogicException(
+                    sprintf(
+                        'You must install the "%s" package to use the "%s" factory.',
+                        $dependency['packageName'],
+                        static::class
+                    )
+                );
+            }
         }
     }
+
+    /**
+     * By default we have not options ot configure. A factory should override this function and confgure
+     * the options resolver.
+     *
+     * @param OptionsResolver $resolver
+     */
+    protected static function configureOptionResolver(OptionsResolver $resolver)
+    {
+    }
 }

src/Factory/AdapterFactoryInterface.php

@@ -24,4 +24,20 @@ interface AdapterFactoryInterface
      * @return CacheItemPoolInterface
      */
     public function createAdapter(array $options = []);
+
+    /**
+     * Make sure the options are valid and the dependencies are met.
+     *
+     * @param array  $options     the options the user has provided
+     * @param string $adapterName the name the user has chosen for this adapter
+     *
+     * @throws \LogicException                                                        If the factory has missing dependencies
+     * @throws \Symfony\Component\OptionsResolver\Exception\UndefinedOptionsException If an option name is undefined
+     * @throws \Symfony\Component\OptionsResolver\Exception\InvalidOptionsException   If an option doesn't fulfill the specified validation rules
+     * @throws \Symfony\Component\OptionsResolver\Exception\MissingOptionsException   If a required option is missing
+     * @throws \Symfony\Component\OptionsResolver\Exception\OptionDefinitionException If there is a cyclic dependency between lazy options and/or normalizers
+     * @throws \Symfony\Component\OptionsResolver\Exception\NoSuchOptionException     If a lazy option reads an unavailable option
+     * @throws \Symfony\Component\OptionsResolver\Exception\AccessException           If called from a lazy option or normalizer
+     */
+    public static function validate(array $options = [], $adapterName);
 }

src/Factory/DoctrineRedisFactory.php

@@ -20,6 +20,10 @@
  */
 class DoctrineRedisFactory extends AbstractAdapterFactory
 {
+    protected static $dependencies = [
+        ['requiredClass' => 'Cache\Adapter\Doctrine\DoctrineCachePool', 'packageName' => 'cache/doctrine-adapter'],
+    ];
+
     /**
      * {@inheritdoc}
      */
@@ -41,7 +45,7 @@ public function getAdapter(array $config)
     /**
      * {@inheritdoc}
      */
-    protected function configureOptionResolver(OptionsResolver $resolver)
+    protected static function configureOptionResolver(OptionsResolver $resolver)
     {
         $resolver->setDefaults([
             'host' => '127.0.0.1',
@@ -51,28 +55,4 @@ protected function configureOptionResolver(OptionsResolver $resolver)
         $resolver->setAllowedTypes('host', ['string']);
         $resolver->setAllowedTypes('port', ['string', 'int']);
     }
-
-    /**
-     * {@inheritdoc}
-     */
-    protected function getRequiredClass()
-    {
-        return 'Cache\Adapter\Doctrine\DoctrineCachePool';
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    protected function getPackageName()
-    {
-        return 'cache/doctrine-adapter';
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    protected function getName()
-    {
-        return 'doctrine_redis';
-    }
 }

src/Factory/RedisFactory.php

@@ -20,6 +20,10 @@
  */
 class RedisFactory extends AbstractAdapterFactory
 {
+    protected static $dependencies = [
+        ['requiredClass' => 'Cache\Adapter\Redis\RedisCachePool', 'packageName' => 'cache/redis-adapter'],
+    ];
+
     /**
      * {@inheritdoc}
      */
@@ -33,7 +37,7 @@ public function getAdapter(array $config)
     /**
      * {@inheritdoc}
      */
-    protected function configureOptionResolver(OptionsResolver $resolver)
+    protected static function configureOptionResolver(OptionsResolver $resolver)
     {
         $resolver->setDefaults([
             'host'     => '127.0.0.1',
@@ -45,28 +49,4 @@ protected function configureOptionResolver(OptionsResolver $resolver)
         $resolver->setAllowedTypes('port', ['string', 'int']);
         $resolver->setAllowedTypes('protocol', ['string']);
     }
-
-    /**
-     * {@inheritdoc}
-     */
-    protected function getRequiredClass()
-    {
-        return 'Cache\Adapter\Redis\RedisCachePool';
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    protected function getPackageName()
-    {
-        return 'cache/redis-adapter';
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    protected function getName()
-    {
-        return 'redis';
-    }
 }