Valinor/tests/Integration/Mapping/Object/ArrayValuesMappingTest.php
Romain Canon b2e810e3ce feat!: allow mapping to any type
Previously, the method `TreeMapper::map` would allow mapping only to an
object. It is now possible to map to any type handled by the library.

It is for instance possible to map to an array of objects:

```php
$objects = (new \CuyZ\Valinor\MapperBuilder())->mapper()->map(
    'array<' . SomeClass::class . '>',
    [/* … */]
);
```

For simple use-cases, an array shape can be used:

```php
$array = (new \CuyZ\Valinor\MapperBuilder())->mapper()->map(
    'array{foo: string, bar: int}',
    [/* … */]
);

echo strtolower($array['foo']);
echo $array['bar'] * 2;
```

This new feature changes the possible behaviour of the mapper, meaning
static analysis tools need help to understand the types correctly. An
extension for PHPStan and a plugin for Psalm are now provided and can be
included in a project to automatically increase the type coverage.
2022-01-02 00:48:01 +01:00

202 lines
8.1 KiB
PHP

<?php
declare(strict_types=1);
namespace CuyZ\Valinor\Tests\Integration\Mapping\Object;
use CuyZ\Valinor\Mapper\MappingError;
use CuyZ\Valinor\Mapper\Tree\Exception\CannotCastToScalarValue;
use CuyZ\Valinor\Mapper\Tree\Exception\InvalidNodeValue;
use CuyZ\Valinor\Tests\Integration\IntegrationTest;
use CuyZ\Valinor\Tests\Integration\Mapping\Fixture\SimpleObject;
use CuyZ\Valinor\Tests\Integration\Mapping\Fixture\SimpleObject as SimpleObjectAlias;
use Throwable;
final class ArrayValuesMappingTest extends IntegrationTest
{
public function test_values_are_mapped_properly(): void
{
$source = [
'booleans' => [true, false, true],
'floats' => [42.404, 404.42],
'integers' => [42, 404, 1337],
'strings' => ['foo', 'bar', 'baz'],
'arrayWithDefaultKeyType' => [42 => 'foo', 'some-key' => 'bar'],
'arrayWithIntegerKeyType' => [1337 => 'foo', 42.0 => 'bar', '404' => 'baz'],
'arrayWithStringKeyType' => [1337 => 'foo', 42.0 => 'bar', 'some-key' => 'baz'],
'simpleArray' => [42 => 'foo', 'some-key' => 'bar'],
'objects' => [
'foo' => ['value' => 'foo'],
'bar' => ['value' => 'bar'],
'baz' => ['value' => 'baz'],
],
'objectsWithAlias' => [
'foo' => ['value' => 'foo'],
'bar' => ['value' => 'bar'],
'baz' => ['value' => 'baz'],
],
'nonEmptyArraysOfStrings' => ['foo', 'bar', 'baz'],
'nonEmptyArrayWithDefaultKeyType' => [42 => 'foo', 'some-key' => 'bar'],
'nonEmptyArrayWithIntegerKeyType' => [1337 => 'foo', 42.0 => 'bar', '404' => 'baz'],
'nonEmptyArrayWithStringKeyType' => [1337 => 'foo', 42.0 => 'bar', 'some-key' => 'baz'],
];
foreach ([ArrayValues::class, ArrayValuesWithConstructor::class] as $class) {
try {
$result = $this->mapperBuilder->mapper()->map($class, $source);
} catch (MappingError $error) {
$this->mappingFail($error);
}
self::assertSame($source['booleans'], $result->booleans);
self::assertSame($source['floats'], $result->floats);
self::assertSame($source['integers'], $result->integers);
self::assertSame($source['strings'], $result->strings);
self::assertSame($source['arrayWithDefaultKeyType'], $result->arrayWithDefaultKeyType);
self::assertSame($source['arrayWithIntegerKeyType'], $result->arrayWithIntegerKeyType);
self::assertSame($source['arrayWithStringKeyType'], $result->arrayWithStringKeyType);
self::assertSame($source['simpleArray'], $result->simpleArray);
self::assertSame('foo', $result->objects['foo']->value);
self::assertSame('bar', $result->objects['bar']->value);
self::assertSame('baz', $result->objects['baz']->value);
self::assertSame('foo', $result->objectsWithAlias['foo']->value);
self::assertSame('bar', $result->objectsWithAlias['bar']->value);
self::assertSame('baz', $result->objectsWithAlias['baz']->value);
self::assertSame($source['nonEmptyArraysOfStrings'], $result->nonEmptyArraysOfStrings);
self::assertSame($source['nonEmptyArrayWithDefaultKeyType'], $result->nonEmptyArrayWithDefaultKeyType);
self::assertSame($source['nonEmptyArrayWithIntegerKeyType'], $result->nonEmptyArrayWithIntegerKeyType);
self::assertSame($source['nonEmptyArrayWithStringKeyType'], $result->nonEmptyArrayWithStringKeyType);
}
}
public function test_empty_array_in_non_empty_array_throws_exception(): void
{
try {
$this->mapperBuilder->mapper()->map(ArrayValues::class, [
'nonEmptyArraysOfStrings' => [],
]);
} catch (MappingError $exception) {
$error = $exception->node()->children()['nonEmptyArraysOfStrings']->messages()[0];
assert($error instanceof Throwable);
self::assertInstanceOf(InvalidNodeValue::class, $error);
self::assertSame(1630678334, $error->getCode());
self::assertSame('Empty array is not accepted by `non-empty-array<string>`.', $error->getMessage());
}
}
public function test_value_that_cannot_be_casted_throws_exception(): void
{
try {
$this->mapperBuilder->mapper()->map(ArrayValues::class, [
'integers' => ['foo'],
]);
} catch (MappingError $exception) {
$error = $exception->node()->children()['integers']->children()[0]->messages()[0];
assert($error instanceof Throwable);
self::assertInstanceOf(CannotCastToScalarValue::class, $error);
self::assertSame(1618736242, $error->getCode());
self::assertSame('Cannot cast value of type `string` to `int`.', $error->getMessage());
}
}
}
class ArrayValues
{
/** @var array<bool> */
public array $booleans;
/** @var array<float> */
public array $floats;
/** @var array<int> */
public array $integers;
/** @var array<string> */
public array $strings;
/** @var array<array-key, string> */
public array $arrayWithDefaultKeyType;
/** @var array<int, string> */
public array $arrayWithIntegerKeyType;
/** @var array<string, string> */
public array $arrayWithStringKeyType;
/** @var string[] */
public array $simpleArray;
/** @var array<SimpleObject> */
public array $objects;
/** @var array<SimpleObjectAlias> */
public array $objectsWithAlias;
/** @var non-empty-array<string> */
public array $nonEmptyArraysOfStrings = ['foo'];
/** @var non-empty-array<array-key, string> */
public array $nonEmptyArrayWithDefaultKeyType = ['foo'];
/** @var non-empty-array<int, string> */
public array $nonEmptyArrayWithIntegerKeyType = ['foo'];
/** @var non-empty-array<string, string> */
public array $nonEmptyArrayWithStringKeyType = ['foo' => 'bar'];
}
class ArrayValuesWithConstructor extends ArrayValues
{
/**
* @param array<bool> $booleans
* @param array<float> $floats
* @param array<int> $integers
* @param array<string> $strings
* @param array<array-key, string> $arrayWithDefaultKeyType
* @param array<int, string> $arrayWithIntegerKeyType
* @param array<string, string> $arrayWithStringKeyType
* @param string[] $simpleArray
* @param array<SimpleObject> $objects
* @param array<SimpleObjectAlias> $objectsWithAlias
* @param non-empty-array<string> $nonEmptyArraysOfStrings
* @param non-empty-array<array-key, string> $nonEmptyArrayWithDefaultKeyType
* @param non-empty-array<int, string> $nonEmptyArrayWithIntegerKeyType
* @param non-empty-array<string, string> $nonEmptyArrayWithStringKeyType
*/
public function __construct(
array $booleans,
array $floats,
array $integers,
array $strings,
array $arrayWithDefaultKeyType,
array $arrayWithIntegerKeyType,
array $arrayWithStringKeyType,
array $simpleArray,
array $objects,
array $objectsWithAlias,
array $nonEmptyArraysOfStrings,
array $nonEmptyArrayWithDefaultKeyType,
array $nonEmptyArrayWithIntegerKeyType,
array $nonEmptyArrayWithStringKeyType
) {
$this->booleans = $booleans;
$this->floats = $floats;
$this->integers = $integers;
$this->strings = $strings;
$this->arrayWithDefaultKeyType = $arrayWithDefaultKeyType;
$this->arrayWithIntegerKeyType = $arrayWithIntegerKeyType;
$this->arrayWithStringKeyType = $arrayWithStringKeyType;
$this->simpleArray = $simpleArray;
$this->objects = $objects;
$this->objectsWithAlias = $objectsWithAlias;
$this->nonEmptyArraysOfStrings = $nonEmptyArraysOfStrings;
$this->nonEmptyArrayWithDefaultKeyType = $nonEmptyArrayWithDefaultKeyType;
$this->nonEmptyArrayWithIntegerKeyType = $nonEmptyArrayWithIntegerKeyType;
$this->nonEmptyArrayWithStringKeyType = $nonEmptyArrayWithStringKeyType;
}
}