Serialization Context Naming Strategy

doc/configuration.rst

@@ -77,6 +77,43 @@ The serializer would expect the metadata files to be named like the fully qualif
 replaced with ``.``. So, if you class would be named ``Vendor\Package\Foo``, the metadata file would need to be located
 at ``$someDir/Vendor.Package.Foo.(xml|yml)``. If not found, ``$someDir/Vendor.Package.(xml|yml)`` will be tried, then ``$someDir/Vendor.Package.(xml|yml)`` and so on. For more information, see the :doc:`reference <reference>`.
 
+Context Strategy
+----------------------------------------------
+
+Context strategy allows you to change serialization configuration for specific serialization or deserialization.
+This allow you to deviate from default configuration.
+
+### Serializing null values::
+
+    use JMS\Serializer\SerializationContext;
+
+    $serializer->serialize(
+        $object,
+        'json',
+        SerializationContext::create()->setSerializeNull(true)
+    )
+
+### Serializing with different property naming strategy::
+
+    use JMS\Serializer\SerializationContext;
+
+    $serializer->serialize(
+        $object,
+        'json',
+        SerializationContext::create()->setPropertyNamingStrategy(new SerializedNameAnnotationStrategy(new IdenticalPropertyNamingStrategy()))
+    )
+
+### Deserializing with different property naming strategy::
+
+    use JMS\Serializer\SerializationContext;
+
+    $serializer->deserialize(
+        $jsonString,
+        Product:class,
+        'json',
+        DeserializationContext::create()->setPropertyNamingStrategy(new SerializedNameAnnotationStrategy(new IdenticalPropertyNamingStrategy()))
+    )
+
 Setting a default SerializationContext factory
 ----------------------------------------------
 To avoid to pass an instance of SerializationContext
@@ -103,4 +140,4 @@ a serialization context from your callable and use it.
 
     You can also set a default DeserializationContextFactory with
     ``->setDeserializationContextFactory(function () { /* ... */ })``
-    to be used with methods ``deserialize()`` and ``fromArray()``.
+    to be used with methods ``deserialize()`` and ``fromArray()``.

src/Context.php

@@ -13,6 +13,7 @@
 use JMS\Serializer\Exclusion\VersionExclusionStrategy;
 use JMS\Serializer\Metadata\ClassMetadata;
 use JMS\Serializer\Metadata\PropertyMetadata;
+use JMS\Serializer\Naming\PropertyNamingStrategyInterface;
 use Metadata\MetadataFactory;
 use Metadata\MetadataFactoryInterface;
 
@@ -54,6 +55,11 @@ abstract class Context
     /** @var \SplStack */
     private $metadataStack;
 
+    /**
+     * @var PropertyNamingStrategyInterface|null
+     */
+    private $propertyNamingStrategy = null;
+
     public function __construct()
     {
         $this->metadataStack = new \SplStack();
@@ -228,6 +234,20 @@ public function popPropertyMetadata(): void
         }
     }
 
+    public function setPropertyNamingStrategy(PropertyNamingStrategyInterface $propertyNamingStrategy): self
+    {
+        $this->assertMutable();
+
+        $this->propertyNamingStrategy = $propertyNamingStrategy;
+
+        return $this;
+    }
+
+    public function getPropertyNamingStrategy(): ?PropertyNamingStrategyInterface
+    {
+        return $this->propertyNamingStrategy;
+    }
+
     public function popClassMetadata(): void
     {
         $metadata = $this->metadataStack->pop();

src/GraphNavigator/DeserializationGraphNavigator.php

@@ -209,13 +209,20 @@ public function accept($data, ?array $type = null)
                         continue;
                     }
 
-                    $this->context->pushPropertyMetadata($propertyMetadata);
+                    /** Metadata changes based on context, should not be cached  */
+                    $contextSpecificMetadata = $propertyMetadata;
+                    if (null !== $this->context->getPropertyNamingStrategy()) {
+                        $contextSpecificMetadata = clone $propertyMetadata;
+                        $contextSpecificMetadata->serializedName = $this->context->getPropertyNamingStrategy()->translateName($propertyMetadata);
+                    }
+
+                    $this->context->pushPropertyMetadata($contextSpecificMetadata);
                     try {
-                        $v = $this->visitor->visitProperty($propertyMetadata, $data);
-                        $this->accessor->setValue($object, $v, $propertyMetadata, $this->context);
+                        $v = $this->visitor->visitProperty($contextSpecificMetadata, $data);
+                        $this->accessor->setValue($object, $v, $contextSpecificMetadata, $this->context);
                     } catch (NotAcceptableException $e) {
-                        if (true === $propertyMetadata->hasDefault) {
-                            $this->accessor->setValue($object, $propertyMetadata->defaultValue, $propertyMetadata, $this->context);
+                        if (true === $contextSpecificMetadata->hasDefault) {
+                            $this->accessor->setValue($object, $contextSpecificMetadata->defaultValue, $contextSpecificMetadata, $this->context);
                         }
                     }
 

src/GraphNavigator/SerializationGraphNavigator.php

@@ -257,8 +257,15 @@ public function accept($data, ?array $type = null)
                         continue;
                     }
 
