Added Cache for serializer and annotation

Author: Nyholm

README.md

@@ -139,6 +139,30 @@ cache:
     level: 'info' # Default logging level
 ```
 
+#### Annotation
+
+To use a PSR-6 cache for your annotations, use the following confguration. This will overwrite the value at 
+`framwork.annotations.cache`
+
+```yml
+cache:
+  annotation:
+    enabled: true
+    service_id: cache.provider.acme_apc_cache
+```
+
+#### Serialization
+
+To use a PSR-6 cache for the serialzer, use the following confguration. This will overwrite the value at 
+`framwork.serializer.cache`
+
+```yml
+cache:
+  serializer:
+    enabled: true
+    service_id: cache.provider.acme_apc_cache
+```
+
 
 ### Clearing the cache
 

src/DependencyInjection/CacheExtension.php

@@ -11,6 +11,7 @@
 
 namespace Cache\CacheBundle\DependencyInjection;
 
+use Cache\Bridge\DoctrineCacheBridge;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Loader;
@@ -36,12 +37,29 @@ public function load(array $configs, ContainerBuilder $container)
         $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
 
         // Make sure config values are in the parameters
-        foreach (['router', 'session', 'doctrine', 'logging'] as $section) {
+        foreach (['router', 'session', 'doctrine', 'logging', 'annotation', 'serializer'] as $section) {
             if ($config[$section]['enabled']) {
                 $container->setParameter('cache.'.$section, $config[$section]);
             }
         }
 
+        if ($config['annotation']['enabled']) {
+            $this->verifyDoctrineBridgeExists('annotation');
+            $container->register('cache.service.annotation', DoctrineCacheBridge::class)
+                ->setFactory('Cache\CacheBundle\Factory\AnnotationFactory::get')
+                ->addArgument(new Reference($config['annotation']['service_id']))
+                ->addArgument($config['annotation']);
+        }
+
+        if ($config['serializer']['enabled']) {
+            $this->verifyDoctrineBridgeExists('serializer');
+            $container->register('cache.service.serializer', DoctrineCacheBridge::class)
+                ->setFactory('Cache\CacheBundle\Factory\SerializerFactory::get')
+                ->addArgument(new Reference($config['serializer']['service_id']))
+                ->addArgument($config['serializer']);
+        }
+
+
         if ($config['router']['enabled']) {
             $loader->load('router.yml');
             $container->getDefinition('cache.router')
@@ -76,6 +94,22 @@ protected function findServiceIds(array $config, array &$serviceIds)
         }
     }
 
+    /**
+     * Make sure the DoctrineBridge is installed
+     *
+     * @param string $name
+     * @throws \Exception
+     */
+    private function verifyDoctrineBridgeExists($name)
+    {
+        if (!class_exists('Cache\Bridge\DoctrineCacheBridge')) {
+            throw new \Exception(sprintf(
+                'You need the DoctrineBridge to be able to use "%s". Please run "composer require cache/psr-6-doctrine-bridge" to install the missing dependency.',
+                $name
+            ));
+        }
+    }
+
     /**
      * @return string
      */

src/DependencyInjection/Compiler/DoctrineSupportCompilerPass.php

@@ -26,6 +26,11 @@
  */
 class DoctrineSupportCompilerPass implements CompilerPassInterface
 {
+    /**
+     * @type ContainerBuilder
+     */
+    private $container;
+
     /**
      * @throws \Exception
      *
@@ -34,6 +39,7 @@ class DoctrineSupportCompilerPass implements CompilerPassInterface
     public function process(ContainerBuilder $container)
     {
         $this->container = $container;
+
         // If disabled, continue
         if (!$this->container->hasParameter('cache.doctrine')) {
             return;

src/DependencyInjection/Compiler/ServiceInjectorPass.php

@@ -0,0 +1,64 @@
+<?php
+
+/*
+ * This file is part of php-cache\cache-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\CacheBundle\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Reference;
+
+/**
+ * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ */
+class ServiceInjectorPass implements CompilerPassInterface
+{
+    /**
+     * @throws \Exception
+     */
+    public function process(ContainerBuilder $container)
+    {
+        $this->injectAnnotationService($container);
+        $this->injectSerializerService($container);
+    }
+
+    /**
+     * @param ContainerBuilder $container
+     *
+     * @throws \Exception
+     */
+    private function injectAnnotationService(ContainerBuilder $container)
+    {
+        // If disabled, continue
+        if (!$container->hasParameter('cache.annotation')) {
+            return;
+        }
+
+        $container
+            ->getDefinition('annotations.cached_reader')
+            ->replaceArgument(1, new Reference('cache.service.annotation'));
+    }
+
+    /**
+     * @param ContainerBuilder $container
+     *
+     * @throws \Exception
+     */
+    private function injectSerializerService(ContainerBuilder $container)
+    {
+        // If disabled, continue
+        if (!$container->hasParameter('cache.serializer')) {
+            return;
+        }
+
+        $container->getDefinition('serializer.mapping.class_metadata_factory')
+            ->replaceArgument(1, new Reference('cache.service.serializer'));
+    }
+}

src/DependencyInjection/Configuration.php

@@ -36,6 +36,8 @@ public function getConfigTreeBuilder()
             ->append($this->addSessionSupportSection())
             ->append($this->addDoctrineSection())
             ->append($this->addRouterSection())
+            ->append($this->addAnnotationSection())
+            ->append($this->addSerializerSection())
             ->append($this->addLoggingSection())
             ->end();
 
@@ -68,6 +70,52 @@ private function addSessionSupportSection()
         return $node;
     }
 
+    /**
+     * Configure the "cache.serializer" section.
+     *
+     * @return ArrayNodeDefinition
+     */
+    private function addSerializerSection()
+    {
+        $tree = new TreeBuilder();
+        $node = $tree->root('serializer');
+
+        $node
+            ->addDefaultsIfNotSet()
+            ->children()
+                ->booleanNode('enabled')
+                    ->defaultFalse()
+                ->end()
+                ->scalarNode('service_id')->isRequired()->end()
+                ->booleanNode('use_tagging')->defaultTrue()->end()
+            ->end();
+
+        return $node;
+    }
+
+    /**
+     * Configure the "cache.annotation" section.
+     *
+     * @return ArrayNodeDefinition
+     */
+    private function addAnnotationSection()
+    {
+        $tree = new TreeBuilder();
+        $node = $tree->root('annotation');
+
+        $node
+            ->addDefaultsIfNotSet()
+            ->children()
+                ->booleanNode('enabled')
+                    ->defaultFalse()
+                ->end()
+                ->scalarNode('service_id')->isRequired()->end()
+                ->booleanNode('use_tagging')->defaultTrue()->end()
+            ->end();
+
+        return $node;
+    }
+
     /**
      * @return ArrayNodeDefinition
      */

src/Factory/AnnotationFactory.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Cache\CacheBundle\Factory;
+
+use Cache\Bridge\DoctrineCacheBridge;
+use Cache\CacheBundle\Cache\FixedTaggingCachePool;
+use Psr\Cache\CacheItemPoolInterface;
+
+/**
+ *
+ *
+ * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ */
+class AnnotationFactory
+{
+    /**
+     * @param CacheItemPoolInterface $pool
+     * @param array $config
+     *
+     * @return DoctrineCacheBridge
+     */
+    public static function get(CacheItemPoolInterface $pool, $config)
+    {
+        if ($config['use_tagging']) {
+            $pool = new FixedTaggingCachePool($pool, 'annotation');
+        }
+
+        return new DoctrineCacheBridge($pool);
+    }
+}

src/Factory/SerializerFactory.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Cache\CacheBundle\Factory;
+
+use Cache\Bridge\DoctrineCacheBridge;
+use Cache\CacheBundle\Cache\FixedTaggingCachePool;
+use Psr\Cache\CacheItemPoolInterface;
+
+/**
+ *
+ *
+ * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ */
+class SerializerFactory
+{
+    /**
+     * @param CacheItemPoolInterface $pool
+     * @param array $config
+     *
+     * @return DoctrineCacheBridge
+     */
+    public static function get(CacheItemPoolInterface $pool, $config)
+    {
+        if ($config['use_tagging']) {
+            $pool = new FixedTaggingCachePool($pool, 'serializer');
+        }
+
+        return new DoctrineCacheBridge($pool);
+    }
+}