Skip to content
This repository has been archived by the owner on Dec 3, 2023. It is now read-only.

Commit

Permalink
skip already added
Browse files Browse the repository at this point in the history
  • Loading branch information
TomasVotruba committed Jul 9, 2021
1 parent e11f76b commit e0ae993
Show file tree
Hide file tree
Showing 5 changed files with 52 additions and 34 deletions.
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
"ondram/ci-detector": "^4.1",
"phpunit/phpunit": "^9.5",
"psr/log": "^1.1",
"rector/rector": "dev-main#e219401",
"rector/rector": "dev-main#307dfa2",
"symfony/doctrine-bridge": "^5.3",
"symfony/framework-bundle": "^5.3",
"symfony/security-bundle": "^5.3",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,14 @@
namespace Symplify\CodingStandard\Fixer\Annotation;

use Doctrine\Common\Annotations\DocLexer;
use PhpCsFixer\Doctrine\Annotation\Token;
use PhpCsFixer\Doctrine\Annotation\Token as DoctrineAnnotationToken;
use PhpCsFixer\Doctrine\Annotation\Tokens as DoctrineAnnotationTokens;
use PhpCsFixer\FixerDefinition\FixerDefinition;
use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
use PhpCsFixer\Tokenizer\Analyzer\NamespaceUsesAnalyzer;
use PhpCsFixer\Tokenizer\Token;
use PhpCsFixer\Tokenizer\Tokens;
use SplFileInfo;
use Symplify\CodingStandard\Fixer\AbstractSymplifyFixer;
use Symplify\CodingStandard\TokenAnalyzer\DoctrineAnnotationElementAnalyzer;
use Symplify\CodingStandard\TokenAnalyzer\DoctrineAnnotationNameResolver;
Expand Down Expand Up @@ -39,7 +41,7 @@ final class DoctrineAnnotationNestedBracketsFixer extends AbstractSymplifyFixer

public function __construct(
private DoctrineAnnotationElementAnalyzer $doctrineAnnotationElementAnalyzer,
private DoctrineAnnotationNameResolver $annotationNameResolver,
private DoctrineAnnotationNameResolver $doctrineAnnotationNameResolver,
private NamespaceUsesAnalyzer $namespaceUsesAnalyzer
) {
}
Expand Down Expand Up @@ -90,18 +92,24 @@ public function configure(array $configuration): void
$this->annotationClasses = $annotationsClasses;
}

/**
* @param Tokens<Token> $tokens
*/
public function isCandidate(Tokens $tokens): bool
{
return $tokens->isTokenKindFound(T_DOC_COMMENT);
}

