-
-
Notifications
You must be signed in to change notification settings - Fork 339
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[TASK] Add RenamePackageComposerRector (#27)
- Loading branch information
1 parent
74d6f9b
commit b9e96e7
Showing
5 changed files
with
182 additions
and
0 deletions.
There are no files selected for viewing
17 changes: 17 additions & 0 deletions
17
rules-tests/Composer/Rector/RenamePackageComposerRector/Fixture/remove_package.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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" | ||
} | ||
} |
33 changes: 33 additions & 0 deletions
33
rules-tests/Composer/Rector/RenamePackageComposerRector/RenamePackageComposerRectorTest.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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'; | ||
} | ||
} |
21 changes: 21 additions & 0 deletions
21
rules-tests/Composer/Rector/RenamePackageComposerRector/config/some_config.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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')] | ||
), | ||
], | ||
]); | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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] ?? []; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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; | ||
} | ||
} |