rector/rules/Php80/Rector/Class_/AnnotationToAttributeRector.php

222 lines
9.3 KiB
PHP
Raw Normal View History

2020-04-24 22:57:13 +00:00
<?php
declare (strict_types=1);
2020-04-24 22:57:13 +00:00
namespace Rector\Php80\Rector\Class_;
use PhpParser\Node;
use PhpParser\Node\AttributeGroup;
use PhpParser\Node\Expr\ArrowFunction;
use PhpParser\Node\Expr\Closure;
use PhpParser\Node\Param;
2020-04-24 22:57:13 +00:00
use PhpParser\Node\Stmt\Class_;
use PhpParser\Node\Stmt\ClassMethod;
use PhpParser\Node\Stmt\Function_;
2020-04-24 22:57:13 +00:00
use PhpParser\Node\Stmt\Property;
use PHPStan\PhpDocParser\Ast\Node as DocNode;
use PHPStan\PhpDocParser\Ast\PhpDoc\GenericTagValueNode;
use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagNode;
use Rector\BetterPhpDocParser\PhpDoc\DoctrineAnnotationTagValueNode;
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo;
use Rector\BetterPhpDocParser\PhpDocManipulator\PhpDocTagRemover;
use Rector\Core\Contract\Rector\ConfigurableRectorInterface;
2020-04-24 22:57:13 +00:00
use Rector\Core\Rector\AbstractRector;
use Rector\Core\ValueObject\PhpVersionFeature;
use Rector\Php80\NodeFactory\AttrGroupsFactory;
use Rector\Php80\PhpDoc\PhpDocNodeFinder;
use Rector\Php80\ValueObject\AnnotationToAttribute;
use Rector\Php80\ValueObject\DoctrineTagAndAnnotationToAttribute;
use Rector\PhpAttribute\Printer\PhpAttributeGroupFactory;
use Rector\VersionBonding\Contract\MinPhpVersionInterface;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
use RectorPrefix20211210\Symplify\SimplePhpDocParser\PhpDocNodeTraverser;
use RectorPrefix20211210\Webmozart\Assert\Assert;
2020-04-24 22:57:13 +00:00
/**
* @changelog https://wiki.php.net/rfc/attributes_v2
2020-04-24 22:57:13 +00:00
*
* @see \Rector\Tests\Php80\Rector\Class_\AnnotationToAttributeRector\AnnotationToAttributeRectorTest
2020-04-24 22:57:13 +00:00
*/
final class AnnotationToAttributeRector extends \Rector\Core\Rector\AbstractRector implements \Rector\Core\Contract\Rector\ConfigurableRectorInterface, \Rector\VersionBonding\Contract\MinPhpVersionInterface
2020-04-24 22:57:13 +00:00
{
/**
* @deprecated
* @var string
2020-04-24 22:57:13 +00:00
*/
public const ANNOTATION_TO_ATTRIBUTE = 'annotations_to_attributes';
/**
* @var AnnotationToAttribute[]
*/
private $annotationsToAttributes = [];
/**
* @readonly
* @var \Rector\PhpAttribute\Printer\PhpAttributeGroupFactory
*/
private $phpAttributeGroupFactory;
/**
* @readonly
* @var \Rector\Php80\NodeFactory\AttrGroupsFactory
*/
private $attrGroupsFactory;
/**
* @readonly
* @var \Rector\BetterPhpDocParser\PhpDocManipulator\PhpDocTagRemover
*/
private $phpDocTagRemover;
/**
* @readonly
* @var \Rector\Php80\PhpDoc\PhpDocNodeFinder
*/
private $phpDocNodeFinder;
public function __construct(\Rector\PhpAttribute\Printer\PhpAttributeGroupFactory $phpAttributeGroupFactory, \Rector\Php80\NodeFactory\AttrGroupsFactory $attrGroupsFactory, \Rector\BetterPhpDocParser\PhpDocManipulator\PhpDocTagRemover $phpDocTagRemover, \Rector\Php80\PhpDoc\PhpDocNodeFinder $phpDocNodeFinder)
{
$this->phpAttributeGroupFactory = $phpAttributeGroupFactory;
$this->attrGroupsFactory = $attrGroupsFactory;
$this->phpDocTagRemover = $phpDocTagRemover;
$this->phpDocNodeFinder = $phpDocNodeFinder;
2020-04-24 22:57:13 +00:00
}
public function getRuleDefinition() : \Symplify\RuleDocGenerator\ValueObject\RuleDefinition
2020-04-24 22:57:13 +00:00
{
return new \Symplify\RuleDocGenerator\ValueObject\RuleDefinition('Change annotation to attribute', [new \Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample(<<<'CODE_SAMPLE'
use Symfony\Component\Routing\Annotation\Route;
2020-04-24 22:57:13 +00:00
class SymfonyRoute
2020-04-24 22:57:13 +00:00
{
/**
* @Route("/path", name="action")
*/
public function action()
{
}
2020-04-24 22:57:13 +00:00
}
CODE_SAMPLE
, <<<'CODE_SAMPLE'
use Symfony\Component\Routing\Annotation\Route;
2020-04-24 22:57:13 +00:00
class SymfonyRoute
2020-04-24 22:57:13 +00:00
{
#[Route(path: '/path', name: 'action')]
public function action()
{
}
2020-04-24 22:57:13 +00:00
}
CODE_SAMPLE
, [new \Rector\Php80\ValueObject\AnnotationToAttribute('Symfony\\Component\\Routing\\Annotation\\Route')])]);
2020-04-24 22:57:13 +00:00
}
/**
* @return array<class-string<Node>>
2020-04-24 22:57:13 +00:00
*/
public function getNodeTypes() : array
2020-04-24 22:57:13 +00:00
{
return [\PhpParser\Node\Stmt\Class_::class, \PhpParser\Node\Stmt\Property::class, \PhpParser\Node\Param::class, \PhpParser\Node\Stmt\ClassMethod::class, \PhpParser\Node\Stmt\Function_::class, \PhpParser\Node\Expr\Closure::class, \PhpParser\Node\Expr\ArrowFunction::class];
2020-04-24 22:57:13 +00:00
}
/**
* @param \PhpParser\Node $node
2020-04-24 22:57:13 +00:00
*/
public function refactor($node) : ?\PhpParser\Node
2020-04-24 22:57:13 +00:00
{
$phpDocInfo = $this->phpDocInfoFactory->createFromNode($node);
if (!$phpDocInfo instanceof \Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo) {
return null;
}
// 1. generic tags
$genericAttributeGroups = $this->processGenericTags($phpDocInfo);
// 2. Doctrine annotation classes
$annotationAttributeGroups = $this->processDoctrineAnnotationClasses($phpDocInfo);
$attributeGroups = \array_merge($genericAttributeGroups, $annotationAttributeGroups);
if ($attributeGroups === []) {
return null;
}
$node->attrGroups = \array_merge($node->attrGroups, $attributeGroups);
return $node;
}
/**
* @param mixed[] $configuration
*/
public function configure($configuration) : void
{
$annotationsToAttributes = $configuration[self::ANNOTATION_TO_ATTRIBUTE] ?? $configuration;
\RectorPrefix20211210\Webmozart\Assert\Assert::allIsAOf($annotationsToAttributes, \Rector\Php80\ValueObject\AnnotationToAttribute::class);
$this->annotationsToAttributes = $annotationsToAttributes;
2020-04-24 22:57:13 +00:00
}
public function provideMinPhpVersion() : int
{
return \Rector\Core\ValueObject\PhpVersionFeature::ATTRIBUTES;
}
/**
* @return AttributeGroup[]
*/
private function processGenericTags(\Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo $phpDocInfo) : array
{
$attributeGroups = [];
$phpDocNodeTraverser = new \RectorPrefix20211210\Symplify\SimplePhpDocParser\PhpDocNodeTraverser();
$phpDocNodeTraverser->traverseWithCallable($phpDocInfo->getPhpDocNode(), '', function (\PHPStan\PhpDocParser\Ast\Node $docNode) use(&$attributeGroups, $phpDocInfo) : ?int {
if (!$docNode instanceof \PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagNode) {
return null;
}
if (!$docNode->value instanceof \PHPStan\PhpDocParser\Ast\PhpDoc\GenericTagValueNode) {
return null;
}
$tag = \trim($docNode->name, '@');
// not a basic one
if (\strpos($tag, '\\') !== \false) {
return null;
}
foreach ($this->annotationsToAttributes as $annotationToAttribute) {
$desiredTag = $annotationToAttribute->getTag();
if ($desiredTag !== $tag) {
continue;
}
$attributeGroups[] = $this->phpAttributeGroupFactory->createFromSimpleTag($annotationToAttribute);
$phpDocInfo->markAsChanged();
return \RectorPrefix20211210\Symplify\SimplePhpDocParser\PhpDocNodeTraverser::NODE_REMOVE;
}
return null;
});
return $attributeGroups;
}
/**
* @return AttributeGroup[]
*/
private function processDoctrineAnnotationClasses(\Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo $phpDocInfo) : array
{
if ($phpDocInfo->getPhpDocNode()->children === []) {
return [];
}
$doctrineTagAndAnnotationToAttributes = [];
foreach ($phpDocInfo->getPhpDocNode()->children as $phpDocChildNode) {
if (!$phpDocChildNode instanceof \PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagNode) {
continue;
}
if (!$phpDocChildNode->value instanceof \Rector\BetterPhpDocParser\PhpDoc\DoctrineAnnotationTagValueNode) {
continue;
}
$doctrineTagValueNode = $phpDocChildNode->value;
$annotationToAttribute = $this->matchAnnotationToAttribute($doctrineTagValueNode);
if (!$annotationToAttribute instanceof \Rector\Php80\ValueObject\AnnotationToAttribute) {
continue;
}
$nestedDoctrineAnnotationTagValueNodes = $this->phpDocNodeFinder->findByType($doctrineTagValueNode, \Rector\BetterPhpDocParser\PhpDoc\DoctrineAnnotationTagValueNode::class);
// depends on PHP 8.1+ - nested values, skip for now
if ($nestedDoctrineAnnotationTagValueNodes !== [] && !$this->phpVersionProvider->isAtLeastPhpVersion(\Rector\Core\ValueObject\PhpVersionFeature::NEW_INITIALIZERS)) {
continue;
}
$doctrineTagAndAnnotationToAttributes[] = new \Rector\Php80\ValueObject\DoctrineTagAndAnnotationToAttribute($doctrineTagValueNode, $annotationToAttribute);
$this->phpDocTagRemover->removeTagValueFromNode($phpDocInfo, $doctrineTagValueNode);
}
return $this->attrGroupsFactory->create($doctrineTagAndAnnotationToAttributes);
}
/**
* @return \Rector\Php80\ValueObject\AnnotationToAttribute|null
*/
private function matchAnnotationToAttribute(\Rector\BetterPhpDocParser\PhpDoc\DoctrineAnnotationTagValueNode $doctrineAnnotationTagValueNode)
{
foreach ($this->annotationsToAttributes as $annotationToAttribute) {
if (!$doctrineAnnotationTagValueNode->hasClassName($annotationToAttribute->getTag())) {
continue;
}
return $annotationToAttribute;
}
return null;
}
2020-04-24 22:57:13 +00:00
}