Updated Rector to commit 97e2433a8378ccc6666c67d4a01ace3abc97589f

97e2433a83 [CodeQuality] Allow transform return; to return null; when there is other return with Expr on ExplicitReturnNullRector (#5761)
This commit is contained in:
Tomas Votruba 2024-03-23 06:28:38 +00:00
parent 74b8ed7cd4
commit e18e5ef364
2 changed files with 34 additions and 24 deletions

View File

@ -4,18 +4,23 @@ declare (strict_types=1);
namespace Rector\CodeQuality\Rector\ClassMethod; namespace Rector\CodeQuality\Rector\ClassMethod;
use PhpParser\Node; use PhpParser\Node;
use PhpParser\Node\Expr;
use PhpParser\Node\Expr\Closure;
use PhpParser\Node\Expr\ConstFetch; use PhpParser\Node\Expr\ConstFetch;
use PhpParser\Node\Name; use PhpParser\Node\Name;
use PhpParser\Node\Stmt\Class_;
use PhpParser\Node\Stmt\ClassMethod; use PhpParser\Node\Stmt\ClassMethod;
use PhpParser\Node\Stmt\Function_;
use PhpParser\Node\Stmt\Return_; use PhpParser\Node\Stmt\Return_;
use PhpParser\NodeTraverser;
use PHPStan\Type\NullType; use PHPStan\Type\NullType;
use PHPStan\Type\UnionType; use PHPStan\Type\UnionType;
use PHPStan\Type\VoidType; use PHPStan\Type\VoidType;
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory; use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
use Rector\BetterPhpDocParser\PhpDocManipulator\PhpDocTypeChanger; use Rector\BetterPhpDocParser\PhpDocManipulator\PhpDocTypeChanger;
use Rector\NodeTypeResolver\PHPStan\Type\TypeFactory; use Rector\NodeTypeResolver\PHPStan\Type\TypeFactory;
use Rector\PhpParser\Node\BetterNodeFinder;
use Rector\Rector\AbstractRector; use Rector\Rector\AbstractRector;
use Rector\TypeDeclaration\TypeInferer\ReturnTypeInferer;
use Rector\TypeDeclaration\TypeInferer\SilentVoidResolver; use Rector\TypeDeclaration\TypeInferer\SilentVoidResolver;
use Rector\ValueObject\MethodName; use Rector\ValueObject\MethodName;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample; use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
@ -25,11 +30,6 @@ use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
*/ */
final class ExplicitReturnNullRector extends AbstractRector final class ExplicitReturnNullRector extends AbstractRector
{ {
/**
* @readonly
* @var \Rector\PhpParser\Node\BetterNodeFinder
*/
private $betterNodeFinder;
/** /**
* @readonly * @readonly
* @var \Rector\TypeDeclaration\TypeInferer\SilentVoidResolver * @var \Rector\TypeDeclaration\TypeInferer\SilentVoidResolver
@ -50,13 +50,18 @@ final class ExplicitReturnNullRector extends AbstractRector
* @var \Rector\BetterPhpDocParser\PhpDocManipulator\PhpDocTypeChanger * @var \Rector\BetterPhpDocParser\PhpDocManipulator\PhpDocTypeChanger
*/ */
private $phpDocTypeChanger; private $phpDocTypeChanger;
public function __construct(BetterNodeFinder $betterNodeFinder, SilentVoidResolver $silentVoidResolver, PhpDocInfoFactory $phpDocInfoFactory, TypeFactory $typeFactory, PhpDocTypeChanger $phpDocTypeChanger) /**
* @readonly
* @var \Rector\TypeDeclaration\TypeInferer\ReturnTypeInferer
*/
private $returnTypeInferer;
public function __construct(SilentVoidResolver $silentVoidResolver, PhpDocInfoFactory $phpDocInfoFactory, TypeFactory $typeFactory, PhpDocTypeChanger $phpDocTypeChanger, ReturnTypeInferer $returnTypeInferer)
{ {
$this->betterNodeFinder = $betterNodeFinder;
$this->silentVoidResolver = $silentVoidResolver; $this->silentVoidResolver = $silentVoidResolver;
$this->phpDocInfoFactory = $phpDocInfoFactory; $this->phpDocInfoFactory = $phpDocInfoFactory;
$this->typeFactory = $typeFactory; $this->typeFactory = $typeFactory;
$this->phpDocTypeChanger = $phpDocTypeChanger; $this->phpDocTypeChanger = $phpDocTypeChanger;
$this->returnTypeInferer = $returnTypeInferer;
} }
public function getRuleDefinition() : RuleDefinition public function getRuleDefinition() : RuleDefinition
{ {
@ -111,11 +116,27 @@ CODE_SAMPLE
if ($this->isName($node, MethodName::CONSTRUCT)) { if ($this->isName($node, MethodName::CONSTRUCT)) {
return null; return null;
} }
if (!$this->silentVoidResolver->hasSilentVoid($node)) { $returnType = $this->returnTypeInferer->inferFunctionLike($node);
if (!$returnType instanceof UnionType) {
return null; return null;
} }
// it has at least some return value in it $hasChanged = \false;
if (!$this->hasReturnsWithValues($node)) { $this->traverseNodesWithCallable((array) $node->stmts, static function (Node $node) use(&$hasChanged) {
if ($node instanceof Class_ || $node instanceof Function_ || $node instanceof Closure) {
return NodeTraverser::DONT_TRAVERSE_CURRENT_AND_CHILDREN;
}
if ($node instanceof Return_ && !$node->expr instanceof Expr) {
$hasChanged = \true;
$node->expr = new ConstFetch(new Name('null'));
return $node;
}
return null;
});
if (!$this->silentVoidResolver->hasSilentVoid($node)) {
if ($hasChanged) {
$this->transformDocUnionVoidToUnionNull($node);
return $node;
}
return null; return null;
} }
$node->stmts[] = new Return_(new ConstFetch(new Name('null'))); $node->stmts[] = new Return_(new ConstFetch(new Name('null')));
@ -147,15 +168,4 @@ CODE_SAMPLE
} }
$this->phpDocTypeChanger->changeReturnType($classMethod, $phpDocInfo, $type); $this->phpDocTypeChanger->changeReturnType($classMethod, $phpDocInfo, $type);
} }
private function hasReturnsWithValues(ClassMethod $classMethod) : bool
{
/** @var Return_[] $returns */
$returns = $this->betterNodeFinder->findInstancesOfInFunctionLikeScoped($classMethod, Return_::class);
foreach ($returns as $return) {
if (!$return->expr instanceof Node) {
return \false;
}
}
return $returns !== [];
}
} }

View File

@ -19,12 +19,12 @@ final class VersionResolver
* @api * @api
* @var string * @var string
*/ */
public const PACKAGE_VERSION = 'cae06912ed7d7274d900fdc996448f100be2ed34'; public const PACKAGE_VERSION = '97e2433a8378ccc6666c67d4a01ace3abc97589f';
/** /**
* @api * @api
* @var string * @var string
*/ */
public const RELEASE_DATE = '2024-03-23 12:10:30'; public const RELEASE_DATE = '2024-03-23 13:26:17';
/** /**
* @var int * @var int
*/ */