Added abstract adapter factory

Author: Nyholm

src/Factory/AbstractAdapterFactory.php

@@ -0,0 +1,86 @@
+<?php
+
+/*
+ * This file is part of php-cache\adapter-bundle package.
+ *
+ * (c) 2015-2015 Aaron Scherer <aequasi@gmail.com>, Tobias Nyholm <tobias.nyholm@gmail.com>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Cache\AdapterBundle\Factory;
+
+use Psr\Cache\CacheItemPoolInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+/**
+ * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ */
+abstract class AbstractAdapterFactory implements AdapterFactoryInterface
+{
+    /**
+     * @param OptionsResolver $resolver
+     */
+    abstract protected function configureOptionResolver(OptionsResolver $resolver);
+
+    /**
+     * @param array $config
+     *
+     * @return CacheItemPoolInterface
+     */
+    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
+     */
+    abstract protected function getRequiredClass();
+
+    /**
+     * Get the name of the package where require class lives.
+     *
+     * @return string
+     */
+    abstract protected function getPackageName();
+
+    /**
+     * Get the name of the adapter.
+     *
+     * @return string
+     */
+    abstract protected function getName();
+
+    /**
+     * {@inheritdoc}
+     */
+    public function createAdapter(array $options = [])
+    {
+        $this->verifyDependencies();
+
+        $resolver = new OptionsResolver();
+        $this->configureOptionResolver($resolver);
+        $config = $resolver->resolve($options);
+
+        return $this->getAdapter($config);
+    }
+
+    /**
+     * Make sure that we have the required class and throws and exception if we dont.
+     *
+     * @throws \LogicException
+     */
+    protected 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()
+                )
+            );
+        }
+    }
+}

src/Factory/DoctrineRedisFactory.php

@@ -18,18 +18,17 @@
 /**
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  */
-class DoctrineRedisFactory implements AdapterFactoryInterface
+class DoctrineRedisFactory extends AbstractAdapterFactory
 {
     /**
      * {@inheritdoc}
      */
-    public function createAdapter(array $options = [])
+    public function getAdapter(array $config)
     {
         if (!class_exists('Cache\Adapter\Doctrine\DoctrineCachePool')) {
             throw new \LogicException('You must install the "cache/doctrine-adapter" package to use the "doctrine_redis" provider.');
         }
 
-        $config = $this->configureOptions($options);
         $redis  = new \Redis();
         $redis->connect($config['host'], $config['port']);
 
@@ -40,21 +39,40 @@ public function createAdapter(array $options = [])
     }
 
     /**
-     * @param array $options
-     *
-     * @return array
+     * {@inheritdoc}
      */
-    private function configureOptions(array $options)
+    protected function configureOptionResolver(OptionsResolver $resolver)
     {
-        $resolver = new OptionsResolver();
         $resolver->setDefaults([
             'host' => '127.0.0.1',
             'port' => '6379',
         ]);
 
         $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';
+    }
 
-        return $resolver->resolve($options);
+    /**
+     * {@inheritdoc}
+     */
+    protected function getName()
+    {
+        return 'doctrine_redis';
     }
 }

src/Factory/RedisFactory.php

@@ -18,31 +18,23 @@
 /**
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  */
-class RedisFactory implements AdapterFactoryInterface
+class RedisFactory extends AbstractAdapterFactory
 {
     /**
      * {@inheritdoc}
      */
-    public function createAdapter(array $options = [])
+    public function getAdapter(array $config)
     {
-        if (!class_exists('Cache\Adapter\Redis\RedisCachePool')) {
-            throw new \LogicException('You must install the "cache/redis-adapter" package to use the "redis" provider.');
-        }
-
-        $config = $this->configureOptions($options);
         $client = new Client(sprintf('%s://%s:%s', $config['protocol'], $config['host'], $config['port']));
 
         return new RedisCachePool($client);
     }
 
     /**
-     * @param array $options
-     *
-     * @return array
+     * {@inheritdoc}
      */
-    private function configureOptions(array $options)
+    protected function configureOptionResolver(OptionsResolver $resolver)
     {
-        $resolver = new OptionsResolver();
         $resolver->setDefaults([
             'host'     => '127.0.0.1',
             'port'     => '6379',
@@ -52,7 +44,29 @@ private function configureOptions(array $options)
         $resolver->setAllowedTypes('host', ['string']);
         $resolver->setAllowedTypes('port', ['string', 'int']);
         $resolver->setAllowedTypes('protocol', ['string']);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function getRequiredClass()
+    {
+        return 'Cache\Adapter\Redis\RedisCachePool';
+    }
 
-        return $resolver->resolve($options);
+    /**
+     * {@inheritdoc}
+     */
+    protected function getPackageName()
+    {
+        return 'cache/redis-adapter';
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function getName()
+    {
+        return 'redis';
     }
 }