rector/rules/PSR4/Rector/Namespace_/MultipleClassFileToPsr4Clas...

188 lines
6.6 KiB
PHP

<?php
declare (strict_types=1);
namespace Rector\PSR4\Rector\Namespace_;
use PhpParser\Node;
use PhpParser\Node\Stmt\Class_;
use PhpParser\Node\Stmt\ClassLike;
use PhpParser\Node\Stmt\Namespace_;
use Rector\Core\Application\FileSystem\RemovedAndAddedFilesCollector;
use Rector\Core\NodeAnalyzer\ClassAnalyzer;
use Rector\Core\PhpParser\Node\CustomNode\FileWithoutNamespace;
use Rector\Core\PhpParser\Printer\NeighbourClassLikePrinter;
use Rector\Core\Rector\AbstractRector;
use Rector\FileSystemRector\ValueObject\AddedFileWithContent;
use Rector\PSR4\FileInfoAnalyzer\FileInfoDeletionAnalyzer;
use Rector\PSR4\NodeManipulator\NamespaceManipulator;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
/**
* @see \Rector\Tests\PSR4\Rector\Namespace_\MultipleClassFileToPsr4ClassesRector\MultipleClassFileToPsr4ClassesRectorTest
*/
final class MultipleClassFileToPsr4ClassesRector extends AbstractRector
{
/**
* @readonly
* @var \Rector\PSR4\NodeManipulator\NamespaceManipulator
*/
private $namespaceManipulator;
/**
* @readonly
* @var \Rector\PSR4\FileInfoAnalyzer\FileInfoDeletionAnalyzer
*/
private $fileInfoDeletionAnalyzer;
/**
* @readonly
* @var \Rector\Core\PhpParser\Printer\NeighbourClassLikePrinter
*/
private $neighbourClassLikePrinter;
/**
* @readonly
* @var \Rector\Core\Application\FileSystem\RemovedAndAddedFilesCollector
*/
private $removedAndAddedFilesCollector;
/**
* @readonly
* @var \Rector\Core\NodeAnalyzer\ClassAnalyzer
*/
private $classAnalyzer;
public function __construct(NamespaceManipulator $namespaceManipulator, FileInfoDeletionAnalyzer $fileInfoDeletionAnalyzer, NeighbourClassLikePrinter $neighbourClassLikePrinter, RemovedAndAddedFilesCollector $removedAndAddedFilesCollector, ClassAnalyzer $classAnalyzer)
{
$this->namespaceManipulator = $namespaceManipulator;
$this->fileInfoDeletionAnalyzer = $fileInfoDeletionAnalyzer;
$this->neighbourClassLikePrinter = $neighbourClassLikePrinter;
$this->removedAndAddedFilesCollector = $removedAndAddedFilesCollector;
$this->classAnalyzer = $classAnalyzer;
}
public function getRuleDefinition() : RuleDefinition
{
return new RuleDefinition('Change multiple classes in one file to standalone PSR-4 classes.', [new CodeSample(<<<'CODE_SAMPLE'
namespace App\Exceptions;
use Exception;
final class FirstException extends Exception
{
}
final class SecondException extends Exception
{
}
CODE_SAMPLE
, <<<'CODE_SAMPLE'
// new file: "app/Exceptions/FirstException.php"
namespace App\Exceptions;
use Exception;
final class FirstException extends Exception
{
}
// new file: "app/Exceptions/SecondException.php"
namespace App\Exceptions;
use Exception;
final class SecondException extends Exception
{
}
CODE_SAMPLE
)]);
}
/**
* @return array<class-string<Node>>
*/
public function getNodeTypes() : array
{
return [Namespace_::class, FileWithoutNamespace::class];
}
/**
* @param Namespace_|FileWithoutNamespace $node
*/
public function refactor(Node $node) : ?Node
{
if (!$this->hasAtLeastTwoClassLikes($node)) {
return null;
}
$nodeToReturn = null;
if ($node instanceof Namespace_) {
$nodeToReturn = $this->refactorNamespace($node);
}
if ($node instanceof FileWithoutNamespace) {
$nodeToReturn = $this->refactorFileWithoutNamespace($node);
}
// 1. remove this node
if ($nodeToReturn instanceof Node) {
return $nodeToReturn;
}
$isInAddedFiles = (bool) \array_filter($this->removedAndAddedFilesCollector->getAddedFilesWithContent(), function (AddedFileWithContent $addedFileWithContent) : bool {
return $addedFileWithContent->getFilePath() === $this->file->getFilePath();
});
if ($isInAddedFiles === \false) {
// 2. nothing to return - remove the file
$this->removedAndAddedFilesCollector->removeFile($this->file->getFilePath());
}
return $node;
}
private function hasAtLeastTwoClassLikes(Node $node) : bool
{
$nonAnonymousClassLikes = $this->findNonAnonymousClassLikes($node);
return \count($nonAnonymousClassLikes) > 1;
}
private function refactorNamespace(Namespace_ $namespace) : ?Namespace_
{
$classLikes = $this->findNonAnonymousClassLikes($namespace);
$this->namespaceManipulator->removeClassLikes($namespace);
$nodeToReturn = null;
foreach ($classLikes as $classLike) {
$newNamespace = clone $namespace;
$newNamespace->stmts[] = $classLike;
// 1. is the class that will be kept in original file?
if ($this->fileInfoDeletionAnalyzer->isClassLikeAndFileInfoMatch($this->file, $classLike)) {
$nodeToReturn = $newNamespace;
continue;
}
$this->printNewNodes($classLike, $newNamespace);
}
return $nodeToReturn;
}
private function refactorFileWithoutNamespace(FileWithoutNamespace $fileWithoutNamespace) : ?FileWithoutNamespace
{
$classLikes = $this->findNonAnonymousClassLikes($fileWithoutNamespace);
$nodeToReturn = null;
foreach ($classLikes as $classLike) {
// 1. is the class that will be kept in original file?
if ($this->fileInfoDeletionAnalyzer->isClassLikeAndFileInfoMatch($this->file, $classLike)) {
$nodeToReturn = $fileWithoutNamespace;
continue;
}
// 2. is new file
$this->printNewNodes($classLike, $fileWithoutNamespace);
}
return $nodeToReturn;
}
/**
* @param \PhpParser\Node\Stmt\Namespace_|\Rector\Core\PhpParser\Node\CustomNode\FileWithoutNamespace $mainNode
*/
private function printNewNodes(ClassLike $classLike, $mainNode) : void
{
$filePath = $this->file->getFilePath();
$this->neighbourClassLikePrinter->printClassLike($classLike, $mainNode, $filePath, $this->file);
}
/**
* @return ClassLike[]
*/
private function findNonAnonymousClassLikes(Node $node) : array
{
$classLikes = $this->betterNodeFinder->findInstanceOf([$node], ClassLike::class);
return \array_filter($classLikes, function (ClassLike $classLike) : bool {
if (!$classLike instanceof Class_) {
return \true;
}
return !$this->classAnalyzer->isAnonymousClass($classLike);
});
}
}