Merge pull request #933 from FriendsOfSymfony/auto_config_serializer

Automatically fallback to the core serializer if available

Author: lsmith77

DependencyInjection/Compiler/SerializerConfigurationPass.php

@@ -0,0 +1,36 @@
+<?php
+
+/*
+ * This file is part of the FOSRestBundle package.
+ *
+ * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace FOS\RestBundle\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+
+/**
+ * Checks if a serializer is either set or can be auto-configured.
+ */
+class SerializerConfigurationPass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container)
+    {
+        if ($container->has('fos_rest.serializer')) {
+            return;
+        }
+
+        if ($container->has('jms_serializer.serializer')) {
+            $container->setAlias('fos_rest.serializer', 'jms_serializer.serializer');
+        } elseif ($container->has('serializer')) {
+            $container->setAlias('fos_rest.serializer', 'serializer');
+        } else {
+            throw new \InvalidArgumentException('Neither a service called "jms_serializer.serializer" nor "serializer" is available and no serializer is explicitly configured. You must either enable the JMSSerializerBundle, enable the FrameworkBundle serializer or configure a custom serializer.');
+        }
+    }
+}

DependencyInjection/FOSRestExtension.php

@@ -80,18 +80,10 @@ public function load(array $configs, ContainerBuilder $container)
         $validator = $config['service']['validator'];
         unset($config['service']['validator']);
 
-        if (null === $config['service']['serializer']) {
-            $bundles = $container->getParameter('kernel.bundles');
-
-            if (isset($bundles['JMSSerializerBundle'])) {
-                $config['service']['serializer'] = 'jms_serializer.serializer';
-            } else {
-                throw new \InvalidArgumentException('JMSSerializerBundle is not available and no other serializer is configured. You must either enable the JMSSerializerBundle or configure a custom serializer.');
-            }
-        }
-
         foreach ($config['service'] as $key => $service) {
-            $container->setAlias($this->getAlias().'.'.$key, $service);
+            if (null !== $service) {
+                $container->setAlias($this->getAlias().'.'.$key, $service);
+            }
         }
 
         if (!empty($config['serializer']['version'])) {

FOSRestBundle.php

@@ -13,6 +13,7 @@
 
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
+use FOS\RestBundle\DependencyInjection\Compiler\SerializerConfigurationPass;
 use FOS\RestBundle\DependencyInjection\Compiler\ConfigurationCheckPass;
 use FOS\RestBundle\DependencyInjection\Compiler\FormatListenerRulesPass;
 use FOS\RestBundle\DependencyInjection\Compiler\TwigExceptionPass;
@@ -28,6 +29,7 @@ class FOSRestBundle extends Bundle
      */
     public function build(ContainerBuilder $container)
     {
+        $container->addCompilerPass(new SerializerConfigurationPass());
         $container->addCompilerPass(new ConfigurationCheckPass());
         $container->addCompilerPass(new FormatListenerRulesPass());
         $container->addCompilerPass(new TwigExceptionPass());

Resources/doc/1-setting_up_the_bundle.rst

@@ -14,16 +14,6 @@ following command to download the latest stable version of this bundle:
 This command requires you to have Composer installed globally, as explained
 in the `installation chapter`_ of the Composer documentation.
 
-.. note::
-
-    This bundle recommends using `JMSSerializer`_ which is integrated into Symfony
-    via `JMSSerializerBundle`_.
-
-    If you want to use JMSSerializer, take a look into the instructions of the
-    bundle to install it and set it up. You can also use `Symfony Serializer`_.
-    But in this case, you need to manually set it up and configure FOSRestBundle
-    to use it via the ``service`` section in the app config
-
 B) Enable the Bundle
 --------------------
 
@@ -41,14 +31,26 @@ file of your project:
                 // ...
                 new FOS\RestBundle\FOSRestBundle(),
             );
-        
+
             // ...
         }
     }
 
+C) Enable a Serializer
+----------------------
+
+This bundle needs a serializer to work correctly. In most cases,
+you'll need to enable a serializer or install one. This bundle tries
+the following this (in this order) to determine the serializer to use:
+
+#. The one you configured using ``fos_rest.services.serializer`` (if you did).
+#. The JMS serializer, if the `JMSSerializerBundle`_ is available (and registered).
+#. The `Symfony Serializer`_ if it's enabled (or any service called ``serializer``).
+
 That was it!
 
 .. _`installation chapter`: https://getcomposer.org/doc/00-intro.md
 .. _`JMSSerializer`: https://github.com/schmittjoh/serializer
 .. _`JMSSerializerBundle`: https://github.com/schmittjoh/JMSSerializerBundle
 .. _`Symfony Serializer`: https://github.com/symfony/Serializer
