feature #38151 [Serializer] add UidNormalizer (guillbdx, norkunas)
This PR was merged into the 5.2-dev branch. Discussion ---------- [Serializer] add UidNormalizer | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | #36102 | License | MIT | Doc PR | symfony/symfony-docs#... <!-- required for new features --> UUID and ULID normalizer. Continuation of #36406 Commits -------d6a899395b
Update based on feedback1c21c78d25
UidNormalizer.
This commit is contained in:
commit
7192d29efc
@ -44,6 +44,7 @@ use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
|
||||
use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
|
||||
use Symfony\Component\Serializer\Normalizer\ProblemNormalizer;
|
||||
use Symfony\Component\Serializer\Normalizer\PropertyNormalizer;
|
||||
use Symfony\Component\Serializer\Normalizer\UidNormalizer;
|
||||
use Symfony\Component\Serializer\Normalizer\UnwrappingDenormalizer;
|
||||
use Symfony\Component\Serializer\Serializer;
|
||||
use Symfony\Component\Serializer\SerializerInterface;
|
||||
@ -106,6 +107,9 @@ return static function (ContainerConfigurator $container) {
|
||||
->args([service('serializer.property_accessor')])
|
||||
->tag('serializer.normalizer', ['priority' => 1000])
|
||||
|
||||
->set('serializer.normalizer.uid', UidNormalizer::class)
|
||||
->tag('serializer.normalizer', ['priority' => -915])
|
||||
|
||||
->set('serializer.normalizer.object', ObjectNormalizer::class)
|
||||
->args([
|
||||
service('serializer.mapping.class_metadata_factory'),
|
||||
|
@ -5,6 +5,7 @@ CHANGELOG
|
||||
-----
|
||||
|
||||
* added `CompiledClassMetadataFactory` and `ClassMetadataFactoryCompiler` for faster metadata loading.
|
||||
* added `UidNormalizer`
|
||||
|
||||
5.1.0
|
||||
-----
|
||||
|
@ -0,0 +1,71 @@
|
||||
<?php
|
||||
|
||||
/*
|
||||
* This file is part of the Symfony package.
|
||||
*
|
||||
* (c) Fabien Potencier <fabien@symfony.com>
|
||||
*
|
||||
* For the full copyright and license information, please view the LICENSE
|
||||
* file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace Symfony\Component\Serializer\Normalizer;
|
||||
|
||||
use Symfony\Component\Serializer\Exception\InvalidArgumentException;
|
||||
use Symfony\Component\Serializer\Exception\NotNormalizableValueException;
|
||||
use Symfony\Component\Uid\AbstractUid;
|
||||
use Symfony\Component\Uid\Ulid;
|
||||
use Symfony\Component\Uid\Uuid;
|
||||
|
||||
final class UidNormalizer implements NormalizerInterface, DenormalizerInterface, CacheableSupportsMethodInterface
|
||||
{
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function normalize($object, string $format = null, array $context = [])
|
||||
{
|
||||
if (!$object instanceof AbstractUid) {
|
||||
throw new InvalidArgumentException('The object must be an instance of "Symfony\Component\Uid\AbstractUid".');
|
||||
}
|
||||
|
||||
return (string) $object;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function supportsNormalization($data, string $format = null)
|
||||
{
|
||||
return $data instanceof AbstractUid;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function denormalize($data, string $type, string $format = null, array $context = [])
|
||||
{
|
||||
try {
|
||||
$uid = Ulid::class === $type ? Ulid::fromString($data) : Uuid::fromString($data);
|
||||
} catch (\InvalidArgumentException $exception) {
|
||||
throw new NotNormalizableValueException(sprintf('The data is not a valid "%s" string representation.', $type));
|
||||
}
|
||||
|
||||
return $uid;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function supportsDenormalization($data, string $type, string $format = null)
|
||||
{
|
||||
return is_a($type, AbstractUid::class, true);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function hasCacheableSupportsMethod(): bool
|
||||
{
|
||||
return __CLASS__ === static::class;
|
||||
}
|
||||
}
|
@ -0,0 +1,95 @@
|
||||
<?php
|
||||
|
||||
namespace Symfony\Component\Serializer\Tests\Normalizer;
|
||||
|
||||
use PHPUnit\Framework\TestCase;
|
||||
use Symfony\Component\Serializer\Exception\InvalidArgumentException;
|
||||
use Symfony\Component\Serializer\Normalizer\UidNormalizer;
|
||||
use Symfony\Component\Uid\AbstractUid;
|
||||
use Symfony\Component\Uid\Ulid;
|
||||
use Symfony\Component\Uid\Uuid;
|
||||
use Symfony\Component\Uid\UuidV1;
|
||||
use Symfony\Component\Uid\UuidV3;
|
||||
use Symfony\Component\Uid\UuidV4;
|
||||
use Symfony\Component\Uid\UuidV5;
|
||||
use Symfony\Component\Uid\UuidV6;
|
||||
|
||||
class UidNormalizerTest extends TestCase
|
||||
{
|
||||
/**
|
||||
* @var UidNormalizer
|
||||
*/
|
||||
private $normalizer;
|
||||
|
||||
protected function setUp(): void
|
||||
{
|
||||
$this->normalizer = new UidNormalizer();
|
||||
}
|
||||
|
||||
public function dataProvider()
|
||||
{
|
||||
return [
|
||||
['9b7541de-6f87-11ea-ab3c-9da9a81562fc', UuidV1::class],
|
||||
['e576629b-ff34-3642-9c08-1f5219f0d45b', UuidV3::class],
|
||||
['4126dbc1-488e-4f6e-aadd-775dcbac482e', UuidV4::class],
|
||||
['18cdf3d3-ea1b-5b23-a9c5-40abd0e2df22', UuidV5::class],
|
||||
['1ea6ecef-eb9a-66fe-b62b-957b45f17e43', UuidV6::class],
|
||||
['1ea6ecef-eb9a-66fe-b62b-957b45f17e43', AbstractUid::class],
|
||||
['01E4BYF64YZ97MDV6RH0HAMN6X', Ulid::class],
|
||||
];
|
||||
}
|
||||
|
||||
public function testSupportsNormalization()
|
||||
{
|
||||
$this->assertTrue($this->normalizer->supportsNormalization(Uuid::v1()));
|
||||
$this->assertTrue($this->normalizer->supportsNormalization(Uuid::v3(Uuid::v1(), 'foo')));
|
||||
$this->assertTrue($this->normalizer->supportsNormalization(Uuid::v4()));
|
||||
$this->assertTrue($this->normalizer->supportsNormalization(Uuid::v5(Uuid::v1(), 'foo')));
|
||||
$this->assertTrue($this->normalizer->supportsNormalization(Uuid::v6()));
|
||||
$this->assertTrue($this->normalizer->supportsNormalization(new Ulid()));
|
||||
$this->assertFalse($this->normalizer->supportsNormalization(new \stdClass()));
|
||||
}
|
||||
|
||||
/**
|
||||
* @dataProvider dataProvider
|
||||
*/
|
||||
public function testNormalize($uuidString, $class)
|
||||
{
|
||||
if (Ulid::class === $class) {
|
||||
$this->assertEquals($uuidString, $this->normalizer->normalize(Ulid::fromString($uuidString)));
|
||||
} else {
|
||||
$this->assertEquals($uuidString, $this->normalizer->normalize(Uuid::fromString($uuidString)));
|
||||
}
|
||||
}
|
||||
|
||||
public function testNormalizeForNonUid()
|
||||
{
|
||||
$this->expectException(InvalidArgumentException::class);
|
||||
$this->normalizer->normalize(new \stdClass());
|
||||
}
|
||||
|
||||
/**
|
||||
* @dataProvider dataProvider
|
||||
*/
|
||||
public function testSupportsDenormalization($uuidString, $class)
|
||||
{
|
||||
$this->assertTrue($this->normalizer->supportsDenormalization($uuidString, $class));
|
||||
}
|
||||
|
||||
public function testSupportsDenormalizationForNonUid()
|
||||
{
|
||||
$this->assertFalse($this->normalizer->supportsDenormalization('foo', \stdClass::class));
|
||||
}
|
||||
|
||||
/**
|
||||
* @dataProvider dataProvider
|
||||
*/
|
||||
public function testDenormalize($uuidString, $class)
|
||||
{
|
||||
if (Ulid::class === $class) {
|
||||
$this->assertEquals(new Ulid($uuidString), $this->normalizer->denormalize($uuidString, $class));
|
||||
} else {
|
||||
$this->assertEquals(Uuid::fromString($uuidString), $this->normalizer->denormalize($uuidString, $class));
|
||||
}
|
||||
}
|
||||
}
|
Reference in New Issue
Block a user