+                    /** Metadata changes based on context, should not be cached  */
+                    $contextSpecificMetadata = $propertyMetadata;
+                    if (null !== $this->context->getPropertyNamingStrategy()) {
+                        $contextSpecificMetadata = clone $propertyMetadata;
+                        $contextSpecificMetadata->serializedName = $this->context->getPropertyNamingStrategy()->translateName($propertyMetadata);
+                    }
+
                     try {
-                        $v = $this->accessor->getValue($data, $propertyMetadata, $this->context);
+                        $v = $this->accessor->getValue($data, $contextSpecificMetadata, $this->context);
                     } catch (UninitializedPropertyException $e) {
                         continue;
                     }
@@ -267,8 +274,8 @@ public function accept($data, ?array $type = null)
                         continue;
                     }
 
-                    $this->context->pushPropertyMetadata($propertyMetadata);
-                    $this->visitor->visitProperty($propertyMetadata, $v);
+                    $this->context->pushPropertyMetadata($contextSpecificMetadata);
+                    $this->visitor->visitProperty($contextSpecificMetadata, $v);
                     $this->context->popPropertyMetadata();
                 }
 

src/Metadata/PropertyMetadata.php

@@ -33,6 +33,11 @@ class PropertyMetadata extends BasePropertyMetadata
      */
     public $serializedName;
 
+    /**
+     * @var string|null
+     */
+    public $preContextSerializedName;
+
     /**
      * @var array|null
      */

tests/Benchmark/JsonContextNamingSerializationBench.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace JMS\Serializer\Tests\Benchmark;
+
+use JMS\Serializer\Naming\IdenticalPropertyNamingStrategy;
+use JMS\Serializer\SerializationContext;
+
+class JsonContextNamingSerializationBench extends JsonSerializationBench
+{
+    protected function createContext(): SerializationContext
+    {
+        return parent::createContext()->setPropertyNamingStrategy(new IdenticalPropertyNamingStrategy());
+    }
+}

tests/Fixtures/CustomDeserializationObject.php

@@ -4,14 +4,14 @@
 
 namespace JMS\Serializer\Tests\Fixtures;
 
-use JMS\Serializer\Annotation\Type;
+use JMS\Serializer\Annotation as Serializer;
 
 class CustomDeserializationObject
 {
     /**
-     * @Type("string")
+     * @Serializer\Type("string")
      */
-    #[Type(name: 'string')]
+    #[Serializer\Type(name: 'string')]
     public $someProperty;
 
     public function __construct($value)

tests/Fixtures/CustomDeserializationObjectWithInnerClass.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace JMS\Serializer\Tests\Fixtures;
+
+use JMS\Serializer\Annotation as Serializer;
+
+class CustomDeserializationObjectWithInnerClass
+{
+    /**
+     * @Serializer\Type("JMS\Serializer\Tests\Fixtures\CustomDeserializationObject")
+     */
+    #[Serializer\Type(name: CustomDeserializationObject::class)]
+    private $someProperty;
+
+    public function __construct(CustomDeserializationObject $value)
+    {
+        $this->someProperty = $value;
+    }
+}

tests/Fixtures/CustomDeserializationObjectWithSerializedName.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace JMS\Serializer\Tests\Fixtures;
+
+use JMS\Serializer\Annotation as Serializer;
+
+class CustomDeserializationObjectWithSerializedName
+{
+    /**
+     * @Serializer\Type("string")
+     * @Serializer\SerializedName("name")
+     */
+    #[Serializer\Type(name: 'string')]
+    #[Serializer\SerializedName(name: 'name')]
+    public $someProperty;
+
+    public function __construct($value)
+    {
+        $this->someProperty = $value;
+    }
+}

tests/SerializerBuilderTest.php

@@ -8,8 +8,14 @@
 use JMS\Serializer\Exception\UnsupportedFormatException;
 use JMS\Serializer\Expression\ExpressionEvaluator;
 use JMS\Serializer\Handler\HandlerRegistry;
+use JMS\Serializer\Naming\CamelCaseNamingStrategy;
+use JMS\Serializer\Naming\IdenticalPropertyNamingStrategy;
+use JMS\Serializer\Naming\SerializedNameAnnotationStrategy;
 use JMS\Serializer\SerializationContext;
 use JMS\Serializer\SerializerBuilder;
+use JMS\Serializer\Tests\Fixtures\CustomDeserializationObject;
+use JMS\Serializer\Tests\Fixtures\CustomDeserializationObjectWithInnerClass;
+use JMS\Serializer\Tests\Fixtures\CustomDeserializationObjectWithSerializedName;
 use JMS\Serializer\Tests\Fixtures\DocBlockType\Collection\Details\ProductDescription;
 use JMS\Serializer\Tests\Fixtures\DocBlockType\SingleClassFromDifferentNamespaceTypeHint;
 use JMS\Serializer\Tests\Fixtures\PersonSecret;
@@ -201,6 +207,116 @@ public function testSetCallbackSerializationContextWithNotSerializeNull()
         self::assertEquals('{"not_null":"ok"}', $result);
     }
 
