Merge pull request #35 from Nyholm/features

Nyholm · Nyholm · commit ae71ff306c34 · 2016-01-07T22:12:25.000+01:00
Add cache for annotation, serializer and validation
diff --git a/README.md b/README.md
@@ -139,6 +139,51 @@ cache:
     level: 'info' # Default logging level
 ```
 
+#### Annotation
+
+To use a PSR-6 cache for your annotations, use the following confguration.
+
+```yml
+cache:
+  annotation:
+    enabled: true
+    service_id: cache.provider.acme_apc_cache
+    
+framwork:
+  annotations:
+    cache: cache.service.annotation
+```
+
+#### Serialization
+
+To use a PSR-6 cache for the serialzer, use the following confguration. 
+
+```yml
+cache:
+  serializer:
+    enabled: true
+    service_id: cache.provider.acme_apc_cache
+    
+framwork:
+  serializer:
+    cache: cache.service.serializer
+```
+
+#### Validation
+
+To use a PSR-6 cache for the validation, use the following confguration. 
+
+```yml
+cache:
+  validation:
+    enabled: true
+    service_id: cache.provider.acme_apc_cache
+
+framwork:
+  validation:
+    cache: cache.service.validation
+```
+
 
 ### Clearing the cache
 
diff --git a/src/Bridge/SymfonyValidatorBridge.php b/src/Bridge/SymfonyValidatorBridge.php
@@ -0,0 +1,79 @@
+<?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\Bridge;
+
+use Psr\Cache\CacheItemPoolInterface;
+use Symfony\Component\Validator\Mapping\Cache\CacheInterface;
+use Symfony\Component\Validator\Mapping\ClassMetadata;
+
+/**
+ * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ */
+class SymfonyValidatorBridge implements CacheInterface
+{
+    /**
+     * @type CacheItemPoolInterface
+     */
+    private $pool;
+
+    /**
+     * DoctrineCacheBridge constructor.
+     *
+     * @param CacheItemPoolInterface $cachePool
+     */
+    public function __construct(CacheItemPoolInterface $cachePool)
+    {
+        $this->pool = $cachePool;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function has($class)
+    {
+        return $this->pool->hasItem($this->normalizeKey($class));
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function read($class)
+    {
+        $item = $this->pool->getItem($this->normalizeKey($class));
+
+        if (!$item->isHit()) {
+            return false;
+        }
+
+        return $item->get();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function write(ClassMetadata $metadata)
+    {
+        $item = $this->pool->getItem($this->normalizeKey($metadata->getClassName()));
+        $item->set($metadata);
+        $this->pool->save($item);
+    }
+
+    /**
+     * @param string $key
+     *
+     * @return string
+     */
+    private function normalizeKey($key)
+    {
+        return preg_replace('|[\\\/]|', '.', $key);
+    }
+}
diff --git a/src/Command/CacheFlushCommand.php b/src/Command/CacheFlushCommand.php
@@ -26,7 +26,7 @@
  */
 class CacheFlushCommand extends ContainerAwareCommand
 {
-    const VALID_TYPES = ['all', 'session', 'router', 'doctrine', 'symfony', 'provider'];
+    const VALID_TYPES = ['all', 'annotation', 'session', 'serializer', 'router', 'doctrine', 'symfony', 'validation', 'provider'];
 
     /**
      * {@inheritdoc}
@@ -41,11 +41,14 @@ protected function configure()
 
 Types and their description
 all                       Clear all types of caches
+annotation                Clear annotation cache
 doctrine                  Clear doctrine cache for query, result and metadata
 privider cache.acme       Clear all the cache for the provider with service id "cache.acme"
 router                    Clear router cache
+serializer                Clear serializer cache
 session                   Clear session cache. All your logged in users will be logged out.
 symfony                   Clear Symfony cache. This is the same as cache:clear
+validation                Clear validation cache
 
 EOD
     );
@@ -60,7 +63,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             return 0;
         }
 
-        $builtInTypes = ['session', 'router', 'doctrine'];
+        $builtInTypes = ['annotation', 'doctrine', 'serializer', 'session', 'router', 'validation'];
         if (in_array($type, $builtInTypes)) {
             return $this->clearCacheForBuiltInType($type) ? 0 : 1;
         }
diff --git a/src/DependencyInjection/CacheExtension.php b/src/DependencyInjection/CacheExtension.php
@@ -11,6 +11,11 @@
 
 namespace Cache\CacheBundle\DependencyInjection;
 
+use Cache\Bridge\DoctrineCacheBridge;
+use Cache\CacheBundle\Bridge\SymfonyValidatorBridge;
+use Cache\CacheBundle\Factory\AnnotationFactory;
+use Cache\CacheBundle\Factory\SerializerFactory;
+use Cache\CacheBundle\Factory\ValidationFactory;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Loader;
@@ -36,12 +41,35 @@ 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', 'validation'] 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([AnnotationFactory::class, '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([SerializerFactory::class, 'get'])
+                ->addArgument(new Reference($config['serializer']['service_id']))
+                ->addArgument($config['serializer']);
+        }
+
+        if ($config['validation']['enabled']) {
+            $container->register('cache.service.validation', SymfonyValidatorBridge::class)
+                ->setFactory([ValidationFactory::class, 'get'])
+                ->addArgument(new Reference($config['validation']['service_id']))
+                ->addArgument($config['validation']);
+        }
+
         if ($config['router']['enabled']) {
             $loader->load('router.yml');
             $container->getDefinition('cache.router')
@@ -76,6 +104,23 @@ 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
      */
diff --git a/src/DependencyInjection/Compiler/DoctrineSupportCompilerPass.php b/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;
diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -36,6 +36,9 @@ public function getConfigTreeBuilder()
             ->append($this->addSessionSupportSection())
             ->append($this->addDoctrineSection())
             ->append($this->addRouterSection())
+            ->append($this->addAnnotationSection())
+            ->append($this->addSerializerSection())
+            ->append($this->addValidationSection())
             ->append($this->addLoggingSection())
             ->end();
 
@@ -53,11 +56,9 @@ private function addSessionSupportSection()
         $node = $tree->root('session');
 
         $node
+            ->canBeEnabled()
             ->addDefaultsIfNotSet()
             ->children()
-                ->booleanNode('enabled')
-                    ->defaultFalse()
-                ->end()
                 ->scalarNode('service_id')->isRequired()->end()
                 ->scalarNode('prefix')
                     ->defaultValue('session_')
@@ -68,6 +69,69 @@ private function addSessionSupportSection()
         return $node;
     }
 
+    /**
+     * Configure the "cache.serializer" section.
+     *
+     * @return ArrayNodeDefinition
+     */
+    private function addSerializerSection()
+    {
+        $tree = new TreeBuilder();
+        $node = $tree->root('serializer');
+
+        $node
+            ->canBeEnabled()
+            ->addDefaultsIfNotSet()
+            ->children()
+            ->scalarNode('service_id')->isRequired()->end()
+                ->booleanNode('use_tagging')->defaultTrue()->end()
+            ->end();
+
+        return $node;
+    }
+
+    /**
+     * Configure the "cache.serializer" section.
+     *
+     * @return ArrayNodeDefinition
+     */
+    private function addValidationSection()
+    {
+        $tree = new TreeBuilder();
+        $node = $tree->root('validation');
+
+        $node
+            ->canBeEnabled()
+            ->addDefaultsIfNotSet()
+            ->children()
+                ->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
+            ->canBeEnabled()
+            ->addDefaultsIfNotSet()
+            ->children()
+                ->scalarNode('service_id')->isRequired()->end()
+                ->booleanNode('use_tagging')->defaultTrue()->end()
+            ->end();
+
+        return $node;
+    }
+
     /**
      * @return ArrayNodeDefinition
      */
@@ -77,11 +141,9 @@ private function addLoggingSection()
         $node = $tree->root('logging');
 
         $node
+            ->canBeEnabled()
             ->addDefaultsIfNotSet()
             ->children()
-                ->booleanNode('enabled')
-                    ->defaultFalse()
-                ->end()
                 ->scalarNode('logger')->defaultValue('logger')->end()
                 ->scalarNode('level')->defaultValue('info')->end()
             ->end();
@@ -100,12 +162,9 @@ private function addDoctrineSection()
         $node = $tree->root('doctrine');
 
         $node
+            ->canBeEnabled()
             ->addDefaultsIfNotSet()
             ->children()
-                ->booleanNode('enabled')
-                    ->defaultFalse()
-                    ->isRequired()
-                ->end()
                 ->booleanNode('use_tagging')
                     ->defaultTrue()
                 ->end()
@@ -159,11 +218,10 @@ private function addRouterSection()
         $tree = new TreeBuilder();
         $node = $tree->root('router');
 
-        $node->addDefaultsIfNotSet()
+        $node
+            ->canBeEnabled()
+            ->addDefaultsIfNotSet()
             ->children()
-                ->booleanNode('enabled')
-                    ->defaultFalse()
-                ->end()
                 ->integerNode('ttl')
                     ->defaultValue(604800)
                 ->end()
diff --git a/src/Factory/AnnotationFactory.php b/src/Factory/AnnotationFactory.php
diff --git a/src/Factory/SerializerFactory.php b/src/Factory/SerializerFactory.php
diff --git a/src/Factory/ValidationFactory.php b/src/Factory/ValidationFactory.php

Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,11 @@`
`26`	`26`	`*/`
`27`	`27`	`class DoctrineSupportCompilerPass implements CompilerPassInterface`
`28`	`28`	`{`
	`29`	`+ /**`
	`30`	`+ * @type ContainerBuilder`
	`31`	`+ */`
	`32`	`+ private $container;`
	`33`	`+`
`29`	`34`	`/**`
`30`	`35`	`* @throws \Exception`
`31`	`36`	`*`
`@@ -34,6 +39,7 @@ class DoctrineSupportCompilerPass implements CompilerPassInterface`
`34`	`39`	`public function process(ContainerBuilder $container)`
`35`	`40`	`{`
`36`	`41`	`$this->container = $container;`
	`42`	`+`
`37`	`43`	`// If disabled, continue`
`38`	`44`	`if (!$this->container->hasParameter('cache.doctrine')) {`
`39`	`45`	`return;`