octoleo/rector
1
1
Fork 0
mirror of https://github.com/rectorphp/rector.git synced 2024-06-01 17:00:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated Rector to commit 2406dc813a3eba3e25522fcb69af879fbc4a60cd

Browse Source 
2406dc813a [Traverser] Add ByRefReturnNodeVisitor (#3826)
This commit is contained in:
Tomas Votruba 2023-05-13 18:07:42 +00:00
parent 6eead6b8f7
commit 722cf05380
10 changed files with 89 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
packages/NodeTypeResolver/Node/AttributeKey.php
View File

@ -182,4 +182,8 @@ final class AttributeKey
* @var string
*/
public const IS_BYREF_VAR = 'is_byref_var';
/**
* @var string
*/
public const IS_BYREF_RETURN = 'is_byref_return';
}

49
packages/NodeTypeResolver/PHPStan/Scope/NodeVisitor/ByRefReturnNodeVisitor.php Normal file
View File

@ -0,0 +1,49 @@
<?php
declare (strict_types=1);
namespace Rector\NodeTypeResolver\PHPStan\Scope\NodeVisitor;
use PhpParser\Node;
use PhpParser\Node\Expr\CallLike;
use PhpParser\Node\FunctionLike;
use PhpParser\Node\Stmt\Return_;
use PhpParser\NodeTraverser;
use PhpParser\NodeVisitorAbstract;
use Rector\NodeTypeResolver\Node\AttributeKey;
use Rector\PhpDocParser\NodeTraverser\SimpleCallableNodeTraverser;
final class ByRefReturnNodeVisitor extends NodeVisitorAbstract
{
/**
* @readonly
* @var \Rector\PhpDocParser\NodeTraverser\SimpleCallableNodeTraverser
*/
private $simpleCallableNodeTraverser;
public function __construct(SimpleCallableNodeTraverser $simpleCallableNodeTraverser)
{
$this->simpleCallableNodeTraverser = $simpleCallableNodeTraverser;
}
public function enterNode(Node $node) : ?Node
{
if (!$node instanceof FunctionLike) {
return null;
}
if (!$node->returnsByRef()) {
return null;
}
$stmts = $node->getStmts();
if ($stmts === null) {
return null;
}
$this->simpleCallableNodeTraverser->traverseNodesWithCallable($stmts, static function (Node $subNode) {
if ($subNode instanceof CallLike || $subNode instanceof FunctionLike) {
return NodeTraverser::DONT_TRAVERSE_CURRENT_AND_CHILDREN;
}
if (!$subNode instanceof Return_) {
return null;
}
$subNode->setAttribute(AttributeKey::IS_BYREF_RETURN, \true);
return $subNode;
});
return null;
}
}

4
packages/NodeTypeResolver/PHPStan/Scope/PHPStanNodeScopeResolver.php
View File