+    public function testSetCallbackSerializationContextWithIdenticalPropertyNamingStrategy()
+    {
+        $this->builder->setSerializationContextFactory(static function () {
+            return SerializationContext::create()
+                ->setPropertyNamingStrategy(new IdenticalPropertyNamingStrategy());
+        });
+        $this->builder->setDeserializationContextFactory(static function () {
+            return DeserializationContext::create()
+                ->setPropertyNamingStrategy(new IdenticalPropertyNamingStrategy());
+        });
+
+        $serializer = $this->builder
+            ->build();
+
+        $object = new CustomDeserializationObject('johny');
+        $json = '{"someProperty":"johny"}';
+
+        self::assertEquals($json, $serializer->serialize($object, 'json'));
+        self::assertEquals($object, $serializer->deserialize($json, get_class($object), 'json'));
+    }
+
+    public function testUsingNoSerializationContextInSecondRun()
+    {
+        $serializer = $this->builder->build();
+        $object = new CustomDeserializationObjectWithSerializedName('johny');
+
+        $jsonWithCamelCase = '{"someProperty":"johny"}';
+        self::assertEquals($jsonWithCamelCase, $serializer->serialize($object, 'json', SerializationContext::create()->setPropertyNamingStrategy(new IdenticalPropertyNamingStrategy())));
+        self::assertEquals($object, $serializer->deserialize($jsonWithCamelCase, get_class($object), 'json', DeserializationContext::create()->setPropertyNamingStrategy(new IdenticalPropertyNamingStrategy())));
+
+        $jsonWithUnderscores = '{"name":"johny"}';
+        self::assertEquals($jsonWithUnderscores, $serializer->serialize($object, 'json'));
+        self::assertEquals($object, $serializer->deserialize($jsonWithUnderscores, get_class($object), 'json'));
+    }
+
+    public function testUsingSerializedNameStrategyInContext()
+    {
+        $serializer = $this->builder->build();
+        $object = new CustomDeserializationObjectWithSerializedName('johny');
+
+        $jsonWithUnderscores = '{"name":"johny"}';
+        self::assertEquals($jsonWithUnderscores, $serializer->serialize(
+            $object,
+            'json',
+            SerializationContext::create()->setPropertyNamingStrategy(new SerializedNameAnnotationStrategy(new IdenticalPropertyNamingStrategy()))
+        ));
+        self::assertEquals($object, $serializer->deserialize(
+            $jsonWithUnderscores,
+            get_class($object),
+            'json',
+            DeserializationContext::create()->setPropertyNamingStrategy(new SerializedNameAnnotationStrategy(new IdenticalPropertyNamingStrategy()))
+        ));
+    }
+
+    public function testSetCallbackSerializationContextWithCamelCaseStrategy()
+    {
+        $this->builder->setSerializationContextFactory(static function () {
+            return SerializationContext::create()
+                ->setPropertyNamingStrategy(new CamelCaseNamingStrategy());
+        });
+
+        $serializer = $this->builder
+            ->build();
+
+        $object = new CustomDeserializationObject('johny');
+        $json = '{"some_property":"johny"}';
+
+        self::assertEquals($json, $serializer->serialize($object, 'json'));
+        self::assertEquals($object, $serializer->deserialize($json, get_class($object), 'json'));
+    }
+
+    public function testSetCallbackSerializationContextOverridingDefaultStrategy()
+    {
+        $this->builder->setSerializationContextFactory(static function () {
+            return SerializationContext::create()
+                ->setPropertyNamingStrategy(new IdenticalPropertyNamingStrategy());
+        });
+        $this->builder->setDeserializationContextFactory(static function () {
+            return DeserializationContext::create()
+                ->setPropertyNamingStrategy(new IdenticalPropertyNamingStrategy());
+        });
+
+        $serializer = $this->builder
+            ->setPropertyNamingStrategy(new CamelCaseNamingStrategy())
+            ->build();
+
+        $object = new CustomDeserializationObject('johny');
+        $json = '{"someProperty":"johny"}';
+
+        self::assertEquals($json, $serializer->serialize($object, 'json'));
+        self::assertEquals($object, $serializer->deserialize($json, get_class($object), 'json'));
+    }
+
+    public function testSetCallbackSerializationContextWithIdenticalPropertyNamingForInnerClass()
+    {
+        $this->builder->setSerializationContextFactory(static function () {
+            return SerializationContext::create()
+                ->setPropertyNamingStrategy(new CamelCaseNamingStrategy());
+        });
+
+        $serializer = $this->builder
+            ->build();
+
+        $object = new CustomDeserializationObjectWithInnerClass(new CustomDeserializationObject('johny'));
+        $json = '{"some_property":{"some_property":"johny"}}';
+
+        self::assertEquals($json, $serializer->serialize($object, 'json'));
+        self::assertEquals($object, $serializer->deserialize($json, get_class($object), 'json'));
+    }
+
     public function expressionFunctionProvider()
     {
         return [