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

Updated Rector to commit 48121fb6f4

Browse Source 
48121fb6f4 [PHP 8.1] Add basic support for Spatie Enums to native Enums (#653)
This commit is contained in:
Tomas Votruba 2021-08-12 14:48:46 +00:00
parent 359cdb2450
commit a0b5bf612c
8 changed files with 132 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
rules/Php81/NodeFactory/EnumFactory.php
View File

@ -3,10 +3,15 @@
declare (strict_types=1);
namespace Rector\Php81\NodeFactory;
use RectorPrefix20210812\Nette\Utils\Strings;
use PhpParser\BuilderFactory;
use PhpParser\Node\Stmt\Class_;
use PhpParser\Node\Stmt\ClassConst;
use PhpParser\Node\Stmt\Enum_;
use PhpParser\Node\Stmt\EnumCase;
use PHPStan\PhpDocParser\Ast\PhpDoc\MethodTagValueNode;
use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagNode;
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
use Rector\NodeNameResolver\NodeNameResolver;
use Rector\NodeTypeResolver\Node\AttributeKey;
final class EnumFactory
@ -15,9 +20,19 @@ final class EnumFactory
* @var \Rector\NodeNameResolver\NodeNameResolver
*/
private $nodeNameResolver;
public function __construct(\Rector\NodeNameResolver\NodeNameResolver $nodeNameResolver)
/**
* @var \Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory
*/
private $phpDocInfoFactory;
/**
* @var \PhpParser\BuilderFactory
*/
private $builderFactory;
public function __construct(\Rector\NodeNameResolver\NodeNameResolver $nodeNameResolver, \Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory $phpDocInfoFactory, \PhpParser\BuilderFactory $builderFactory)
{
$this->nodeNameResolver = $nodeNameResolver;
$this->phpDocInfoFactory = $phpDocInfoFactory;
$this->builderFactory = $builderFactory;
}
public function createFromClass(\PhpParser\Node\Stmt\Class_ $class) : \PhpParser\Node\Stmt\Enum_
{
@ -25,17 +40,39 @@ final class EnumFactory
$enum = new \PhpParser\Node\Stmt\Enum_($shortClassName);
// constant to cases
foreach ($class->getConstants() as $classConst) {
$enum->stmts[] = $this->createEnumCase($classConst);
$enum->stmts[] = $this->createEnumCaseFromConst($classConst);
}
return $enum;
}
private function createEnumCase(\PhpParser\Node\Stmt\ClassConst $classConst) : \PhpParser\Node\Stmt\EnumCase
public function createFromSpatieClass(\PhpParser\Node\Stmt\Class_ $class) : \PhpParser\Node\Stmt\Enum_
{
$shortClassName = $this->nodeNameResolver->getShortName($class);
$enum = new \PhpParser\Node\Stmt\Enum_($shortClassName);
// constant to cases
$classDocInfo = $this->phpDocInfoFactory->createFromNode($class);
$docBlockMethods = ($classDocInfo2 = $classDocInfo) ? $classDocInfo2->getTagsByName('@method') : null;
if ($docBlockMethods !== null) {
foreach ($docBlockMethods as $docBlockMethod) {
$enum->stmts[] = $this->createEnumCaseFromDocComment($docBlockMethod);
}
}
return $enum;
}
private function createEnumCaseFromConst(\PhpParser\Node\Stmt\ClassConst $classConst) : \PhpParser\Node\Stmt\EnumCase
{
$constConst = $classConst->consts[0];
$enumCase = new \PhpParser\Node\Stmt\EnumCase($constConst->name, $constConst->value);
// mirrow comments
// mirror comments
$enumCase->setAttribute(\Rector\NodeTypeResolver\Node\AttributeKey::PHP_DOC_INFO, $classConst->getAttribute(\Rector\NodeTypeResolver\Node\AttributeKey::PHP_DOC_INFO));
$enumCase->setAttribute(\Rector\NodeTypeResolver\Node\AttributeKey::COMMENTS, $classConst->getAttribute(\Rector\NodeTypeResolver\Node\AttributeKey::COMMENTS));
return $enumCase;
}
private function createEnumCaseFromDocComment(\PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagNode $docTagNode) : \PhpParser\Node\Stmt\EnumCase
{
/**
* @var MethodTagValueNode $nodeValue
*/
$nodeValue = $docTagNode->value;
return new \PhpParser\Node\Stmt\EnumCase($nodeValue->methodName, $this->builderFactory->val($nodeValue->methodName));
}
}

