Updated Rector to commit 325387738852fd1be30b8918910b049967a368e2

3253877388 [TypeDeclaration] Remove and disable breaking ReturnTypeDeclarationRector, use split rules instead (#3120)
This commit is contained in:
Tomas Votruba 2022-11-28 12:49:02 +00:00
parent 09d2ee9618
commit d192e83312
8 changed files with 51 additions and 157 deletions

View File

@ -1,4 +1,4 @@
# 405 Rules Overview
# 406 Rules Overview
<br>
@ -64,7 +64,7 @@
- [Transform](#transform) (34)
- [TypeDeclaration](#typedeclaration) (33)
- [TypeDeclaration](#typedeclaration) (34)
- [Visibility](#visibility) (3)
@ -8971,6 +8971,28 @@ Add missing return type declaration based on parent class method
<br>
### AddReturnTypeDeclarationFromYieldsRector
Add return type declarations from yields
- class: [`Rector\TypeDeclaration\Rector\FunctionLike\AddReturnTypeDeclarationFromYieldsRector`](../rules/TypeDeclaration/Rector/FunctionLike/AddReturnTypeDeclarationFromYieldsRector.php)
```diff
class SomeClass
{
- public function provide()
+ /**
+ * @return Iterator<int>
+ */
+ public function provide(): Iterator
{
yield 1;
}
}
```
<br>
### AddReturnTypeDeclarationRector
Changes defined return typehint of method and class.

View File

@ -29,6 +29,9 @@ use Rector\StaticTypeMapper\ValueObject\Type\FullyQualifiedObjectType;
use Rector\StaticTypeMapper\ValueObject\Type\ParentStaticType;
use Rector\StaticTypeMapper\ValueObject\Type\SelfObjectType;
use Rector\StaticTypeMapper\ValueObject\Type\ShortenedObjectType;
/**
* @todo create own rule to clean these in dead-code set
*/
final class NonInformativeReturnTagRemover
{
/**

View File

@ -4,64 +4,28 @@ declare (strict_types=1);
namespace Rector\TypeDeclaration\Rector\FunctionLike;
use PhpParser\Node;
use PhpParser\Node\FunctionLike;
use PhpParser\Node\IntersectionType;
use PhpParser\Node\Name;
use PhpParser\Node\NullableType;
use PhpParser\Node\Stmt\Class_;
use PhpParser\Node\Stmt\ClassMethod;
use PhpParser\Node\Stmt\Function_;
use PhpParser\Node\UnionType as PhpParserUnionType;
use PHPStan\Type\MixedType;
use PHPStan\Type\Type;
use PHPStan\Type\UnionType;
use Rector\Core\Rector\AbstractRector;
use Rector\Core\ValueObject\PhpVersionFeature;
use Rector\PHPStanStaticTypeMapper\Enum\TypeKind;
use Rector\StaticTypeMapper\ValueObject\Type\NonExistingObjectType;
use Rector\TypeDeclaration\PhpDocParser\NonInformativeReturnTagRemover;
use Rector\TypeDeclaration\TypeInferer\ReturnTypeInferer;
use Rector\VendorLocker\NodeVendorLocker\ClassMethodReturnTypeOverrideGuard;
use Rector\VendorLocker\NodeVendorLocker\ClassMethodReturnVendorLockResolver;
use Rector\VersionBonding\Contract\MinPhpVersionInterface;
use RectorPrefix202211\Symfony\Component\Console\Style\SymfonyStyle;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
/**
* @changelog https://wiki.php.net/rfc/scalar_type_hints_v5
*
* @see \Rector\Tests\TypeDeclaration\Rector\FunctionLike\ReturnTypeDeclarationRector\ReturnTypeDeclarationRectorTest
*
* @deprecated Moving doc types to type declarations is dangerous. Use specific strict types instead.
* This rule will be split info many small ones.
*/
final class ReturnTypeDeclarationRector extends AbstractRector implements MinPhpVersionInterface
final class ReturnTypeDeclarationRector extends AbstractRector
{
/**
* @readonly
* @var \Rector\TypeDeclaration\TypeInferer\ReturnTypeInferer
* @var \Symfony\Component\Console\Style\SymfonyStyle
*/
private $returnTypeInferer;
/**
* @readonly
* @var \Rector\TypeDeclaration\PhpDocParser\NonInformativeReturnTagRemover
*/
private $nonInformativeReturnTagRemover;
/**
* @readonly
* @var \Rector\VendorLocker\NodeVendorLocker\ClassMethodReturnTypeOverrideGuard
*/
private $classMethodReturnTypeOverrideGuard;
/**
* @readonly
* @var \Rector\VendorLocker\NodeVendorLocker\ClassMethodReturnVendorLockResolver
*/
private $classMethodReturnVendorLockResolver;
public function __construct(ReturnTypeInferer $returnTypeInferer, NonInformativeReturnTagRemover $nonInformativeReturnTagRemover, ClassMethodReturnTypeOverrideGuard $classMethodReturnTypeOverrideGuard, ClassMethodReturnVendorLockResolver $classMethodReturnVendorLockResolver)
private $symfonyStyle;
public function __construct(SymfonyStyle $symfonyStyle)
{
$this->returnTypeInferer = $returnTypeInferer;
$this->nonInformativeReturnTagRemover = $nonInformativeReturnTagRemover;
$this->classMethodReturnTypeOverrideGuard = $classMethodReturnTypeOverrideGuard;
$this->classMethodReturnVendorLockResolver = $classMethodReturnVendorLockResolver;
$this->symfonyStyle = $symfonyStyle;
}
/**
* @return array<class-string<Node>>
@ -98,63 +62,8 @@ CODE_SAMPLE
*/
public function refactor(Node $node) : ?Node
{
if ($this->shouldSkipClassLike($node)) {
return null;
}
if ($node instanceof ClassMethod && $this->shouldSkipClassMethod($node)) {
return null;
}
// skip already added types
if ($node->returnType instanceof Node) {
return null;
}
$inferedReturnType = $this->returnTypeInferer->inferFunctionLike($node);
if ($inferedReturnType instanceof MixedType || $inferedReturnType instanceof NonExistingObjectType) {
return null;
}
if (!$inferedReturnType instanceof UnionType) {
return $this->processType($node, $inferedReturnType);
}
foreach ($inferedReturnType->getTypes() as $unionedType) {
// mixed type cannot be joined with another types
if ($unionedType instanceof MixedType) {
return null;
}
}
return $this->processType($node, $inferedReturnType);
}
public function provideMinPhpVersion() : int
{
return PhpVersionFeature::SCALAR_TYPES;
}
/**
* @param \PhpParser\Node\Stmt\ClassMethod|\PhpParser\Node\Stmt\Function_ $node
*/
private function processType($node, Type $inferedType) : ?Node
{
$inferredReturnNode = $this->staticTypeMapper->mapPHPStanTypeToPhpParserNode($inferedType, TypeKind::RETURN);
// nothing to change in PHP code
if (!$inferredReturnNode instanceof Node) {
return null;
}
/** @var Name|NullableType|PhpParserUnionType|IntersectionType $inferredReturnNode */
$node->returnType = $inferredReturnNode;
$this->nonInformativeReturnTagRemover->removeReturnTagIfNotUseful($node);
return $node;
}
private function shouldSkipClassMethod(ClassMethod $classMethod) : bool
{
if ($this->classMethodReturnTypeOverrideGuard->shouldSkipClassMethod($classMethod)) {
return \true;
}
return $this->classMethodReturnVendorLockResolver->isVendorLocked($classMethod);
}
private function shouldSkipClassLike(FunctionLike $functionLike) : bool
{
if (!$functionLike instanceof ClassMethod) {
return \false;
}
$classLike = $this->betterNodeFinder->findParentType($functionLike, Class_::class);
return !$classLike instanceof Class_;
$this->symfonyStyle->error('This rule will was split info many small ones as breaking types based on falsy docblocks. Use specific rules to infer return instead.');
\sleep(5);
return null;
}
}

View File

@ -7,12 +7,10 @@ use PhpParser\Node;
use PhpParser\Node\Expr;
use PhpParser\Node\Expr\Closure;
use PhpParser\Node\FunctionLike;
use PhpParser\Node\Name\FullyQualified;
use PhpParser\Node\Stmt\Class_;
use PhpParser\Node\Stmt\ClassMethod;
use PhpParser\Node\Stmt\Function_;
use PhpParser\Node\Stmt\Return_;
use PhpParser\Node\UnionType as PhpParserUnionType;
use PHPStan\Reflection\ClassReflection;
use PHPStan\Reflection\ReflectionProvider;
use PHPStan\Type\BenevolentUnionType;
@ -23,8 +21,6 @@ use PHPStan\Type\Type;
use PHPStan\Type\TypeWithClassName;
use PHPStan\Type\UnionType;
use PHPStan\Type\VoidType;
use Rector\Core\Configuration\Option;
use Rector\Core\Configuration\Parameter\ParameterProvider;
use Rector\Core\Enum\ObjectReference;
use Rector\Core\Exception\ShouldNotHappenException;
use Rector\Core\Php\PhpVersionProvider;
@ -62,11 +58,6 @@ final class ReturnTypeInferer
* @var \Rector\Core\Php\PhpVersionProvider
*/
private $phpVersionProvider;
/**
* @readonly
* @var \Rector\Core\Configuration\Parameter\ParameterProvider
*/
private $parameterProvider;
/**
* @readonly
* @var \Rector\Core\PhpParser\Node\BetterNodeFinder
@ -87,13 +78,12 @@ final class ReturnTypeInferer
* @var \Rector\NodeNameResolver\NodeNameResolver
*/
private $nodeNameResolver;
public function __construct(TypeNormalizer $typeNormalizer, ReturnedNodesReturnTypeInfererTypeInferer $returnedNodesReturnTypeInfererTypeInferer, GenericClassStringTypeNormalizer $genericClassStringTypeNormalizer, PhpVersionProvider $phpVersionProvider, ParameterProvider $parameterProvider, BetterNodeFinder $betterNodeFinder, ReflectionProvider $reflectionProvider, NodeTypeResolver $nodeTypeResolver, NodeNameResolver $nodeNameResolver)
public function __construct(TypeNormalizer $typeNormalizer, ReturnedNodesReturnTypeInfererTypeInferer $returnedNodesReturnTypeInfererTypeInferer, GenericClassStringTypeNormalizer $genericClassStringTypeNormalizer, PhpVersionProvider $phpVersionProvider, BetterNodeFinder $betterNodeFinder, ReflectionProvider $reflectionProvider, NodeTypeResolver $nodeTypeResolver, NodeNameResolver $nodeNameResolver)
{
$this->typeNormalizer = $typeNormalizer;
$this->returnedNodesReturnTypeInfererTypeInferer = $returnedNodesReturnTypeInfererTypeInferer;
$this->genericClassStringTypeNormalizer = $genericClassStringTypeNormalizer;
$this->phpVersionProvider = $phpVersionProvider;
$this->parameterProvider = $parameterProvider;
$this->betterNodeFinder = $betterNodeFinder;
$this->reflectionProvider = $reflectionProvider;
$this->nodeTypeResolver = $nodeTypeResolver;
@ -105,10 +95,6 @@ final class ReturnTypeInferer
public function inferFunctionLike($functionLike) : Type
{
$isSupportedStaticReturnType = $this->phpVersionProvider->isAtLeastPhpVersion(PhpVersionFeature::STATIC_RETURN_TYPE);
$isAutoImport = $this->parameterProvider->provideBoolParameter(Option::AUTO_IMPORT_NAMES);
if ($this->isAutoImportWithFullyQualifiedReturn($isAutoImport, $functionLike)) {
return new MixedType();
}
$originalType = $this->returnedNodesReturnTypeInfererTypeInferer->inferFunctionLike($functionLike);
if ($originalType instanceof MixedType) {
return new MixedType();
@ -215,32 +201,6 @@ final class ReturnTypeInferer
}
return $types[0];
}
private function isAutoImportWithFullyQualifiedReturn(bool $isAutoImport, FunctionLike $functionLike) : bool
{
if (!$isAutoImport) {
return \false;
}
if (!$functionLike instanceof ClassMethod) {
return \false;
}
if ($this->isNamespacedFullyQualified($functionLike->returnType)) {
return \true;
}
if (!$functionLike->returnType instanceof PhpParserUnionType) {
return \false;
}
$types = $functionLike->returnType->types;
foreach ($types as $type) {
if ($this->isNamespacedFullyQualified($type)) {
return \true;
}
}
return \false;
}
private function isNamespacedFullyQualified(?Node $node) : bool
{
return $node instanceof FullyQualified && \strpos($node->toString(), '\\') !== \false;
}
private function isStaticType(Type $type) : bool
{
if (!$type instanceof TypeWithClassName) {

View File

@ -17,12 +17,12 @@ final class VersionResolver
* @api
* @var string
*/
public const PACKAGE_VERSION = '696ddd92aa288b3ade2075688faef2b3d81f5101';
public const PACKAGE_VERSION = '325387738852fd1be30b8918910b049967a368e2';
/**
* @api
* @var string
*/
public const RELEASE_DATE = '2022-11-28 13:21:26';
public const RELEASE_DATE = '2022-11-28 13:44:37';
/**
* @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 ComposerAutoloaderInit823ec31825858f15058c7032134b97a1::getLoader();
return ComposerAutoloaderInit08ffd7d8f0ce655958291ddeb1b82745::getLoader();

View File

@ -2,7 +2,7 @@
// autoload_real.php @generated by Composer
class ComposerAutoloaderInit823ec31825858f15058c7032134b97a1
class ComposerAutoloaderInit08ffd7d8f0ce655958291ddeb1b82745
{
private static $loader;
@ -22,19 +22,19 @@ class ComposerAutoloaderInit823ec31825858f15058c7032134b97a1
return self::$loader;
}
spl_autoload_register(array('ComposerAutoloaderInit823ec31825858f15058c7032134b97a1', 'loadClassLoader'), true, true);
spl_autoload_register(array('ComposerAutoloaderInit08ffd7d8f0ce655958291ddeb1b82745', 'loadClassLoader'), true, true);
self::$loader = $loader = new \Composer\Autoload\ClassLoader(\dirname(__DIR__));
spl_autoload_unregister(array('ComposerAutoloaderInit823ec31825858f15058c7032134b97a1', 'loadClassLoader'));
spl_autoload_unregister(array('ComposerAutoloaderInit08ffd7d8f0ce655958291ddeb1b82745', 'loadClassLoader'));
require __DIR__ . '/autoload_static.php';
call_user_func(\Composer\Autoload\ComposerStaticInit823ec31825858f15058c7032134b97a1::getInitializer($loader));
call_user_func(\Composer\Autoload\ComposerStaticInit08ffd7d8f0ce655958291ddeb1b82745::getInitializer($loader));
$loader->setClassMapAuthoritative(true);
$loader->register(true);
$includeFiles = \Composer\Autoload\ComposerStaticInit823ec31825858f15058c7032134b97a1::$files;
$includeFiles = \Composer\Autoload\ComposerStaticInit08ffd7d8f0ce655958291ddeb1b82745::$files;
foreach ($includeFiles as $fileIdentifier => $file) {
composerRequire823ec31825858f15058c7032134b97a1($fileIdentifier, $file);
composerRequire08ffd7d8f0ce655958291ddeb1b82745($fileIdentifier, $file);
}
return $loader;
@ -46,7 +46,7 @@ class ComposerAutoloaderInit823ec31825858f15058c7032134b97a1
* @param string $file
* @return void
*/
function composerRequire823ec31825858f15058c7032134b97a1($fileIdentifier, $file)
function composerRequire08ffd7d8f0ce655958291ddeb1b82745($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 ComposerStaticInit823ec31825858f15058c7032134b97a1
class ComposerStaticInit08ffd7d8f0ce655958291ddeb1b82745
{
public static $files = array (
'ad155f8f1cf0d418fe49e248db8c661b' => __DIR__ . '/..' . '/react/promise/src/functions_include.php',
@ -3019,9 +3019,9 @@ class ComposerStaticInit823ec31825858f15058c7032134b97a1
public static function getInitializer(ClassLoader $loader)
{
return \Closure::bind(function () use ($loader) {
$loader->prefixLengthsPsr4 = ComposerStaticInit823ec31825858f15058c7032134b97a1::$prefixLengthsPsr4;
$loader->prefixDirsPsr4 = ComposerStaticInit823ec31825858f15058c7032134b97a1::$prefixDirsPsr4;
$loader->classMap = ComposerStaticInit823ec31825858f15058c7032134b97a1::$classMap;
$loader->prefixLengthsPsr4 = ComposerStaticInit08ffd7d8f0ce655958291ddeb1b82745::$prefixLengthsPsr4;
$loader->prefixDirsPsr4 = ComposerStaticInit08ffd7d8f0ce655958291ddeb1b82745::$prefixDirsPsr4;
$loader->classMap = ComposerStaticInit08ffd7d8f0ce655958291ddeb1b82745::$classMap;
}, null, ClassLoader::class);
}