@ -50,6 +50,7 @@ use Rector\Core\Util\Reflection\PrivatesAccessor;
use Rector\NodeNameResolver\NodeNameResolver;
use Rector\NodeTypeResolver\Node\AttributeKey;
use Rector\NodeTypeResolver\PHPStan\Scope\NodeVisitor\AssignedToNodeVisitor;
use Rector\NodeTypeResolver\PHPStan\Scope\NodeVisitor\ByRefReturnNodeVisitor;
use Rector\NodeTypeResolver\PHPStan\Scope\NodeVisitor\ByRefVariableNodeVisitor;
use Rector\NodeTypeResolver\PHPStan\Scope\NodeVisitor\GlobalVariableNodeVisitor;
use Rector\NodeTypeResolver\PHPStan\Scope\NodeVisitor\RemoveDeepChainMethodCallNodeVisitor;
@ -115,7 +116,7 @@ final class PHPStanNodeScopeResolver
* @var \Rector\Core\NodeAnalyzer\ClassAnalyzer
*/
private $classAnalyzer;
public function __construct(ChangedFilesDetector $changedFilesDetector, DependencyResolver $dependencyResolver, NodeScopeResolver $nodeScopeResolver, ReflectionProvider $reflectionProvider, RemoveDeepChainMethodCallNodeVisitor $removeDeepChainMethodCallNodeVisitor, AssignedToNodeVisitor $assignedToNodeVisitor, GlobalVariableNodeVisitor $globalVariableNodeVisitor, StaticVariableNodeVisitor $staticVariableNodeVisitor, ByRefVariableNodeVisitor $byRefVariableNodeVisitor, \Rector\NodeTypeResolver\PHPStan\Scope\ScopeFactory $scopeFactory, PrivatesAccessor $privatesAccessor, NodeNameResolver $nodeNameResolver, BetterNodeFinder $betterNodeFinder, ClassAnalyzer $classAnalyzer)
public function __construct(ChangedFilesDetector $changedFilesDetector, DependencyResolver $dependencyResolver, NodeScopeResolver $nodeScopeResolver, ReflectionProvider $reflectionProvider, RemoveDeepChainMethodCallNodeVisitor $removeDeepChainMethodCallNodeVisitor, AssignedToNodeVisitor $assignedToNodeVisitor, GlobalVariableNodeVisitor $globalVariableNodeVisitor, StaticVariableNodeVisitor $staticVariableNodeVisitor, ByRefVariableNodeVisitor $byRefVariableNodeVisitor, ByRefReturnNodeVisitor $byRefReturnNodeVisitor, \Rector\NodeTypeResolver\PHPStan\Scope\ScopeFactory $scopeFactory, PrivatesAccessor $privatesAccessor, NodeNameResolver $nodeNameResolver, BetterNodeFinder $betterNodeFinder, ClassAnalyzer $classAnalyzer)
{
$this->changedFilesDetector = $changedFilesDetector;
$this->dependencyResolver = $dependencyResolver;
@ -132,6 +133,7 @@ final class PHPStanNodeScopeResolver
$this->nodeTraverser->addVisitor($globalVariableNodeVisitor);
$this->nodeTraverser->addVisitor($staticVariableNodeVisitor);
$this->nodeTraverser->addVisitor($byRefVariableNodeVisitor);
$this->nodeTraverser->addVisitor($byRefReturnNodeVisitor);
}
/**
* @param Stmt[] $stmts

28
rules/CodeQuality/NodeAnalyzer/ReturnAnalyzer.php
View File

@ -1,28 +0,0 @@
<?php
declare (strict_types=1);
namespace Rector\CodeQuality\NodeAnalyzer;
use PhpParser\Node\FunctionLike;
use PhpParser\Node\Stmt\Return_;
use Rector\Core\PhpParser\Node\BetterNodeFinder;
final class ReturnAnalyzer
{
/**
* @readonly
* @var \Rector\Core\PhpParser\Node\BetterNodeFinder
*/
private $betterNodeFinder;
public function __construct(BetterNodeFinder $betterNodeFinder)
{
$this->betterNodeFinder = $betterNodeFinder;
}
public function hasByRefReturn(Return_ $return) : bool
{
$parentFunctionLike = $this->betterNodeFinder->findParentType($return, FunctionLike::class);
if ($parentFunctionLike instanceof FunctionLike) {
return $parentFunctionLike->returnsByRef();
}
return \false;
}
}

41
rules/CodeQuality/Rector/FunctionLike/SimplifyUselessVariableRector.php
View File