70
rules/Php81/Rector/Class_/SpatieEnumClassToEnumRector.php Normal file
View File

@ -0,0 +1,70 @@
<?php
declare (strict_types=1);
namespace Rector\Php81\Rector\Class_;
use PhpParser\Node;
use PhpParser\Node\Stmt\Class_;
use PHPStan\Type\ObjectType;
use Rector\Core\Rector\AbstractRector;
use Rector\Php81\NodeFactory\EnumFactory;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
/**
* @changelog https://wiki.php.net/rfc/enumerations
* @changelog https://github.com/spatie/enum
*
* @see \Rector\Tests\Php81\Rector\Class_\SpatieEnumClassToEnumRector\SpatieEnumClassToEnumRectorTest
*/
final class SpatieEnumClassToEnumRector extends \Rector\Core\Rector\AbstractRector
{
/**
* @var \Rector\Php81\NodeFactory\EnumFactory
*/
private $enumFactory;
public function __construct(\Rector\Php81\NodeFactory\EnumFactory $enumFactory)
{
$this->enumFactory = $enumFactory;
}
public function getRuleDefinition() : \Symplify\RuleDocGenerator\ValueObject\RuleDefinition
{
return new \Symplify\RuleDocGenerator\ValueObject\RuleDefinition('Refactor Spatie enum class to native Enum', [new \Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample(<<<'CODE_SAMPLE'
use \Spatie\Enum\Enum;
/**
* @method static self draft()
* @method static self published()
* @method static self archived()
*/
class StatusEnum extends Enum
{
}
CODE_SAMPLE
, <<<'CODE_SAMPLE'
enum StatusEnum
{
case draft = 'draft';
case published = 'published';
case archived = 'archived';
}
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->isObjectType($node, new \PHPStan\Type\ObjectType('Spatie\\Enum\\Enum'))) {
return null;
}
return $this->enumFactory->createFromSpatieClass($node);
}
}

4
src/Application/VersionResolver.php
View File

@ -16,11 +16,11 @@ final class VersionResolver
/**
* @var string
*/
public const PACKAGE_VERSION = '8e48e498234ac51af25b584f866ddd200803f02f';
public const PACKAGE_VERSION = '48121fb6f4dd5c3a81c50fb8809256f9cd72fffa';
/**
* @var string
*/
public const RELEASE_DATE = '2021-08-12 13:01:47';
public const RELEASE_DATE = '2021-08-12 14:37:18';
public static function resolvePackageVersion() : string
{
$process = new \RectorPrefix20210812\Symfony\Component\Process\Process(['git', 'log', '--pretty="%H"', '-n1', 'HEAD'], __DIR__);

2
vendor/autoload.php vendored
View File

@ -4,4 +4,4 @@
require_once __DIR__ . '/composer/autoload_real.php';
return ComposerAutoloaderInitd3fefe2aaa18e81a090620c6e55610a3::getLoader();
return ComposerAutoloaderInit8d050aef70723a73af80f331e153e3cf::getLoader();

1
vendor/composer/autoload_classmap.php vendored
View File

@ -2765,6 +2765,7 @@ return array(
'Rector\\Php81\\NodeFactory\\EnumFactory' => $baseDir . '/rules/Php81/NodeFactory/EnumFactory.php',
'Rector\\Php81\\Rector\\ClassConst\\FinalizePublicClassConstantRector' => $baseDir . '/rules/Php81/Rector/ClassConst/FinalizePublicClassConstantRector.php',
'Rector\\Php81\\Rector\\Class_\\MyCLabsClassToEnumRector' => $baseDir . '/rules/Php81/Rector/Class_/MyCLabsClassToEnumRector.php',
'Rector\\Php81\\Rector\\Class_\\SpatieEnumClassToEnumRector' => $baseDir . '/rules/Php81/Rector/Class_/SpatieEnumClassToEnumRector.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\\PhpAttribute\\NodeAnalyzer\\NamedArgumentsResolver' => $baseDir . '/packages/PhpAttribute/NodeAnalyzer/NamedArgumentsResolver.php',

14
vendor/composer/autoload_real.php vendored
View File

@ -2,7 +2,7 @@
// autoload_real.php @generated by Composer
class ComposerAutoloaderInitd3fefe2aaa18e81a090620c6e55610a3
class ComposerAutoloaderInit8d050aef70723a73af80f331e153e3cf
{
private static $loader;
@ -22,15 +22,15 @@ class ComposerAutoloaderInitd3fefe2aaa18e81a090620c6e55610a3
return self::$loader;
}
spl_autoload_register(array('ComposerAutoloaderInitd3fefe2aaa18e81a090620c6e55610a3', 'loadClassLoader'), true, true);
spl_autoload_register(array('ComposerAutoloaderInit8d050aef70723a73af80f331e153e3cf', 'loadClassLoader'), true, true);
self::$loader = $loader = new \Composer\Autoload\ClassLoader(\dirname(\dirname(__FILE__)));
spl_autoload_unregister(array('ComposerAutoloaderInitd3fefe2aaa18e81a090620c6e55610a3', 'loadClassLoader'));
spl_autoload_unregister(array('ComposerAutoloaderInit8d050aef70723a73af80f331e153e3cf', 'loadClassLoader'));
$useStaticLoader = PHP_VERSION_ID >= 50600 && !defined('HHVM_VERSION') && (!function_exists('zend_loader_file_encoded') || !zend_loader_file_encoded());
if ($useStaticLoader) {
require __DIR__ . '/autoload_static.php';
call_user_func(\Composer\Autoload\ComposerStaticInitd3fefe2aaa18e81a090620c6e55610a3::getInitializer($loader));
call_user_func(\Composer\Autoload\ComposerStaticInit8d050aef70723a73af80f331e153e3cf::getInitializer($loader));
} else {
$classMap = require __DIR__ . '/autoload_classmap.php';
if ($classMap) {
@ -42,19 +42,19 @@ class ComposerAutoloaderInitd3fefe2aaa18e81a090620c6e55610a3
$loader->register(true);
if ($useStaticLoader) {
$includeFiles = Composer\Autoload\ComposerStaticInitd3fefe2aaa18e81a090620c6e55610a3::$files;
$includeFiles = Composer\Autoload\ComposerStaticInit8d050aef70723a73af80f331e153e3cf::$files;
} else {
$includeFiles = require __DIR__ . '/autoload_files.php';
}
foreach ($includeFiles as $fileIdentifier => $file) {
composerRequired3fefe2aaa18e81a090620c6e55610a3($fileIdentifier, $file);
composerRequire8d050aef70723a73af80f331e153e3cf($fileIdentifier, $file);
}
return $loader;
}
}
function composerRequired3fefe2aaa18e81a090620c6e55610a3($fileIdentifier, $file)
function composerRequire8d050aef70723a73af80f331e153e3cf($fileIdentifier, $file)
{
if (empty($GLOBALS['__composer_autoload_files'][$fileIdentifier])) {
require $file;

9
vendor/composer/autoload_static.php vendored
View File

@ -4,7 +4,7 @@
namespace Composer\Autoload;
class ComposerStaticInitd3fefe2aaa18e81a090620c6e55610a3
class ComposerStaticInit8d050aef70723a73af80f331e153e3cf
{
public static $files = array (
'a4a119a56e50fbb293281d9a48007e0e' => __DIR__ . '/..' . '/symfony/polyfill-php80/bootstrap.php',
@ -3125,6 +3125,7 @@ class ComposerStaticInitd3fefe2aaa18e81a090620c6e55610a3
'Rector\\Php81\\NodeFactory\\EnumFactory' => __DIR__ . '/../..' . '/rules/Php81/NodeFactory/EnumFactory.php',
'Rector\\Php81\\Rector\\ClassConst\\FinalizePublicClassConstantRector' => __DIR__ . '/../..' . '/rules/Php81/Rector/ClassConst/FinalizePublicClassConstantRector.php',
'Rector\\Php81\\Rector\\Class_\\MyCLabsClassToEnumRector' => __DIR__ . '/../..' . '/rules/Php81/Rector/Class_/MyCLabsClassToEnumRector.php',
'Rector\\Php81\\Rector\\Class_\\SpatieEnumClassToEnumRector' => __DIR__ . '/../..' . '/rules/Php81/Rector/Class_/SpatieEnumClassToEnumRector.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\\PhpAttribute\\NodeAnalyzer\\NamedArgumentsResolver' => __DIR__ . '/../..' . '/packages/PhpAttribute/NodeAnalyzer/NamedArgumentsResolver.php',
@ -3849,9 +3850,9 @@ class ComposerStaticInitd3fefe2aaa18e81a090620c6e55610a3
public static function getInitializer(ClassLoader $loader)
{
return \Closure::bind(function () use ($loader) {
$loader->prefixLengthsPsr4 = ComposerStaticInitd3fefe2aaa18e81a090620c6e55610a3::$prefixLengthsPsr4;
$loader->prefixDirsPsr4 = ComposerStaticInitd3fefe2aaa18e81a090620c6e55610a3::$prefixDirsPsr4;
$loader->classMap = ComposerStaticInitd3fefe2aaa18e81a090620c6e55610a3::$classMap;
$loader->prefixLengthsPsr4 = ComposerStaticInit8d050aef70723a73af80f331e153e3cf::$prefixLengthsPsr4;
$loader->prefixDirsPsr4 = ComposerStaticInit8d050aef70723a73af80f331e153e3cf::$prefixDirsPsr4;
$loader->classMap = ComposerStaticInit8d050aef70723a73af80f331e153e3cf::$classMap;
}, null, ClassLoader::class);
}

10
vendor/scoper-autoload.php vendored
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('RectorPrefix20210812\AutoloadIncluder');
}
if (!class_exists('ComposerAutoloaderInitd3fefe2aaa18e81a090620c6e55610a3', false) && !interface_exists('ComposerAutoloaderInitd3fefe2aaa18e81a090620c6e55610a3', false) && !trait_exists('ComposerAutoloaderInitd3fefe2aaa18e81a090620c6e55610a3', false)) {
spl_autoload_call('RectorPrefix20210812\ComposerAutoloaderInitd3fefe2aaa18e81a090620c6e55610a3');
if (!class_exists('ComposerAutoloaderInit8d050aef70723a73af80f331e153e3cf', false) && !interface_exists('ComposerAutoloaderInit8d050aef70723a73af80f331e153e3cf', false) && !trait_exists('ComposerAutoloaderInit8d050aef70723a73af80f331e153e3cf', false)) {
spl_autoload_call('RectorPrefix20210812\ComposerAutoloaderInit8d050aef70723a73af80f331e153e3cf');
}
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('RectorPrefix20210812\Helmich\TypoScriptParser\Parser\AST\Statement');
@ -3308,9 +3308,9 @@ if (!function_exists('print_node')) {
return \RectorPrefix20210812\print_node(...func_get_args());
}
}
if (!function_exists('composerRequired3fefe2aaa18e81a090620c6e55610a3')) {
function composerRequired3fefe2aaa18e81a090620c6e55610a3() {
return \RectorPrefix20210812\composerRequired3fefe2aaa18e81a090620c6e55610a3(...func_get_args());
if (!function_exists('composerRequire8d050aef70723a73af80f331e153e3cf')) {
function composerRequire8d050aef70723a73af80f331e153e3cf() {
return \RectorPrefix20210812\composerRequire8d050aef70723a73af80f331e153e3cf(...func_get_args());
}
}
if (!function_exists('parseArgs')) {