octoleo
/
rector
mirror of https://github.com/rectorphp/rector.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated Rector to commit 643814dc92ceacb159adbac79c1ab6fb6e5cc2ee 

643814dc92 [TypeDeclaration] Add ChildDoctrineRepositoryClassTypeRector (#5695)
This commit is contained in:
Tomas Votruba 2024-03-06 20:37:05 +00:00
parent bd3297e237
commit 5cc97f5690
5 changed files with 194 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

188
rules/TypeDeclaration/Rector/Class_/ChildDoctrineRepositoryClassTypeRector.php Normal file
View File

@ -0,0 +1,188 @@
<?php
declare (strict_types=1);
namespace Rector\TypeDeclaration\Rector\Class_;
use PhpParser\Node;
use PhpParser\Node\Expr\MethodCall;
use PhpParser\Node\Identifier;
use PhpParser\Node\Name;
use PhpParser\Node\NullableType;
use PhpParser\Node\Stmt\Class_;
use PhpParser\Node\Stmt\ClassMethod;
use PhpParser\NodeFinder;
use PHPStan\PhpDocParser\Ast\PhpDoc\ExtendsTagValueNode;
use PHPStan\PhpDocParser\Ast\PhpDoc\ReturnTagValueNode;
use PHPStan\PhpDocParser\Ast\Type\ArrayTypeNode;
use PHPStan\PhpDocParser\Ast\Type\GenericTypeNode;
use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
use PHPStan\Type\ObjectType;
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo;
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
use Rector\Comments\NodeDocBlock\DocBlockUpdater;
use Rector\Rector\AbstractRector;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
/**
* @see \Rector\Tests\TypeDeclaration\Rector\Class_\ChildDoctrineRepositoryClassTypeRector\ChildDoctrineRepositoryClassTypeRectorTest
*/
final class ChildDoctrineRepositoryClassTypeRector extends AbstractRector
{
/**
* @readonly
* @var \Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory
*/
private $phpDocInfoFactory;
/**
* @readonly
* @var \PhpParser\NodeFinder
*/
private $nodeFinder;
/**
* @readonly
* @var \Rector\Comments\NodeDocBlock\DocBlockUpdater
*/
private $docBlockUpdater;
public function __construct(PhpDocInfoFactory $phpDocInfoFactory, NodeFinder $nodeFinder, DocBlockUpdater $docBlockUpdater)
{
$this->phpDocInfoFactory = $phpDocInfoFactory;
$this->nodeFinder = $nodeFinder;
$this->docBlockUpdater = $docBlockUpdater;
}
public function getRuleDefinition() : RuleDefinition
{
return new RuleDefinition('Add return type to classes that extend Doctrine\\ORM\\EntityRepository', [new CodeSample(<<<'CODE_SAMPLE'
use Doctrine\ORM\EntityRepository;
/**
* @extends EntityRepository<SomeType>
*/
final class SomeRepository extends EntityRepository
{
public function getActiveItem()
{
return $this->findOneBy([
'something'
]);
}
}
CODE_SAMPLE
, <<<'CODE_SAMPLE'
use Doctrine\ORM\EntityRepository;
/**
* @extends EntityRepository<SomeType>
*/
final class SomeRepository extends EntityRepository
{
public function getActiveItem(): ?SomeType
{
return $this->findOneBy([
'something'
]);
}
}
CODE_SAMPLE
)]);
}
/**
* @return array<class-string<Node>>
*/
public function getNodeTypes() : array
{
return [Class_::class];
}
/**
* @param Class_ $node
*/
public function refactor(Node $node) : ?Node
{
if (!$this->isObjectType($node, new ObjectType('Doctrine\\ORM\\EntityRepository'))) {
return null;
}
$entityClassName = $this->resolveEntityClassnameFromPhpDoc($node);
if ($entityClassName === null) {
return null;
}
$hasChanged = \false;
foreach ($node->getMethods() as $classMethod) {
if ($this->shouldSkipClassMethod($classMethod)) {
continue;
}
if ($this->containsMethodCallNamed($classMethod, 'findOneBy')) {
$classMethod->returnType = $this->createNullableType($entityClassName);
}
if ($this->containsMethodCallNamed($classMethod, 'findBy')) {
$classMethod->returnType = new Identifier('array');
// add docblock with type
$classMethodPhpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($classMethod);
$arrayTypeNode = new ArrayTypeNode(new IdentifierTypeNode($entityClassName));
$classMethodPhpDocInfo->addTagValueNode(new ReturnTagValueNode($arrayTypeNode, ''));
$this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($classMethod);
}
$hasChanged = \true;
// try to figure out the return type
}
if ($hasChanged) {
return $node;
}
return null;
}
private function resolveEntityClassnameFromPhpDoc(Class_ $class) : ?string
{
$classPhpDocInfo = $this->phpDocInfoFactory->createFromNode($class);
// we need a way to resolve entity type... 1st idea is from @extends docblock
if (!$classPhpDocInfo instanceof PhpDocInfo) {
return null;
}
$extendsTagValuePhpDocNodes = $classPhpDocInfo->getTagsByName('extends');
if ($extendsTagValuePhpDocNodes === []) {
return null;
}
$extendsTagValueNode = $extendsTagValuePhpDocNodes[0]->value;
if (!$extendsTagValueNode instanceof ExtendsTagValueNode) {
return null;
}
// we look for generic type class
if (!$extendsTagValueNode->type instanceof GenericTypeNode) {
return null;
}
$genericTypeNode = $extendsTagValueNode->type;
if ($genericTypeNode->type->name !== 'EntityRepository') {
return null;
}
$entityGenericType = $genericTypeNode->genericTypes[0];
if (!$entityGenericType instanceof IdentifierTypeNode) {
return null;
}
return $entityGenericType->name;
}
private function containsMethodCallNamed(ClassMethod $classMethod, string $desiredMethodName) : bool
{
return (bool) $this->nodeFinder->findFirst((array) $classMethod->stmts, static function (Node $node) use($desiredMethodName) : bool {
if (!$node instanceof MethodCall) {
return \false;
}
if (!$node->name instanceof Identifier) {
return \false;
}
$currentMethodCallName = $node->name->toString();
return $currentMethodCallName === $desiredMethodName;
});
}
private function shouldSkipClassMethod(ClassMethod $classMethod) : bool
{
if (!$classMethod->isPublic()) {
return \true;
}
if ($classMethod->isStatic()) {
return \true;
}
return $classMethod->returnType instanceof Node;
}
private function createNullableType(string $entityClassName) : NullableType
{
$name = new Name($entityClassName);
return new NullableType($name);
}
}

4
src/Application/VersionResolver.php
View File

@ -19,12 +19,12 @@ final class VersionResolver
* @api
* @var string
*/
public const PACKAGE_VERSION = '84639e6aa9c5daa4958121e9aa19e36b5b6bb9b6';
public const PACKAGE_VERSION = '643814dc92ceacb159adbac79c1ab6fb6e5cc2ee';
/**
* @api
* @var string
*/
public const RELEASE_DATE = '2024-03-06 05:46:53';
public const RELEASE_DATE = '2024-03-06 20:34:50';
/**
* @var int
*/

2
src/Config/Level/TypeDeclarationLevel.php
View File

@ -6,6 +6,7 @@ namespace Rector\Config\Level;
use Rector\Contract\Rector\RectorInterface;
use Rector\TypeDeclaration\Rector\ArrowFunction\AddArrowFunctionReturnTypeRector;
use Rector\TypeDeclaration\Rector\Class_\AddTestsVoidReturnTypeWhereNoReturnRector;
use Rector\TypeDeclaration\Rector\Class_\ChildDoctrineRepositoryClassTypeRector;
use Rector\TypeDeclaration\Rector\Class_\MergeDateTimePropertyTypeDeclarationRector;
use Rector\TypeDeclaration\Rector\Class_\PropertyTypeFromStrictSetterGetterRector;
use Rector\TypeDeclaration\Rector\Class_\ReturnTypeFromStrictTernaryRector;
@ -78,6 +79,7 @@ final class TypeDeclarationLevel
TypedPropertyFromStrictSetUpRector::class,
ReturnTypeFromStrictNativeCallRector::class,
ReturnTypeFromStrictTypedCallRector::class,
ChildDoctrineRepositoryClassTypeRector::class,
// param
AddMethodCallBasedStrictParamTypeRector::class,
ParamTypeByParentCallTypeRector::class,

1
vendor/composer/autoload_classmap.php vendored
View File

@ -2385,6 +2385,7 @@ return array(
'Rector\\TypeDeclaration\\Rector\\ClassMethod\\StrictArrayParamDimFetchRector' => $baseDir . '/rules/TypeDeclaration/Rector/ClassMethod/StrictArrayParamDimFetchRector.php',
'Rector\\TypeDeclaration\\Rector\\ClassMethod\\StrictStringParamConcatRector' => $baseDir . '/rules/TypeDeclaration/Rector/ClassMethod/StrictStringParamConcatRector.php',
'Rector\\TypeDeclaration\\Rector\\Class_\\AddTestsVoidReturnTypeWhereNoReturnRector' => $baseDir . '/rules/TypeDeclaration/Rector/Class_/AddTestsVoidReturnTypeWhereNoReturnRector.php',
'Rector\\TypeDeclaration\\Rector\\Class_\\ChildDoctrineRepositoryClassTypeRector' => $baseDir . '/rules/TypeDeclaration/Rector/Class_/ChildDoctrineRepositoryClassTypeRector.php',
'Rector\\TypeDeclaration\\Rector\\Class_\\MergeDateTimePropertyTypeDeclarationRector' => $baseDir . '/rules/TypeDeclaration/Rector/Class_/MergeDateTimePropertyTypeDeclarationRector.php',
'Rector\\TypeDeclaration\\Rector\\Class_\\PropertyTypeFromStrictSetterGetterRector' => $baseDir . '/rules/TypeDeclaration/Rector/Class_/PropertyTypeFromStrictSetterGetterRector.php',
'Rector\\TypeDeclaration\\Rector\\Class_\\ReturnTypeFromStrictTernaryRector' => $baseDir . '/rules/TypeDeclaration/Rector/Class_/ReturnTypeFromStrictTernaryRector.php',

1
vendor/composer/autoload_static.php vendored
View File

@ -2604,6 +2604,7 @@ class ComposerStaticInit2d887a2f87c676eb32b3e04612865e54
'Rector\\TypeDeclaration\\Rector\\ClassMethod\\StrictArrayParamDimFetchRector' => __DIR__ . '/../..' . '/rules/TypeDeclaration/Rector/ClassMethod/StrictArrayParamDimFetchRector.php',
'Rector\\TypeDeclaration\\Rector\\ClassMethod\\StrictStringParamConcatRector' => __DIR__ . '/../..' . '/rules/TypeDeclaration/Rector/ClassMethod/StrictStringParamConcatRector.php',
'Rector\\TypeDeclaration\\Rector\\Class_\\AddTestsVoidReturnTypeWhereNoReturnRector' => __DIR__ . '/../..' . '/rules/TypeDeclaration/Rector/Class_/AddTestsVoidReturnTypeWhereNoReturnRector.php',
'Rector\\TypeDeclaration\\Rector\\Class_\\ChildDoctrineRepositoryClassTypeRector' => __DIR__ . '/../..' . '/rules/TypeDeclaration/Rector/Class_/ChildDoctrineRepositoryClassTypeRector.php',
'Rector\\TypeDeclaration\\Rector\\Class_\\MergeDateTimePropertyTypeDeclarationRector' => __DIR__ . '/../..' . '/rules/TypeDeclaration/Rector/Class_/MergeDateTimePropertyTypeDeclarationRector.php',
'Rector\\TypeDeclaration\\Rector\\Class_\\PropertyTypeFromStrictSetterGetterRector' => __DIR__ . '/../..' . '/rules/TypeDeclaration/Rector/Class_/PropertyTypeFromStrictSetterGetterRector.php',
'Rector\\TypeDeclaration\\Rector\\Class_\\ReturnTypeFromStrictTernaryRector' => __DIR__ . '/../..' . '/rules/TypeDeclaration/Rector/Class_/ReturnTypeFromStrictTernaryRector.php',