public function fix(\SplFileInfo $fileInfo, Tokens $tokens): void
/**
* @param Tokens<Token> $tokens
*/
public function fix(SplFileInfo $fileInfo, Tokens $tokens): void
{
$useDeclarations = $this->namespaceUsesAnalyzer->getDeclarationsFromTokens($tokens);

// fetch indexes one time, this is safe as we never add or remove a token during fixing

/** @var \PhpCsFixer\Tokenizer\Token[] $docCommentTokens */
/** @var Token[] $docCommentTokens */
$docCommentTokens = $tokens->findGivenKind(T_DOC_COMMENT);
foreach ($docCommentTokens as $index => $docCommentToken) {
if (! $this->doctrineAnnotationElementAnalyzer->detect($tokens, $index)) {
Expand All @@ -111,22 +119,26 @@ public function fix(\SplFileInfo $fileInfo, Tokens $tokens): void
$doctrineAnnotationTokens = DoctrineAnnotationTokens::createFromDocComment($docCommentToken, []);
$this->fixAnnotations($doctrineAnnotationTokens, $useDeclarations);

$tokens[$index] = new \PhpCsFixer\Tokenizer\Token([T_DOC_COMMENT, $doctrineAnnotationTokens->getCode()]);
$tokens[$index] = new Token([T_DOC_COMMENT, $doctrineAnnotationTokens->getCode()]);
}
}

/**
* @param DoctrineAnnotationTokens<Token> $tokens
* @param DoctrineAnnotationTokens<DoctrineAnnotationToken> $doctrineAnnotationTokens
*/
private function fixAnnotations(DoctrineAnnotationTokens $tokens, $useDeclarations): void
private function fixAnnotations(DoctrineAnnotationTokens $doctrineAnnotationTokens, $useDeclarations): void
{
foreach ($tokens as $index => $token) {
$isAtToken = $tokens[$index]->isType(DocLexer::T_AT);
foreach ($doctrineAnnotationTokens as $index => $token) {
$isAtToken = $doctrineAnnotationTokens[$index]->isType(DocLexer::T_AT);
if (! $isAtToken) {
continue;
}

$annotationName = $this->annotationNameResolver->resolveName($tokens, $index, $useDeclarations);
$annotationName = $this->doctrineAnnotationNameResolver->resolveName(
$doctrineAnnotationTokens,
$index,
$useDeclarations
);
if ($annotationName === null) {
continue;
}
Expand All @@ -135,31 +147,37 @@ private function fixAnnotations(DoctrineAnnotationTokens $tokens, $useDeclaratio
continue;
}

$closingBraceIndex = $tokens->getAnnotationEnd($index);
$closingBraceIndex = $doctrineAnnotationTokens->getAnnotationEnd($index);
if ($closingBraceIndex === null) {
continue;
}

$braceIndex = $tokens->getNextMeaningfulToken($index + 1);
$braceIndex = $doctrineAnnotationTokens->getNextMeaningfulToken($index + 1);
if ($braceIndex === null) {
continue;
}

/** @var Token $braceToken */
$braceToken = $tokens[$braceIndex];
/** @var DoctrineAnnotationToken $braceToken */
$braceToken = $doctrineAnnotationTokens[$braceIndex];
if (! $this->doctrineAnnotationElementAnalyzer->isOpeningBracketFollowedByAnnotation(
$braceToken,
$tokens,
$doctrineAnnotationTokens,
$braceIndex
)) {
continue;
}

// add closing brace
$tokens->insertAt($closingBraceIndex, new Token(DocLexer::T_OPEN_CURLY_BRACES, '}'));
$doctrineAnnotationTokens->insertAt(
$closingBraceIndex,
new DoctrineAnnotationToken(DocLexer::T_OPEN_CURLY_BRACES, '}')
);

// add opening brace
$tokens->insertAt($braceIndex + 1, new Token(DocLexer::T_OPEN_CURLY_BRACES, '{'));
$doctrineAnnotationTokens->insertAt(
$braceIndex + 1,
new DoctrineAnnotationToken(DocLexer::T_OPEN_CURLY_BRACES, '{')
);
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@
*/
final class DoctrineAnnotationElementAnalyzer
{
/**
* @param Tokens<\PhpCsFixer\Tokenizer\Token> $tokens
*/
public function detect(Tokens $tokens, int $index): bool
{
$analyzer = new TokensAnalyzer($tokens);
Expand Down Expand Up @@ -49,11 +52,11 @@ public function detect(Tokens $tokens, int $index): bool
/**
* We look for "(@SomeAnnotation"
*
* @param DoctrineAnnotationTokens<Token> $tokens
* @param DoctrineAnnotationTokens<Token> $doctrineAnnotationTokens
*/
public function isOpeningBracketFollowedByAnnotation(
Token $token,
DoctrineAnnotationTokens $tokens,
DoctrineAnnotationTokens $doctrineAnnotationTokens,
int $braceIndex
): bool {
// should be "("
Expand All @@ -62,13 +65,13 @@ public function isOpeningBracketFollowedByAnnotation(
return false;
}

$nextTokenIndex = $tokens->getNextMeaningfulToken($braceIndex + 1);
$nextTokenIndex = $doctrineAnnotationTokens->getNextMeaningfulToken($braceIndex);
if ($nextTokenIndex === null) {
return false;
}

/** @var Token $nextToken */
$nextToken = $tokens[$nextTokenIndex];
$nextToken = $doctrineAnnotationTokens[$nextTokenIndex];

// next token must be nested annotation, we don't care otherwise
return $nextToken->isType(DocLexer::T_AT);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,16 @@ public function resolveName(Tokens $tokens, int $index, array $namespaceUseAnaly
$annotationShortName .= $currentToken->getContent();
}

if ($annotationShortName) {
foreach ($namespaceUseAnalyses as $namespaceUseAnalysis) {
if ($namespaceUseAnalysis->getShortName() === $annotationShortName) {
return $namespaceUseAnalysis->getFullName();
}
}
if ($annotationShortName === '') {
return null;
}

return $annotationShortName;
foreach ($namespaceUseAnalyses as $namespaceUseAnalysis) {
if ($namespaceUseAnalysis->getShortName() === $annotationShortName) {
return $namespaceUseAnalysis->getFullName();
}
}

return null;
return $annotationShortName;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,7 @@ public function configureClassName(string $className): void
$this->className = $className;
}

/**
* @return int|Node|null
*/
public function enterNode(Node $node)
public function enterNode(Node $node): Node
{
if ($node instanceof PhpDocTagNode) {
$this->processPhpDocTagNode($node);
Expand Down

0 comments on commit e0ae993

Please sign in to comment.