[RFR] Fix #24: bridge normalizer (#25)

* Fix #24: bridge normalizer

* Fix PHP5.5 typehint

* Use custom normalizer bridge

.travis.yml

@@ -35,3 +35,4 @@ script:
     - if [[ $lint = 1 ]]; then php php-cs-fixer.phar fix --dry-run --diff; fi
     - vendor/bin/phpunit
     - vendor/bin/behat
+    - vendor/bin/behat -p jmsserializer

Controller/ForgotPasswordController.php

@@ -13,9 +13,9 @@
 
 use CoopTilleuls\ForgotPasswordBundle\Entity\AbstractPasswordToken;
 use CoopTilleuls\ForgotPasswordBundle\Manager\ForgotPasswordManager;
+use CoopTilleuls\ForgotPasswordBundle\Normalizer\NormalizerInterface;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Response;
-use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 
 /**
  * @author Vincent Chalamon <[email protected]>

DependencyInjection/Configuration.php

@@ -72,6 +72,7 @@ public function getConfigTreeBuilder()
                         ->scalarNode('password_field')->defaultValue('password')->cannotBeEmpty()->info('User password field name.')->end()
                     ->end()
                 ->end()
+                ->booleanNode('use_jms_serializer')->defaultFalse()->end()
             ->end();
 
         return $treeBuilder;

DependencyInjection/CoopTilleulsForgotPasswordExtension.php

@@ -11,9 +11,13 @@
 
 namespace CoopTilleuls\ForgotPasswordBundle\DependencyInjection;
 
+use CoopTilleuls\ForgotPasswordBundle\Normalizer\JMSNormalizer;
+use CoopTilleuls\ForgotPasswordBundle\Normalizer\SymfonyNormalizer;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
+use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 
 /**
@@ -47,5 +51,9 @@ public function load(array $configs, ContainerBuilder $container)
             throw new \LogicException(sprintf('Service "%s" does not exist.', $config['manager']));
         }
         $container->setAlias('coop_tilleuls_forgot_password.manager', $config['manager']);
+
+        // Build normalizer
+        $class = true === $config['use_jms_serializer'] ? JMSNormalizer::class : SymfonyNormalizer::class;
+        $container->setDefinition('coop_tilleuls_forgot_password.normalizer', new Definition($class, [new Reference('serializer')]))->setPublic(false);
     }
 }

Normalizer/JMSNormalizer.php

@@ -0,0 +1,42 @@
+<?php
+
+/*
+ * This file is part of the CoopTilleulsForgotPasswordBundle package.
+ *
+ * (c) Vincent Chalamon <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace CoopTilleuls\ForgotPasswordBundle\Normalizer;
+
+use CoopTilleuls\ForgotPasswordBundle\Entity\AbstractPasswordToken;
+use JMS\Serializer\ArrayTransformerInterface;
+
+/**
+ * @author Vincent Chalamon <[email protected]>
+ */
+final class JMSNormalizer implements NormalizerInterface
+{
+    /**
+     * @var ArrayTransformerInterface
+     */
+    private $normalizer;
+
+    /**
+     * @param ArrayTransformerInterface $normalizer
+     */
+    public function __construct(ArrayTransformerInterface $normalizer)
+    {
+        $this->normalizer = $normalizer;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function normalize(AbstractPasswordToken $object, $format, array $context = [])
+    {
+        return $this->normalizer->toArray($object);
+    }
+}

Normalizer/NormalizerInterface.php

@@ -0,0 +1,29 @@
+<?php
+
+/*
+ * This file is part of the CoopTilleulsForgotPasswordBundle package.
+ *
+ * (c) Vincent Chalamon <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace CoopTilleuls\ForgotPasswordBundle\Normalizer;
+
+use CoopTilleuls\ForgotPasswordBundle\Entity\AbstractPasswordToken;
+
+/**
+ * @author Vincent Chalamon <[email protected]>
+ */
+interface NormalizerInterface
+{
+    /**
+     * @param AbstractPasswordToken $object
+     * @param string                $format
+     * @param array                 $context
+     *
+     * @return mixed
+     */
+    public function normalize(AbstractPasswordToken $object, $format, array $context = []);
+}

Normalizer/SymfonyNormalizer.php

@@ -0,0 +1,42 @@
+<?php
+
+/*
+ * This file is part of the CoopTilleulsForgotPasswordBundle package.
+ *
+ * (c) Vincent Chalamon <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace CoopTilleuls\ForgotPasswordBundle\Normalizer;
+
+use CoopTilleuls\ForgotPasswordBundle\Entity\AbstractPasswordToken;
+use Symfony\Component\Serializer\Normalizer\NormalizerInterface as SymfonyNormalizerInterface;
+
+/**
+ * @author Vincent Chalamon <[email protected]>
+ */
+final class SymfonyNormalizer implements NormalizerInterface
+{
+    /**
+     * @var SymfonyNormalizerInterface
+     */
+    private $normalizer;
+
+    /**
+     * @param SymfonyNormalizerInterface $normalizer
+     */
+    public function __construct(SymfonyNormalizerInterface $normalizer)
+    {
+        $this->normalizer = $normalizer;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function normalize(AbstractPasswordToken $object, $format, array $context = [])
+    {
+        return $this->normalizer->normalize($object, $format, $context);
+    }
+}

Resources/config/services.xml

@@ -7,7 +7,7 @@
     <services>
         <service id="coop_tilleuls_forgot_password.controller.forgot_password" class="CoopTilleuls\ForgotPasswordBundle\Controller\ForgotPasswordController">
             <argument type="service" id="coop_tilleuls_forgot_password.manager.forgot_password" />
-            <argument type="service" id="serializer" />
+            <argument type="service" id="coop_tilleuls_forgot_password.normalizer" />
             <argument>%coop_tilleuls_forgot_password.password_token_serialization_groups%</argument>
         </service>
 

behat.yml

@@ -1,3 +1,4 @@
+# Test with Symfony Serializer
 default:
     suites:
         default:
@@ -13,3 +14,20 @@ default:
                 debug:     'true'
                 path:      'features/app/AppKernel.php'
                 bootstrap: 'features/app/bootstrap.php'
+
+# Test with JmsSerializerBundle
+jmsserializer:
+    suites:
+        default:
+            contexts:
+                - FeatureContext:
+                    - '@test.client'
+                    - '@doctrine'
+                    - '@coop_tilleuls_forgot_password.manager.password_token'
+    extensions:
+        'Behat\Symfony2Extension':
+            kernel:
+                env:       'jmsserializer'
+                debug:     'true'
+                path:      'features/app/AppKernel.php'
+                bootstrap: 'features/app/bootstrap.php'

composer.json

@@ -23,8 +23,7 @@
         "symfony/dependency-injection": "^2.3 || ^3.0",
         "symfony/event-dispatcher": "^2.3 || ^3.0",
         "symfony/http-foundation": "^2.3 || ^3.0",
-        "symfony/http-kernel": "^2.3 || ^3.0",
-        "symfony/serializer": "^2.7 || ^3.0"
+        "symfony/http-kernel": "^2.3 || ^3.0"
     },
     "require-dev": {
         "behat/behat": "^3.1",
@@ -42,7 +41,9 @@
         "symfony/security-bundle": "^2.3 || ^3.0",
         "symfony/swiftmailer-bundle": "^2.3.11",
         "symfony/templating": "^2.3 || ^3.0",
-        "symfony/twig-bundle": "^2.8 || ^3.0"
+        "symfony/twig-bundle": "^2.8 || ^3.0",
+        "symfony/serializer": "^2.7 || ^3.0",
+        "jms/serializer-bundle": "^1.4"
     },
     "suggest": {
         "doctrine/doctrine-bundle": "To connect with Doctrine in Symfony project",

features/app/AppKernel.php

@@ -29,7 +29,7 @@ final class AppKernel extends Kernel
 
     public function registerBundles()
     {
-        return [
+        $bundles = [
             new Symfony\Bundle\FrameworkBundle\FrameworkBundle(),
             new Symfony\Bundle\SecurityBundle\SecurityBundle(),
             new Symfony\Bundle\SwiftmailerBundle\SwiftmailerBundle(),
@@ -39,6 +39,11 @@ public function registerBundles()
             new CoopTilleuls\ForgotPasswordBundle\CoopTilleulsForgotPasswordBundle(),
             new CoopTilleuls\ForgotPasswordBundle\Tests\TestBundle\CoopTilleulsTestBundle(),
         ];
+        if ('jmsserializer' === $this->getEnvironment()) {
+            $bundles[] = new JMS\SerializerBundle\JMSSerializerBundle();
+        }
+
+        return $bundles;
     }
 
     protected function configureRoutes(RouteCollectionBuilder $routes)
@@ -51,6 +56,7 @@ protected function configureContainer(ContainerBuilder $c, LoaderInterface $load
         $c->loadFromExtension('coop_tilleuls_forgot_password', [
             'password_token_class' => PasswordToken::class,
             'user_class' => User::class,
+            'use_jms_serializer' => 'jmsserializer' === $this->getEnvironment(),
         ]);
 
         $c->loadFromExtension('swiftmailer', [

tests/Controller/ForgotPasswordControllerTest.php

@@ -14,9 +14,9 @@
 use CoopTilleuls\ForgotPasswordBundle\Controller\ForgotPasswordController;
 use CoopTilleuls\ForgotPasswordBundle\Entity\AbstractPasswordToken;
 use CoopTilleuls\ForgotPasswordBundle\Manager\ForgotPasswordManager;
+use CoopTilleuls\ForgotPasswordBundle\Normalizer\NormalizerInterface;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Response;
-use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 
 /**
  * @author Vincent Chalamon <[email protected]>

tests/Normalizer/JMSNormalizerTest.php

@@ -0,0 +1,33 @@
+<?php
+
+/*
+ * This file is part of the CoopTilleulsForgotPasswordBundle package.
+ *
+ * (c) Vincent Chalamon <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Tests\ForgotPasswordBundle\Normalizer;
+
+use CoopTilleuls\ForgotPasswordBundle\Entity\AbstractPasswordToken;
+use CoopTilleuls\ForgotPasswordBundle\Normalizer\JMSNormalizer;
+use JMS\Serializer\ArrayTransformerInterface;
+
+/**
+ * @author Vincent Chalamon <[email protected]>
+ */
+final class JMSNormalizerTest extends \PHPUnit_Framework_TestCase
+{
+    public function testNormalize()
+    {
+        $normalizerMock = $this->prophesize(ArrayTransformerInterface::class);
+        $passwordTokenMock = $this->prophesize(AbstractPasswordToken::class);
+
+        $normalizerMock->toArray($passwordTokenMock)->willReturn('foo')->shouldBeCalledTimes(1);
+
+        $normalizer = new JMSNormalizer($normalizerMock->reveal());
+        $this->assertEquals('foo', $normalizer->normalize($passwordTokenMock->reveal(), 'json'));
+    }
+}

tests/Normalizer/SymfonyNormalizerTest.php

@@ -0,0 +1,33 @@
+<?php
+
+/*
+ * This file is part of the CoopTilleulsForgotPasswordBundle package.
+ *
+ * (c) Vincent Chalamon <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Tests\ForgotPasswordBundle\Normalizer;
+
+use CoopTilleuls\ForgotPasswordBundle\Entity\AbstractPasswordToken;
+use CoopTilleuls\ForgotPasswordBundle\Normalizer\SymfonyNormalizer;
+use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
+
+/**
+ * @author Vincent Chalamon <[email protected]>
+ */
+final class SymfonyNormalizerTest extends \PHPUnit_Framework_TestCase
+{
+    public function testNormalize()
+    {
+        $normalizerMock = $this->prophesize(NormalizerInterface::class);
+        $passwordTokenMock = $this->prophesize(AbstractPasswordToken::class);
+
+        $normalizerMock->normalize($passwordTokenMock, 'json', [])->willReturn('foo')->shouldBeCalledTimes(1);
+
+        $normalizer = new SymfonyNormalizer($normalizerMock->reveal());
+        $this->assertEquals('foo', $normalizer->normalize($passwordTokenMock->reveal(), 'json'));
+    }
+}