Added xml serialization in ExceptionWrapper serialize handler

Author: munkie

Serializer/ExceptionWrapperSerializeHandler.php

@@ -6,7 +6,8 @@
 use JMS\Serializer\Context;
 use JMS\Serializer\GraphNavigator;
 use JMS\Serializer\Handler\SubscribingHandlerInterface;
-use JMS\Serializer\VisitorInterface;
+use JMS\Serializer\JsonSerializationVisitor;
+use JMS\Serializer\XmlSerializationVisitor;
 
 class ExceptionWrapperSerializeHandler implements SubscribingHandlerInterface
 {
@@ -21,29 +22,75 @@ public static function getSubscribingMethods()
                 'format' => 'json',
                 'type' => 'FOS\\RestBundle\\Util\\ExceptionWrapper',
                 'method' => 'serializeToJson'
+            ),
+            array(
+                'direction' => GraphNavigator::DIRECTION_SERIALIZATION,
+                'format' => 'xml',
+                'type' => 'FOS\\RestBundle\\Util\\ExceptionWrapper',
+                'method' => 'serializeToXml'
             )
         );
     }
 
     /**
-     * @param VisitorInterface $visitor
-     * @param ExceptionWrapper $value
+     * @param JsonSerializationVisitor $visitor
+     * @param ExceptionWrapper $wrapper
      * @param array $type
      * @param Context $context
-     * @return string
+     * @return array
      */
     public function serializeToJson(
-        VisitorInterface $visitor,
-        ExceptionWrapper $value,
+        JsonSerializationVisitor $visitor,
+        ExceptionWrapper $wrapper,
         array $type,
         Context $context
     ) {
-        $type['name'] = 'array';
-        $data = array(
-            'code' => $value->getCode(),
-            'message' => $value->getMessage(),
-            'errors' => $value->getErrors(),
-        );
+        $data = $this->convertToArray($wrapper);
         return $visitor->visitArray($data, $type, $context);
     }
+
+    /**
+     * @param XmlSerializationVisitor $visitor
+     * @param ExceptionWrapper $wrapper
+     * @param array $type
+     * @param Context $context
+     */
+    public function serializeToXml(
+        XmlSerializationVisitor $visitor,
+        ExceptionWrapper $wrapper,
+        array $type,
+        Context $context
+    ) {
+        $data = $this->convertToArray($wrapper);
+
+        if (null === $visitor->document) {
+            $visitor->document = $visitor->createDocument(null, null, true);
+        }
+
+        foreach ($data as $key => $value) {
+            $entryNode = $visitor->document->createElement($key);
+            $visitor->getCurrentNode()->appendChild($entryNode);
+            $visitor->setCurrentNode($entryNode);
+
+            $node = $context->getNavigator()->accept($value, null, $context);
+            if (null !== $node) {
+                $visitor->getCurrentNode()->appendChild($node);
+            }
+
+            $visitor->revertCurrentNode();
+        }
+    }
+
+    /**
+     * @param ExceptionWrapper $exceptionWrapper
+     * @return array
+     */
+    protected function convertToArray(ExceptionWrapper $exceptionWrapper)
+    {
+        return array(
+            'code' => $exceptionWrapper->getCode(),
+            'message' => $exceptionWrapper->getMessage(),
+            'errors' => $exceptionWrapper->getErrors(),
+        );
+    }
 }

Tests/View/ViewHandlerTest.php

@@ -17,6 +17,7 @@
 use FOS\RestBundle\View\View;
 use FOS\RestBundle\View\ViewHandler;
 use JMS\Serializer\EventDispatcher\EventDispatcher;
+use JMS\Serializer\Exclusion\GroupsExclusionStrategy;
 use JMS\Serializer\Handler\FormErrorHandler;
 use JMS\Serializer\Handler\HandlerRegistry;
 use JMS\Serializer\SerializerBuilder;
@@ -557,14 +558,19 @@ public function testConfigurableViewHandlerInterface()
         $this->assertTrue($context->shouldSerializeNull());
     }
 
