mirror of
https://github.com/danog/Valinor.git
synced 2024-12-02 09:37:46 +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.
69 lines
1.8 KiB
PHP
69 lines
1.8 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace CuyZ\Valinor\QA\Psalm\Plugin;
|
|
|
|
use CuyZ\Valinor\Mapper\TreeMapper;
|
|
use Psalm\Plugin\EventHandler\Event\MethodReturnTypeProviderEvent;
|
|
use Psalm\Plugin\EventHandler\MethodReturnTypeProviderInterface;
|
|
use Psalm\Type;
|
|
use Psalm\Type\Atomic;
|
|
use Psalm\Type\Atomic\TClassString;
|
|
use Psalm\Type\Atomic\TDependentGetClass;
|
|
use Psalm\Type\Atomic\TLiteralString;
|
|
use Psalm\Type\Union;
|
|
|
|
final class TreeMapperPsalmPlugin implements MethodReturnTypeProviderInterface
|
|
{
|
|
public static function getClassLikeNames(): array
|
|
{
|
|
return [TreeMapper::class];
|
|
}
|
|
|
|
public static function getMethodReturnType(MethodReturnTypeProviderEvent $event): ?Union
|
|
{
|
|
if ($event->getMethodNameLowercase() !== 'map') {
|
|
return null;
|
|
}
|
|
|
|
$type = $event->getSource()->getNodeTypeProvider()->getType($event->getCallArgs()[0]->value);
|
|
|
|
if (! $type) {
|
|
return null;
|
|
}
|
|
|
|
$types = [];
|
|
|
|
foreach ($type->getChildNodes() as $node) {
|
|
$inferred = self::type($node);
|
|
|
|
if ($inferred === null) {
|
|
return null;
|
|
}
|
|
|
|
$types[] = $inferred;
|
|
}
|
|
|
|
if (count($types) === 0) {
|
|
return null;
|
|
}
|
|
|
|
return Type::combineUnionTypeArray($types, $event->getSource()->getCodebase());
|
|
}
|
|
|
|
private static function type(Atomic $node): ?Union
|
|
{
|
|
switch (true) {
|
|
case $node instanceof TLiteralString:
|
|
return Type::parseString($node->value);
|
|
case $node instanceof TDependentGetClass:
|
|
return $node->as_type;
|
|
case $node instanceof TClassString && $node->as_type:
|
|
return new Union([$node->as_type]);
|
|
default:
|
|
return null;
|
|
}
|
|
}
|
|
}
|