mirror of
https://github.com/danog/Valinor.git
synced 2024-11-27 04:34:48 +01:00
b2e810e3ce
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.
233 lines
11 KiB
PHP
233 lines
11 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace CuyZ\Valinor\Tests\Integration\Mapping\Object;
|
|
|
|
use CuyZ\Valinor\Mapper\MappingError;
|
|
use CuyZ\Valinor\Tests\Integration\IntegrationTest;
|
|
use CuyZ\Valinor\Tests\Integration\Mapping\Fixture\SimpleObject;
|
|
use CuyZ\Valinor\Tests\Integration\Mapping\Fixture\SimpleObject as SimpleObjectAlias;
|
|
|
|
final class GenericValuesMappingTest extends IntegrationTest
|
|
{
|
|
public function test_values_are_mapped_properly(): void
|
|
{
|
|
$source = [
|
|
'genericWithBoolean' => ['value' => true],
|
|
'genericWithFloat' => ['value' => 42.404],
|
|
'genericWithInteger' => ['value' => 1337],
|
|
'genericWithIntegerValue' => ['value' => 1337],
|
|
'genericWithString' => ['value' => 'foo'],
|
|
'genericWithSingleQuoteStringValue' => ['value' => 'foo'],
|
|
'genericWithDoubleQuoteStringValue' => ['value' => 'foo'],
|
|
'genericWithArrayOfStrings' => ['value' => ['foo', 'bar', 'baz']],
|
|
'genericWithSimpleArrayOfStrings' => ['value' => ['foo', 'bar', 'baz']],
|
|
'genericWithUnionOfScalar' => ['value' => 'foo'],
|
|
'genericWithObject' => ['value' => ['value' => 'foo']],
|
|
'genericWithObjectAlias' => ['value' => ['value' => 'foo']],
|
|
'genericWithTwoTemplates' => [
|
|
'valueA' => 'foo',
|
|
'valueB' => 42,
|
|
],
|
|
'genericWithTwoTemplatesOnSeveralLines' => [
|
|
'valueA' => 'foo',
|
|
'valueB' => 42,
|
|
],
|
|
'genericWithSpecifiedTypeWithString' => ['value' => 'foo'],
|
|
'genericWithSpecifiedTypeWithObject' => ['value' => ['value' => 'foo']],
|
|
'genericWithSpecifiedTypeWithIntegerValue' => ['value' => 42],
|
|
'genericWithSpecifiedTypeWithStringValue' => ['value' => 'foo'],
|
|
];
|
|
|
|
foreach ([GenericValues::class, GenericValuesWithConstructor::class] as $class) {
|
|
try {
|
|
$result = $this->mapperBuilder->mapper()->map($class, $source);
|
|
} catch (MappingError $error) {
|
|
$this->mappingFail($error);
|
|
}
|
|
|
|
self::assertSame(true, $result->genericWithBoolean->value);
|
|
self::assertSame(42.404, $result->genericWithFloat->value);
|
|
self::assertSame(1337, $result->genericWithInteger->value);
|
|
self::assertSame(1337, $result->genericWithIntegerValue->value);
|
|
self::assertSame('foo', $result->genericWithString->value);
|
|
self::assertSame('foo', $result->genericWithSingleQuoteStringValue->value);
|
|
self::assertSame('foo', $result->genericWithDoubleQuoteStringValue->value);
|
|
self::assertSame(['foo', 'bar', 'baz'], $result->genericWithArrayOfStrings->value);
|
|
self::assertSame(['foo', 'bar', 'baz'], $result->genericWithSimpleArrayOfStrings->value);
|
|
self::assertSame('foo', $result->genericWithUnionOfScalar->value);
|
|
self::assertSame('foo', $result->genericWithObject->value->value);
|
|
self::assertSame('foo', $result->genericWithObjectAlias->value->value);
|
|
self::assertSame('foo', $result->genericWithTwoTemplates->valueA);
|
|
self::assertSame(42, $result->genericWithTwoTemplates->valueB);
|
|
self::assertSame('foo', $result->genericWithTwoTemplatesOnSeveralLines->valueA);
|
|
self::assertSame(42, $result->genericWithTwoTemplatesOnSeveralLines->valueB);
|
|
self::assertSame('foo', $result->genericWithSpecifiedTypeWithString->value);
|
|
self::assertSame('foo', $result->genericWithSpecifiedTypeWithObject->value->value);
|
|
self::assertSame(42, $result->genericWithSpecifiedTypeWithIntegerValue->value);
|
|
self::assertSame('foo', $result->genericWithSpecifiedTypeWithStringValue->value);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @template T
|
|
*/
|
|
final class GenericObjectWithOneTemplate
|
|
{
|
|
/** @var T */
|
|
public $value;
|
|
}
|
|
|
|
/**
|
|
* @template TemplateA
|
|
* @template TemplateB
|
|
*/
|
|
final class GenericObjectWithTwoTemplates
|
|
{
|
|
/** @var TemplateA */
|
|
public $valueA;
|
|
|
|
/** @var TemplateB */
|
|
public $valueB;
|
|
}
|
|
|
|
/**
|
|
* @phpstan-ignore-next-line
|
|
* @template T of string|object|42|'foo'
|
|
*/
|
|
final class GenericObjectWithSpecifiedType
|
|
{
|
|
/** @var T */
|
|
public $value;
|
|
}
|
|
|
|
class GenericValues
|
|
{
|
|
/** @var GenericObjectWithOneTemplate<bool> */
|
|
public GenericObjectWithOneTemplate $genericWithBoolean;
|
|
|
|
/** @var GenericObjectWithOneTemplate<float> */
|
|
public GenericObjectWithOneTemplate $genericWithFloat;
|
|
|
|
/** @var GenericObjectWithOneTemplate<int> */
|
|
public GenericObjectWithOneTemplate $genericWithInteger;
|
|
|
|
/** @var GenericObjectWithOneTemplate<1337> */
|
|
public GenericObjectWithOneTemplate $genericWithIntegerValue;
|
|
|
|
/** @var GenericObjectWithOneTemplate<string> */
|
|
public GenericObjectWithOneTemplate $genericWithString;
|
|
|
|
/** @var GenericObjectWithOneTemplate<'foo'> */
|
|
public GenericObjectWithOneTemplate $genericWithSingleQuoteStringValue;
|
|
|
|
/** @var GenericObjectWithOneTemplate<"foo"> */
|
|
public GenericObjectWithOneTemplate $genericWithDoubleQuoteStringValue;
|
|
|
|
/** @var GenericObjectWithOneTemplate<array<string>> */
|
|
public GenericObjectWithOneTemplate $genericWithArrayOfStrings;
|
|
|
|
/** @var GenericObjectWithOneTemplate<string[]> */
|
|
public GenericObjectWithOneTemplate $genericWithSimpleArrayOfStrings;
|
|
|
|
/** @var GenericObjectWithOneTemplate<bool|float|int|string> */
|
|
public GenericObjectWithOneTemplate $genericWithUnionOfScalar;
|
|
|
|
/** @var GenericObjectWithOneTemplate<SimpleObject> */
|
|
public GenericObjectWithOneTemplate $genericWithObject;
|
|
|
|
/** @var GenericObjectWithOneTemplate<SimpleObjectAlias> */
|
|
public GenericObjectWithOneTemplate $genericWithObjectAlias;
|
|
|
|
/** @var GenericObjectWithTwoTemplates<string, int> */
|
|
public GenericObjectWithTwoTemplates $genericWithTwoTemplates;
|
|
|
|
/**
|
|
* @var GenericObjectWithTwoTemplates<
|
|
* string,
|
|
* int
|
|
* >
|
|
*/
|
|
public GenericObjectWithTwoTemplates $genericWithTwoTemplatesOnSeveralLines;
|
|
|
|
/** @var GenericObjectWithSpecifiedType<string> */
|
|
public GenericObjectWithSpecifiedType $genericWithSpecifiedTypeWithString;
|
|
|
|
/** @var GenericObjectWithSpecifiedType<SimpleObject> */
|
|
public GenericObjectWithSpecifiedType $genericWithSpecifiedTypeWithObject;
|
|
|
|
/** @var GenericObjectWithSpecifiedType<42> */
|
|
public GenericObjectWithSpecifiedType $genericWithSpecifiedTypeWithIntegerValue;
|
|
|
|
/** @var GenericObjectWithSpecifiedType<'foo'> */
|
|
public GenericObjectWithSpecifiedType $genericWithSpecifiedTypeWithStringValue;
|
|
}
|
|
|
|
class GenericValuesWithConstructor extends GenericValues
|
|
{
|
|
/**
|
|
* @param GenericObjectWithOneTemplate<bool> $genericWithBoolean
|
|
* @param GenericObjectWithOneTemplate<float> $genericWithFloat
|
|
* @param GenericObjectWithOneTemplate<int> $genericWithInteger
|
|
* @param GenericObjectWithOneTemplate<1337> $genericWithIntegerValue
|
|
* @param GenericObjectWithOneTemplate<string> $genericWithString
|
|
* @param GenericObjectWithOneTemplate<'foo'> $genericWithSingleQuoteStringValue
|
|
* @param GenericObjectWithOneTemplate<"foo"> $genericWithDoubleQuoteStringValue
|
|
* @param GenericObjectWithOneTemplate<array<string>> $genericWithArrayOfStrings
|
|
* @param GenericObjectWithOneTemplate<string[]> $genericWithSimpleArrayOfStrings
|
|
* @param GenericObjectWithOneTemplate<bool|float|int|string> $genericWithUnionOfScalar
|
|
* @param GenericObjectWithOneTemplate<SimpleObject> $genericWithObject
|
|
* @param GenericObjectWithOneTemplate<SimpleObjectAlias> $genericWithObjectAlias
|
|
* @param GenericObjectWithTwoTemplates<string, int> $genericWithTwoTemplates
|
|
* @param GenericObjectWithTwoTemplates<
|
|
* string,
|
|
* int
|
|
* > $genericWithTwoTemplatesOnSeveralLines
|
|
* @param GenericObjectWithSpecifiedType<string> $genericWithSpecifiedTypeWithString
|
|
* @param GenericObjectWithSpecifiedType<SimpleObject> $genericWithSpecifiedTypeWithObject
|
|
* @param GenericObjectWithSpecifiedType<42> $genericWithSpecifiedTypeWithIntegerValue
|
|
* @param GenericObjectWithSpecifiedType<'foo'> $genericWithSpecifiedTypeWithStringValue
|
|
*/
|
|
public function __construct(
|
|
GenericObjectWithOneTemplate $genericWithBoolean,
|
|
GenericObjectWithOneTemplate $genericWithFloat,
|
|
GenericObjectWithOneTemplate $genericWithInteger,
|
|
GenericObjectWithOneTemplate $genericWithIntegerValue,
|
|
GenericObjectWithOneTemplate $genericWithString,
|
|
GenericObjectWithOneTemplate $genericWithSingleQuoteStringValue,
|
|
GenericObjectWithOneTemplate $genericWithDoubleQuoteStringValue,
|
|
GenericObjectWithOneTemplate $genericWithArrayOfStrings,
|
|
GenericObjectWithOneTemplate $genericWithSimpleArrayOfStrings,
|
|
GenericObjectWithOneTemplate $genericWithUnionOfScalar,
|
|
GenericObjectWithOneTemplate $genericWithObject,
|
|
GenericObjectWithOneTemplate $genericWithObjectAlias,
|
|
GenericObjectWithTwoTemplates $genericWithTwoTemplates,
|
|
GenericObjectWithTwoTemplates $genericWithTwoTemplatesOnSeveralLines,
|
|
GenericObjectWithSpecifiedType $genericWithSpecifiedTypeWithString,
|
|
GenericObjectWithSpecifiedType $genericWithSpecifiedTypeWithObject,
|
|
GenericObjectWithSpecifiedType $genericWithSpecifiedTypeWithIntegerValue,
|
|
GenericObjectWithSpecifiedType $genericWithSpecifiedTypeWithStringValue
|
|
) {
|
|
$this->genericWithBoolean = $genericWithBoolean;
|
|
$this->genericWithFloat = $genericWithFloat;
|
|
$this->genericWithInteger = $genericWithInteger;
|
|
$this->genericWithIntegerValue = $genericWithIntegerValue;
|
|
$this->genericWithString = $genericWithString;
|
|
$this->genericWithSingleQuoteStringValue = $genericWithSingleQuoteStringValue;
|
|
$this->genericWithDoubleQuoteStringValue = $genericWithDoubleQuoteStringValue;
|
|
$this->genericWithArrayOfStrings = $genericWithArrayOfStrings;
|
|
$this->genericWithSimpleArrayOfStrings = $genericWithSimpleArrayOfStrings;
|
|
$this->genericWithUnionOfScalar = $genericWithUnionOfScalar;
|
|
$this->genericWithObject = $genericWithObject;
|
|
$this->genericWithObjectAlias = $genericWithObjectAlias;
|
|
$this->genericWithTwoTemplates = $genericWithTwoTemplates;
|
|
$this->genericWithTwoTemplatesOnSeveralLines = $genericWithTwoTemplatesOnSeveralLines;
|
|
$this->genericWithSpecifiedTypeWithString = $genericWithSpecifiedTypeWithString;
|
|
$this->genericWithSpecifiedTypeWithObject = $genericWithSpecifiedTypeWithObject;
|
|
$this->genericWithSpecifiedTypeWithIntegerValue = $genericWithSpecifiedTypeWithIntegerValue;
|
|
$this->genericWithSpecifiedTypeWithStringValue = $genericWithSpecifiedTypeWithStringValue;
|
|
}
|
|
}
|