rector/rules/PSR4/Rector/Namespace_/MultipleClassFileToPsr4ClassesRector.php
Tomas Votruba 96112cb1f0 Updated Rector to commit 2da49992cc
2da49992cc [Downgrade] [PHP 7.2] Make DowngradeParameterTypeWideningRector always downgrade to phpdoc type (#390)
2021-07-05 22:50:18 +00:00

169 lines
6.6 KiB
PHP

<?php
declare (strict_types=1);
namespace Rector\PSR4\Rector\Namespace_;
use PhpParser\Node;
use PhpParser\Node\Stmt\ClassLike;
use PhpParser\Node\Stmt\Declare_;
use PhpParser\Node\Stmt\Namespace_;
use Rector\Core\PhpParser\Node\CustomNode\FileWithoutNamespace;
use Rector\Core\Rector\AbstractRector;
use Rector\FileSystemRector\ValueObject\AddedFileWithNodes;
use Rector\PSR4\FileInfoAnalyzer\FileInfoDeletionAnalyzer;
use Rector\PSR4\NodeManipulator\NamespaceManipulator;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
use Symplify\SmartFileSystem\SmartFileInfo;
/**
* @see \Rector\Tests\PSR4\Rector\Namespace_\MultipleClassFileToPsr4ClassesRector\MultipleClassFileToPsr4ClassesRectorTest
*/
final class MultipleClassFileToPsr4ClassesRector extends \Rector\Core\Rector\AbstractRector
{
/**
* @var \Rector\PSR4\NodeManipulator\NamespaceManipulator
*/
private $namespaceManipulator;
/**
* @var \Rector\PSR4\FileInfoAnalyzer\FileInfoDeletionAnalyzer
*/
private $fileInfoDeletionAnalyzer;
public function __construct(\Rector\PSR4\NodeManipulator\NamespaceManipulator $namespaceManipulator, \Rector\PSR4\FileInfoAnalyzer\FileInfoDeletionAnalyzer $fileInfoDeletionAnalyzer)
{
$this->namespaceManipulator = $namespaceManipulator;
$this->fileInfoDeletionAnalyzer = $fileInfoDeletionAnalyzer;
}
public function getRuleDefinition() : \Symplify\RuleDocGenerator\ValueObject\RuleDefinition
{
return new \Symplify\RuleDocGenerator\ValueObject\RuleDefinition('Change multiple classes in one file to standalone PSR-4 classes.', [new \Symplify\RuleDocGenerator\ValueObject\CodeSample\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 [\PhpParser\Node\Stmt\Namespace_::class, \Rector\Core\PhpParser\Node\CustomNode\FileWithoutNamespace::class];
}
/**
* @param Namespace_|FileWithoutNamespace $node
*/
public function refactor(\PhpParser\Node $node) : ?\PhpParser\Node
{
if (!$this->hasAtLeastTwoClassLikes($node)) {
return null;
}
$nodeToReturn = null;
if ($node instanceof \PhpParser\Node\Stmt\Namespace_) {
$nodeToReturn = $this->refactorNamespace($node);
}
if ($node instanceof \Rector\Core\PhpParser\Node\CustomNode\FileWithoutNamespace) {
$nodeToReturn = $this->refactorFileWithoutNamespace($node);
}
// 1. remove this node
if ($nodeToReturn !== null) {
return $nodeToReturn;
}
$smartFileInfo = $this->file->getSmartFileInfo();
// 2. nothing to return - remove the file
$this->removedAndAddedFilesCollector->removeFile($smartFileInfo);
return null;
}
private function hasAtLeastTwoClassLikes(\PhpParser\Node $node) : bool
{
$classes = $this->betterNodeFinder->findClassLikes($node);
return \count($classes) > 1;
}
private function refactorNamespace(\PhpParser\Node\Stmt\Namespace_ $namespace) : ?\PhpParser\Node\Stmt\Namespace_
{
/** @var ClassLike[] $classLikes */
$classLikes = $this->betterNodeFinder->findClassLikes($namespace->stmts);
$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;
}
// 2. new file
$this->printNewNodes($classLike, $newNamespace);
}
return $nodeToReturn;
}
private function refactorFileWithoutNamespace(\Rector\Core\PhpParser\Node\CustomNode\FileWithoutNamespace $fileWithoutNamespace) : ?\Rector\Core\PhpParser\Node\CustomNode\FileWithoutNamespace
{
/** @var ClassLike[] $classLikes */
$classLikes = $this->betterNodeFinder->findClassLikes($fileWithoutNamespace->stmts);
$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(\PhpParser\Node\Stmt\ClassLike $classLike, $mainNode) : void
{
$smartFileInfo = $this->file->getSmartFileInfo();
$declares = [];
$declare = $this->betterNodeFinder->findFirstPreviousOfTypes($mainNode, [\PhpParser\Node\Stmt\Declare_::class]);
if ($declare instanceof \PhpParser\Node\Stmt\Declare_) {
$declares = [$declare];
}
if ($mainNode instanceof \Rector\Core\PhpParser\Node\CustomNode\FileWithoutNamespace) {
$nodesToPrint = \array_merge($declares, [$classLike]);
} else {
$nodesToPrint = \array_merge($declares, [$mainNode]);
}
$fileDestination = $this->createClassLikeFileDestination($classLike, $smartFileInfo);
$addedFileWithNodes = new \Rector\FileSystemRector\ValueObject\AddedFileWithNodes($fileDestination, $nodesToPrint);
$this->removedAndAddedFilesCollector->addAddedFile($addedFileWithNodes);
}
private function createClassLikeFileDestination(\PhpParser\Node\Stmt\ClassLike $classLike, \Symplify\SmartFileSystem\SmartFileInfo $smartFileInfo) : string
{
$currentDirectory = \dirname($smartFileInfo->getRealPath());
return $currentDirectory . \DIRECTORY_SEPARATOR . $classLike->name . '.php';
}
}