Skip to content

Commit 1fa9fa9

Browse files
SerafimArtsSerafimArts
committed
Add phpdoc types reader
1 parent 24508b7 commit 1fa9fa9

6 files changed

+309
-0
lines changed

‎src/Exception/Environment/ComposerPackageRequiredException.php

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace TypeLang\Mapper\Exception\Environment;
6+
7+
final class ComposerPackageRequiredException extends EnvironmentException implements EnvironmentExceptionInterface
8+
{
9+
/**
10+
* @param non-empty-string $package
11+
* @param non-empty-string $for
12+
*/
13+
public static function becausePackageNotInstalled(string $package, string $for): self
14+
{
15+
$message = 'The "%s" component is required to %s. Try running "composer require %$1s"';
16+
17+
return new self(\sprintf($message, $package, $for));
18+
}
19+
}

‎src/Exception/Environment/EnvironmentException.php

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace TypeLang\Mapper\Exception\Environment;
6+
7+
abstract class EnvironmentException extends \LogicException implements EnvironmentExceptionInterface
8+
{
9+
public function __construct(string $message, int $code = 0, ?\Throwable $previous = null)
10+
{
11+
parent::__construct($message, $code, $previous);
12+
}
13+
}

‎src/Exception/Environment/EnvironmentExceptionInterface.php

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace TypeLang\Mapper\Exception\Environment;
6+
7+
use TypeLang\Mapper\Exception\MapperExceptionInterface;
8+
9+
interface EnvironmentExceptionInterface extends MapperExceptionInterface {}

‎src/Meta/Reader/DocBlockReader.php

+129
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace TypeLang\Mapper\Meta\Reader;
6+
7+
use TypeLang\Mapper\Exception\Environment\ComposerPackageRequiredException;
8+
use TypeLang\Mapper\Exception\TypeNotFoundException;
9+
use TypeLang\Mapper\Meta\ClassMetadata;
10+
use TypeLang\Mapper\Meta\PropertyMetadata;
11+
use TypeLang\Mapper\Meta\Reader\DocBlockReader\ClassPropertyTypeReader;
12+
use TypeLang\Mapper\Meta\Reader\DocBlockReader\PromotedPropertyTypeReader;
13+
use TypeLang\Mapper\Registry\RegistryInterface;
14+
use TypeLang\Parser\Node\Stmt\TypeStatement;
15+
use TypeLang\PHPDoc\Parser;
16+
use TypeLang\PHPDoc\Standard\ParamTagFactory;
17+
use TypeLang\PHPDoc\Standard\VarTagFactory;
18+
use TypeLang\PHPDoc\Tag\Factory\TagFactory;
19+
use TypeLang\Reader\Exception\ReaderExceptionInterface;
20+
21+
final class DocBlockReader extends Reader
22+
{
23+
/**
24+
* @var non-empty-string
25+
*/
26+
private const DEFAULT_PARAM_TAG_NAME = 'param';
27+
28+
/**
29+
* @var non-empty-string
30+
*/
31+
private const DEFAULT_VAR_TAG_NAME = 'var';
32+
33+
private readonly PromotedPropertyTypeReader $promotedProperties;
34+
35+
private readonly ClassPropertyTypeReader $classProperties;
36+
37+
/**
38+
* @param non-empty-string $paramTagName
39+
* @param non-empty-string $varTagName
40+
* @throws ComposerPackageRequiredException
41+
*/
42+
public function __construct(
43+
private readonly ReaderInterface $delegate = new ReflectionReader(),
44+
string $paramTagName = self::DEFAULT_PARAM_TAG_NAME,
45+
string $varTagName = self::DEFAULT_VAR_TAG_NAME,
46+
) {
47+
self::assertKernelPackageIsInstalled();
48+
49+
$parser = new Parser(new TagFactory([
50+
$paramTagName => new ParamTagFactory(),
51+
$varTagName => new VarTagFactory(),
52+
]));
53+
54+
$this->promotedProperties = new PromotedPropertyTypeReader($paramTagName, $parser);
55+
$this->classProperties = new ClassPropertyTypeReader($varTagName, $parser);
56+
}
57+
58+
/**
59+
* @throws ComposerPackageRequiredException
60+
*/
61+
private static function assertKernelPackageIsInstalled(): void
62+
{
63+
if (!\class_exists(Parser::class)) {
64+
throw ComposerPackageRequiredException::becausePackageNotInstalled(
65+
package: 'type-lang/phpdoc',
66+
for: 'docblock support'
67+
);
68+
}
69+
70+
if (!\class_exists(ParamTagFactory::class)) {
71+
throw ComposerPackageRequiredException::becausePackageNotInstalled(
72+
package: 'type-lang/phpdoc-standard-tags',
73+
for: '"@param" tag support'
74+
);
75+
}
76+
77+
if (!\class_exists(VarTagFactory::class)) {
78+
throw ComposerPackageRequiredException::becausePackageNotInstalled(
79+
package: 'type-lang/phpdoc-standard-tags',
80+
for: '"@var" tag support'
81+
);
82+
}
83+
}
84+
85+
/**
86+
* @param \ReflectionClass<object> $class
87+
* @throws \ReflectionException
88+
*/
89+
private function findType(\ReflectionClass $class, PropertyMetadata $meta): ?TypeStatement
90+
{
91+
$property = $meta->getReflection($class);
92+
93+
if ($property->isPromoted()) {
94+
return $this->promotedProperties->findType($property, $meta);
95+
}
96+
97+
return $this->classProperties->findType($property);
98+
}
99+
100+
/**
101+
* @throws ReaderExceptionInterface
102+
* @throws \ReflectionException
103+
* @throws TypeNotFoundException
104+
*/
105+
public function getClassMetadata(\ReflectionClass $class, RegistryInterface $types): ClassMetadata
106+
{
107+
$metadata = $this->delegate->getClassMetadata($class, $types);
108+
109+
foreach ($class->getProperties() as $reflection) {
110+
$property = $metadata->findPropertyByName($reflection->getName())
111+
?? new PropertyMetadata($reflection->getName());
112+
113+
$type = $this->findType($class, $property);
114+
115+
if ($type !== null) {
116+
$property = $property->withType(
117+
type: $types->get($type),
118+
statement: $type,
119+
);
120+
}
121+
122+
$metadata = $metadata->withAddedProperty($property);
123+
}
124+
125+
$this->promotedProperties->cleanup();
126+
127+
return $metadata;
128+
}
129+
}

