Updated Rector to commit 0d6234b584f14d25e02c8c97afac7f6374aa306c

0d6234b584 [DeadCode] Skip standalone @return false or true on RemoveUselessReturnTagRector (#3202)
This commit is contained in:
Tomas Votruba 2022-12-15 14:08:31 +00:00
parent 5b79ce9485
commit b607ae2a53
8 changed files with 94 additions and 26 deletions

View File

@ -3,6 +3,7 @@
declare (strict_types=1);
namespace Rector\DeadCode\PhpDoc;
use PhpParser\Node;
use PhpParser\Node\FunctionLike;
use PhpParser\Node\Stmt\ClassLike;
use PhpParser\Node\Stmt\Trait_;
@ -12,6 +13,7 @@ use PHPStan\PhpDocParser\Ast\Type\ThisTypeNode;
use Rector\BetterPhpDocParser\PhpDocManipulator\PhpDocTypeChanger;
use Rector\BetterPhpDocParser\ValueObject\Type\BracketsAwareUnionTypeNode;
use Rector\Core\PhpParser\Node\BetterNodeFinder;
use Rector\DeadCode\PhpDoc\Guard\StandaloneTypeRemovalGuard;
use Rector\DeadCode\TypeNodeAnalyzer\GenericTypeNodeAnalyzer;
use Rector\DeadCode\TypeNodeAnalyzer\MixedArrayTypeNodeAnalyzer;
use Rector\NodeTypeResolver\TypeComparator\TypeComparator;
@ -37,12 +39,18 @@ final class DeadReturnTagValueNodeAnalyzer
* @var \Rector\DeadCode\TypeNodeAnalyzer\MixedArrayTypeNodeAnalyzer
*/
private $mixedArrayTypeNodeAnalyzer;
public function __construct(TypeComparator $typeComparator, BetterNodeFinder $betterNodeFinder, GenericTypeNodeAnalyzer $genericTypeNodeAnalyzer, MixedArrayTypeNodeAnalyzer $mixedArrayTypeNodeAnalyzer)
/**
* @readonly
* @var \Rector\DeadCode\PhpDoc\Guard\StandaloneTypeRemovalGuard
*/
private $standaloneTypeRemovalGuard;
public function __construct(TypeComparator $typeComparator, BetterNodeFinder $betterNodeFinder, GenericTypeNodeAnalyzer $genericTypeNodeAnalyzer, MixedArrayTypeNodeAnalyzer $mixedArrayTypeNodeAnalyzer, StandaloneTypeRemovalGuard $standaloneTypeRemovalGuard)
{
$this->typeComparator = $typeComparator;
$this->betterNodeFinder = $betterNodeFinder;
$this->genericTypeNodeAnalyzer = $genericTypeNodeAnalyzer;
$this->mixedArrayTypeNodeAnalyzer = $mixedArrayTypeNodeAnalyzer;
$this->standaloneTypeRemovalGuard = $standaloneTypeRemovalGuard;
}
public function isDead(ReturnTagValueNode $returnTagValueNode, FunctionLike $functionLike) : bool
{
@ -61,7 +69,7 @@ final class DeadReturnTagValueNodeAnalyzer
return \false;
}
if (!$returnTagValueNode->type instanceof BracketsAwareUnionTypeNode) {
return $returnTagValueNode->description === '';
return $this->isIdentiferRemovalAllowed($returnTagValueNode, $returnType);
}
if ($this->genericTypeNodeAnalyzer->hasGenericType($returnTagValueNode->type)) {
return \false;
@ -74,6 +82,13 @@ final class DeadReturnTagValueNodeAnalyzer
}
return $returnTagValueNode->description === '';
}
private function isIdentiferRemovalAllowed(ReturnTagValueNode $returnTagValueNode, Node $node) : bool
{
if ($returnTagValueNode->description === '') {
return $this->standaloneTypeRemovalGuard->isLegal($returnTagValueNode->type, $node);
}
return \false;
}
private function hasTruePseudoType(BracketsAwareUnionTypeNode $bracketsAwareUnionTypeNode) : bool
{
$unionTypes = $bracketsAwareUnionTypeNode->types;

View File

@ -0,0 +1,29 @@
<?php
declare (strict_types=1);
namespace Rector\DeadCode\PhpDoc\Guard;
use PhpParser\Node;
use PhpParser\Node\Identifier;
use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
use PHPStan\PhpDocParser\Ast\Type\TypeNode;
final class StandaloneTypeRemovalGuard
{
/**
* @var string[]
*/
private const ALLOWED_TYPES = ['false', 'true'];
public function isLegal(TypeNode $typeNode, Node $node) : bool
{
if (!$typeNode instanceof IdentifierTypeNode) {
return \true;
}
if (!$node instanceof Identifier) {
return \true;
}
if ($node->toString() !== 'bool') {
return \true;
}
return !\in_array($typeNode->name, self::ALLOWED_TYPES, \true);
}
}

View File

@ -4,12 +4,14 @@ declare (strict_types=1);
namespace Rector\Php81\NodeFactory;
use PhpParser\BuilderFactory;
use PhpParser\Node\Expr;
use PhpParser\Node\Expr\Array_;
use PhpParser\Node\Expr\ArrayItem;
use PhpParser\Node\Identifier;
use PhpParser\Node\Scalar\LNumber;
use PhpParser\Node\Scalar\String_;
use PhpParser\Node\Stmt\Class_;
use PhpParser\Node\Stmt\ClassConst;
use PhpParser\Node\Stmt\ClassMethod;
use PhpParser\Node\Stmt\Enum_;
use PhpParser\Node\Stmt\EnumCase;
use PhpParser\Node\Stmt\Return_;
@ -117,20 +119,39 @@ final class EnumFactory
private function generateMappingFromClass(Class_ $class) : array
{
$classMethod = $class->getMethod('values');
if ($classMethod === null) {
if (!$classMethod instanceof ClassMethod) {
return [];
}
/** @var Return_[] $returns */
$returns = $this->betterNodeFinder->findInstancesOfInFunctionLikeScoped($classMethod, Return_::class);
/** @var array<int|string, mixed> $mapping */
$mapping = [];
foreach ($returns as $returnStmt) {
if (!$returnStmt->expr instanceof Expr\Array_) {
foreach ($returns as $return) {
if (!$return->expr instanceof Array_) {
continue;
}
foreach ($returnStmt->expr->items as $item) {
if ($item instanceof Expr\ArrayItem && ($item->key instanceof LNumber || $item->key instanceof String_) && ($item->value instanceof LNumber || $item->value instanceof String_)) {
$mapping[$item->key->value] = $item->value->value;
}
$mapping = $this->collectMappings($return->expr->items, $mapping);
}
return $mapping;
}
/**
* @param null[]|ArrayItem[] $items
* @param array<int|string, mixed> $mapping
* @return array<int|string, mixed>
*/
private function collectMappings(array $items, array $mapping) : array
{
foreach ($items as $item) {
if (!$item instanceof ArrayItem) {
continue;
}
if (!$item->key instanceof LNumber && !$item->key instanceof String_) {
continue;
}
if (!$item->value instanceof LNumber && !$item->value instanceof String_) {
continue;
}
$mapping[$item->key->value] = $item->value->value;
}
return $mapping;
}
@ -139,9 +160,10 @@ final class EnumFactory
*/
private function getIdentifierTypeFromMappings(array $mapping) : string
{
$valueTypes = \array_map(static function ($value) : string {
$callableGetType = static function ($value) : string {
return \gettype($value);
}, $mapping);
};
$valueTypes = \array_map($callableGetType, $mapping);
$uniqueValueTypes = \array_unique($valueTypes);
if (\count($uniqueValueTypes) === 1) {
$identifierType = \reset($uniqueValueTypes);

View File

@ -17,12 +17,12 @@ final class VersionResolver
* @api
* @var string
*/
public const PACKAGE_VERSION = '40f6d194e78026978fa5af3a0be9d209a511c173';
public const PACKAGE_VERSION = '0d6234b584f14d25e02c8c97afac7f6374aa306c';
/**
* @api
* @var string
*/
public const RELEASE_DATE = '2022-12-15 11:14:37';
public const RELEASE_DATE = '2022-12-15 21:04:27';
/**
* @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 ComposerAutoloaderInit57288704ab80d1fa10d9d662af03a4d5::getLoader();
return ComposerAutoloaderInite416a44bd4d5723a790830e2163f3aee::getLoader();

View File

@ -1525,6 +1525,7 @@ return array(
'Rector\\DeadCode\\PhpDoc\\DeadParamTagValueNodeAnalyzer' => $baseDir . '/rules/DeadCode/PhpDoc/DeadParamTagValueNodeAnalyzer.php',
'Rector\\DeadCode\\PhpDoc\\DeadReturnTagValueNodeAnalyzer' => $baseDir . '/rules/DeadCode/PhpDoc/DeadReturnTagValueNodeAnalyzer.php',
'Rector\\DeadCode\\PhpDoc\\DeadVarTagValueNodeAnalyzer' => $baseDir . '/rules/DeadCode/PhpDoc/DeadVarTagValueNodeAnalyzer.php',
'Rector\\DeadCode\\PhpDoc\\Guard\\StandaloneTypeRemovalGuard' => $baseDir . '/rules/DeadCode/PhpDoc/Guard/StandaloneTypeRemovalGuard.php',
'Rector\\DeadCode\\PhpDoc\\TagRemover\\ParamTagRemover' => $baseDir . '/rules/DeadCode/PhpDoc/TagRemover/ParamTagRemover.php',
'Rector\\DeadCode\\PhpDoc\\TagRemover\\ReturnTagRemover' => $baseDir . '/rules/DeadCode/PhpDoc/TagRemover/ReturnTagRemover.php',
'Rector\\DeadCode\\PhpDoc\\TagRemover\\VarTagRemover' => $baseDir . '/rules/DeadCode/PhpDoc/TagRemover/VarTagRemover.php',

View File

@ -2,7 +2,7 @@
// autoload_real.php @generated by Composer
class ComposerAutoloaderInit57288704ab80d1fa10d9d662af03a4d5
class ComposerAutoloaderInite416a44bd4d5723a790830e2163f3aee
{
private static $loader;
@ -22,19 +22,19 @@ class ComposerAutoloaderInit57288704ab80d1fa10d9d662af03a4d5
return self::$loader;
}
spl_autoload_register(array('ComposerAutoloaderInit57288704ab80d1fa10d9d662af03a4d5', 'loadClassLoader'), true, true);
spl_autoload_register(array('ComposerAutoloaderInite416a44bd4d5723a790830e2163f3aee', 'loadClassLoader'), true, true);
self::$loader = $loader = new \Composer\Autoload\ClassLoader(\dirname(__DIR__));
spl_autoload_unregister(array('ComposerAutoloaderInit57288704ab80d1fa10d9d662af03a4d5', 'loadClassLoader'));
spl_autoload_unregister(array('ComposerAutoloaderInite416a44bd4d5723a790830e2163f3aee', 'loadClassLoader'));
require __DIR__ . '/autoload_static.php';
call_user_func(\Composer\Autoload\ComposerStaticInit57288704ab80d1fa10d9d662af03a4d5::getInitializer($loader));
call_user_func(\Composer\Autoload\ComposerStaticInite416a44bd4d5723a790830e2163f3aee::getInitializer($loader));
$loader->setClassMapAuthoritative(true);
$loader->register(true);
$includeFiles = \Composer\Autoload\ComposerStaticInit57288704ab80d1fa10d9d662af03a4d5::$files;
$includeFiles = \Composer\Autoload\ComposerStaticInite416a44bd4d5723a790830e2163f3aee::$files;
foreach ($includeFiles as $fileIdentifier => $file) {
composerRequire57288704ab80d1fa10d9d662af03a4d5($fileIdentifier, $file);
composerRequiree416a44bd4d5723a790830e2163f3aee($fileIdentifier, $file);
}
return $loader;
@ -46,7 +46,7 @@ class ComposerAutoloaderInit57288704ab80d1fa10d9d662af03a4d5
* @param string $file
* @return void
*/
function composerRequire57288704ab80d1fa10d9d662af03a4d5($fileIdentifier, $file)
function composerRequiree416a44bd4d5723a790830e2163f3aee($fileIdentifier, $file)
{
if (empty($GLOBALS['__composer_autoload_files'][$fileIdentifier])) {
$GLOBALS['__composer_autoload_files'][$fileIdentifier] = true;

View File

@ -4,7 +4,7 @@
namespace Composer\Autoload;
class ComposerStaticInit57288704ab80d1fa10d9d662af03a4d5
class ComposerStaticInite416a44bd4d5723a790830e2163f3aee
{
public static $files = array (
'ad155f8f1cf0d418fe49e248db8c661b' => __DIR__ . '/..' . '/react/promise/src/functions_include.php',
@ -1765,6 +1765,7 @@ class ComposerStaticInit57288704ab80d1fa10d9d662af03a4d5
'Rector\\DeadCode\\PhpDoc\\DeadParamTagValueNodeAnalyzer' => __DIR__ . '/../..' . '/rules/DeadCode/PhpDoc/DeadParamTagValueNodeAnalyzer.php',
'Rector\\DeadCode\\PhpDoc\\DeadReturnTagValueNodeAnalyzer' => __DIR__ . '/../..' . '/rules/DeadCode/PhpDoc/DeadReturnTagValueNodeAnalyzer.php',
'Rector\\DeadCode\\PhpDoc\\DeadVarTagValueNodeAnalyzer' => __DIR__ . '/../..' . '/rules/DeadCode/PhpDoc/DeadVarTagValueNodeAnalyzer.php',
'Rector\\DeadCode\\PhpDoc\\Guard\\StandaloneTypeRemovalGuard' => __DIR__ . '/../..' . '/rules/DeadCode/PhpDoc/Guard/StandaloneTypeRemovalGuard.php',
'Rector\\DeadCode\\PhpDoc\\TagRemover\\ParamTagRemover' => __DIR__ . '/../..' . '/rules/DeadCode/PhpDoc/TagRemover/ParamTagRemover.php',
'Rector\\DeadCode\\PhpDoc\\TagRemover\\ReturnTagRemover' => __DIR__ . '/../..' . '/rules/DeadCode/PhpDoc/TagRemover/ReturnTagRemover.php',
'Rector\\DeadCode\\PhpDoc\\TagRemover\\VarTagRemover' => __DIR__ . '/../..' . '/rules/DeadCode/PhpDoc/TagRemover/VarTagRemover.php',
@ -3029,9 +3030,9 @@ class ComposerStaticInit57288704ab80d1fa10d9d662af03a4d5
public static function getInitializer(ClassLoader $loader)
{
return \Closure::bind(function () use ($loader) {
$loader->prefixLengthsPsr4 = ComposerStaticInit57288704ab80d1fa10d9d662af03a4d5::$prefixLengthsPsr4;
$loader->prefixDirsPsr4 = ComposerStaticInit57288704ab80d1fa10d9d662af03a4d5::$prefixDirsPsr4;
$loader->classMap = ComposerStaticInit57288704ab80d1fa10d9d662af03a4d5::$classMap;
$loader->prefixLengthsPsr4 = ComposerStaticInite416a44bd4d5723a790830e2163f3aee::$prefixLengthsPsr4;
$loader->prefixDirsPsr4 = ComposerStaticInite416a44bd4d5723a790830e2163f3aee::$prefixDirsPsr4;
$loader->classMap = ComposerStaticInite416a44bd4d5723a790830e2163f3aee::$classMap;
}, null, ClassLoader::class);
}