+.. _`enable the core Serializer`: http://symfony.com/doc/current/cookbook/serializer.html

Tests/DependencyInjection/Compiler/SerializerConfigurationPassTest.php

@@ -0,0 +1,99 @@
+<?php
+
+/*
+ * This file is part of the FOSRestBundle package.
+ *
+ * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace FOS\RestBundle\Tests\DependencyInjection\Compiler;
+
+use FOS\RestBundle\DependencyInjection\Compiler\SerializerConfigurationPass;
+
+/**
+ * SerializerConfigurationPassTest test
+ */
+class SerializerConfigurationPassTest extends \PHPUnit_Framework_TestCase
+{
+    public function testShouldDoNothingIfSerializerIsFound()
+    {
+        $container = $this->getMockBuilder('Symfony\Component\DependencyInjection\ContainerBuilder')
+            ->setMethods(array('has'))
+            ->getMock();
+
+        $container->expects($this->once())
+            ->method('has')
+            ->with($this->equalTo('fos_rest.serializer'))
+            ->will($this->returnValue(true));
+
+        $container->expects($this->never())
+            ->method('setAlias');
+
+        $compiler = new SerializerConfigurationPass();
+        $compiler->process($container);
+    }
+
+    /**
+     * @expectedException \InvalidArgumentException
+     */
+    public function testShouldThrowInvalidArgumentExceptionWhenNoSerializerIsFound()
+    {
+        $container = $this->getMockBuilder('Symfony\Component\DependencyInjection\ContainerBuilder')
+            ->setMethods(array('has'))
+            ->getMock();
+
+        $container->method('has')
+            ->will($this->returnValueMap(array(
+                array('fos_rest.serializer', false),
+                array('jms_serializer.serializer', false),
+                array('serializer', false))));
+
+        $compiler = new SerializerConfigurationPass();
+        $compiler->process($container);
+    }
+
+    public function testShouldConfigureJMSSerializer()
+    {
+        $container = $this->getMockBuilder('Symfony\Component\DependencyInjection\ContainerBuilder')
+            ->setMethods(array('has', 'setAlias'))
+            ->getMock();
+
+        $container->method('has')
+            ->will($this->returnValueMap(array(
+                array('fos_rest.serializer', false),
+                array('jms_serializer.serializer', true),
+                array('serializer', true))));
+
+
+        $container->expects($this->once())
+            ->method('setAlias')
+            ->with($this->equalTo('fos_rest.serializer'), $this->equalTo('jms_serializer.serializer'));
+
+        $compiler = new SerializerConfigurationPass();
+        $compiler->process($container);
+    }
+
+    public function testShouldConfigureCoreSerializer()
+    {
+        $container = $this->getMockBuilder('Symfony\Component\DependencyInjection\ContainerBuilder')
+            ->setMethods(array('has', 'setAlias'))
+            ->getMock();
+
+        $container->method('has')
+            ->will($this->returnValueMap(array(
+                array('fos_rest.serializer', false),
+                array('jms_serializer.serializer', false),
+                array('serializer', true))));
+
+
+        $container->expects($this->once())
+            ->method('setAlias')
+            ->with($this->equalTo('fos_rest.serializer'), $this->equalTo('serializer'));
+
+        $compiler = new SerializerConfigurationPass();
+        $compiler->process($container);
+    }
+}

Tests/DependencyInjection/FOSRestExtensionTest.php

@@ -535,23 +535,6 @@ public function testExceptionThrownIfCallbackFilterIsUsed()
         $this->extension->load(array('fos_rest' => array('view' => array('jsonp_handler' => array('callback_filter' => 'foo')))), $this->container);
     }
 
-    public function testSerializerDefaultWhenJMSIsAvailable()
-    {
-        $this->extension->load(array(), $this->container);
-
-        $this->assertEquals('jms_serializer.serializer', $this->container->getAlias('fos_rest.serializer'));
-    }
-
-    /**
-     * @expectedException \InvalidArgumentException
-     */
-    public function testSerializerRequiredWhenJMSIsNotAvailable()
-    {
-        $this->container->setParameter('kernel.bundles', array());
-
-        $this->extension->load(array(), $this->container);
-    }
-
     /**
      * Asserts the service definition has the method call with the specified arguments.
      *

Tests/FOSRestBundleTest.php

@@ -25,7 +25,7 @@ public function testBuild()
         $container = $this->getMockBuilder('\Symfony\Component\DependencyInjection\ContainerBuilder')
             ->setMethods(array('addCompilerPass'))
             ->getMock();
-        $container->expects($this->exactly(3))
+        $container->expects($this->exactly(4))
             ->method('addCompilerPass')
             ->with($this->isInstanceOf('\Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface'));