[TASK] Add RenamePackageComposerRector (#27)

This commit is contained in:
Sebastian Schreiber 2021-05-13 02:22:27 +02:00 committed by GitHub
parent 74d6f9b927
commit b9e96e7f46
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 182 additions and 0 deletions

View File

@ -0,0 +1,17 @@
{
"require": {
"foo/bar": "dev-main"
},
"require-dev": {
"foo/baz": "dev-main"
}
}
-----
{
"require": {
"baz/bar": "dev-main"
},
"require-dev": {
"baz/baz": "dev-main"
}
}

View File

@ -0,0 +1,33 @@
<?php
declare(strict_types=1);
namespace Rector\Tests\Composer\Rector\RenamePackageComposerRector;
use Iterator;
use Rector\Testing\PHPUnit\AbstractRectorTestCase;
use Symplify\SmartFileSystem\SmartFileInfo;
final class RenamePackageComposerRectorTest extends AbstractRectorTestCase
{
/**
* @dataProvider provideData()
*/
public function test(SmartFileInfo $fileInfo): void
{
$this->doTestFileInfo($fileInfo);
}
/**
* @return Iterator<SmartFileInfo>
*/
public function provideData(): Iterator
{
return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture', '*.json');
}
public function provideConfigFilePath(): string
{
return __DIR__ . '/config/some_config.php';
}
}

View File

@ -0,0 +1,21 @@
<?php
declare(strict_types=1);
use Rector\Composer\Rector\RenamePackageComposerRector;
use Rector\Composer\ValueObject\RenamePackage;
use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
use Symplify\SymfonyPhpConfig\ValueObjectInliner;
return static function (ContainerConfigurator $containerConfigurator): void {
$services = $containerConfigurator->services();
$services->set(RenamePackageComposerRector::class)
->call('configure', [
[
RenamePackageComposerRector::RENAME_PACKAGES =>
ValueObjectInliner::inline(
[new RenamePackage('foo/bar', 'baz/bar'), new RenamePackage('foo/baz', 'baz/baz')]
),
],
]);
};

View File

@ -0,0 +1,83 @@
<?php
declare(strict_types=1);
namespace Rector\Composer\Rector;
use Rector\Composer\Contract\Rector\ComposerRectorInterface;
use Rector\Composer\ValueObject\RenamePackage;
use Symplify\ComposerJsonManipulator\ValueObject\ComposerJson;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
/**
* @see \Rector\Tests\Composer\Rector\RenamePackageComposerRector\RenamePackageComposerRectorTest
*/
final class RenamePackageComposerRector implements ComposerRectorInterface
{
/**
* @var string
*/
public const RENAME_PACKAGES = 'rename_packages';
/**
* @var RenamePackage[]
*/
private array $renamePackages = [];
public function refactor(ComposerJson $composerJson): void
{
foreach ($this->renamePackages as $renamePackage) {
if ($composerJson->hasRequiredPackage($renamePackage->getOldPackageName())) {
$version = $composerJson->getRequire()[$renamePackage->getOldPackageName()];
$composerJson->replacePackage(
$renamePackage->getOldPackageName(),
$renamePackage->getNewPackageName(),
$version
);
}
if ($composerJson->hasRequiredDevPackage($renamePackage->getOldPackageName())) {
$version = $composerJson->getRequireDev()[$renamePackage->getOldPackageName()];
$composerJson->replacePackage(
$renamePackage->getOldPackageName(),
$renamePackage->getNewPackageName(),
$version
);
}
}
}
public function getRuleDefinition(): RuleDefinition
{
return new RuleDefinition('Change package name in `composer.json`', [new ConfiguredCodeSample(
<<<'CODE_SAMPLE'
{
"require": {
"rector/rector": "dev-main"
}
}
CODE_SAMPLE
,
<<<'CODE_SAMPLE'
{
"require": {
"rector/rector-src": "dev-main"
}
}
CODE_SAMPLE
,
[
self::RENAME_PACKAGES => [new RenamePackage('rector/rector', 'rector/rector-src')],
]
),
]);
}
/**
* @param array<string, RenamePackage[]> $configuration
*/
public function configure(array $configuration): void
{
$this->renamePackages = $configuration[self::RENAME_PACKAGES] ?? [];
}
}

View File

@ -0,0 +1,28 @@
<?php
declare(strict_types=1);
namespace Rector\Composer\ValueObject;
final class RenamePackage
{
private string $oldPackageName;
private string $newPackageName;
public function __construct(string $oldPackageName, string $newPackageName)
{
$this->oldPackageName = $oldPackageName;
$this->newPackageName = $newPackageName;
}
public function getOldPackageName(): string
{
return $this->oldPackageName;
}
public function getNewPackageName(): string
{
return $this->newPackageName;
}
}