‎src/Meta/Reader/DocBlockReader/ClassPropertyTypeReader.php

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace TypeLang\Mapper\Meta\Reader\DocBlockReader;
6+
7+
use TypeLang\Parser\Node\Stmt\TypeStatement;
8+
use TypeLang\PHPDoc\DocBlock;
9+
use TypeLang\PHPDoc\ParserInterface;
10+
use TypeLang\PHPDoc\Standard\VarTag;
11+
use TypeLang\PHPDoc\Tag\TagInterface;
12+
13+
final class ClassPropertyTypeReader
14+
{
15+
/**
16+
* @param non-empty-string $varTagName
17+
*/
18+
public function __construct(
19+
private readonly string $varTagName,
20+
private readonly ParserInterface $parser,
21+
) {}
22+
23+
/**
24+
* Return type for given property from docblock.
25+
*/
26+
public function findType(\ReflectionProperty $property): ?TypeStatement
27+
{
28+
$phpdoc = $this->getDocBlockFromProperty($property);
29+
30+
foreach ($phpdoc as $tag) {
31+
if ($this->isExpectedVarTag($tag)) {
32+
/** @var VarTag $tag */
33+
return $tag->getType();
34+
}
35+
}
36+
37+
return null;
38+
}
39+
40+
private function isExpectedVarTag(TagInterface $tag): bool
41+
{
42+
return $tag instanceof VarTag
43+
&& $tag->getName() === $this->varTagName;
44+
}
45+
46+
private function getDocBlockFromProperty(\ReflectionProperty $property): DocBlock
47+
{
48+
$comment = $property->getDocComment();
49+
50+
if ($comment === false) {
51+
return new DocBlock();
52+
}
53+
54+
return $this->parser->parse($comment);
55+
}
56+
}

‎src/Meta/Reader/DocBlockReader/PromotedPropertyTypeReader.php

+83
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace TypeLang\Mapper\Meta\Reader\DocBlockReader;
6+
7+
use TypeLang\Mapper\Meta\PropertyMetadata;
8+
use TypeLang\Parser\Node\Stmt\TypeStatement;
9+
use TypeLang\PHPDoc\DocBlock;
10+
use TypeLang\PHPDoc\ParserInterface;
11+
use TypeLang\PHPDoc\Standard\ParamTag;
12+
use TypeLang\PHPDoc\Tag\TagInterface;
13+
14+
final class PromotedPropertyTypeReader
15+
{
16+
/**
17+
* @var array<class-string, DocBlock>
18+
*/
19+
private array $constructors = [];
20+
21+
/**
22+
* @param non-empty-string $paramTagName
23+
*/
24+
public function __construct(
25+
private readonly string $paramTagName,
26+
private readonly ParserInterface $parser,
27+
) {}
28+
29+
/**
30+
* Return type for given property from docblock.
31+
*/
32+
public function findType(\ReflectionProperty $property, PropertyMetadata $meta): ?TypeStatement
33+
{
34+
$class = $property->getDeclaringClass();
35+
36+
$phpdoc = $this->constructors[$class->getName()]
37+
??= $this->getDocBlockFromPromotedProperty($class);
38+
39+
foreach ($phpdoc as $tag) {
40+
if ($this->isExpectedParamTag($tag, $meta)) {
41+
/** @var ParamTag $tag */
42+
return $tag->getType();
43+
}
44+
}
45+
46+
return null;
47+
}
48+
49+
/**
50+
* Cleanup memory after task completion.
51+
*/
52+
public function cleanup(): void
53+
{
54+
$this->constructors = [];
55+
}
56+
57+
private function isExpectedParamTag(TagInterface $tag, PropertyMetadata $meta): bool
58+
{
59+
return $tag instanceof ParamTag
60+
&& $tag->getName() === $this->paramTagName
61+
&& $tag->getVariableName() === $meta->getName();
62+
}
63+
64+
/**
65+
* @param \ReflectionClass<object> $class
66+
*/
67+
private function getDocBlockFromPromotedProperty(\ReflectionClass $class): DocBlock
68+
{
69+
$constructor = $class->getConstructor();
70+
71+
if ($constructor === null) {
72+
return new DocBlock();
73+
}
74+
75+
$comment = $constructor->getDocComment();
76+
77+
if ($comment === false) {
78+
return new DocBlock();
79+
}
80+
81+
return $this->parser->parse($comment);
82+
}
83+
}

0 commit comments

Comments
 (0)