2018-02-09 00:14:45 +00:00
|
|
|
<?php declare(strict_types=1);
|
|
|
|
|
2018-08-01 18:34:58 +00:00
|
|
|
namespace Rector\Rector\Annotation;
|
2018-02-09 00:14:45 +00:00
|
|
|
|
|
|
|
use PhpParser\Node;
|
|
|
|
use PhpParser\Node\Stmt\ClassMethod;
|
|
|
|
use PhpParser\Node\Stmt\Property;
|
2019-01-25 00:49:26 +00:00
|
|
|
use Rector\Exception\ShouldNotHappenException;
|
2019-04-13 09:20:27 +00:00
|
|
|
use Rector\NodeTypeResolver\Node\AttributeKey;
|
2019-02-27 21:54:39 +00:00
|
|
|
use Rector\NodeTypeResolver\PhpDoc\NodeAnalyzer\DocBlockManipulator;
|
2018-02-09 00:14:45 +00:00
|
|
|
use Rector\Rector\AbstractPHPUnitRector;
|
2018-08-01 19:52:44 +00:00
|
|
|
use Rector\RectorDefinition\ConfiguredCodeSample;
|
2018-04-08 11:51:26 +00:00
|
|
|
use Rector\RectorDefinition\RectorDefinition;
|
2018-02-09 00:14:45 +00:00
|
|
|
|
2019-09-03 09:11:45 +00:00
|
|
|
/**
|
|
|
|
* @see \Rector\Tests\Rector\Annotation\RenameAnnotationRector\RenameAnnotationRectorTest
|
|
|
|
*/
|
2019-03-09 13:15:14 +00:00
|
|
|
final class RenameAnnotationRector extends AbstractPHPUnitRector
|
2018-02-09 00:14:45 +00:00
|
|
|
{
|
|
|
|
/**
|
|
|
|
* @var string[][]
|
|
|
|
*/
|
2018-02-09 00:16:54 +00:00
|
|
|
private $classToAnnotationMap = [];
|
2018-02-09 00:14:45 +00:00
|
|
|
|
|
|
|
/**
|
2018-10-31 11:53:59 +00:00
|
|
|
* @var string[]
|
2018-02-09 00:14:45 +00:00
|
|
|
*/
|
2018-10-31 11:53:59 +00:00
|
|
|
private $activeAnnotationMap = [];
|
2018-02-09 00:14:45 +00:00
|
|
|
|
2018-02-09 09:27:48 +00:00
|
|
|
/**
|
2019-02-27 21:54:39 +00:00
|
|
|
* @var DocBlockManipulator
|
2018-02-09 09:27:48 +00:00
|
|
|
*/
|
2019-02-27 21:54:39 +00:00
|
|
|
private $docBlockManipulator;
|
2018-02-09 09:27:48 +00:00
|
|
|
|
2018-02-09 00:14:45 +00:00
|
|
|
/**
|
|
|
|
* @param string[][] $classToAnnotationMap
|
|
|
|
*/
|
2019-04-26 13:32:24 +00:00
|
|
|
public function __construct(DocBlockManipulator $docBlockManipulator, array $classToAnnotationMap = [])
|
2018-10-14 10:48:21 +00:00
|
|
|
{
|
2019-02-27 21:54:39 +00:00
|
|
|
$this->docBlockManipulator = $docBlockManipulator;
|
2018-02-09 00:14:45 +00:00
|
|
|
$this->classToAnnotationMap = $classToAnnotationMap;
|
|
|
|
}
|
|
|
|
|
2018-04-08 11:51:26 +00:00
|
|
|
public function getDefinition(): RectorDefinition
|
|
|
|
{
|
2018-04-08 14:05:11 +00:00
|
|
|
return new RectorDefinition(
|
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(
|
2018-04-29 17:25:44 +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()
|
|
|
|
{
|
|
|
|
}
|
|
|
|
}
|
2018-04-29 17:25:44 +00:00
|
|
|
CODE_SAMPLE
|
|
|
|
,
|
|
|
|
<<<'CODE_SAMPLE'
|
2018-08-01 19:52:44 +00:00
|
|
|
class SomeTest extends PHPUnit\Framework\TestCase
|
|
|
|
{
|
2018-08-04 07:33:54 +00:00
|
|
|
/**
|
|
|
|
* @scenario
|
|
|
|
*/
|
2018-08-01 19:52:44 +00:00
|
|
|
public function someMethod()
|
|
|
|
{
|
|
|
|
}
|
|
|
|
}
|
2018-04-29 17:25:44 +00:00
|
|
|
CODE_SAMPLE
|
2018-08-01 19:52:44 +00:00
|
|
|
,
|
|
|
|
[
|
2018-11-11 12:22:35 +00:00
|
|
|
'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
|
|
|
/**
|
|
|
|
* @return string[]
|
|
|
|
*/
|
|
|
|
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
|
|
|
{
|
2018-02-09 09:27:48 +00:00
|
|
|
if ($this->shouldSkip($node)) {
|
2018-08-14 21:33:39 +00:00
|
|
|
return null;
|
2018-02-09 00:14:45 +00:00
|
|
|
}
|
2018-08-14 22:12:41 +00:00
|
|
|
|
2019-04-13 09:20:27 +00:00
|
|
|
$parentNode = $node->getAttribute(AttributeKey::PARENT_NODE);
|
2019-01-25 00:49:26 +00:00
|
|
|
if ($parentNode === null) {
|
2019-08-26 16:47:46 +00:00
|
|
|
throw new ShouldNotHappenException(__METHOD__ . '() on line ' . __LINE__);
|
2019-01-25 00:49:26 +00:00
|
|
|
}
|
|
|
|
|
2018-10-14 10:48:21 +00:00
|
|
|
$parentNodeTypes = $this->getTypes($parentNode);
|
2018-02-09 00:14:45 +00:00
|
|
|
foreach ($this->classToAnnotationMap as $type => $annotationMap) {
|
2018-08-04 07:33:54 +00:00
|
|
|
if (! in_array($type, $parentNodeTypes, true)) {
|
2018-02-09 00:14:45 +00:00
|
|
|
continue;
|
|
|
|
}
|
|
|
|
|
2018-02-09 09:27:48 +00:00
|
|
|
$this->activeAnnotationMap = $annotationMap;
|
|
|
|
|
2018-08-14 22:12:41 +00:00
|
|
|
if (! $this->hasAnyAnnotation($node)) {
|
|
|
|
return null;
|
2018-02-09 09:27:48 +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
|
|
|
foreach ($this->activeAnnotationMap as $oldAnnotation => $newAnnotation) {
|
2019-02-27 21:54:39 +00:00
|
|
|
$this->docBlockManipulator->replaceAnnotationInNode($node, $oldAnnotation, $newAnnotation);
|
2018-02-09 09:27:48 +00:00
|
|
|
}
|
2018-02-09 00:14:45 +00:00
|
|
|
|
2018-02-09 09:27:48 +00:00
|
|
|
return $node;
|
|
|
|
}
|
|
|
|
|
|
|
|
private function shouldSkip(Node $node): bool
|
|
|
|
{
|
|
|
|
if (! $node instanceof ClassMethod && ! $node instanceof Property) {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2019-08-29 20:44:30 +00:00
|
|
|
$parentNode = $node->getAttribute(AttributeKey::PARENT_NODE);
|
|
|
|
|
|
|
|
return $parentNode === null;
|
2018-02-09 09:27:48 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
private function hasAnyAnnotation(Node $node): bool
|
|
|
|
{
|
2018-09-06 12:50:23 +00:00
|
|
|
foreach (array_keys($this->activeAnnotationMap) as $oldAnnotation) {
|
2019-02-27 21:54:39 +00:00
|
|
|
if ($this->docBlockManipulator->hasTag($node, $oldAnnotation)) {
|
2018-02-09 09:27:48 +00:00
|
|
|
return true;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return false;
|
2018-02-09 00:14:45 +00:00
|
|
|
}
|
|
|
|
}
|