2019-10-13 05:59:52 +00:00
|
|
|
<?php
|
|
|
|
|
|
|
|
declare(strict_types=1);
|
2018-02-09 00:14:45 +00:00
|
|
|
|
2020-08-18 15:57:30 +00:00
|
|
|
namespace Rector\Renaming\Rector\ClassMethod;
|
2018-02-09 00:14:45 +00:00
|
|
|
|
|
|
|
use PhpParser\Node;
|
2019-09-06 10:30:58 +00:00
|
|
|
use PhpParser\Node\Stmt\Class_;
|
2018-02-09 00:14:45 +00:00
|
|
|
use PhpParser\Node\Stmt\ClassMethod;
|
|
|
|
use PhpParser\Node\Stmt\Property;
|
2020-07-29 13:55:33 +00:00
|
|
|
use Rector\Core\Contract\Rector\ConfigurableRectorInterface;
|
2021-01-28 21:24:00 +00:00
|
|
|
use Rector\Core\Rector\AbstractRector;
|
2019-04-13 09:20:27 +00:00
|
|
|
use Rector\NodeTypeResolver\Node\AttributeKey;
|
2021-01-19 15:03:26 +00:00
|
|
|
use Rector\NodeTypeResolver\PhpDoc\NodeAnalyzer\DocBlockTagReplacer;
|
2020-09-12 21:19:08 +00:00
|
|
|
use Rector\Renaming\ValueObject\RenameAnnotation;
|
2020-11-16 17:50:38 +00:00
|
|
|
use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
|
|
|
|
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
|
2020-08-26 10:54:53 +00:00
|
|
|
use Webmozart\Assert\Assert;
|
2018-02-09 00:14:45 +00:00
|
|
|
|
2019-09-03 09:11:45 +00:00
|
|
|
/**
|
2020-08-18 15:57:30 +00:00
|
|
|
* @see \Rector\Renaming\Tests\Rector\ClassMethod\RenameAnnotationRector\RenameAnnotationRectorTest
|
2019-09-03 09:11:45 +00:00
|
|
|
*/
|
2021-01-28 21:24:00 +00:00
|
|
|
final class RenameAnnotationRector extends AbstractRector implements ConfigurableRectorInterface
|
2018-02-09 00:14:45 +00:00
|
|
|
{
|
|
|
|
/**
|
2020-07-29 13:55:33 +00:00
|
|
|
* @var string
|
2018-02-09 00:14:45 +00:00
|
|
|
*/
|
2020-08-26 10:54:53 +00:00
|
|
|
public const RENAMED_ANNOTATIONS_IN_TYPES = 'renamed_annotations_in_types';
|
2018-02-09 00:14:45 +00:00
|
|
|
|
|
|
|
/**
|
2020-09-12 21:19:08 +00:00
|
|
|
* @var RenameAnnotation[]
|
2018-02-09 00:14:45 +00:00
|
|
|
*/
|
2021-01-19 15:03:26 +00:00
|
|
|
private $renamedAnnotations = [];
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @var DocBlockTagReplacer
|
|
|
|
*/
|
|
|
|
private $docBlockTagReplacer;
|
|
|
|
|
|
|
|
public function __construct(DocBlockTagReplacer $docBlockTagReplacer)
|
|
|
|
{
|
|
|
|
$this->docBlockTagReplacer = $docBlockTagReplacer;
|
|
|
|
}
|
2018-02-09 00:14:45 +00:00
|
|
|
|
2020-11-16 17:50:38 +00:00
|
|
|
public function getRuleDefinition(): RuleDefinition
|
2018-04-08 11:51:26 +00:00
|
|
|
{
|
2020-11-16 17:50:38 +00:00
|
|
|
return new RuleDefinition(
|
2018-08-01 13:34:55 +00:00
|
|
|
'Turns defined annotations above properties and methods to their new values.',
|
2018-04-08 14:05:11 +00:00
|
|
|
[
|
2018-08-01 19:52:44 +00:00
|
|
|
new ConfiguredCodeSample(
|
2020-09-15 08:23:13 +00:00
|
|
|
<<<'CODE_SAMPLE'
|
2018-08-01 19:52:44 +00:00
|
|
|
class SomeTest extends PHPUnit\Framework\TestCase
|
|
|
|
{
|
2018-08-04 07:33:54 +00:00
|
|
|
/**
|
|
|
|
* @test
|
|
|
|
*/
|
2018-08-01 19:52:44 +00:00
|
|
|
public function someMethod()
|
|
|
|
{
|
|
|
|
}
|
|
|
|
}
|
2020-09-15 08:23:13 +00:00
|
|
|
CODE_SAMPLE
|
2018-04-29 17:25:44 +00:00
|
|
|
,
|
2020-09-15 08:23:13 +00:00
|
|
|
<<<'CODE_SAMPLE'
|
2018-08-01 19:52:44 +00:00
|
|
|
class SomeTest extends PHPUnit\Framework\TestCase
|
|
|
|
{
|
2020-02-04 07:54:00 +00:00
|
|
|
/**
|
2018-08-04 07:33:54 +00:00
|
|
|
* @scenario
|
|
|
|
*/
|
2018-08-01 19:52:44 +00:00
|
|
|
public function someMethod()
|
|
|
|
{
|
|
|
|
}
|
|
|
|
}
|
2020-09-15 08:23:13 +00:00
|
|
|
CODE_SAMPLE
|
2018-08-01 19:52:44 +00:00
|
|
|
,
|
|
|
|
[
|
2020-08-26 10:54:53 +00:00
|
|
|
self::RENAMED_ANNOTATIONS_IN_TYPES => [
|
2020-09-12 21:19:08 +00:00
|
|
|
new RenameAnnotation('PHPUnit\Framework\TestCase', 'test', 'scenario'),
|
2018-08-01 19:52:44 +00:00
|
|
|
],
|
|
|
|
]
|
2018-04-08 14:05:11 +00:00
|
|
|
),
|
|
|
|
]
|
|
|
|
);
|
2018-04-08 11:51:26 +00:00
|
|
|
}
|
|
|
|
|
2018-08-14 22:12:41 +00:00
|
|
|
/**
|
2021-02-27 00:06:15 +00:00
|
|
|
* @return array<class-string<Node>>
|
2018-08-14 22:12:41 +00:00
|
|
|
*/
|
|
|
|
public function getNodeTypes(): array
|
2018-08-14 21:33:39 +00:00
|
|
|
{
|
|
|
|
return [ClassMethod::class, Property::class];
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param ClassMethod|Property $node
|
|
|
|
*/
|
|
|
|
public function refactor(Node $node): ?Node
|
2018-02-09 00:14:45 +00:00
|
|
|
{
|
2020-07-19 18:52:42 +00:00
|
|
|
$classLike = $node->getAttribute(AttributeKey::CLASS_NODE);
|
2021-01-19 15:03:26 +00:00
|
|
|
if (! $classLike instanceof Class_) {
|
|
|
|
return null;
|
|
|
|
}
|
2019-01-25 00:49:26 +00:00
|
|
|
|
2021-01-18 21:45:13 +00:00
|
|
|
$phpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($node);
|
2018-02-09 00:14:45 +00:00
|
|
|
|
2021-03-05 10:55:40 +00:00
|
|
|
foreach ($this->renamedAnnotations as $renamedAnnotation) {
|
|
|
|
if (! $this->isObjectType($classLike, $renamedAnnotation->getObjectType())) {
|
2020-08-26 10:54:53 +00:00
|
|
|
continue;
|
2018-02-09 09:27:48 +00:00
|
|
|
}
|
2020-08-26 10:54:53 +00:00
|
|
|
|
2021-01-19 15:03:26 +00:00
|
|
|
$this->docBlockTagReplacer->replaceTagByAnother(
|
|
|
|
$phpDocInfo,
|
2021-03-05 10:55:40 +00:00
|
|
|
$renamedAnnotation->getOldAnnotation(),
|
|
|
|
$renamedAnnotation->getNewAnnotation()
|
2021-01-19 15:03:26 +00:00
|
|
|
);
|
2018-02-09 00:14:45 +00:00
|
|
|
}
|
2018-08-14 22:12:41 +00:00
|
|
|
|
2018-02-09 09:27:48 +00:00
|
|
|
return $node;
|
|
|
|
}
|
2020-07-29 13:55:33 +00:00
|
|
|
|
|
|
|
public function configure(array $configuration): void
|
|
|
|
{
|
2020-08-26 10:54:53 +00:00
|
|
|
$renamedAnnotationsInTypes = $configuration[self::RENAMED_ANNOTATIONS_IN_TYPES] ?? [];
|
2020-09-12 21:19:08 +00:00
|
|
|
Assert::allIsInstanceOf($renamedAnnotationsInTypes, RenameAnnotation::class);
|
2021-01-19 15:03:26 +00:00
|
|
|
$this->renamedAnnotations = $renamedAnnotationsInTypes;
|
2020-07-29 13:55:33 +00:00
|
|
|
}
|
2018-02-09 00:14:45 +00:00
|
|
|
}
|