Updated Rector to commit 78aaf7ee0b

78aaf7ee0b [Php82] Add ReadOnlyClassRector (#2296)
This commit is contained in:
Tomas Votruba 2022-05-12 15:51:17 +00:00
parent 75c4d1eb67
commit 093c37f3c5
13 changed files with 214 additions and 21 deletions

View File

@ -0,0 +1,14 @@
<?php
declare (strict_types=1);
namespace RectorPrefix20220512;
use Rector\Config\RectorConfig;
use Rector\Core\ValueObject\PhpVersion;
use Rector\Set\ValueObject\LevelSetList;
use Rector\Set\ValueObject\SetList;
return static function (\Rector\Config\RectorConfig $rectorConfig) : void {
$rectorConfig->sets([\Rector\Set\ValueObject\SetList::PHP_82, \Rector\Set\ValueObject\LevelSetList::UP_TO_PHP_81]);
// parameter must be defined after import, to override imported param version
$rectorConfig->phpVersion(\Rector\Core\ValueObject\PhpVersion::PHP_82);
};

10
config/set/php82.php Normal file
View File

@ -0,0 +1,10 @@
<?php
declare (strict_types=1);
namespace RectorPrefix20220512;
use Rector\Config\RectorConfig;
use Rector\Php82\Rector\Class_\ReadOnlyClassRector;
return static function (\Rector\Config\RectorConfig $rectorConfig) : void {
$rectorConfig->rule(\Rector\Php82\Rector\Class_\ReadOnlyClassRector::class);
};

View File

@ -6,6 +6,10 @@ namespace Rector\Set\ValueObject;
use Rector\Set\Contract\SetListInterface;
final class LevelSetList implements \Rector\Set\Contract\SetListInterface
{
/**
* @var string
*/
public const UP_TO_PHP_82 = __DIR__ . '/../../../config/set/level/up-to-php82.php';
/**
* @var string
*/

View File

@ -102,6 +102,10 @@ final class SetList implements \Rector\Set\Contract\SetListInterface
* @var string
*/
public const PHP_81 = __DIR__ . '/../../../config/set/php81.php';
/**
* @var string
*/
public const PHP_82 = __DIR__ . '/../../../config/set/php82.php';
/**
* @var string
*/

View File

@ -0,0 +1,154 @@
<?php
declare (strict_types=1);
namespace Rector\Php82\Rector\Class_;
use PhpParser\Node;
use PhpParser\Node\Stmt\Class_;
use PhpParser\Node\Stmt\ClassMethod;
use PhpParser\Node\Stmt\Property;
use Rector\Core\NodeAnalyzer\ClassAnalyzer;
use Rector\Core\Rector\AbstractRector;
use Rector\Core\ValueObject\MethodName;
use Rector\Core\ValueObject\PhpVersionFeature;
use Rector\Core\ValueObject\Visibility;
use Rector\Php80\NodeAnalyzer\PhpAttributeAnalyzer;
use Rector\Privatization\NodeManipulator\VisibilityManipulator;
use Rector\VersionBonding\Contract\MinPhpVersionInterface;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
/**
* @changelog https://wiki.php.net/rfc/readonly_classes
*
* @see \Rector\Tests\Php82\Rector\Class_\ReadOnlyClassRector\ReadOnlyClassRectorTest
*/
final class ReadOnlyClassRector extends \Rector\Core\Rector\AbstractRector implements \Rector\VersionBonding\Contract\MinPhpVersionInterface
{
/**
* @var string
*/
private const ATTRIBUTE = 'AllowDynamicProperties';
/**
* @readonly
* @var \Rector\Core\NodeAnalyzer\ClassAnalyzer
*/
private $classAnalyzer;
/**
* @readonly
* @var \Rector\Privatization\NodeManipulator\VisibilityManipulator
*/
private $visibilityManipulator;
/**
* @readonly
* @var \Rector\Php80\NodeAnalyzer\PhpAttributeAnalyzer
*/
private $phpAttributeAnalyzer;
public function __construct(\Rector\Core\NodeAnalyzer\ClassAnalyzer $classAnalyzer, \Rector\Privatization\NodeManipulator\VisibilityManipulator $visibilityManipulator, \Rector\Php80\NodeAnalyzer\PhpAttributeAnalyzer $phpAttributeAnalyzer)
{
$this->classAnalyzer = $classAnalyzer;
$this->visibilityManipulator = $visibilityManipulator;
$this->phpAttributeAnalyzer = $phpAttributeAnalyzer;
}
public function getRuleDefinition() : \Symplify\RuleDocGenerator\ValueObject\RuleDefinition
{
return new \Symplify\RuleDocGenerator\ValueObject\RuleDefinition('Decorate read-only class with `readonly` attribute', [new \Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample(<<<'CODE_SAMPLE'
final class SomeClass
{
public function __construct(
private readonly string $name
) {
}
}
CODE_SAMPLE
, <<<'CODE_SAMPLE'
final readonly class SomeClass
{
public function __construct(
private string $name
) {
}
}
CODE_SAMPLE
)]);
}
/**
* @return array<class-string<Node>>
*/
public function getNodeTypes() : array
{
return [\PhpParser\Node\Stmt\Class_::class];
}
/**
* @param Class_ $node
*/
public function refactor(\PhpParser\Node $node) : ?\PhpParser\Node
{
if ($this->shouldSkip($node)) {
return null;
}
$this->visibilityManipulator->makeReadonly($node);
$constructClassMethod = $node->getMethod(\Rector\Core\ValueObject\MethodName::CONSTRUCT);
if ($constructClassMethod instanceof \PhpParser\Node\Stmt\ClassMethod) {
foreach ($constructClassMethod->getParams() as $param) {
$this->visibilityManipulator->removeReadonly($param);
}
}
foreach ($node->getProperties() as $property) {
$this->visibilityManipulator->removeReadonly($property);
}
return $node;
}
public function provideMinPhpVersion() : int
{
return \Rector\Core\ValueObject\PhpVersionFeature::READONLY_CLASS;
}
private function shouldSkip(\PhpParser\Node\Stmt\Class_ $class) : bool
{
// need to have test fixture once feature added to nikic/PHP-Parser
if ($this->visibilityManipulator->hasVisibility($class, \Rector\Core\ValueObject\Visibility::READONLY)) {
return \true;
}
if ($this->classAnalyzer->isAnonymousClass($class)) {
return \true;
}
if (!$class->isFinal()) {
return \true;
}
if ($this->phpAttributeAnalyzer->hasPhpAttribute($class, self::ATTRIBUTE)) {
return \true;
}
$properties = $class->getProperties();
if ($this->hasWritableProperty($properties)) {
return \true;
}
$constructClassMethod = $class->getMethod(\Rector\Core\ValueObject\MethodName::CONSTRUCT);
if (!$constructClassMethod instanceof \PhpParser\Node\Stmt\ClassMethod) {
// no __construct means no property promotion, skip if class has no property defined
return $properties === [];
}
$params = $constructClassMethod->getParams();
if ($params === []) {
// no params means no property promotion, skip if class has no property defined
return $properties === [];
}
foreach ($params as $param) {
// has non-property promotion, skip
if (!$this->visibilityManipulator->hasVisibility($param, \Rector\Core\ValueObject\Visibility::READONLY)) {
return \true;
}
}
return \false;
}
/**
* @param Property[] $properties
*/
private function hasWritableProperty(array $properties) : bool
{
foreach ($properties as $property) {
if (!$property->isReadonly()) {
return \true;
}
}
return \false;
}
}

View File

@ -16,7 +16,7 @@ use RectorPrefix20220512\Webmozart\Assert\Assert;
final class VisibilityManipulator
{
/**
* @param \PhpParser\Node\Stmt\ClassMethod|\PhpParser\Node\Stmt\Property|\PhpParser\Node\Stmt\ClassConst|\PhpParser\Node\Param $node
* @param \PhpParser\Node\Stmt\Class_|\PhpParser\Node\Stmt\ClassMethod|\PhpParser\Node\Stmt\Property|\PhpParser\Node\Stmt\ClassConst|\PhpParser\Node\Param $node
*/
public function hasVisibility($node, int $visibility) : bool
{
@ -124,7 +124,7 @@ final class VisibilityManipulator
$classMethod->flags -= \PhpParser\Node\Stmt\Class_::MODIFIER_ABSTRACT;
}
/**
* @param \PhpParser\Node\Stmt\Property|\PhpParser\Node\Param $node
* @param \PhpParser\Node\Stmt\Class_|\PhpParser\Node\Stmt\Property|\PhpParser\Node\Param $node
*/
public function makeReadonly($node) : void
{

View File

@ -16,11 +16,11 @@ final class VersionResolver
/**
* @var string
*/
public const PACKAGE_VERSION = '93cf392561fec928e688fe55381da4d7c425498a';
public const PACKAGE_VERSION = '78aaf7ee0b1b03a9adeb76018c1ccffdd475c972';
/**
* @var string
*/
public const RELEASE_DATE = '2022-05-12 16:27:28';
public const RELEASE_DATE = '2022-05-12 22:44:59';
/**
* @var string
*/

View File

@ -458,6 +458,11 @@ final class PhpVersionFeature
* @var int
*/
public const DEPRECATE_DYNAMIC_PROPERTIES = \Rector\Core\ValueObject\PhpVersion::PHP_82;
/**
* @see https://wiki.php.net/rfc/readonly_classes
* @var int
*/
public const READONLY_CLASS = \Rector\Core\ValueObject\PhpVersion::PHP_82;
/**
* @see https://wiki.php.net/rfc/mixed_type_v2
* @var int

2
vendor/autoload.php vendored
View File

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

View File

@ -2717,6 +2717,7 @@ return array(
'Rector\\Php81\\Rector\\FunctionLike\\IntersectionTypesRector' => $baseDir . '/rules/Php81/Rector/FunctionLike/IntersectionTypesRector.php',
'Rector\\Php81\\Rector\\MethodCall\\MyCLabsMethodCallToEnumConstRector' => $baseDir . '/rules/Php81/Rector/MethodCall/MyCLabsMethodCallToEnumConstRector.php',
'Rector\\Php81\\Rector\\Property\\ReadOnlyPropertyRector' => $baseDir . '/rules/Php81/Rector/Property/ReadOnlyPropertyRector.php',
'Rector\\Php82\\Rector\\Class_\\ReadOnlyClassRector' => $baseDir . '/rules/Php82/Rector/Class_/ReadOnlyClassRector.php',
'Rector\\PhpAttribute\\AnnotationToAttributeMapper' => $baseDir . '/packages/PhpAttribute/AnnotationToAttributeMapper.php',
'Rector\\PhpAttribute\\AnnotationToAttributeMapper\\ArrayAnnotationToAttributeMapper' => $baseDir . '/packages/PhpAttribute/AnnotationToAttributeMapper/ArrayAnnotationToAttributeMapper.php',
'Rector\\PhpAttribute\\AnnotationToAttributeMapper\\ClassConstFetchAnnotationToAttributeMapper' => $baseDir . '/packages/PhpAttribute/AnnotationToAttributeMapper/ClassConstFetchAnnotationToAttributeMapper.php',

View File

@ -2,7 +2,7 @@
// autoload_real.php @generated by Composer
class ComposerAutoloaderInit5c03c90529f0aa64881de1d57e5d16d7
class ComposerAutoloaderInit8780a4aca5ad8a91147a0fadb68cc41f
{
private static $loader;
@ -22,19 +22,19 @@ class ComposerAutoloaderInit5c03c90529f0aa64881de1d57e5d16d7
return self::$loader;
}
spl_autoload_register(array('ComposerAutoloaderInit5c03c90529f0aa64881de1d57e5d16d7', 'loadClassLoader'), true, true);
spl_autoload_register(array('ComposerAutoloaderInit8780a4aca5ad8a91147a0fadb68cc41f', 'loadClassLoader'), true, true);
self::$loader = $loader = new \Composer\Autoload\ClassLoader(\dirname(__DIR__));
spl_autoload_unregister(array('ComposerAutoloaderInit5c03c90529f0aa64881de1d57e5d16d7', 'loadClassLoader'));
spl_autoload_unregister(array('ComposerAutoloaderInit8780a4aca5ad8a91147a0fadb68cc41f', 'loadClassLoader'));
require __DIR__ . '/autoload_static.php';
call_user_func(\Composer\Autoload\ComposerStaticInit5c03c90529f0aa64881de1d57e5d16d7::getInitializer($loader));
call_user_func(\Composer\Autoload\ComposerStaticInit8780a4aca5ad8a91147a0fadb68cc41f::getInitializer($loader));
$loader->setClassMapAuthoritative(true);
$loader->register(true);
$includeFiles = \Composer\Autoload\ComposerStaticInit5c03c90529f0aa64881de1d57e5d16d7::$files;
$includeFiles = \Composer\Autoload\ComposerStaticInit8780a4aca5ad8a91147a0fadb68cc41f::$files;
foreach ($includeFiles as $fileIdentifier => $file) {
composerRequire5c03c90529f0aa64881de1d57e5d16d7($fileIdentifier, $file);
composerRequire8780a4aca5ad8a91147a0fadb68cc41f($fileIdentifier, $file);
}
return $loader;
@ -46,7 +46,7 @@ class ComposerAutoloaderInit5c03c90529f0aa64881de1d57e5d16d7
* @param string $file
* @return void
*/
function composerRequire5c03c90529f0aa64881de1d57e5d16d7($fileIdentifier, $file)
function composerRequire8780a4aca5ad8a91147a0fadb68cc41f($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 ComposerStaticInit5c03c90529f0aa64881de1d57e5d16d7
class ComposerStaticInit8780a4aca5ad8a91147a0fadb68cc41f
{
public static $files = array (
'320cde22f66dd4f5d3fd621d3e88b98f' => __DIR__ . '/..' . '/symfony/polyfill-ctype/bootstrap.php',
@ -3086,6 +3086,7 @@ class ComposerStaticInit5c03c90529f0aa64881de1d57e5d16d7
'Rector\\Php81\\Rector\\FunctionLike\\IntersectionTypesRector' => __DIR__ . '/../..' . '/rules/Php81/Rector/FunctionLike/IntersectionTypesRector.php',
'Rector\\Php81\\Rector\\MethodCall\\MyCLabsMethodCallToEnumConstRector' => __DIR__ . '/../..' . '/rules/Php81/Rector/MethodCall/MyCLabsMethodCallToEnumConstRector.php',
'Rector\\Php81\\Rector\\Property\\ReadOnlyPropertyRector' => __DIR__ . '/../..' . '/rules/Php81/Rector/Property/ReadOnlyPropertyRector.php',
'Rector\\Php82\\Rector\\Class_\\ReadOnlyClassRector' => __DIR__ . '/../..' . '/rules/Php82/Rector/Class_/ReadOnlyClassRector.php',
'Rector\\PhpAttribute\\AnnotationToAttributeMapper' => __DIR__ . '/../..' . '/packages/PhpAttribute/AnnotationToAttributeMapper.php',
'Rector\\PhpAttribute\\AnnotationToAttributeMapper\\ArrayAnnotationToAttributeMapper' => __DIR__ . '/../..' . '/packages/PhpAttribute/AnnotationToAttributeMapper/ArrayAnnotationToAttributeMapper.php',
'Rector\\PhpAttribute\\AnnotationToAttributeMapper\\ClassConstFetchAnnotationToAttributeMapper' => __DIR__ . '/../..' . '/packages/PhpAttribute/AnnotationToAttributeMapper/ClassConstFetchAnnotationToAttributeMapper.php',
@ -3895,9 +3896,9 @@ class ComposerStaticInit5c03c90529f0aa64881de1d57e5d16d7
public static function getInitializer(ClassLoader $loader)
{
return \Closure::bind(function () use ($loader) {
$loader->prefixLengthsPsr4 = ComposerStaticInit5c03c90529f0aa64881de1d57e5d16d7::$prefixLengthsPsr4;
$loader->prefixDirsPsr4 = ComposerStaticInit5c03c90529f0aa64881de1d57e5d16d7::$prefixDirsPsr4;
$loader->classMap = ComposerStaticInit5c03c90529f0aa64881de1d57e5d16d7::$classMap;
$loader->prefixLengthsPsr4 = ComposerStaticInit8780a4aca5ad8a91147a0fadb68cc41f::$prefixLengthsPsr4;
$loader->prefixDirsPsr4 = ComposerStaticInit8780a4aca5ad8a91147a0fadb68cc41f::$prefixDirsPsr4;
$loader->classMap = ComposerStaticInit8780a4aca5ad8a91147a0fadb68cc41f::$classMap;
}, null, ClassLoader::class);
}

View File

@ -9,8 +9,8 @@ $loader = require_once __DIR__.'/autoload.php';
if (!class_exists('AutoloadIncluder', false) && !interface_exists('AutoloadIncluder', false) && !trait_exists('AutoloadIncluder', false)) {
spl_autoload_call('RectorPrefix20220512\AutoloadIncluder');
}
if (!class_exists('ComposerAutoloaderInit5c03c90529f0aa64881de1d57e5d16d7', false) && !interface_exists('ComposerAutoloaderInit5c03c90529f0aa64881de1d57e5d16d7', false) && !trait_exists('ComposerAutoloaderInit5c03c90529f0aa64881de1d57e5d16d7', false)) {
spl_autoload_call('RectorPrefix20220512\ComposerAutoloaderInit5c03c90529f0aa64881de1d57e5d16d7');
if (!class_exists('ComposerAutoloaderInit8780a4aca5ad8a91147a0fadb68cc41f', false) && !interface_exists('ComposerAutoloaderInit8780a4aca5ad8a91147a0fadb68cc41f', false) && !trait_exists('ComposerAutoloaderInit8780a4aca5ad8a91147a0fadb68cc41f', false)) {
spl_autoload_call('RectorPrefix20220512\ComposerAutoloaderInit8780a4aca5ad8a91147a0fadb68cc41f');
}
if (!class_exists('Helmich\TypoScriptParser\Parser\AST\Statement', false) && !interface_exists('Helmich\TypoScriptParser\Parser\AST\Statement', false) && !trait_exists('Helmich\TypoScriptParser\Parser\AST\Statement', false)) {
spl_autoload_call('RectorPrefix20220512\Helmich\TypoScriptParser\Parser\AST\Statement');
@ -59,9 +59,9 @@ if (!function_exists('print_node')) {
return \RectorPrefix20220512\print_node(...func_get_args());
}
}
if (!function_exists('composerRequire5c03c90529f0aa64881de1d57e5d16d7')) {
function composerRequire5c03c90529f0aa64881de1d57e5d16d7() {
return \RectorPrefix20220512\composerRequire5c03c90529f0aa64881de1d57e5d16d7(...func_get_args());
if (!function_exists('composerRequire8780a4aca5ad8a91147a0fadb68cc41f')) {
function composerRequire8780a4aca5ad8a91147a0fadb68cc41f() {
return \RectorPrefix20220512\composerRequire8780a4aca5ad8a91147a0fadb68cc41f(...func_get_args());
}
}
if (!function_exists('scanPath')) {