[Serializer] add UidNormalizer #36406
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| <?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\LogicException; | ||
| 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} | ||
| * | ||
| * @throws InvalidArgumentException | ||
|
|
||
| */ | ||
| public function normalize($object, string $format = null, array $context = []) | ||
| { | ||
| if (!$object instanceof AbstractUid) { | ||
|
There was a problem hiding this comment. The condition can be removed as the supports method garuantees that already. |
||
| 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} | ||
| * | ||
| * @throws NotNormalizableValueException | ||
|
|
||
| */ | ||
| public function denormalize($data, string $type, string $format = null, array $context = []) | ||
| { | ||
| if (!class_exists(AbstractUid::class)) { | ||
|
|
||
| throw new LogicException('You cannot use the "Symfony\Component\Serializer\Normalizer\UidNormalizer" as the Symfony Uid Component is not installed. Try running "composer require symfony/uid".'); | ||
| } | ||
|
|
||
| try { | ||
| $uid = Ulid::class === $type ? Ulid::fromString($data) : Uuid::fromString($data); | ||
guillbdx marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } catch (\InvalidArgumentException $exception) { | ||
| throw new NotNormalizableValueException('The data is not a valid '.$type.' string representation.'); | ||
|
|
||
| } | ||
|
|
||
| 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; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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)); | ||
| } | ||
| } | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can be removed