mirror of
https://github.com/danog/Valinor.git
synced 2025-01-10 06:38:24 +01:00
90dc586018
The mapper is now more type-sensitive and will fail in the following
situations:
- When a value does not match exactly the awaited scalar type, for
instance a string `"42"` given to a node that awaits an integer.
- When unnecessary array keys are present, for instance mapping an array
`['foo' => …, 'bar' => …, 'baz' => …]` to an object that needs only
`foo` and `bar`.
- When permissive types like `mixed` or `object` are encountered.
These limitations can be bypassed by enabling the flexible mode:
```php
(new \CuyZ\Valinor\MapperBuilder())
->flexible()
->mapper();
->map('array{foo: int, bar: bool}', [
'foo' => '42', // Will be cast from `string` to `int`
'bar' => 'true', // Will be cast from `string` to `bool`
'baz' => '…', // Will be ignored
]);
```
When using this library for a provider application — for instance an API
endpoint that can be called with a JSON payload — it is recommended to
use the strict mode. This ensures that the consumers of the API provide
the exact awaited data structure, and prevents unknown values to be
passed.
When using this library as a consumer of an external source, it can make
sense to enable the flexible mode. This allows for instance to convert
string numeric values to integers or to ignore data that is present in
the source but not needed in the application.
---
All these changes led to a new check that runs on all registered object
constructors. If a collision is found between several constructors that
have the same signature (the same parameter names), an exception will be
thrown.
```php
final class SomeClass
{
public static function constructorA(string $foo, string $bar): self
{
// …
}
public static function constructorB(string $foo, string $bar): self
{
// …
}
}
(new \CuyZ\Valinor\MapperBuilder())
->registerConstructor(
SomeClass::constructorA(...),
SomeClass::constructorB(...),
)
->mapper();
->map(SomeClass::class, [
'foo' => 'foo',
'bar' => 'bar',
]);
// Exception: A collision was detected […]
```
103 lines
3.0 KiB
PHP
103 lines
3.0 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace CuyZ\Valinor\Tests\Integration\Mapping\Object;
|
|
|
|
use CuyZ\Valinor\Mapper\MappingError;
|
|
use CuyZ\Valinor\MapperBuilder;
|
|
use CuyZ\Valinor\Tests\Integration\IntegrationTest;
|
|
use CuyZ\Valinor\Tests\Integration\Mapping\Fixture\SimpleObject;
|
|
use stdClass;
|
|
|
|
final class ObjectValuesMappingTest extends IntegrationTest
|
|
{
|
|
public function test_values_are_mapped_properly(): void
|
|
{
|
|
$source = [
|
|
'string' => 'foo',
|
|
'object' => [
|
|
'value' => 'foo',
|
|
],
|
|
];
|
|
|
|
foreach ([ObjectValues::class, ObjectValuesWithConstructor::class] as $class) {
|
|
try {
|
|
$result = (new MapperBuilder())->mapper()->map($class, $source);
|
|
} catch (MappingError $error) {
|
|
$this->mappingFail($error);
|
|
}
|
|
|
|
self::assertSame('foo', $result->object->value);
|
|
}
|
|
}
|
|
|
|
public function test_invalid_iterable_source_throws_exception(): void
|
|
{
|
|
$source = 'foo';
|
|
|
|
foreach ([ObjectValues::class, ObjectValuesWithConstructor::class] as $class) {
|
|
try {
|
|
(new MapperBuilder())->mapper()->map($class, $source);
|
|
} catch (MappingError $exception) {
|
|
$error = $exception->node()->messages()[0];
|
|
|
|
self::assertSame('1632903281', $error->code());
|
|
self::assertSame("Value 'foo' does not match type `array{object: ?, string: string}`.", (string)$error);
|
|
}
|
|
}
|
|
}
|
|
|
|
public function test_unexpected_key_throws_exception(): void
|
|
{
|
|
try {
|
|
(new MapperBuilder())->mapper()->map(ObjectWithTwoProperties::class, [
|
|
'stringA' => 'fooA',
|
|
'stringB' => 'fooB',
|
|
'unexpectedValueA' => 'foo',
|
|
'unexpectedValueB' => 'bar',
|
|
]);
|
|
} catch (MappingError $exception) {
|
|
$error = $exception->node()->messages()[0];
|
|
|
|
self::assertSame('1655149208', $error->code());
|
|
self::assertSame('Unexpected key(s) `unexpectedValueA`, `unexpectedValueB`, expected `stringA`, `stringB`.', (string)$error);
|
|
}
|
|
}
|
|
|
|
public function test_object_with_no_argument_build_with_non_array_source_throws_exception(): void
|
|
{
|
|
try {
|
|
(new MapperBuilder())->mapper()->map(stdClass::class, 'foo');
|
|
} catch (MappingError $exception) {
|
|
$error = $exception->node()->messages()[0];
|
|
|
|
self::assertSame('1632903281', $error->code());
|
|
self::assertSame("Value 'foo' does not match type array.", (string)$error);
|
|
}
|
|
}
|
|
}
|
|
|
|
class ObjectValues
|
|
{
|
|
public SimpleObject $object;
|
|
|
|
public string $string;
|
|
}
|
|
|
|
class ObjectValuesWithConstructor extends ObjectValues
|
|
{
|
|
public function __construct(SimpleObject $object, string $string)
|
|
{
|
|
$this->object = $object;
|
|
$this->string = $string;
|
|
}
|
|
}
|
|
|
|
final class ObjectWithTwoProperties
|
|
{
|
|
public string $stringA;
|
|
|
|
public string $stringB;
|
|
}
|