Skip to content

Follow type hint when converting to generics syntax #601

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
merged 1 commit into from
Feb 6, 2019
Merged

Follow type hint when converting to generics syntax #601

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
73 changes: 59 additions & 14 deletions SlevomatCodingStandard/Sniffs/TypeHints/DisallowArrayTypeHintSyntaxSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,28 @@
use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
use PHPStan\PhpDocParser\Ast\Type\TypeNode;
use PHPStan\PhpDocParser\Ast\Type\UnionTypeNode;
use SlevomatCodingStandard\Helpers\Annotation\Annotation;
use SlevomatCodingStandard\Helpers\Annotation\GenericAnnotation;
use SlevomatCodingStandard\Helpers\Annotation\ParameterAnnotation;
use SlevomatCodingStandard\Helpers\Annotation\ReturnAnnotation;
use SlevomatCodingStandard\Helpers\AnnotationHelper;
use SlevomatCodingStandard\Helpers\AnnotationTypeHelper;
use SlevomatCodingStandard\Helpers\FunctionHelper;
use SlevomatCodingStandard\Helpers\NamespaceHelper;
use SlevomatCodingStandard\Helpers\ReturnTypeHint;
use SlevomatCodingStandard\Helpers\SniffSettingsHelper;
use SlevomatCodingStandard\Helpers\TokenHelper;
use SlevomatCodingStandard\Helpers\TypeHintHelper;
use function array_flip;
use function array_key_exists;
use function array_map;
use function array_merge;
use function count;
use function in_array;
use function sprintf;
use const T_DOC_COMMENT_OPEN_TAG;
use const T_FUNCTION;
use const T_VARIABLE;

class DisallowArrayTypeHintSyntaxSniff implements Sniff
{
Expand Down Expand Up @@ -79,16 +88,18 @@ public function process(File $phpcsFile, $docCommentOpenPointer): void
$unionTypeNode = $this->findUnionTypeThatContainsArrayType($arrayTypeNode, $unionTypeNodes);

if ($unionTypeNode !== null) {
$genericIdentifier = $this->findGenericIdentifier($phpcsFile, $annotation->getStartPointer(), $unionTypeNode);
$genericIdentifier = $this->findGenericIdentifier($phpcsFile, $annotation->getStartPointer(), $unionTypeNode, $annotation);
if ($genericIdentifier !== null) {
$genericTypeNode = new GenericTypeNode(new IdentifierTypeNode($genericIdentifier), [$arrayTypeNode->type]);
$genericTypeNode = new GenericTypeNode(new IdentifierTypeNode($genericIdentifier), [$this->fixArrayNode($arrayTypeNode->type)]);
$fixedAnnotationContent = AnnotationHelper::fixAnnotation($phpcsFile, $annotation, $unionTypeNode, $genericTypeNode);
} else {
$genericTypeNode = new GenericTypeNode(new IdentifierTypeNode('array'), [$arrayTypeNode->type]);
$genericTypeNode = new GenericTypeNode(new IdentifierTypeNode('array'), [$this->fixArrayNode($arrayTypeNode->type)]);
$fixedAnnotationContent = AnnotationHelper::fixAnnotation($phpcsFile, $annotation, $arrayTypeNode, $genericTypeNode);
}
} else {
$genericTypeNode = new GenericTypeNode(new IdentifierTypeNode('array'), [$arrayTypeNode->type]);
$genericIdentifier = $this->findGenericIdentifier($phpcsFile, $annotation->getStartPointer(), $arrayTypeNode, $annotation) ?? 'array';

$genericTypeNode = new GenericTypeNode(new IdentifierTypeNode($genericIdentifier), [$this->fixArrayNode($arrayTypeNode->type)]);
$fixedAnnotationContent = AnnotationHelper::fixAnnotation($phpcsFile, $annotation, $arrayTypeNode, $genericTypeNode);
}

Expand All @@ -104,6 +115,15 @@ public function process(File $phpcsFile, $docCommentOpenPointer): void
}
}

