Add event support

DependencyInjection/Compiler/RegisterListenerPass.php

@@ -0,0 +1,29 @@
+<?php
+
+/*
+ * This file is part of the Ivory Serializer bundle package.
+ *
+ * (c) Eric GELOEN <geloen.eric@gmail.com>
+ *
+ * For the full copyright and license information, please read the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Ivory\SerializerBundle\DependencyInjection\Compiler;
+
+use Symfony\Component\EventDispatcher\DependencyInjection\RegisterListenersPass as AbstractRegisterListenerPass;
+
+/**
+ * @author GeLo <geloen.eric@gmail.com>
+ */
+class RegisterListenerPass extends AbstractRegisterListenerPass
+{
+    public function __construct()
+    {
+        parent::__construct(
+            'ivory.serializer.event.dispatcher',
+            'ivory.serializer.listener',
+            'ivory.serializer.subscriber'
+        );
+    }
+}

DependencyInjection/Configuration.php

@@ -15,6 +15,7 @@
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
+use Symfony\Component\EventDispatcher\EventDispatcher;
 
 /**
  * @author GeLo <geloen.eric@gmail.com>
@@ -29,6 +30,7 @@ public function getConfigTreeBuilder()
         $treeBuilder = $this->createTreeBuilder();
         $treeBuilder->root('ivory_serializer')
             ->children()
+            ->append($this->createEventNode())
             ->append($this->createMappingNode())
             ->append($this->createTypesNode())
             ->append($this->createVisitorsNode());
@@ -74,6 +76,18 @@ private function createMappingNode()
             ->end();
     }
 
+    /**
+     * @return ArrayNodeDefinition
+     */
+    private function createEventNode()
+    {
+        return $this->createNode('event')
+            ->addDefaultsIfNotSet()
+            ->children()
+                ->booleanNode('enabled')->defaultValue(class_exists(EventDispatcher::class))->end()
+            ->end();
+    }
+
     /**
      * @return ArrayNodeDefinition
      */

DependencyInjection/IvorySerializerExtension.php

@@ -40,6 +40,7 @@ protected function loadInternal(array $config, ContainerBuilder $container)
         $resources = [
             'cache',
             'common',
+            'event',
             'fos',
             'mapping',
             'navigator',
@@ -54,6 +55,7 @@ protected function loadInternal(array $config, ContainerBuilder $container)
         }
 
         $this->loadCache($config, $container);
+        $this->loadEvent($config['event'], $container);
         $this->loadMapping($config['mapping'], $container);
         $this->loadTypes($config['types'], $container);
         $this->loadVisitors($config['visitors'], $container);
@@ -75,6 +77,29 @@ private function loadCache(array $config, ContainerBuilder $container)
             ->addArgument($cache);
     }
 
