Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactor conversion of PHPDoc to type declarations
- Loading branch information
1 parent
18e95e4
commit 777cb40
Showing
11 changed files
with
937 additions
and
481 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,209 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of PHP CS Fixer. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * Dariusz Rumiński <dariusz.ruminski@gmail.com> | ||
| * | ||
| * This source file is subject to the MIT license that is bundled | ||
| * with this source code in the file LICENSE. | ||
| */ | ||
|
|
||
| namespace PhpCsFixer; | ||
|
|
||
| use PhpCsFixer\DocBlock\Annotation; | ||
| use PhpCsFixer\DocBlock\DocBlock; | ||
| use PhpCsFixer\Tokenizer\Analyzer\Analysis\NamespaceAnalysis; | ||
| use PhpCsFixer\Tokenizer\Analyzer\Analysis\NamespaceUseAnalysis; | ||
| use PhpCsFixer\Tokenizer\CT; | ||
| use PhpCsFixer\Tokenizer\Token; | ||
| use PhpCsFixer\Tokenizer\Tokens; | ||
|
|
||
| /** | ||
| * @internal | ||
| */ | ||
| abstract class AbstractPhpdocToTypeDeclarationFixer extends AbstractFixer | ||
| { | ||
| /** | ||
| * @var array<string, bool> | ||
| */ | ||
| protected $scalarTypes = [ | ||
| 'bool' => true, | ||
| 'float' => true, | ||
| 'int' => true, | ||
| 'string' => true, | ||
| ]; | ||
| /** | ||
| * @var string | ||
| */ | ||
| private $classRegex = '/^\\\\?[a-zA-Z_\\x7f-\\xff](?:\\\\?[a-zA-Z0-9_\\x7f-\\xff]+)*$/'; | ||
|
|
||
| /** | ||
| * @var array<string, int> | ||
| */ | ||
| private $versionSpecificTypes = [ | ||
| 'void' => 70100, | ||
| 'iterable' => 70100, | ||
| 'object' => 70200, | ||
| ]; | ||
|
|
||
| /** | ||
| * @var array<string, bool> | ||
| */ | ||
| private $skippedTypes = [ | ||
| 'mixed' => true, | ||
| 'resource' => true, | ||
| 'null' => true, | ||
| ]; | ||
|
|
||
| /** | ||
| * Find all the annotations of given type in the function's PHPDoc comment. | ||
| * | ||
| * @param string $name | ||
| * @param Tokens $tokens | ||
| * @param int $index The index of the function token | ||
| * @param NamespaceAnalysis[] $namespaces | ||
| * @param NamespaceUseAnalysis[] $namespaceUses | ||
| * | ||
| * @return Annotation[] | ||
| */ | ||
| protected function findAnnotations($name, Tokens $tokens, $index, array $namespaces, array $namespaceUses) | ||
| { | ||
| do { | ||
| $index = $tokens->getPrevNonWhitespace($index); | ||
| } while ($tokens[$index]->isGivenKind([ | ||
| T_COMMENT, | ||
| T_ABSTRACT, | ||
| T_FINAL, | ||
| T_PRIVATE, | ||
| T_PROTECTED, | ||
| T_PUBLIC, | ||
| T_STATIC, | ||
| ])); | ||
|
|
||
| if (!$tokens[$index]->isGivenKind(T_DOC_COMMENT)) { | ||
| return []; | ||
| } | ||
|
|
||
| $namespace = $this->getNamespace($namespaces, $index); | ||
|
|
||
| $doc = new DocBlock( | ||
| $tokens[$index]->getContent(), | ||
| $namespace, | ||
| $this->getNamespaceUses($namespace, $namespaceUses) | ||
| ); | ||
|
|
||
| return $doc->getAnnotationsOfType($name); | ||
| } | ||
|
|
||
| /** | ||
| * @param string $type | ||
| * @param bool $isNullable | ||
| * | ||
| * @return Token[] | ||
| */ | ||
| protected function createTypeDeclarationTokens($type, $isNullable) | ||
| { | ||
| static $specialTypes = [ | ||
| 'array' => [CT::T_ARRAY_TYPEHINT, 'array'], | ||
| 'callable' => [T_CALLABLE, 'callable'], | ||
| ]; | ||
|
|
||
| if (true === $isNullable) { | ||
| $newTokens[] = new Token([CT::T_NULLABLE_TYPE, '?']); | ||
| } | ||
|
|
||
| if (isset($specialTypes[$type])) { | ||
| $newTokens[] = new Token($specialTypes[$type]); | ||
| } else { | ||
| foreach (explode('\\', $type) as $nsIndex => $value) { | ||
| if (0 === $nsIndex && '' === $value) { | ||
| continue; | ||
| } | ||
|
|
||
| if (0 < $nsIndex) { | ||
| $newTokens[] = new Token([T_NS_SEPARATOR, '\\']); | ||
| } | ||
| $newTokens[] = new Token([T_STRING, $value]); | ||
| } | ||
| } | ||
|
|
||
| return $newTokens; | ||
| } | ||
|
|
||
| /** | ||
| * @param Annotation $annotation | ||
| * | ||
| * @return null|array | ||
| */ | ||
| protected function getCommonTypeFromAnnotation(Annotation $annotation) | ||
| { | ||
| $typesExpression = $annotation->getTypeExpression(); | ||
|
|
||
| $commonType = $typesExpression->getCommonType(); | ||
| $isNullable = $typesExpression->allowsNull(); | ||
|
|
||
| if (null === $commonType) { | ||
| return null; | ||
| } | ||
|
|
||
| if ($isNullable && (\PHP_VERSION_ID < 70100 || 'void' === $commonType)) { | ||
| return null; | ||
| } | ||
|
|
||
| if ('static' === $commonType) { | ||
| $commonType = 'self'; | ||
| } | ||
|
|
||
| if (isset($this->skippedTypes[$commonType])) { | ||
| return null; | ||
| } | ||
|
|
||
| if (isset($this->versionSpecificTypes[$commonType]) && \PHP_VERSION_ID < $this->versionSpecificTypes[$commonType]) { | ||
| return null; | ||
| } | ||
|
|
||
| if (!isset($this->scalarTypes[$commonType]) && 1 !== Preg::match($this->classRegex, $commonType)) { | ||
| return null; | ||
| } | ||
|
|
||
| return [$commonType, $isNullable]; | ||
| } | ||
|
|
||
| /** | ||
| * @param NamespaceAnalysis[] $namespaces $namespaces | ||
| * @param int $index | ||
| * | ||
| * @return NamespaceAnalysis | ||
| */ | ||
| private function getNamespace(array $namespaces, $index) | ||
| { | ||
| foreach ($namespaces as $namespace) { | ||
| if ($namespace->getScopeStartIndex() <= $index && $namespace->getScopeEndIndex() >= $index) { | ||
| return $namespace; | ||
| } | ||
| } | ||
|
|
||
| throw new \RuntimeException("Unable to get the namespace at index {$index}."); | ||
| } | ||
|
|
||
| /** | ||
| * @param NamespaceAnalysis $namespace | ||
| * @param NamespaceUseAnalysis[] $namespaceUses | ||
| * | ||
| * @return NamespaceUseAnalysis[] | ||
| */ | ||
| private function getNamespaceUses(NamespaceAnalysis $namespace, array $namespaceUses) | ||
| { | ||
| $result = []; | ||
|
|
||
| foreach ($namespaceUses as $namespaceUse) { | ||
| if ($namespaceUse->getStartIndex() >= $namespace->getScopeStartIndex() && $namespaceUse->getStartIndex() <= $namespace->getScopeEndIndex()) { | ||
| $result[] = $namespaceUse; | ||
| } | ||
| } | ||
|
|
||
| return $result; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.