Merge pull request #1932 from bendavies/constraint-violation-normalizer-name-converter

soyuka · web-flow · commit 29aa05318811 · 2018-05-03T17:58:33.000+02:00
use name converter in ConstraintViolationListNormalizer
diff --git a/src/Bridge/Symfony/Bundle/Resources/config/hydra.xml b/src/Bridge/Symfony/Bundle/Resources/config/hydra.xml
@@ -32,6 +32,7 @@
         <service id="api_platform.hydra.normalizer.constraint_violation_list" class="ApiPlatform\Core\Hydra\Serializer\ConstraintViolationListNormalizer" public="false">
             <argument type="service" id="api_platform.router" />
             <argument>%api_platform.validator.serialize_payload_fields%</argument>
+            <argument type="service" id="api_platform.name_converter" on-invalid="ignore" />
 
             <tag name="serializer.normalizer" priority="64" />
         </service>
diff --git a/src/Bridge/Symfony/Bundle/Resources/config/problem.xml b/src/Bridge/Symfony/Bundle/Resources/config/problem.xml
@@ -14,6 +14,7 @@
 
         <service id="api_platform.problem.normalizer.constraint_violation_list" class="ApiPlatform\Core\Problem\Serializer\ConstraintViolationListNormalizer" public="false">
             <argument>%api_platform.validator.serialize_payload_fields%</argument>
+            <argument type="service" id="api_platform.name_converter" on-invalid="ignore" />
             
             <tag name="serializer.normalizer" priority="16" />
         </service>
diff --git a/src/Hydra/Serializer/ConstraintViolationListNormalizer.php b/src/Hydra/Serializer/ConstraintViolationListNormalizer.php
@@ -15,6 +15,7 @@
 
 use ApiPlatform\Core\Api\UrlGeneratorInterface;
 use ApiPlatform\Core\Serializer\AbstractConstraintViolationListNormalizer;