+    /**
+     * @param mixed[]          $config
+     * @param ContainerBuilder $container
+     */
+    private function loadEvent(array $config, ContainerBuilder $container)
+    {
+        if ($config['enabled']) {
+            $container
+                ->getDefinition('ivory.serializer.mapping.factory')
+                ->replaceArgument(0, new Reference('ivory.serializer.mapping.factory.event'));
+
+            $container->setAlias('ivory.serializer.navigator', 'ivory.serializer.navigator.event');
+
+            return;
+        }
+
+        $container->removeDefinition('ivory.serializer.event.dispatcher');
+        $container->removeDefinition('ivory.serializer.mapping.factory.event');
+        $container->removeDefinition('ivory.serializer.navigator.event');
+
+        $container->setAlias('ivory.serializer.navigator', 'ivory.serializer.navigator.default');
+    }
+
     /**
      * @param mixed[]          $config
      * @param ContainerBuilder $container

IvorySerializerBundle.php

@@ -13,6 +13,7 @@
 
 use Ivory\SerializerBundle\DependencyInjection\Compiler\RegisterClassMetadataLoaderPass;
 use Ivory\SerializerBundle\DependencyInjection\Compiler\RegisterFOSServicePass;
+use Ivory\SerializerBundle\DependencyInjection\Compiler\RegisterListenerPass;
 use Ivory\SerializerBundle\DependencyInjection\Compiler\RegisterTypePass;
 use Ivory\SerializerBundle\DependencyInjection\Compiler\RegisterVisitorPass;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -30,6 +31,7 @@ public function build(ContainerBuilder $container)
     {
         $container
             ->addCompilerPass(new RegisterClassMetadataLoaderPass())
+            ->addCompilerPass(new RegisterListenerPass())
             ->addCompilerPass(new RegisterFOSServicePass())
             ->addCompilerPass(new RegisterTypePass())
             ->addCompilerPass(new RegisterVisitorPass());

README.md

@@ -36,6 +36,7 @@ $deserialize = $serializer->deserialize($json, \stdClass::class, Format::JSON);
  - [Configuration](/Resources/doc/configuration/index.md)
     - [Mapping](/Resources/doc/configuration/mapping.md)
     - [Type](/Resources/doc/configuration/type.md)
+    - [Event](/Resources/doc/configuration/event.md)
     - [Visitor](/Resources/doc/configuration/visitor.md)
     - [Cache](/Resources/doc/configuration/cache.md)
     - [FOSRestBundle Integration](/Resources/doc/configuration/fos_rest.md)

Resources/config/event.xml

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<container
+    xmlns="http://symfony.com/schema/dic/services"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://symfony.com/schema/dic/services
+                        http://symfony.com/schema/dic/services/services-1.0.xsd"
+>
+    <services>
+        <service
+            id="ivory.serializer.event.dispatcher"
+            class="Symfony\Component\EventDispatcher\EventDispatcher"
+        />
+
+        <service
+            id="ivory.serializer.mapping.factory.event"
+            class="Ivory\Serializer\Mapping\Factory\EventClassMetadataFactory"
+        >
+            <argument type="service" id="ivory.serializer.mapping.factory.default" />
+            <argument type="service" id="ivory.serializer.event.dispatcher" />
+        </service>
+
+        <service id="ivory.serializer.navigator.event" class="Ivory\Serializer\Navigator\EventNavigator">
+            <argument type="service" id="ivory.serializer.navigator.default" />
+            <argument type="service" id="ivory.serializer.event.dispatcher" />
+        </service>
+    </services>
+</container>

Resources/config/navigator.xml

@@ -7,7 +7,7 @@
                         http://symfony.com/schema/dic/services/services-1.0.xsd"
 >
     <services>
-        <service id="ivory.serializer.navigator" class="Ivory\Serializer\Navigator\Navigator">
+        <service id="ivory.serializer.navigator.default" class="Ivory\Serializer\Navigator\Navigator">
             <argument type="service" id="ivory.serializer.registry.type" />
             <argument type="service" id="ivory.serializer.type.guesser" />
         </service>

Resources/doc/configuration/event.md

@@ -0,0 +1,67 @@
+# Event
+
+The bundle supports events and allows you to hook into the (de)-serialization process. If you want to learn more about 
+the supported events, you can read this [documentation](https://github.com/egeloen/ivory-serializer/blob/master/doc/event.md).
+
+## Register a listener
+
+In order to register a listener on the event dispatcher, you need to use the `ivory.serializer.listener` tag as well 
+as the `event` and `method` attributes:
+
+``` xml
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<container
+    xmlns="http://symfony.com/schema/dic/services"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://symfony.com/schema/dic/services
+                        http://symfony.com/schema/dic/services/services-1.0.xsd"
+>
+    <services>
+        <service
+            id="acme.serializer.event.listener"
+            class="Acme\Serializer\Event\CustomListener"
+        >
+            <tag 
+                name="ivory.serializer.listsner"
+                event="serializer.pre_serialize"
+                method="onPreSerialize"
+            />
+        </service>
+    </services>
+</container>
+```
+
+## Register a subscriber
+
+To register a subscriber on the event dispatcher, you need to use the `ivory.serializer.subscriber` tag:
+
+``` xml
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<container
+    xmlns="http://symfony.com/schema/dic/services"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://symfony.com/schema/dic/services
+                        http://symfony.com/schema/dic/services/services-1.0.xsd"
+>
+    <services>
+        <service
+            id="acme.serializer.event.listener"
+            class="Acme\Serializer\Event\CustomSubscriber"
+        >
+            <tag name="ivory.serializer.subscriber" />
+        </service>
+    </services>
+</container>
+```
+
+## Disable Events
+
+If you don't use events, we recommend you to disable it since it adds some overhead:
+
+``` yaml
+ivory_serializer:
+    event:
+        enabled: false
+```

Resources/doc/configuration/index.md

@@ -4,6 +4,7 @@ The configuration allows you to set up the serializer the way you want instead o
 
  - [Mapping](/Resources/doc/configuration/mapping.md)
  - [Types](/Resources/doc/configuration/types.md)
+
  - [Visitors](/Resources/doc/configuration/visitors.md)
  - [Cache](/Resources/doc/configuration/cache.md)
  - [FOSRestBundle Integration](/Resources/doc/configuration/fos_rest.md)

Tests/DependencyInjection/AbstractIvorySerializerExtensionTest.php

@@ -204,7 +204,7 @@ public function testMappingCache()
         $classMetadataFactoryDefinition = $this->container->getDefinition($classMetadataFactoryService);
 
         $this->assertSame(
-            'ivory.serializer.mapping.factory.default',
+            'ivory.serializer.mapping.factory.event',
             (string) $classMetadataFactoryDefinition->getArgument(0)
         );
 
@@ -227,7 +227,7 @@ public function testCustomMappingCache()
         $classMetadataFactoryDefinition = $this->container->getDefinition($classMetadataFactoryService);
 
         $this->assertSame(
-            'ivory.serializer.mapping.factory.default',
+            'ivory.serializer.mapping.factory.event',
             (string) $classMetadataFactoryDefinition->getArgument(0)
         );
 
@@ -257,6 +257,25 @@ public function testCacheWarmer()
         );
     }
 
+    public function testEventEnabled()
+    {
+        $this->container->compile();
+
+        $this->assertTrue($this->container->has('ivory.serializer.event.dispatcher'));
+        $this->assertTrue($this->container->has('ivory.serializer.mapping.factory.event'));
+        $this->assertTrue($this->container->has('ivory.serializer.navigator.event'));
+    }
+
+    public function testEventDisabled()
+    {
+        $this->loadConfiguration($this->container, 'event_disabled');
+        $this->container->compile();
+
+        $this->assertFalse($this->container->has('ivory.serializer.event.dispatcher'));
+        $this->assertFalse($this->container->has('ivory.serializer.mapping.factory.event'));
+        $this->assertFalse($this->container->has('ivory.serializer.navigator.event'));
+    }
+
     public function testDateTimeType()
     {
         $this->loadConfiguration($this->container, 'type_date_time');

Tests/Fixtures/Config/Yaml/event_disabled.yml

@@ -0,0 +1,3 @@
+ivory_serializer:
+    event:
+        enabled: false