Merge pull request #1086 from mickadoo/feature/allow-symfony-serializer

Feature/allow symfony serializer

Author: XWB

Resources/doc/serializer.md

@@ -8,28 +8,17 @@ it means types do not have to be mapped.
 A) Install and declare the serializer
 -------------------------------------
 
-Follow the installation instructions for [JMSSerializerBundle](http://jmsyst.com/bundles/JMSSerializerBundle).
+Both the [Symfony Serializer](http://symfony.com/doc/current/components/serializer.html) and 
+[JMSSerializerBundle](http://jmsyst.com/bundles/JMSSerializerBundle) are supported.
 
-Enable the serializer configuration for the bundle:
+Enable the serializer in the configuration:
 
 ```yaml
 #app/config/config.yml
 fos_elastica:
     serializer: ~
 ```
 
-The default configuration that comes with FOSElasticaBundle supports both the JMS Serializer
-and the Symfony Serializer. If JMSSerializerBundle is installed, additional support for
-serialization groups, versions and null value serialization are added to the bundle. Example:
-
-```yaml
-fos_elastica:
-    serializer:
-        groups: [elastica, Default]
-        version: '1.1'
-        serialize_null: true
-```
-
 B) Set up each defined type to support serialization
 ----------------------------------------------------
 
@@ -43,5 +32,37 @@ fos_elastica:
             types:
                 user:
                     serializer:
-                        groups: [elastica, Default]
+                        groups: [elastica]
+```
+
+And inside the User class:
+
+```php
+use Symfony\Component\Serializer\Annotation\Groups;
+
+class User {
+
+    /**
+     * @Groups({"elastica"})
+     *
+     * @var string
+     */
+    private $username;
+    
+}
 ```
+
+In addition the JMS Serializer allows you to specify options for version and whether to serialize null
+
+```yaml
+fos_elastica:
+
+    indexes:
+        app:
+            types:
+                user:
+                    serializer:
+                        groups: [elastica]
+                        version: '1.1'
+                        serialize_null: true
+```

Serializer/Callback.php

@@ -3,7 +3,8 @@
 namespace FOS\ElasticaBundle\Serializer;
 
 use JMS\Serializer\SerializationContext;
-use JMS\Serializer\SerializerInterface;
+use Symfony\Component\Serializer\SerializerInterface;
+use JMS\Serializer\SerializerInterface as JMSSerializer;
 
 class Callback
 {
@@ -30,8 +31,8 @@ public function setGroups(array $groups)
     {
         $this->groups = $groups;
 
-        if (!empty($this->groups) && !$this->serializer instanceof SerializerInterface) {
-            throw new \RuntimeException('Setting serialization groups requires using "JMS\Serializer\Serializer".');
+        if (!empty($this->groups) && !$this->serializer instanceof SerializerInterface && !$this->serializer instanceof JMSSerializer) {
+            throw new \RuntimeException('Setting serialization groups requires using "JMS\Serializer\Serializer" or "Symfony\Component\Serializer\Serializer"');
         }
     }
 
@@ -42,7 +43,7 @@ public function setVersion($version)
     {
         $this->version = $version;
 
-        if ($this->version && !$this->serializer instanceof SerializerInterface) {
+        if ($this->version && !$this->serializer instanceof JMSSerializer) {
             throw new \RuntimeException('Setting serialization version requires using "JMS\Serializer\Serializer".');
         }
     }
@@ -54,7 +55,7 @@ public function setSerializeNull($serializeNull)
     {
         $this->serializeNull = $serializeNull;
 
-        if (true === $this->serializeNull && !$this->serializer instanceof SerializerInterface) {
+        if (true === $this->serializeNull && !$this->serializer instanceof JMSSerializer) {
             throw new \RuntimeException('Setting null value serialization option requires using "JMS\Serializer\Serializer".');
         }
     }
@@ -66,10 +67,14 @@ public function setSerializeNull($serializeNull)
      */
     public function serialize($object)
     {
-        $context = $this->serializer instanceof SerializerInterface ? SerializationContext::create()->enableMaxDepthChecks() : array();
+        $context = $this->serializer instanceof JMSSerializer ? SerializationContext::create()->enableMaxDepthChecks() : array();
 
         if (!empty($this->groups)) {
-            $context->setGroups($this->groups);
+            if ($context instanceof SerializationContext) {
+                $context->setGroups($this->groups);
+            } else {
+                $context['groups'] = $this->groups;
+            }
         }
 
         if ($this->version) {

Tests/Serializer/CallbackTest.php

@@ -0,0 +1,37 @@
+<?php
+
+use \FOS\ElasticaBundle\Serializer\Callback;
+
+class CallbackTest extends PHPUnit_Framework_TestCase
+{
+    public function testSerializerMustHaveSerializeMethod()
+    {
+        $callback = new Callback();
+        $this->setExpectedException('RuntimeException', 'The serializer must have a "serialize" method.');
+        $callback->setSerializer(new \stdClass());
+    }
+
+    public function testSetGroupsWorksWithValidSerializer()
+    {
+        $callback = new Callback();
+        $serializer = $this->getMock('Symfony\Component\Serializer\Serializer', array(), array(), '', false);
+        $callback->setSerializer($serializer);
+
+        $callback->setGroups(array('foo'));
+    }
+
+    public function testSetGroupsFailsWithInvalidSerializer()
+    {
+        $callback = new Callback();
+        $serializer = $this->getMockBuilder('FakeSerializer')->setMethods(array('serialize'))->getMock();
+        $callback->setSerializer($serializer);
+
+        $this->setExpectedException(
+            'RuntimeException',
+            'Setting serialization groups requires using "JMS\Serializer\Serializer" or '
+                . '"Symfony\Component\Serializer\Serializer"'
+        );
+
+        $callback->setGroups(array('foo'));
+    }
+}

composer.json

@@ -33,7 +33,8 @@
         "knplabs/knp-paginator-bundle": "~2.4",
         "symfony/browser-kit" : "~2.3|~3.0",
         "symfony/expression-language" : "~2.4|~3.0",
-        "symfony/twig-bundle": "~2.3|~3.0"
+        "symfony/twig-bundle": "~2.3|~3.0",
+        "symfony/serializer": "~2.7|~3.0"
     },
     "autoload": {
         "psr-4": { "FOS\\ElasticaBundle\\": "" }