-    public function testCreateResponseWithFormErrorsAndSerializationGroups()
+    /**
+     * @dataProvider exceptionWrapperSerializeResponseContentProvider
+     * @param string $format
+     */
+    public function testCreateResponseWithFormErrorsAndSerializationGroups($format)
     {
-        $builder = Forms::createFormFactory()->createBuilder();
-        $form = $builder
+        $form = Forms::createFormFactory()->createBuilder()
             ->add('name', 'text')
             ->add('description', 'text')
             ->getForm();
 
+        $form->get('name')->addError(new FormError('Invalid name'));
+
         $exceptionWrapper = new ExceptionWrapper(
             array(
                 'status_code' => 400,
@@ -576,43 +582,22 @@ public function testCreateResponseWithFormErrorsAndSerializationGroups()
         $view = new View($exceptionWrapper);
         $view->getSerializationContext()->setGroups(array('Custom'));
 
-        $handler = new ExceptionWrapperSerializeHandler();
-        $formErrorHandlerMock = $this->getMock(
-            'JMS\Serializer\Handler\FormErrorHandler',
-            array('serializeFormToJson'),
-            array(),
-            '',
-            false
+        $wrapperHandler = new ExceptionWrapperSerializeHandler();
+        $translatorMock = $this->getMock(
+            'Symfony\\Component\\Translation\\TranslatorInterface',
+            array('trans', 'transChoice', 'setLocale', 'getLocale')
         );
-        $formErrorHandlerMock
-            ->expects($this->once())
-            ->method('serializeFormToJson')
-            ->with(
-                $this->isInstanceOf('JMS\\Serializer\\JsonSerializationVisitor'),
-                $form,
-                array(
-                    'name' => 'Symfony\Component\Form\Form',
-                    'params' => array()
-                )
-            )
-            ->will(
-                $this->returnValue(
-                    array(
-                        'children' => array(
-                            'name' => array(
-                                'errors' => array(
-                                    'Invalid name'
-                                )
-                            ),
-                        )
-                    )
-                )
-            );
+        $translatorMock
+            ->expects($this->any())
+            ->method('trans')
+            ->will($this->returnArgument(0));
+
+        $formErrorHandler = new FormErrorHandler($translatorMock);
 
         $serializer = SerializerBuilder::create()
-            ->configureHandlers(function (HandlerRegistry $handlerRegistry) use ($handler, $formErrorHandlerMock) {
-                $handlerRegistry->registerSubscribingHandler($handler);
-                $handlerRegistry->registerSubscribingHandler($formErrorHandlerMock);
+            ->configureHandlers(function (HandlerRegistry $handlerRegistry) use ($wrapperHandler, $formErrorHandler) {
+                $handlerRegistry->registerSubscribingHandler($wrapperHandler);
+                $handlerRegistry->registerSubscribingHandler($formErrorHandler);
             })
             ->build();
 
@@ -626,22 +611,38 @@ public function testCreateResponseWithFormErrorsAndSerializationGroups()
         $viewHandler = new ViewHandler(array());
         $viewHandler->setContainer($container);
 
-        $response = $viewHandler->createResponse($view, new Request(), 'json');
-
-        $expected = array(
-            'code' => 400,
-            'message' => 'Validation Failed',
-            'errors' => array(
-                'children' => array(
-                    'name' => array(
-                        'errors' => array(
-                            'Invalid name'
-                        )
-                    )
-                )
-            )
-        );
+        $response = $viewHandler->createResponse($view, new Request(), $format);
 
-        $this->assertEquals($expected, json_decode($response->getContent(), true));
+        $serializer2 = SerializerBuilder::create()
+            ->configureHandlers(function (HandlerRegistry $handlerRegistry) use ($wrapperHandler, $formErrorHandler) {
+                $handlerRegistry->registerSubscribingHandler($formErrorHandler);
+            })
+            ->build();
+
+        $container2 = $this->getMock('Symfony\Component\DependencyInjection\Container', array('get'));
+        $container2
+            ->expects($this->once())
+            ->method('get')
+            ->with('fos_rest.serializer')
+            ->will($this->returnValue($serializer2));
+
+        $viewHandler = new ViewHandler(array());
+        $viewHandler->setContainer($container2);
+
+        $view2 = new View($exceptionWrapper);
+        $response2 = $viewHandler->createResponse($view2, new Request(), $format);
+
+        $this->assertEquals($response->getContent(), $response2->getContent());
+    }
+
+    /**
+     * @return array
+     */
+    public function exceptionWrapperSerializeResponseContentProvider()
+    {
+        return array(
+            'json' => array('json'),
+            'xml' => array('xml')
+        );
     }
 }