Merge pull request #5 from florianv/issue-4

Allow doctrine cache services as types

Author: florianv

DependencyInjection/Configuration.php

@@ -106,8 +106,8 @@ private function getCacheDriverNode($name)
             ->end()
             ->isRequired()
             ->children()
-                ->enumNode('type')
-                    ->values(array('apc', 'array', 'xcache', 'wincache', 'zenddata'))
+                ->scalarNode('type')
+                    ->info('A cache type or service id')
                     ->defaultValue('array')
                 ->end()
             ->end()

DependencyInjection/FlorianvSwapExtension.php

@@ -79,8 +79,12 @@ private function loadProviders(array $config, ContainerBuilder $container)
 
     private function loadCache(array $config, ContainerBuilder $container)
     {
-        $cacheProvider = new Definition('%florianv_swap.cache.doctrine.'.$config['doctrine']['type'].'.class%');
-        $cacheProvider->setPublic(false);
+        if (in_array($config['doctrine']['type'], ['apc', 'array', 'xcache', 'wincache', 'zenddata'], true)) {
+            $cacheProvider = new Definition('%florianv_swap.cache.doctrine.'.$config['doctrine']['type'].'.class%');
+            $cacheProvider->setPublic(false);
+        } else {
+            $cacheProvider = new Reference($config['doctrine']['type']);
+        }
 
         $cacheDefinition = new Definition('%florianv_swap.cache.doctrine.class%', array(
             $cacheProvider,

README.md

@@ -4,7 +4,7 @@
 [![Version][version-image]][version-url]
 [![Downloads][downloads-image]][downloads-url]
 
-> Integrates the [Swap](https://github.com/florianv/swap) library with Symfony.
+> Integrates the [Swap](https://github.com/florianv/swap) library with Symfony
 
 ## Documentation
 

Resources/doc/index.md

@@ -126,6 +126,32 @@ In order to add your custom providers implementing `Swap\ProviderInterface`, you
 </service>
 ```
 
+## Providers priority
+
+A priority attribute is available in tags and `config.yml` to sort providers.
+
+```yaml
+# app/config/config.yml
+florianv_swap:
+    providers:
+        yahoo_finance:
+            priority: 10
+        google_finance:
+            priority: 0
+```
+
+```xml
+<service id="acme_demo.provider.custom" class="Acme\DemoBundle\Provider\Custom">
+    <tag name="florianv_swap.provider" priority="5" />
+</service>
+```
+
+In this case, the order of providers will be:
+
+- yahoo_finance
+- acme_demo.provider.custom
+- google_finance
+
 ## Custom HTTP adapter
 
 You can define your own HTTP adapter. It has to inherit from `Ivory\HttpAdapter\HttpAdapterInterface`.
@@ -138,49 +164,38 @@ florianv_swap:
 
 ## Cache
 
-Some doctrine cache providers are implemented:
+Currently only [Doctrine Cache](https://github.com/doctrine/cache) is supported as cache implementation.
+
+### Lifetime
 
-- apc
-- array
-- xcache
-- wincache
-- zenddata
+You must specify a lifetime for your cache entries:
 
 ```yaml
 # app/config/config.yml
 florianv_swap:
     cache:
-        doctrine: apc
-    providers:
-        yahoo_finance: ~
-        google_finance: ~
+        ttl: 3600 # seconds
 ```
 
-## Priority
+### Provider
 
-A priority attribute is available in tags and config.yml to sort providers.
+You can use a doctrine service id:
 
 ```yaml
 # app/config/config.yml
 florianv_swap:
-    providers:
-        yahoo_finance:
-            priority: 10
-        google_finance:
-            priority: 0
-```
-
-```xml
-<service id="acme_demo.provider.custom" class="Acme\DemoBundle\Provider\Custom">
-    <tag name="florianv_swap.provider" priority="5" />
-</service>
+    cache:
+        doctrine: my_apc_service
 ```
 
-In this case, the order of providers will be:
+or one of the implemented providers (`apc`, `array`, `xcache`, `wincache`, `zenddata`)
 
-- yahoo_finance
-- acme_demo.provider.custom
-- google_finance
+```yaml
+# app/config/config.yml
+florianv_swap:
+    cache:
+        doctrine: apc
+```
 
 # Usage
 

Tests/DependencyInjection/FlorianvSwapExtensionTest.php

@@ -35,7 +35,7 @@ protected function setUp()
     }
 
     /**
-     * @expectedException Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
+     * @expectedException \Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
      */
     public function testNoProvider()
     {
@@ -187,7 +187,7 @@ public function testCacheMissTtl()
         $this->extension->load($config, $this->container);
     }
 
-    public function testCache()
+    public function testDoctrineCacheProvider()
     {
         $config = array(
             'florianv_swap' => array(
@@ -212,6 +212,31 @@ public function testCache()
         $this->assertEquals(array($apcDefinition, 3600), $cache->getArguments());
     }
 
+    public function testDoctrineCacheService()
+    {
+        $config = array(
+            'florianv_swap' => array(
+                'cache'     => array(
+                    'ttl' => 60,
+                    'doctrine' => 'my_service',
+                ),
+                'providers' => array('yahoo_finance' => null)
+            )
+        );
+        $this->extension->load($config, $this->container);
+
+        $swap = $this->container->getDefinition('florianv_swap.swap');
+        $arguments = $swap->getArguments();
+        $cache = $arguments[1];
+        $cacheArguments = $cache->getArguments();
+
+        $this->assertEquals($cache->getClass(), '%florianv_swap.cache.doctrine.class%');
+        $this->assertFalse($cache->isPublic());
+
+        $this->assertEquals(new Reference('my_service'), $cacheArguments[0]);
+        $this->assertEquals(60, $cacheArguments[1]);
+    }
+
     private function createProvidersConfig(array $providers)
     {
         return array('florianv_swap' => array('providers' => $providers));