feature #20097 [FrameworkBundle] removed the Doctrine Annotations lib dependency on FrameworkBundle (fabpot)

This PR was merged into the 3.2-dev branch.

Discussion
----------

[FrameworkBundle] removed the Doctrine Annotations lib dependency on FrameworkBundle

| Q             | A
| ------------- | ---
| Branch?       | master
| Bug fix?      | no
| New feature?  | yes
| BC breaks?    | yes (fixing this is easy by adding doctrine/annotations explicitly)
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | #15748 partially
| License       | MIT
| Doc PR        | n/a

Another PR to reduce the number of required dependencies on FrameworkBundle. This PR removes the Doctrine annotations library from the list.

Commits
-------

c2d8356 [FrameworkBundle] removed the Doctrine Annotations lib dependency on FrameworkBundle

Author: fabpot

CHANGELOG.md

@@ -4,6 +4,7 @@ CHANGELOG
 3.2.0
 -----
 
+ * Removed `doctrine/annotations` from the list of required dependencies in `composer.json`
  * Removed `symfony/security-core` and `symfony/security-csrf` from the list of required dependencies in `composer.json`
  * Removed `symfony/templating` from the list of required dependencies in `composer.json`
  * Removed `symfony/translation` from the list of required dependencies in `composer.json`

DependencyInjection/Configuration.php

@@ -593,7 +593,7 @@ private function addAnnotationsSection(ArrayNodeDefinition $rootNode)
             ->children()
                 ->arrayNode('annotations')
                     ->info('annotation configuration')
-                    ->addDefaultsIfNotSet()
+                    ->canBeDisabled()
                     ->children()
                         ->scalarNode('cache')->defaultValue('php_array')->end()
                         ->scalarNode('file_cache_dir')->defaultValue('%kernel.cache_dir%/annotations')->end()

DependencyInjection/FrameworkExtension.php

@@ -48,6 +48,7 @@ class FrameworkExtension extends Extension
     private $formConfigEnabled = false;
     private $translationConfigEnabled = false;
     private $sessionConfigEnabled = false;
+    private $annotationsConfigEnabled = false;
 
     /**
      * @var string|null
@@ -79,6 +80,8 @@ public function load(array $configs, ContainerBuilder $container)
         $configuration = $this->getConfiguration($configs, $container);
         $config = $this->processConfiguration($configuration, $configs);
 
+        $this->annotationsConfigEnabled = $this->isConfigEnabled($container, $config['annotations']);
+
         // A translator must always be registered (as support is included by
         // default in the Form component). If disabled, an identity translator
         // will be used and everything will still work as expected.
@@ -892,6 +895,10 @@ private function registerValidationConfiguration(array $config, ContainerBuilder
         $definition->replaceArgument(0, $config['strict_email']);
 
         if (array_key_exists('enable_annotations', $config) && $config['enable_annotations']) {
+            if (!$this->annotationsConfigEnabled) {
+                throw new \LogicException('"enable_annotations" on the validator cannot be set as Annotations support is disabled.');
+            }
+
             $validatorBuilder->addMethodCall('enableAnnotationMapping', array(new Reference('annotation_reader')));
         }
 
@@ -957,6 +964,14 @@ private function getValidatorMappingFiles(ContainerBuilder $container)
 
     private function registerAnnotationsConfiguration(array $config, ContainerBuilder $container, $loader)
     {
+        if (!$this->annotationsConfigEnabled) {
+            return;
+        }
+
+        if (!class_exists('Doctrine\Common\Annotations\Annotation')) {
+            throw new LogicException('Annotations cannot be enabled as the Doctrine Annotation library is not installed.');
+        }
+
         $loader->load('annotations.xml');
 
         if ('none' !== $config['cache']) {
@@ -1081,6 +1096,10 @@ private function registerSerializerConfiguration(array $config, ContainerBuilder
 
         $serializerLoaders = array();
         if (isset($config['enable_annotations']) && $config['enable_annotations']) {
+            if (!$this->annotationsConfigEnabled) {
+                throw new \LogicException('"enable_annotations" on the serializer cannot be set as Annotations support is disabled.');
+            }
+
             $annotationLoader = new Definition(
                 'Symfony\Component\Serializer\Mapping\Loader\AnnotationLoader',
                  array(new Reference('annotation_reader'))

Resources/config/schema/symfony-1.0.xsd

@@ -188,6 +188,7 @@
         <xsd:attribute name="cache" type="xsd:string" />
         <xsd:attribute name="debug" type="xsd:string" />
         <xsd:attribute name="file-cache-dir" type="xsd:string" />
+        <xsd:attribute name="enabled" type="xsd:boolean" />
     </xsd:complexType>
 
     <xsd:complexType name="property_access">

Resources/config/services.xml

@@ -25,7 +25,6 @@
         <service id="kernel.class_cache.cache_warmer" class="Symfony\Bundle\FrameworkBundle\CacheWarmer\ClassCacheCacheWarmer">
             <tag name="kernel.cache_warmer" />
             <argument type="collection">
-                <argument>Doctrine\Common\Annotations\AnnotationRegistry</argument>
                 <argument>Symfony\Component\HttpFoundation\ParameterBag</argument>
                 <argument>Symfony\Component\HttpFoundation\HeaderBag</argument>
                 <argument>Symfony\Component\HttpFoundation\FileBag</argument>

Tests/DependencyInjection/ConfigurationTest.php

@@ -216,6 +216,7 @@ protected static function getBundleDefaultConfig()
                 'cache' => 'php_array',
                 'file_cache_dir' => '%kernel.cache_dir%/annotations',
                 'debug' => true,
+                'enabled' => true,
             ),
             'serializer' => array(
                 'enabled' => false,

composer.json

@@ -29,8 +29,7 @@
         "symfony/finder": "~2.8|~3.0",
         "symfony/routing": "~3.0",
         "symfony/stopwatch": "~2.8|~3.0",
-        "doctrine/cache": "~1.0",
-        "doctrine/annotations": "~1.0"
+        "doctrine/cache": "~1.0"
     },
     "require-dev": {
         "symfony/asset": "~2.8|~3.0",
@@ -51,6 +50,7 @@
         "symfony/validator": "~3.2",
         "symfony/yaml": "~3.2",
         "symfony/property-info": "~2.8|~3.0",
+        "doctrine/annotations": "~1.0",
         "phpdocumentor/reflection-docblock": "^3.0",
         "twig/twig": "~1.23|~2.0"
     },