Convert class to interface and move class to implementation

[ruudk]

In our project we have like 250 standard Doctrine repository classes. For example a UserRepository class.

I want to rename the UserRepository class to DoctrineUserRepository and introduce an UserRepository interface. All code that used to depend on the UserRepository class should now depend on the UserRepository interface. The DoctrineUserRepository should implement the newly created UserRepository interface.

I looked at the list of Rectors but couldn't find something like this.

What's the best way to achieve this?

 <?php
 
-namespace App\Repository 
+namespace App\Infrastructure\Persistence\Doctrine\Repository 
 {
     use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository;
     use Doctrine\Persistence\ManagerRegistry;
+    use App\Repository\UserRepository;
 
-    final class UserRepository extends ServiceEntityRepository
+    final class DoctrineUserRepository extends ServiceEntityRepository implements UserRepository
     {
         public function __construct(private ManagerRegistry $registry, string $entityClass)
         {
             parent::__construct($registry, $entityClass);
         }
 
         public function save(User ...$users) : void
         {
             // todo
         }
 
         public function findOrThrow(int $id) : User
         {
             // todo
         }
     }
 }

 
+namespace App\Repository 
+{
+    use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository;
+    use Doctrine\Persistence\ManagerRegistry;
+    use App\Repository\UserRepository;
+
+    interface UserRepository
+    {
+        public function save(User ...$users) : void;
+
+        public function findOrThrow(int $id) : User;
+    }
+}
 
 namespace App\Controller
 {
     use App\Repository\UserRepository;
     
     final class UserController
     {
         public function __construct(private UserRepository $userRepository)
         {
         }
     }
 }

• Rename App\Repository\UserRepository to App\Infrastructure\Persistence\Doctrine\DoctrineUserRepository without updating depending code
• Create App\Repository\UserRepository based of App\Infrastructure\Persistence\Doctrine\DoctrineUserRepository
• Modify App\Infrastructure\Persistence\Doctrine\DoctrineUserRepository and implement App\Repository\UserRepository interface
• All existing code that used to depend on App\Repository\UserRepository class now depends on App\Repository\UserRepository interface.

[TomasVotruba]

Hi, thanks for the question.

Could you share a simple diff example of what is your goal? It would more readable to me and I'd be able to navigate you better.

[ruudk]

This seems to work better:

<?php

declare(strict_types=1);

namespace Dev\Rector;

use PhpParser\Node;
use PhpParser\Node\Name;
use PhpParser\Node\Name\FullyQualified;
use PhpParser\Node\Stmt\Class_;
use PHPStan\Analyser\Scope;
use PHPStan\Reflection\ClassReflection;
use Rector\Core\Contract\Rector\ConfigurableRectorInterface;
use Rector\Core\Rector\AbstractRector;
use Rector\NodeTypeResolver\Node\AttributeKey;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;

final class ExtractClassToInterfaceRector extends AbstractRector implements ConfigurableRectorInterface
{
    /**
     * @var string
     */
    public const CLASS_TO_INTERFACE = 'class_to_interface';

    /**
     * @var array<class-string, class-string>
     */
    private array $classToInterface = [];

    public function getRuleDefinition() : RuleDefinition
    {
        return new RuleDefinition('Extract class to interface', [
            new ConfiguredCodeSample(
                <<<'CODE_SAMPLE'
                class SomeClass
                {
                    public function save(): void
                    {
                    }
                }
                CODE_SAMPLE
                ,
                <<<'CODE_SAMPLE'
                interface SomeClass
                {
                    public function save(): void;
                }
                
                class DoctrineSomeClass implements SomeClass
                {
                    public function save(): void
                    {
                    }
                }
                CODE_SAMPLE
                ,
                [
                    self::CLASS_TO_INTERFACE => [
                        'App\Repository\SomeClass' => 'App\Repository\DoctrineSomeClass',
                    ],
                ]
            ),
        ]);
    }

    /**
     * @return array<class-string<Node>>
     */
    public function getNodeTypes() : array
    {
        return [Class_::class];
    }

    /**
     * @param Class_ $node
     */
    public function refactor(Node $node) : ?Node
    {
        /** @var Scope $scope */
        $scope = $node->getAttribute(AttributeKey::SCOPE);

        $classReflection = $scope->getClassReflection();
        if ($classReflection instanceof ClassReflection === false) {
            return null;
        }

        if (isset($this->classToInterface[$classReflection->getName()]) === false) {
            return null;
        }

        $newName = $this->classToInterface[$classReflection->getName()];

        if ($this->isName($node, $newName)) {
            return null;
        }

        $this->implementInterface($node, $node->namespacedName->getLast());

        $node->namespacedName = new FullyQualified($newName);
        $node->name = new Node\Identifier($node->namespacedName->getLast());

        return $node;
    }

    private function implementInterface(Class_ $node, string $interfaceName) : void
    {
        foreach ($node->implements as $implement) {
            if ($this->isName($implement, $interfaceName)) {
                return;
            }
        }

        $node->implements[] = new Name($interfaceName);
    }

    public function configure(array $configuration) : void
    {
        $this->classToInterface = $configuration[self::CLASS_TO_INTERFACE];
    }
}

    ---------- begin diff ----------
@@ @@
-class TransactionRepository extends BaseServiceEntityRepository
+class DoctrineTransactionRepository extends BaseServiceEntityRepository implements TransactionRepository
 {
    ----------- end diff -----------

[TomasVotruba]

Nodes are re-traversed, once the content is changed. This should ensure repated changes from the parent node, e.g. https://twitter.com/rectorphp/status/1415102116725731330
In case of class it might be useful to skip this retraverse, as there is usually just single class in a file and no repeated class operatoins are needed in same rule.

Just to be sure, could you share a reproducible repository with failing test case like in here
#6946 (reply in thread)?

It helps me with the full context and proposing the fix 👍

[ruudk]

Thanks for your answer. I will do that next error I encounter.

[ruudk]

How to skip the retraverse? Is there a common method?

[TomasVotruba]

The core architecture in AbstractRector::refactor() would have to be changed.