Skip to content

[PHPStanStaticTypeMapper] Make use of toPhpDocNode() on ObjectTypeMapper #4581

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
samsonasik merged 15 commits into from
Jul 25, 2023
Merged

[PHPStanStaticTypeMapper] Make use of toPhpDocNode() on ObjectTypeMapper #4581

Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
e95d2af
[PHPStanStaticTypeMapper] Make use of toPhpDocNode() on ObjectTypeMapper
samsonasik Jul 23, 2023
96c9cd7
[ci-review] Rector Rectify
actions-user Jul 23, 2023
a4a2b19
[ci-review] Rector Rectify
actions-user Jul 23, 2023
e93c299
handle Fqcn
samsonasik Jul 23, 2023
53d8162
check with type with class name
samsonasik Jul 23, 2023
0883078
verify FullyQualifiedObjectType
samsonasik Jul 23, 2023
0f9eaf0
[ci-review] Rector Rectify
actions-user Jul 23, 2023
5006246
type
samsonasik Jul 23, 2023
fdc7101
generic object type
samsonasik Jul 25, 2023
66d7489
generic object type
samsonasik Jul 25, 2023
04f480d
generic object type
samsonasik Jul 25, 2023
d8c4037
fix
samsonasik Jul 25, 2023
3d7c7e1
handle FullyQualifiedObjectType
samsonasik Jul 25, 2023
0cf182f
fix
samsonasik Jul 25, 2023
573edfe
fix
samsonasik Jul 25, 2023
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
87 changes: 20 additions & 67 deletions packages/PHPStanStaticTypeMapper/TypeMapper/ObjectTypeMapper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,30 +8,23 @@
use PhpParser\Node;
use PhpParser\Node\Name;
use PhpParser\Node\Name\FullyQualified;
use PHPStan\PhpDocParser\Ast\Type\GenericTypeNode;
use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
use PHPStan\PhpDocParser\Ast\Type\TypeNode;
use PHPStan\Type\Generic\GenericObjectType;
use PHPStan\Type\MixedType;
use PHPStan\Type\ObjectType;
use PHPStan\Type\Type;
use PHPStan\Type\TypeTraverser;
use Rector\PHPStanStaticTypeMapper\Contract\TypeMapperInterface;
use Rector\PHPStanStaticTypeMapper\PHPStanStaticTypeMapper;
use Rector\StaticTypeMapper\ValueObject\Type\AliasedObjectType;
use Rector\StaticTypeMapper\ValueObject\Type\FullyQualifiedGenericObjectType;
use Rector\StaticTypeMapper\ValueObject\Type\FullyQualifiedObjectType;
use Rector\StaticTypeMapper\ValueObject\Type\NonExistingObjectType;
use Rector\StaticTypeMapper\ValueObject\Type\SelfObjectType;
use Rector\StaticTypeMapper\ValueObject\Type\ShortenedObjectType;
use Symfony\Contracts\Service\Attribute\Required;

/**
* @implements TypeMapperInterface<ObjectType>
*/
final class ObjectTypeMapper implements TypeMapperInterface
{
private PHPStanStaticTypeMapper $phpStanStaticTypeMapper;

/**
* @return class-string<Type>
*/
Expand All @@ -45,28 +38,30 @@ public function getNodeClass(): string
*/
public function mapToPHPStanPhpDocTypeNode(Type $type): TypeNode
{
if ($type instanceof ShortenedObjectType) {
return new IdentifierTypeNode($type->getClassName());
}
$type = TypeTraverser::map($type, static function (Type $type, callable $traverse): Type {
if (! $type instanceof ObjectType) {
return $traverse($type);
}

if ($type instanceof AliasedObjectType) {
return new IdentifierTypeNode($type->getClassName());
}
$typeClass = $type::class;

if ($type instanceof GenericObjectType) {
return $this->mapGenericObjectType($type);
}
// early native ObjectType check
if ($typeClass === 'PHPStan\Type\ObjectType') {
return new ObjectType('\\' . $type->getClassName());
}

if ($type instanceof NonExistingObjectType) {
// possibly generic type
return new IdentifierTypeNode($type->getClassName());
}
if ($type instanceof FullyQualifiedObjectType) {
return new ObjectType('\\' . $type->getClassName());
}

if ($type instanceof FullyQualifiedObjectType && str_starts_with($type->getClassName(), '\\')) {
return new IdentifierTypeNode($type->getClassName());
}
if ($type instanceof GenericObjectType) {
return $traverse(new GenericObjectType('\\' . $type->getClassName(), $type->getTypes()));
}

return new IdentifierTypeNode('\\' . $type->getClassName());
return $traverse($type);
});

return $type->toPhpDocNode();
}

/**
Expand Down Expand Up @@ -103,46 +98,4 @@ public function mapToPhpParserNode(Type $type, string $typeKind): ?Node

return new FullyQualified($type->getClassName());
}

#[Required]
public function autowire(PHPStanStaticTypeMapper $phpStanStaticTypeMapper): void
{
$this->phpStanStaticTypeMapper = $phpStanStaticTypeMapper;
}

private function mapGenericObjectType(GenericObjectType $genericObjectType): TypeNode
{
$name = $this->resolveGenericObjectTypeName($genericObjectType);
$identifierTypeNode = new IdentifierTypeNode($name);

$genericTypeNodes = [];
foreach ($genericObjectType->getTypes() as $key => $genericType) {
// mixed type on 1st item in iterator has no value
if ($name === 'Iterator' && $genericType instanceof MixedType && $key === 0) {
continue;
}

$typeNode = $this->phpStanStaticTypeMapper->mapToPHPStanPhpDocTypeNode($genericType);
$genericTypeNodes[] = $typeNode;
}

if ($genericTypeNodes === []) {
return $identifierTypeNode;
}

return new GenericTypeNode($identifierTypeNode, $genericTypeNodes);
}

private function resolveGenericObjectTypeName(GenericObjectType $genericObjectType): string
{
if ($genericObjectType instanceof FullyQualifiedGenericObjectType) {
return '\\' . $genericObjectType->getClassName();
}

if (\str_contains($genericObjectType->getClassName(), '\\')) {
return '\\' . $genericObjectType->getClassName();
}

return $genericObjectType->getClassName();
}
}