@ -11,20 +11,21 @@ use PhpParser\Node\Expr\Variable;
use PhpParser\Node\Stmt;
use PhpParser\Node\Stmt\Expression;
use PhpParser\Node\Stmt\Return_;
use PHPStan\Analyser\Scope;
use PHPStan\Reflection\FunctionReflection;
use PHPStan\Type\MixedType;
use Rector\CodeQuality\NodeAnalyzer\ReturnAnalyzer;
use Rector\Core\Contract\PhpParser\Node\StmtsAwareInterface;
use Rector\Core\NodeAnalyzer\CallAnalyzer;
use Rector\Core\NodeAnalyzer\VariableAnalyzer;
use Rector\Core\PhpParser\Node\AssignAndBinaryMap;
use Rector\Core\Rector\AbstractRector;
use Rector\Core\Rector\AbstractScopeAwareRector;
use Rector\NodeTypeResolver\Node\AttributeKey;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
/**
* @see Based on https://github.com/slevomat/coding-standard/blob/master/SlevomatCodingStandard/Sniffs/Variables/UselessVariableSniff.php
* @see \Rector\Tests\CodeQuality\Rector\FunctionLike\SimplifyUselessVariableRector\SimplifyUselessVariableRectorTest
*/
final class SimplifyUselessVariableRector extends AbstractRector
final class SimplifyUselessVariableRector extends AbstractScopeAwareRector
{
/**
* @readonly
@ -41,17 +42,11 @@ final class SimplifyUselessVariableRector extends AbstractRector
* @var \Rector\Core\NodeAnalyzer\CallAnalyzer
*/
private $callAnalyzer;
/**
* @readonly
* @var \Rector\CodeQuality\NodeAnalyzer\ReturnAnalyzer
*/
private $returnAnalyzer;
public function __construct(AssignAndBinaryMap $assignAndBinaryMap, VariableAnalyzer $variableAnalyzer, CallAnalyzer $callAnalyzer, ReturnAnalyzer $returnAnalyzer)
public function __construct(AssignAndBinaryMap $assignAndBinaryMap, VariableAnalyzer $variableAnalyzer, CallAnalyzer $callAnalyzer)
{
$this->assignAndBinaryMap = $assignAndBinaryMap;
$this->variableAnalyzer = $variableAnalyzer;
$this->callAnalyzer = $callAnalyzer;
$this->returnAnalyzer = $returnAnalyzer;
}
public function getRuleDefinition() : RuleDefinition
{
@ -78,13 +73,14 @@ CODE_SAMPLE
/**
* @param StmtsAwareInterface $node
*/
public function refactor(Node $node) : ?Node
public function refactorWithScope(Node $node, Scope $scope) : ?Node
{
$stmts = $node->stmts;
if ($stmts === null) {
return null;
}
foreach ($stmts as $key => $stmt) {
// has previous node?
if (!isset($stmts[$key - 1])) {
continue;
}
@ -92,16 +88,16 @@ CODE_SAMPLE
continue;
}
$previousStmt = $stmts[$key - 1];
if ($this->shouldSkipStmt($stmt, $previousStmt)) {
if ($this->shouldSkipStmt($stmt, $previousStmt, $scope)) {
return null;
}
if ($this->hasSomeComment($previousStmt)) {
return null;
}
if ($this->isReturnWithVarAnnotation($stmt)) {
return null;
}
/**
* @var Expression $previousStmt
* @var Assign|AssignOp $assign
*/
/** @var Expression<Assign|AssignOp> $previousStmt */
$assign = $previousStmt->expr;
return $this->processSimplifyUselessVariable($node, $stmt, $assign, $key);
}
@ -124,15 +120,16 @@ CODE_SAMPLE
unset($stmtsAware->stmts[$key - 1]);
return $stmtsAware;
}
private function shouldSkipStmt(Return_ $return, Stmt $previousStmt) : bool
private function shouldSkipStmt(Return_ $return, Stmt $previousStmt, Scope $scope) : bool
{
if ($this->hasSomeComment($previousStmt)) {
return \true;
}
if (!$return->expr instanceof Variable) {
return \true;
}
if ($this->returnAnalyzer->hasByRefReturn($return)) {
$functionReflection = $scope->getFunction();
if ($functionReflection instanceof FunctionReflection && $functionReflection->returnsByReference()->yes()) {
return \true;
}
if ($return->getAttribute(AttributeKey::IS_BYREF_RETURN) === \true) {
return \true;
}
/** @var Variable $variable */

4
src/Application/VersionResolver.php
View File

@ -19,12 +19,12 @@ final class VersionResolver
* @api
* @var string
*/
public const PACKAGE_VERSION = 'a74c640bc1043f19006c7403461108f61d8bf2a5';
public const PACKAGE_VERSION = '2406dc813a3eba3e25522fcb69af879fbc4a60cd';
/**
* @api
* @var string
*/
public const RELEASE_DATE = '2023-05-14 00:33:42';
public const RELEASE_DATE = '2023-05-13 19:03:52';
/**
* @var int
*/

2
vendor/autoload.php vendored
View File

@ -22,4 +22,4 @@ if (PHP_VERSION_ID < 50600) {
require_once __DIR__ . '/composer/autoload_real.php';
return ComposerAutoloaderInit1a3a3ed36ea10c7719447923da5e656e::getLoader();
return ComposerAutoloaderInit435ac4da3d2d131c3524c8fe63432a3f::getLoader();

2
vendor/composer/autoload_classmap.php vendored
View File

@ -1208,7 +1208,6 @@ return array(
'Rector\\CodeQuality\\NodeAnalyzer\\ConstructorPropertyDefaultExprResolver' => $baseDir . '/rules/CodeQuality/NodeAnalyzer/ConstructorPropertyDefaultExprResolver.php',
'Rector\\CodeQuality\\NodeAnalyzer\\ForeachAnalyzer' => $baseDir . '/rules/CodeQuality/NodeAnalyzer/ForeachAnalyzer.php',
'Rector\\CodeQuality\\NodeAnalyzer\\LocalPropertyAnalyzer' => $baseDir . '/rules/CodeQuality/NodeAnalyzer/LocalPropertyAnalyzer.php',
'Rector\\CodeQuality\\NodeAnalyzer\\ReturnAnalyzer' => $baseDir . '/rules/CodeQuality/NodeAnalyzer/ReturnAnalyzer.php',
'Rector\\CodeQuality\\NodeAnalyzer\\VariableDimFetchAssignResolver' => $baseDir . '/rules/CodeQuality/NodeAnalyzer/VariableDimFetchAssignResolver.php',
'Rector\\CodeQuality\\NodeAnalyzer\\VariableNameUsedNextAnalyzer' => $baseDir . '/rules/CodeQuality/NodeAnalyzer/VariableNameUsedNextAnalyzer.php',
'Rector\\CodeQuality\\NodeFactory\\ArrayFilterFactory' => $baseDir . '/rules/CodeQuality/NodeFactory/ArrayFilterFactory.php',
@ -1991,6 +1990,7 @@ return array(
'Rector\\NodeTypeResolver\\PHPStan\\ObjectWithoutClassTypeWithParentTypes' => $baseDir . '/packages/NodeTypeResolver/PHPStan/ObjectWithoutClassTypeWithParentTypes.php',
'Rector\\NodeTypeResolver\\PHPStan\\ParametersAcceptorSelectorVariantsWrapper' => $baseDir . '/packages/NodeTypeResolver/PHPStan/ParametersAcceptorSelectorVariantsWrapper.php',
'Rector\\NodeTypeResolver\\PHPStan\\Scope\\NodeVisitor\\AssignedToNodeVisitor' => $baseDir . '/packages/NodeTypeResolver/PHPStan/Scope/NodeVisitor/AssignedToNodeVisitor.php',
'Rector\\NodeTypeResolver\\PHPStan\\Scope\\NodeVisitor\\ByRefReturnNodeVisitor' => $baseDir . '/packages/NodeTypeResolver/PHPStan/Scope/NodeVisitor/ByRefReturnNodeVisitor.php',
'Rector\\NodeTypeResolver\\PHPStan\\Scope\\NodeVisitor\\ByRefVariableNodeVisitor' => $baseDir . '/packages/NodeTypeResolver/PHPStan/Scope/NodeVisitor/ByRefVariableNodeVisitor.php',
'Rector\\NodeTypeResolver\\PHPStan\\Scope\\NodeVisitor\\GlobalVariableNodeVisitor' => $baseDir . '/packages/NodeTypeResolver/PHPStan/Scope/NodeVisitor/GlobalVariableNodeVisitor.php',
'Rector\\NodeTypeResolver\\PHPStan\\Scope\\NodeVisitor\\RemoveDeepChainMethodCallNodeVisitor' => $baseDir . '/packages/NodeTypeResolver/PHPStan/Scope/NodeVisitor/RemoveDeepChainMethodCallNodeVisitor.php',

10
vendor/composer/autoload_real.php vendored
View File

@ -2,7 +2,7 @@
// autoload_real.php @generated by Composer
class ComposerAutoloaderInit1a3a3ed36ea10c7719447923da5e656e
class ComposerAutoloaderInit435ac4da3d2d131c3524c8fe63432a3f
{
private static $loader;
@ -22,17 +22,17 @@ class ComposerAutoloaderInit1a3a3ed36ea10c7719447923da5e656e
return self::$loader;
}
spl_autoload_register(array('ComposerAutoloaderInit1a3a3ed36ea10c7719447923da5e656e', 'loadClassLoader'), true, true);
spl_autoload_register(array('ComposerAutoloaderInit435ac4da3d2d131c3524c8fe63432a3f', 'loadClassLoader'), true, true);
self::$loader = $loader = new \Composer\Autoload\ClassLoader(\dirname(__DIR__));
spl_autoload_unregister(array('ComposerAutoloaderInit1a3a3ed36ea10c7719447923da5e656e', 'loadClassLoader'));
spl_autoload_unregister(array('ComposerAutoloaderInit435ac4da3d2d131c3524c8fe63432a3f', 'loadClassLoader'));
require __DIR__ . '/autoload_static.php';
call_user_func(\Composer\Autoload\ComposerStaticInit1a3a3ed36ea10c7719447923da5e656e::getInitializer($loader));
call_user_func(\Composer\Autoload\ComposerStaticInit435ac4da3d2d131c3524c8fe63432a3f::getInitializer($loader));
$loader->setClassMapAuthoritative(true);
$loader->register(true);
$filesToLoad = \Composer\Autoload\ComposerStaticInit1a3a3ed36ea10c7719447923da5e656e::$files;
$filesToLoad = \Composer\Autoload\ComposerStaticInit435ac4da3d2d131c3524c8fe63432a3f::$files;
$requireFile = \Closure::bind(static function ($fileIdentifier, $file) {
if (empty($GLOBALS['__composer_autoload_files'][$fileIdentifier])) {
$GLOBALS['__composer_autoload_files'][$fileIdentifier] = true;

10
vendor/composer/autoload_static.php vendored
View File

@ -4,7 +4,7 @@
namespace Composer\Autoload;
class ComposerStaticInit1a3a3ed36ea10c7719447923da5e656e
class ComposerStaticInit435ac4da3d2d131c3524c8fe63432a3f
{
public static $files = array (
'ad155f8f1cf0d418fe49e248db8c661b' => __DIR__ . '/..' . '/react/promise/src/functions_include.php',
@ -1450,7 +1450,6 @@ class ComposerStaticInit1a3a3ed36ea10c7719447923da5e656e
'Rector\\CodeQuality\\NodeAnalyzer\\ConstructorPropertyDefaultExprResolver' => __DIR__ . '/../..' . '/rules/CodeQuality/NodeAnalyzer/ConstructorPropertyDefaultExprResolver.php',
'Rector\\CodeQuality\\NodeAnalyzer\\ForeachAnalyzer' => __DIR__ . '/../..' . '/rules/CodeQuality/NodeAnalyzer/ForeachAnalyzer.php',
'Rector\\CodeQuality\\NodeAnalyzer\\LocalPropertyAnalyzer' => __DIR__ . '/../..' . '/rules/CodeQuality/NodeAnalyzer/LocalPropertyAnalyzer.php',
'Rector\\CodeQuality\\NodeAnalyzer\\ReturnAnalyzer' => __DIR__ . '/../..' . '/rules/CodeQuality/NodeAnalyzer/ReturnAnalyzer.php',
'Rector\\CodeQuality\\NodeAnalyzer\\VariableDimFetchAssignResolver' => __DIR__ . '/../..' . '/rules/CodeQuality/NodeAnalyzer/VariableDimFetchAssignResolver.php',
'Rector\\CodeQuality\\NodeAnalyzer\\VariableNameUsedNextAnalyzer' => __DIR__ . '/../..' . '/rules/CodeQuality/NodeAnalyzer/VariableNameUsedNextAnalyzer.php',
'Rector\\CodeQuality\\NodeFactory\\ArrayFilterFactory' => __DIR__ . '/../..' . '/rules/CodeQuality/NodeFactory/ArrayFilterFactory.php',
@ -2233,6 +2232,7 @@ class ComposerStaticInit1a3a3ed36ea10c7719447923da5e656e
'Rector\\NodeTypeResolver\\PHPStan\\ObjectWithoutClassTypeWithParentTypes' => __DIR__ . '/../..' . '/packages/NodeTypeResolver/PHPStan/ObjectWithoutClassTypeWithParentTypes.php',
'Rector\\NodeTypeResolver\\PHPStan\\ParametersAcceptorSelectorVariantsWrapper' => __DIR__ . '/../..' . '/packages/NodeTypeResolver/PHPStan/ParametersAcceptorSelectorVariantsWrapper.php',
'Rector\\NodeTypeResolver\\PHPStan\\Scope\\NodeVisitor\\AssignedToNodeVisitor' => __DIR__ . '/../..' . '/packages/NodeTypeResolver/PHPStan/Scope/NodeVisitor/AssignedToNodeVisitor.php',
'Rector\\NodeTypeResolver\\PHPStan\\Scope\\NodeVisitor\\ByRefReturnNodeVisitor' => __DIR__ . '/../..' . '/packages/NodeTypeResolver/PHPStan/Scope/NodeVisitor/ByRefReturnNodeVisitor.php',
'Rector\\NodeTypeResolver\\PHPStan\\Scope\\NodeVisitor\\ByRefVariableNodeVisitor' => __DIR__ . '/../..' . '/packages/NodeTypeResolver/PHPStan/Scope/NodeVisitor/ByRefVariableNodeVisitor.php',
'Rector\\NodeTypeResolver\\PHPStan\\Scope\\NodeVisitor\\GlobalVariableNodeVisitor' => __DIR__ . '/../..' . '/packages/NodeTypeResolver/PHPStan/Scope/NodeVisitor/GlobalVariableNodeVisitor.php',
'Rector\\NodeTypeResolver\\PHPStan\\Scope\\NodeVisitor\\RemoveDeepChainMethodCallNodeVisitor' => __DIR__ . '/../..' . '/packages/NodeTypeResolver/PHPStan/Scope/NodeVisitor/RemoveDeepChainMethodCallNodeVisitor.php',
@ -3111,9 +3111,9 @@ class ComposerStaticInit1a3a3ed36ea10c7719447923da5e656e
public static function getInitializer(ClassLoader $loader)
{
return \Closure::bind(function () use ($loader) {
$loader->prefixLengthsPsr4 = ComposerStaticInit1a3a3ed36ea10c7719447923da5e656e::$prefixLengthsPsr4;
$loader->prefixDirsPsr4 = ComposerStaticInit1a3a3ed36ea10c7719447923da5e656e::$prefixDirsPsr4;
$loader->classMap = ComposerStaticInit1a3a3ed36ea10c7719447923da5e656e::$classMap;
$loader->prefixLengthsPsr4 = ComposerStaticInit435ac4da3d2d131c3524c8fe63432a3f::$prefixLengthsPsr4;
$loader->prefixDirsPsr4 = ComposerStaticInit435ac4da3d2d131c3524c8fe63432a3f::$prefixDirsPsr4;
$loader->classMap = ComposerStaticInit435ac4da3d2d131c3524c8fe63432a3f::$classMap;
}, null, ClassLoader::class);
}