+use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
 
 /**
  * Converts {@see \Symfony\Component\Validator\ConstraintViolationListInterface} to a Hydra error representation.
@@ -27,9 +28,9 @@ final class ConstraintViolationListNormalizer extends AbstractConstraintViolatio
 
     private $urlGenerator;
 
-    public function __construct(UrlGeneratorInterface $urlGenerator, array $serializePayloadFields = null)
+    public function __construct(UrlGeneratorInterface $urlGenerator, array $serializePayloadFields = null, NameConverterInterface $nameConverter = null)
     {
-        parent::__construct($serializePayloadFields);
+        parent::__construct($serializePayloadFields, $nameConverter);
 
         $this->urlGenerator = $urlGenerator;
     }
diff --git a/src/Serializer/AbstractConstraintViolationListNormalizer.php b/src/Serializer/AbstractConstraintViolationListNormalizer.php
@@ -13,6 +13,7 @@
 
 namespace ApiPlatform\Core\Serializer;
 
+use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 use Symfony\Component\Validator\ConstraintViolationListInterface;
 
@@ -28,9 +29,11 @@ abstract class AbstractConstraintViolationListNormalizer implements NormalizerIn
     const FORMAT = null; // Must be overrode
 
     private $serializePayloadFields;
+    private $nameConverter;
 
-    public function __construct(array $serializePayloadFields = null)
+    public function __construct(array $serializePayloadFields = null, NameConverterInterface $nameConverter = null)
     {
+        $this->nameConverter = $nameConverter;
         $this->serializePayloadFields = $serializePayloadFields;
     }
 
@@ -47,7 +50,10 @@ protected function getMessagesAndViolations(ConstraintViolationListInterface $co
         $violations = $messages = [];
 
         foreach ($constraintViolationList as $violation) {
-            $violationData = ['propertyPath' => $violation->getPropertyPath(), 'message' => $violation->getMessage()];
+            $violationData = [
+                'propertyPath' => $this->nameConverter ? $this->nameConverter->normalize($violation->getPropertyPath()) : $violation->getPropertyPath(),
+                'message' => $violation->getMessage(),
+            ];
 
             $constraint = $violation->getConstraint();
             if ($this->serializePayloadFields && $constraint && $constraint->payload) {
diff --git a/tests/Hydra/Serializer/ConstraintViolationNormalizerTest.php b/tests/Hydra/Serializer/ConstraintViolationNormalizerTest.php
@@ -16,6 +16,8 @@
 use ApiPlatform\Core\Api\UrlGeneratorInterface;
 use ApiPlatform\Core\Hydra\Serializer\ConstraintViolationListNormalizer;
 use PHPUnit\Framework\TestCase;
+use Prophecy\Argument;
+use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
 use Symfony\Component\Validator\Constraints\NotNull;
 use Symfony\Component\Validator\ConstraintViolation;
 use Symfony\Component\Validator\ConstraintViolationList;
@@ -28,8 +30,9 @@ class ConstraintViolationNormalizerTest extends TestCase
     public function testSupportNormalization()
     {
         $urlGeneratorProphecy = $this->prophesize(UrlGeneratorInterface::class);
+        $nameConverterProphecy = $this->prophesize(NameConverterInterface::class);
 
-        $normalizer = new ConstraintViolationListNormalizer($urlGeneratorProphecy->reveal(), []);
+        $normalizer = new ConstraintViolationListNormalizer($urlGeneratorProphecy->reveal(), [], $nameConverterProphecy->reveal());
 
         $this->assertTrue($normalizer->supportsNormalization(new ConstraintViolationList(), ConstraintViolationListNormalizer::FORMAT));
         $this->assertFalse($normalizer->supportsNormalization(new ConstraintViolationList(), 'xml'));
@@ -39,9 +42,14 @@ public function testSupportNormalization()
     public function testNormalize()
     {
         $urlGeneratorProphecy = $this->prophesize(UrlGeneratorInterface::class);
+        $nameConverterProphecy = $this->prophesize(NameConverterInterface::class);
+
         $urlGeneratorProphecy->generate('api_jsonld_context', ['shortName' => 'ConstraintViolationList'])->willReturn('/context/foo')->shouldBeCalled();
+        $nameConverterProphecy->normalize(Argument::type('string'))->will(function ($args) {
+            return '_'.$args[0];
+        });
 
-        $normalizer = new ConstraintViolationListNormalizer($urlGeneratorProphecy->reveal(), ['severity', 'anotherField1']);
+        $normalizer = new ConstraintViolationListNormalizer($urlGeneratorProphecy->reveal(), ['severity', 'anotherField1'], $nameConverterProphecy->reveal());
 
         // Note : we use NotNull constraint and not Constraint class because Constraint is abstract
         $constraint = new NotNull();
@@ -55,18 +63,18 @@ public function testNormalize()
             '@context' => '/context/foo',
             '@type' => 'ConstraintViolationList',
             'hydra:title' => 'An error occurred',
-            'hydra:description' => 'd: a
-4: 1',
+            'hydra:description' => '_d: a
+_4: 1',
             'violations' => [
                     [
-                        'propertyPath' => 'd',
+                        'propertyPath' => '_d',
                         'message' => 'a',
                         'payload' => [
                             'severity' => 'warning',
                         ],
                     ],
                     [
-                        'propertyPath' => '4',
+                        'propertyPath' => '_4',
                         'message' => '1',
                     ],
                 ],
diff --git a/tests/Problem/Serializer/ConstraintViolationNormalizerTest.php b/tests/Problem/Serializer/ConstraintViolationNormalizerTest.php
@@ -15,6 +15,8 @@
 
 use ApiPlatform\Core\Problem\Serializer\ConstraintViolationListNormalizer;
 use PHPUnit\Framework\TestCase;
+use Prophecy\Argument;
+use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
 use Symfony\Component\Validator\Constraints\NotNull;
 use Symfony\Component\Validator\ConstraintViolation;
 use Symfony\Component\Validator\ConstraintViolationList;
@@ -26,7 +28,8 @@ class ConstraintViolationNormalizerTest extends TestCase
 {
     public function testSupportNormalization()
     {
-        $normalizer = new ConstraintViolationListNormalizer([]);
+        $nameConverterProphecy = $this->prophesize(NameConverterInterface::class);
+        $normalizer = new ConstraintViolationListNormalizer([], $nameConverterProphecy->reveal());
 
         $this->assertTrue($normalizer->supportsNormalization(new ConstraintViolationList(), ConstraintViolationListNormalizer::FORMAT));
         $this->assertFalse($normalizer->supportsNormalization(new ConstraintViolationList(), 'xml'));
@@ -35,7 +38,12 @@ public function testSupportNormalization()
 
     public function testNormalize()
     {
-        $normalizer = new ConstraintViolationListNormalizer(['severity', 'anotherField1']);
+        $nameConverterProphecy = $this->prophesize(NameConverterInterface::class);
+        $normalizer = new ConstraintViolationListNormalizer(['severity', 'anotherField1'], $nameConverterProphecy->reveal());
+
+        $nameConverterProphecy->normalize(Argument::type('string'))->will(function ($args) {
+            return '_'.$args[0];
+        });
 
         // Note : we use NotNull constraint and not Constraint class because Constraint is abstract
         $constraint = new NotNull();
@@ -48,18 +56,18 @@ public function testNormalize()
         $expected = [
             'type' => 'https://tools.ietf.org/html/rfc2616#section-10',
             'title' => 'An error occurred',
-            'detail' => 'd: a
-4: 1',
+            'detail' => '_d: a
+_4: 1',
             'violations' => [
                     [
-                        'propertyPath' => 'd',
+                        'propertyPath' => '_d',
                         'message' => 'a',
                         'payload' => [
                             'severity' => 'warning',
                         ],
                     ],
                     [
-                        'propertyPath' => '4',
+                        'propertyPath' => '_4',
                         'message' => '1',
                     ],
                 ],

Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@`
`15`	`15`
`16`	`16`	`use ApiPlatform\Core\Api\UrlGeneratorInterface;`
`17`	`17`	`use ApiPlatform\Core\Serializer\AbstractConstraintViolationListNormalizer;`
	`18`	`+use Symfony\Component\Serializer\NameConverter\NameConverterInterface;`
`18`	`19`
`19`	`20`	`/**`
`20`	`21`	`* Converts {@see \Symfony\Component\Validator\ConstraintViolationListInterface} to a Hydra error representation.`
`@@ -27,9 +28,9 @@ final class ConstraintViolationListNormalizer extends AbstractConstraintViolatio`
`27`	`28`
`28`	`29`	`private $urlGenerator;`
`29`	`30`
`30`		`- public function __construct(UrlGeneratorInterface $urlGenerator, array $serializePayloadFields = null)`
	`31`	`+ public function __construct(UrlGeneratorInterface $urlGenerator, array $serializePayloadFields = null, NameConverterInterface $nameConverter = null)`
`31`	`32`	`{`
`32`		`- parent::__construct($serializePayloadFields);`
	`33`	`+ parent::__construct($serializePayloadFields, $nameConverter);`
`33`	`34`
`34`	`35`	`$this->urlGenerator = $urlGenerator;`
`35`	`36`	`}`