feature #14987 [FrameworkBundle] Configurable Serializer name converter (dunglas)

fabpot · fabpot · commit f02a5dcec4f8 · 2015-08-01T08:23:02.000+02:00
This PR was merged into the 2.8 branch. Discussion ---------- [FrameworkBundle] Configurable Serializer name converter | Q | A | ------------- | --- | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | n/a | License | MIT | Doc PR | symfony/symfony-docs#5483 - [x] Add tests Commits ------- e500a71 [FrameworkBundle] Configurable Serializer name converter
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
@@ -660,6 +660,7 @@ private function addSerializerSection(ArrayNodeDefinition $rootNode)
                     ->children()
                         ->booleanNode('enable_annotations')->defaultFalse()->end()
                         ->scalarNode('cache')->end()
+                        ->scalarNode('name_converter')->end()
                     ->end()
                 ->end()
             ->end()
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -970,6 +970,10 @@ private function registerSerializerConfiguration(array $config, ContainerBuilder
                 1, new Reference($config['cache'])
             );
         }
+
+        if ($config['name_converter']) {
+            $container->getDefinition('serializer.normalizer.object')->replaceArgument(1, new Reference($config['name_converter']));
+        }
     }
 
     /**
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/schema/symfony-1.0.xsd b/src/Symfony/Bundle/FrameworkBundle/Resources/config/schema/symfony-1.0.xsd
@@ -217,5 +217,6 @@
         <xsd:attribute name="enabled" type="xsd:boolean" />
         <xsd:attribute name="cache" type="xsd:string" />
         <xsd:attribute name="enable-annotations" type="xsd:boolean" />
+        <xsd:attribute name="name-converter" type="xsd:string" />
     </xsd:complexType>
 </xsd:schema>
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/serializer.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/serializer.xml
@@ -22,7 +22,7 @@
         <!-- Normalizer -->
         <service id="serializer.normalizer.object" class="Symfony\Component\Serializer\Normalizer\ObjectNormalizer" public="false">
             <argument type="service" id="serializer.mapping.class_metadata_factory" />
-            <argument>null</argument>
+            <argument>null</argument> <!-- name converter -->
             <argument type="service" id="serializer.property_accessor" />
 
             <!-- Run after all custom serializers -->
@@ -55,5 +55,8 @@
         <service id="serializer.encoder.json" class="%serializer.encoder.json.class%" public="false">
             <tag name="serializer.encoder" />
         </service>
+
+        <!-- Name converter -->
+        <service id="serializer.name_converter.camel_case_to_snake_case" class="Symfony\Component\Serializer\NameConverter\CamelCaseToSnakeCaseNameConverter" public="false" />
     </services>
 </container>
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/full.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/full.php
@@ -61,7 +61,12 @@
         'debug' => true,
         'file_cache_dir' => '%kernel.cache_dir%/annotations',
     ),
-    'serializer' => array('enabled' => true),
+    'serializer' => array(
+        'enabled' => true,
+        'enable_annotations' => true,
+        'cache' => 'serializer.mapping.cache.apc',
+        'name_converter' => 'serializer.name_converter.camel_case_to_snake_case',
+    ),
     'ide' => 'file%%link%%format',
     'request' => array(
         'formats' => array(
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/full.xml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/full.xml
@@ -39,6 +39,6 @@
         </framework:translator>
         <framework:validation enabled="true" cache="apc" />
         <framework:annotations cache="file" debug="true" file-cache-dir="%kernel.cache_dir%/annotations" />
-        <framework:serializer enabled="true" />
+        <framework:serializer enabled="true" enable-annotations="true" cache="serializer.mapping.cache.apc" name-converter="serializer.name_converter.camel_case_to_snake_case" />
     </framework:config>
 </container>
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/full.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/full.yml
@@ -47,7 +47,11 @@ framework:
         cache:   file
         debug:   true
         file_cache_dir: %kernel.cache_dir%/annotations
-    serializer: { enabled: true }
+    serializer:
+         enabled:        true
+         enable_annotations: true
+         cache:          serializer.mapping.cache.apc
+         name_converter: serializer.name_converter.camel_case_to_snake_case
     ide: file%%link%%format
     request:
         formats:
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php
@@ -446,6 +446,13 @@ public function testSerializerEnabled()
     {
         $container = $this->createContainerFromFile('full');
         $this->assertTrue($container->has('serializer'));
+
+        $argument = $container->getDefinition('serializer.mapping.chain_loader')->getArgument(0);
+
+        $this->assertCount(1, $argument);
+        $this->assertEquals('Symfony\Component\Serializer\Mapping\Loader\AnnotationLoader', $argument[0]->getClass());
+        $this->assertEquals(new Reference('serializer.mapping.cache.apc'), $container->getDefinition('serializer.mapping.class_metadata_factory')->getArgument(1));
+        $this->assertEquals(new Reference('serializer.name_converter.camel_case_to_snake_case'), $container->getDefinition('serializer.normalizer.object')->getArgument(1));
     }
 
     public function testAssetHelperWhenAssetsAreEnabled()

Original file line number	Diff line number	Diff line change
`@@ -970,6 +970,10 @@ private function registerSerializerConfiguration(array $config, ContainerBuilder`
`970`	`970`	`1, new Reference($config['cache'])`
`971`	`971`	`);`
`972`	`972`	`}`
	`973`	`+`
	`974`	`+ if ($config['name_converter']) {`
	`975`	`+ $container->getDefinition('serializer.normalizer.object')->replaceArgument(1, new Reference($config['name_converter']));`
	`976`	`+ }`
`973`	`977`	`}`
`974`	`978`
`975`	`979`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -446,6 +446,13 @@ public function testSerializerEnabled()`
`446`	`446`	`{`
`447`	`447`	`$container = $this->createContainerFromFile('full');`
`448`	`448`	`$this->assertTrue($container->has('serializer'));`
	`449`	`+`
	`450`	`+ $argument = $container->getDefinition('serializer.mapping.chain_loader')->getArgument(0);`
	`451`	`+`
	`452`	`+ $this->assertCount(1, $argument);`
	`453`	`+ $this->assertEquals('Symfony\Component\Serializer\Mapping\Loader\AnnotationLoader', $argument[0]->getClass());`
	`454`	`+ $this->assertEquals(new Reference('serializer.mapping.cache.apc'), $container->getDefinition('serializer.mapping.class_metadata_factory')->getArgument(1));`
	`455`	`+ $this->assertEquals(new Reference('serializer.name_converter.camel_case_to_snake_case'), $container->getDefinition('serializer.normalizer.object')->getArgument(1));`
`449`	`456`	`}`
`450`	`457`
`451`	`458`	`public function testAssetHelperWhenAssetsAreEnabled()`