private function fixArrayNode(TypeNode $node): TypeNode
{
if (!$node instanceof ArrayTypeNode) {
return $node;
}

return new GenericTypeNode(new IdentifierTypeNode('array'), [$this->fixArrayNode($node->type)]);
}

/**
* @param \PHPStan\PhpDocParser\Ast\Type\ArrayTypeNode $arrayTypeNode
* @param \PHPStan\PhpDocParser\Ast\Type\UnionTypeNode[] $unionTypeNodes
Expand All @@ -120,26 +140,51 @@ private function findUnionTypeThatContainsArrayType(ArrayTypeNode $arrayTypeNode
return null;
}

private function findGenericIdentifier(File $phpcsFile, int $pointer, UnionTypeNode $unionTypeNode): ?string
private function findGenericIdentifier(File $phpcsFile, int $pointer, TypeNode $typeNode, Annotation $annotation): ?string
{
if (count($unionTypeNode->types) !== 2) {
if (!$typeNode instanceof UnionTypeNode) {
$docCommentOwnerPointer = TokenHelper::findNext($phpcsFile, array_merge(TokenHelper::$functionTokenCodes, TokenHelper::$typeKeywordTokenCodes, [T_VARIABLE]), $pointer);

if ($phpcsFile->getTokens()[$docCommentOwnerPointer]['code'] !== T_FUNCTION) {
return null;
}

switch (true) {
case $annotation instanceof ParameterAnnotation:
$typeHints = FunctionHelper::getParametersTypeHints($phpcsFile, $docCommentOwnerPointer);
if (isset($typeHints[$annotation->getContentNode()->parameterName])) {
return $typeHints[$annotation->getContentNode()->parameterName]->getTypeHint();
}
break;
case $annotation instanceof ReturnAnnotation:
$returnType = FunctionHelper::findReturnTypeHint($phpcsFile, $docCommentOwnerPointer);
if ($returnType instanceof ReturnTypeHint) {
return $returnType->getTypeHint();
}
break;
}

return null;
}

if (count($typeNode->types) !== 2) {
return null;
}

if (
$unionTypeNode->types[0] instanceof ArrayTypeNode
&& $unionTypeNode->types[1] instanceof IdentifierTypeNode
&& $this->isTraversableType(TypeHintHelper::getFullyQualifiedTypeHint($phpcsFile, $pointer, $unionTypeNode->types[1]->name))
$typeNode->types[0] instanceof ArrayTypeNode
&& $typeNode->types[1] instanceof IdentifierTypeNode
&& $this->isTraversableType(TypeHintHelper::getFullyQualifiedTypeHint($phpcsFile, $pointer, $typeNode->types[1]->name))
) {
return $unionTypeNode->types[1]->name;
return $typeNode->types[1]->name;
}

if (
$unionTypeNode->types[1] instanceof ArrayTypeNode
&& $unionTypeNode->types[0] instanceof IdentifierTypeNode
&& $this->isTraversableType(TypeHintHelper::getFullyQualifiedTypeHint($phpcsFile, $pointer, $unionTypeNode->types[0]->name))
$typeNode->types[1] instanceof ArrayTypeNode
&& $typeNode->types[0] instanceof IdentifierTypeNode
&& $this->isTraversableType(TypeHintHelper::getFullyQualifiedTypeHint($phpcsFile, $pointer, $typeNode->types[0]->name))
) {
return $unionTypeNode->types[0]->name;
return $typeNode->types[0]->name;
}

return null;
Expand Down
6 changes: 5 additions & 1 deletion tests/Sniffs/TypeHints/DisallowArrayTypeHintSyntaxSniffTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ public function testErrors(): void
],
]);

self::assertSame(17, $report->getErrorCount());
self::assertSame(21, $report->getErrorCount());

self::assertSniffError($report, 6, DisallowArrayTypeHintSyntaxSniff::CODE_DISALLOWED_ARRAY_TYPE_HINT_SYNTAX, 'Usage of array type hint syntax in "\DateTimeImmutable[]" is disallowed, use generic type hint syntax instead.');
self::assertSniffError($report, 7, DisallowArrayTypeHintSyntaxSniff::CODE_DISALLOWED_ARRAY_TYPE_HINT_SYNTAX, 'Usage of array type hint syntax in "bool[]" is disallowed, use generic type hint syntax instead.');
Expand All @@ -40,6 +40,10 @@ public function testErrors(): void
self::assertSniffError($report, 36, DisallowArrayTypeHintSyntaxSniff::CODE_DISALLOWED_ARRAY_TYPE_HINT_SYNTAX, 'Usage of array type hint syntax in "int[]" is disallowed, use generic type hint syntax instead.');
self::assertSniffError($report, 39, DisallowArrayTypeHintSyntaxSniff::CODE_DISALLOWED_ARRAY_TYPE_HINT_SYNTAX, 'Usage of array type hint syntax in "string[]" is disallowed, use generic type hint syntax instead.');
self::assertSniffError($report, 42, DisallowArrayTypeHintSyntaxSniff::CODE_DISALLOWED_ARRAY_TYPE_HINT_SYNTAX, 'Usage of array type hint syntax in "int[]" is disallowed, use generic type hint syntax instead.');
self::assertSniffError($report, 45, DisallowArrayTypeHintSyntaxSniff::CODE_DISALLOWED_ARRAY_TYPE_HINT_SYNTAX, 'Usage of array type hint syntax in "string[][]" is disallowed, use generic type hint syntax instead.');
self::assertSniffError($report, 49, DisallowArrayTypeHintSyntaxSniff::CODE_DISALLOWED_ARRAY_TYPE_HINT_SYNTAX, 'Usage of array type hint syntax in "string[][]" is disallowed, use generic type hint syntax instead.');
self::assertSniffError($report, 53, DisallowArrayTypeHintSyntaxSniff::CODE_DISALLOWED_ARRAY_TYPE_HINT_SYNTAX, 'Usage of array type hint syntax in "string[][]" is disallowed, use generic type hint syntax instead.');
self::assertSniffError($report, 57, DisallowArrayTypeHintSyntaxSniff::CODE_DISALLOWED_ARRAY_TYPE_HINT_SYNTAX, 'Usage of array type hint syntax in "string[][]" is disallowed, use generic type hint syntax instead.');

self::assertAllFixedInFile($report);
}
Expand Down
16 changes: 16 additions & 0 deletions tests/Sniffs/TypeHints/data/disallowArrayTypeHintSyntaxErrors.fixed.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,20 @@ class Whatever
/** @var array<int>|string */
public $k;

/** @return iterable<array<string>> */
Copy link
Contributor Author

@thewilkybarkid thewilkybarkid Feb 6, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Followed

coding-standard/tests/Sniffs/TypeHints/data/disallowArrayTypeHintSyntaxErrors.fixed.php

Line 30 in fdab228

/** @var Traversable<array<int>> */
in keeping nested items as array.

public function l() : iterable {
}

/** @param iterable<array<string>> $n */
public function m(iterable $n) {
}

/** @return \ArrayObject<array<string>> */
public function o() : ArrayObject {
}

/** @param \ArrayObject<array<string>> $p */
public function p(ArrayObject $q) {
}

}
16 changes: 16 additions & 0 deletions tests/Sniffs/TypeHints/data/disallowArrayTypeHintSyntaxErrors.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,20 @@ class Whatever
/** @var int[]|string */
public $k;

/** @return string[][] */
public function l() : iterable {
}

/** @param string[][] $n */
public function m(iterable $n) {
}

/** @return string[][]|\ArrayObject */
public function o() : ArrayObject {
}

/** @param string[][]|\ArrayObject $p */
public function p(ArrayObject $q) {
}

}