mirror of
https://github.com/rectorphp/rector.git
synced 2024-06-13 22:52:23 +00:00
7e7a2f067a
476cfb00cb
disable fallback for now
206 lines
7.1 KiB
PHP
206 lines
7.1 KiB
PHP
<?php
|
|
|
|
declare (strict_types=1);
|
|
namespace Rector\PHPUnit\CodeQuality\Rector\Class_;
|
|
|
|
use PhpParser\Node;
|
|
use PhpParser\Node\Expr;
|
|
use PhpParser\Node\Expr\StaticCall;
|
|
use PhpParser\Node\Expr\Variable;
|
|
use PhpParser\Node\Identifier;
|
|
use PhpParser\Node\Stmt;
|
|
use PhpParser\Node\Stmt\Class_;
|
|
use PhpParser\Node\Stmt\ClassMethod;
|
|
use PhpParser\Node\Stmt\Expression;
|
|
use PhpParser\NodeTraverser;
|
|
use PHPStan\Reflection\ClassReflection;
|
|
use Rector\NodeAnalyzer\ClassAnalyzer;
|
|
use Rector\NodeTypeResolver\Node\AttributeKey;
|
|
use Rector\PHPUnit\NodeAnalyzer\SetUpMethodDecorator;
|
|
use Rector\PHPUnit\NodeAnalyzer\TestsNodeAnalyzer;
|
|
use Rector\Privatization\NodeManipulator\VisibilityManipulator;
|
|
use Rector\Rector\AbstractRector;
|
|
use Rector\Reflection\ReflectionResolver;
|
|
use Rector\ValueObject\MethodName;
|
|
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
|
|
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
|
|
/**
|
|
* @changelog https://github.com/sebastianbergmann/phpunit/issues/3975#issuecomment-562584609
|
|
*
|
|
* @see \Rector\PHPUnit\Tests\CodeQuality\Rector\Class_\ConstructClassMethodToSetUpTestCaseRector\ConstructClassMethodToSetUpTestCaseRectorTest
|
|
*/
|
|
final class ConstructClassMethodToSetUpTestCaseRector extends AbstractRector
|
|
{
|
|
/**
|
|
* @readonly
|
|
* @var \Rector\PHPUnit\NodeAnalyzer\TestsNodeAnalyzer
|
|
*/
|
|
private $testsNodeAnalyzer;
|
|
/**
|
|
* @readonly
|
|
* @var \Rector\NodeAnalyzer\ClassAnalyzer
|
|
*/
|
|
private $classAnalyzer;
|
|
/**
|
|
* @readonly
|
|
* @var \Rector\Privatization\NodeManipulator\VisibilityManipulator
|
|
*/
|
|
private $visibilityManipulator;
|
|
/**
|
|
* @readonly
|
|
* @var \Rector\PHPUnit\NodeAnalyzer\SetUpMethodDecorator
|
|
*/
|
|
private $setUpMethodDecorator;
|
|
/**
|
|
* @readonly
|
|
* @var \Rector\Reflection\ReflectionResolver
|
|
*/
|
|
private $reflectionResolver;
|
|
public function __construct(TestsNodeAnalyzer $testsNodeAnalyzer, ClassAnalyzer $classAnalyzer, VisibilityManipulator $visibilityManipulator, SetUpMethodDecorator $setUpMethodDecorator, ReflectionResolver $reflectionResolver)
|
|
{
|
|
$this->testsNodeAnalyzer = $testsNodeAnalyzer;
|
|
$this->classAnalyzer = $classAnalyzer;
|
|
$this->visibilityManipulator = $visibilityManipulator;
|
|
$this->setUpMethodDecorator = $setUpMethodDecorator;
|
|
$this->reflectionResolver = $reflectionResolver;
|
|
}
|
|
public function getRuleDefinition() : RuleDefinition
|
|
{
|
|
return new RuleDefinition('Change __construct() method in tests of `PHPUnit\\Framework\\TestCase` to setUp(), to prevent dangerous override', [new CodeSample(<<<'CODE_SAMPLE'
|
|
use PHPUnit\Framework\TestCase;
|
|
|
|
final class SomeTest extends TestCase
|
|
{
|
|
private $someValue;
|
|
|
|
public function __construct(?string $name = null, array $data = [], string $dataName = '')
|
|
{
|
|
$this->someValue = 1000;
|
|
parent::__construct($name, $data, $dataName);
|
|
}
|
|
}
|
|
CODE_SAMPLE
|
|
, <<<'CODE_SAMPLE'
|
|
use PHPUnit\Framework\TestCase;
|
|
|
|
final class SomeTest extends TestCase
|
|
{
|
|
private $someValue;
|
|
|
|
protected function setUp()
|
|
{
|
|
parent::setUp();
|
|
|
|
$this->someValue = 1000;
|
|
}
|
|
}
|
|
CODE_SAMPLE
|
|
)]);
|
|
}
|
|
/**
|
|
* @return array<class-string<Node>>
|
|
*/
|
|
public function getNodeTypes() : array
|
|
{
|
|
return [Class_::class];
|
|
}
|
|
/**
|
|
* @param Class_ $node
|
|
*/
|
|
public function refactor(Node $node) : ?Node
|
|
{
|
|
if (!$this->testsNodeAnalyzer->isInTestClass($node)) {
|
|
return null;
|
|
}
|
|
$constructClassMethod = $node->getMethod(MethodName::CONSTRUCT);
|
|
if (!$constructClassMethod instanceof ClassMethod) {
|
|
return null;
|
|
}
|
|
if ($this->classAnalyzer->isAnonymousClass($node)) {
|
|
return null;
|
|
}
|
|
if ($this->shouldSkip($node, $constructClassMethod)) {
|
|
return null;
|
|
}
|
|
$addedStmts = $this->resolveStmtsToAddToSetUp($constructClassMethod);
|
|
$setUpClassMethod = $node->getMethod(MethodName::SET_UP);
|
|
if (!$setUpClassMethod instanceof ClassMethod) {
|
|
// no setUp() method yet, rename it to setUp :)
|
|
$constructClassMethod->name = new Identifier(MethodName::SET_UP);
|
|
$constructClassMethod->params = [];
|
|
$constructClassMethod->stmts = $addedStmts;
|
|
$this->setUpMethodDecorator->decorate($constructClassMethod);
|
|
$this->visibilityManipulator->makeProtected($constructClassMethod);
|
|
} else {
|
|
$stmtKey = $constructClassMethod->getAttribute(AttributeKey::STMT_KEY);
|
|
unset($node->stmts[$stmtKey]);
|
|
$setUpClassMethod->stmts = \array_merge((array) $setUpClassMethod->stmts, $addedStmts);
|
|
}
|
|
return $node;
|
|
}
|
|
private function shouldSkip(Class_ $class, ClassMethod $classMethod) : bool
|
|
{
|
|
$classReflection = $this->reflectionResolver->resolveClassReflection($class);
|
|
if (!$classReflection instanceof ClassReflection) {
|
|
return \true;
|
|
}
|
|
$currentParent = \current($classReflection->getParents());
|
|
if (!$currentParent instanceof ClassReflection) {
|
|
return \true;
|
|
}
|
|
if ($currentParent->getName() !== 'PHPUnit\\Framework\\TestCase') {
|
|
return \true;
|
|
}
|
|
$paramNames = [];
|
|
foreach ($classMethod->params as $param) {
|
|
$paramNames[] = $this->getName($param);
|
|
}
|
|
$isFoundParamUsed = \false;
|
|
$this->traverseNodesWithCallable((array) $classMethod->stmts, function (Node $subNode) use($paramNames, &$isFoundParamUsed) : ?int {
|
|
if ($subNode instanceof StaticCall && $this->isName($subNode->name, MethodName::CONSTRUCT)) {
|
|
return NodeTraverser::DONT_TRAVERSE_CHILDREN;
|
|
}
|
|
if ($subNode instanceof Variable && $this->isNames($subNode, $paramNames)) {
|
|
$isFoundParamUsed = \true;
|
|
return NodeTraverser::STOP_TRAVERSAL;
|
|
}
|
|
return null;
|
|
});
|
|
return $isFoundParamUsed;
|
|
}
|
|
/**
|
|
* @return Stmt[]
|
|
*/
|
|
private function resolveStmtsToAddToSetUp(ClassMethod $constructClassMethod) : array
|
|
{
|
|
$constructorStmts = (array) $constructClassMethod->stmts;
|
|
// remove parent call
|
|
foreach ($constructorStmts as $key => $constructorStmt) {
|
|
if ($constructorStmt instanceof Expression) {
|
|
$constructorStmt = clone $constructorStmt->expr;
|
|
}
|
|
if (!$this->isParentCallNamed($constructorStmt, MethodName::CONSTRUCT)) {
|
|
continue;
|
|
}
|
|
unset($constructorStmts[$key]);
|
|
}
|
|
return $constructorStmts;
|
|
}
|
|
private function isParentCallNamed(Node $node, string $desiredMethodName) : bool
|
|
{
|
|
if (!$node instanceof StaticCall) {
|
|
return \false;
|
|
}
|
|
if ($node->class instanceof Expr) {
|
|
return \false;
|
|
}
|
|
if (!$this->nodeNameResolver->isName($node->class, 'parent')) {
|
|
return \false;
|
|
}
|
|
if ($node->name instanceof Expr) {
|
|
return \false;
|
|
}
|
|
return $this->nodeNameResolver->isName($node->name, $desiredMethodName);
|
|
}
|
|
}
|