Skip to content

feat(unions): Add support for simple arrays #1571

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 3, 2024
Merged

feat(unions): Add support for simple arrays #1571

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a8b0e9
feat(unions): Add support for simple arrays
Nov 17, 2024
18f462f
Merge branch 'master' into union-properties-array
scyzoryck Dec 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions src/Handler/UnionHandler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,12 +115,15 @@ private function matchSimpleType(mixed $data, array $type, Context $context): mi

private function isPrimitiveType(string $type): bool
{
return in_array($type, ['int', 'integer', 'float', 'double', 'bool', 'boolean', 'string'], true);
return in_array($type, ['int', 'integer', 'float', 'double', 'bool', 'boolean', 'string', 'array'], true);
}

private function testPrimitive(mixed $data, string $type, string $format): bool
{
switch ($type) {
case 'array':
return is_array($data);

case 'integer':
case 'int':
return (string) (int) $data === (string) $data;
Expand All @@ -134,7 +137,7 @@ private function testPrimitive(mixed $data, string $type, string $format): bool
return (string) (bool) $data === (string) $data;

case 'string':
return (string) $data === (string) $data;
return is_string($data);
}

return false;
Expand Down
13 changes: 9 additions & 4 deletions src/Metadata/Driver/TypedPropertiesDriver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,9 @@ public function __construct(DriverInterface $delegate, ?ParserInterface $typePar
private function reorderTypes(array $types): array
{
uasort($types, static function ($a, $b) {
$order = ['null' => 0, 'true' => 1, 'false' => 2, 'bool' => 3, 'int' => 4, 'float' => 5, 'string' => 6];
$order = ['null' => 0, 'true' => 1, 'false' => 2, 'bool' => 3, 'int' => 4, 'float' => 5, 'array' => 6, 'string' => 7];
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the more I look at this the more I think that it would make sense to use the order used in the code (by looking at how the union types are declared) rather that having our own way of sorting.

is there a reason for not doing it?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see 2 risks:

  • the order might be forced by Code Formatters, so coding style might impact Serializer behavior. Not sure if such linter exists.
  • It might be confusing why int|string gives different result than string|int.
    Moved into Union Types - code/tests improvements #1576 as an idea for the future.


return ($order[$a['name']] ?? 7) <=> ($order[$b['name']] ?? 7);
return ($order[$a['name']] ?? 8) <=> ($order[$b['name']] ?? 8);
});

return $types;
Expand Down Expand Up @@ -119,7 +119,7 @@ public function loadMetadataForClass(ReflectionClass $class): ?ClassMetadata
$this->reorderTypes(
array_map(
fn (string $type) => $this->typeParser->parse($type),
array_filter($reflectionType->getTypes(), [$this, 'shouldTypeHint']),
array_filter($reflectionType->getTypes(), [$this, 'shouldTypeHintInsideUnion']),
),
),
],
Expand Down Expand Up @@ -181,11 +181,16 @@ private function shouldTypeHintUnion(?ReflectionType $reflectionType)
}

foreach ($reflectionType->getTypes() as $type) {
if ($this->shouldTypeHint($type)) {
if ($this->shouldTypeHintInsideUnion($type)) {
return true;
}
}

return false;
}

private function shouldTypeHintInsideUnion(ReflectionNamedType $reflectionType)
{
return $this->shouldTypeHint($reflectionType) || 'array' === $reflectionType->getName();
}
}
2 changes: 1 addition & 1 deletion tests/Fixtures/TypedProperties/UnionTypedProperties.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

class UnionTypedProperties
{
private int|bool|float|string $data;
private int|bool|float|string|array $data;

private int|bool|float|string|null $nullableData;

Expand Down
4 changes: 4 additions & 0 deletions tests/Metadata/Driver/UnionTypedPropertiesDriverTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ public function testInferUnionTypesShouldResultInManyTypes()
'params' =>
[
[
[
'name' => 'array',
'params' => [],
],
[
'name' => 'string',
'params' => [],
Expand Down
45 changes: 15 additions & 30 deletions tests/Serializer/JsonSerializationTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,7 @@ protected static function getContent($key)
$outputs['data_float'] = '{"data":1.236}';
$outputs['data_bool'] = '{"data":false}';
$outputs['data_string'] = '{"data":"foo"}';
$outputs['data_array'] = '{"data":[1,2,3]}';
$outputs['data_true'] = '{"data":true}';
$outputs['data_false'] = '{"data":false}';
$outputs['data_author'] = '{"data":{"full_name":"foo"}}';
Expand Down Expand Up @@ -443,46 +444,30 @@ public static function getTypeHintedArraysAndStdClass()
];
}

public function testDeserializingUnionProperties()
public static function getSimpleUnionProperties(): iterable
{
if (PHP_VERSION_ID < 80000) {
$this->markTestSkipped(sprintf('%s requires PHP 8.0', TypedPropertiesDriver::class));

return;
}

$object = new UnionTypedProperties(10000);
self::assertEquals($object, $this->deserialize(static::getContent('data_integer'), UnionTypedProperties::class));

$object = new UnionTypedProperties(1.236);
self::assertEquals($object, $this->deserialize(static::getContent('data_float'), UnionTypedProperties::class));

$object = new UnionTypedProperties(false);
self::assertEquals($object, $this->deserialize(static::getContent('data_bool'), UnionTypedProperties::class));

$object = new UnionTypedProperties('foo');
self::assertEquals($object, $this->deserialize(static::getContent('data_string'), UnionTypedProperties::class));
yield 'int' => [10000, 'data_integer'];
yield [1.236, 'data_float'];
yield [false, 'data_bool'];
yield ['foo', 'data_string'];
yield [[1, 2, 3], 'data_array'];
}

public function testSerializingUnionProperties()
/**
* @dataProvider getSimpleUnionProperties
*/
#[DataProvider('getSimpleUnionProperties')]
public function testUnionProperties($data, string $expected): void
{
if (PHP_VERSION_ID < 80000) {
$this->markTestSkipped(sprintf('%s requires PHP 8.0', TypedPropertiesDriver::class));

return;
}

$serialized = $this->serialize(new UnionTypedProperties(10000));
self::assertEquals(static::getContent('data_integer'), $serialized);

$serialized = $this->serialize(new UnionTypedProperties(1.236));
self::assertEquals(static::getContent('data_float'), $serialized);

$serialized = $this->serialize(new UnionTypedProperties(false));
self::assertEquals(static::getContent('data_bool'), $serialized);

$serialized = $this->serialize(new UnionTypedProperties('foo'));
self::assertEquals(static::getContent('data_string'), $serialized);
$object = new UnionTypedProperties($data);
self::assertEquals($object, $this->deserialize(static::getContent($expected), UnionTypedProperties::class));
self::assertEquals($this->serialize($object), static::getContent($expected));
}

public function testTrueDataType()
Expand Down
Loading