2021-01-16 13:23:37 +01:00
< ? php
2021-05-09 20:15:43 +00:00
declare ( strict_types = 1 );
2021-01-16 13:23:37 +01:00
namespace Rector\Composer\Rector ;
2021-03-03 22:28:27 +01:00
use Rector\Composer\Contract\Rector\ComposerRectorInterface ;
2021-01-18 11:07:57 +01:00
use Rector\Composer\Guard\VersionGuard ;
2021-01-16 13:23:37 +01:00
use Rector\Composer\ValueObject\PackageAndVersion ;
2021-08-22 15:42:22 +00:00
use RectorPrefix20210822\Symplify\ComposerJsonManipulator\ValueObject\ComposerJson ;
2021-01-16 13:23:37 +01:00
use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample ;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition ;
2021-08-22 15:42:22 +00:00
use RectorPrefix20210822\Webmozart\Assert\Assert ;
2021-01-16 13:23:37 +01:00
/**
2021-03-12 23:20:25 +01:00
* @ see \Rector\Tests\Composer\Rector\AddPackageToRequireDevComposerRector\AddPackageToRequireDevComposerRectorTest
2021-01-16 13:23:37 +01:00
*/
2021-05-10 22:23:08 +00:00
final class AddPackageToRequireDevComposerRector implements \Rector\Composer\Contract\Rector\ComposerRectorInterface
2021-01-16 13:23:37 +01:00
{
/**
* @ var string
*/
public const PACKAGES_AND_VERSIONS = 'packages_and_version' ;
/**
* @ var PackageAndVersion []
*/
private $packageAndVersions = [];
2021-01-18 11:07:57 +01:00
/**
2021-05-10 23:39:21 +00:00
* @ var \Rector\Composer\Guard\VersionGuard
2021-01-18 11:07:57 +01:00
*/
private $versionGuard ;
2021-05-10 22:23:08 +00:00
public function __construct ( \Rector\Composer\Guard\VersionGuard $versionGuard )
2021-01-18 11:07:57 +01:00
{
$this -> versionGuard = $versionGuard ;
}
2021-08-22 15:42:22 +00:00
public function refactor ( \RectorPrefix20210822\Symplify\ComposerJsonManipulator\ValueObject\ComposerJson $composerJson ) : void
2021-01-16 13:23:37 +01:00
{
foreach ( $this -> packageAndVersions as $packageAndVersion ) {
2021-05-09 20:15:43 +00:00
$composerJson -> addRequiredDevPackage ( $packageAndVersion -> getPackageName (), $packageAndVersion -> getVersion ());
2021-01-16 13:23:37 +01:00
}
}
2021-05-10 22:23:08 +00:00
public function getRuleDefinition () : \Symplify\RuleDocGenerator\ValueObject\RuleDefinition
2021-01-16 13:23:37 +01:00
{
2021-05-10 22:23:08 +00:00
return new \Symplify\RuleDocGenerator\ValueObject\RuleDefinition ( 'Add package to "require-dev" in `composer.json`' , [ new \Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample ( <<< 'CODE_SAMPLE'
2021-01-16 13:23:37 +01:00
{
}
CODE_SAMPLE
2021-05-09 20:15:43 +00:00
, <<< 'CODE_SAMPLE'
2021-01-16 13:23:37 +01:00
{
" require-dev " : {
" symfony/console " : " ^3.4 "
}
}
CODE_SAMPLE
2021-05-10 22:23:08 +00:00
, [ self :: PACKAGES_AND_VERSIONS => [ new \Rector\Composer\ValueObject\PackageAndVersion ( 'symfony/console' , '^3.4' )]])]);
2021-01-16 13:23:37 +01:00
}
/**
* @ param array < string , PackageAndVersion [] > $configuration
*/
2021-05-09 20:15:43 +00:00
public function configure ( array $configuration ) : void
2021-01-16 13:23:37 +01:00
{
2021-01-18 11:07:57 +01:00
$packagesAndVersions = $configuration [ self :: PACKAGES_AND_VERSIONS ] ? ? [];
2021-08-22 15:42:22 +00:00
\RectorPrefix20210822\Webmozart\Assert\Assert :: allIsInstanceOf ( $packagesAndVersions , \Rector\Composer\ValueObject\PackageAndVersion :: class );
2021-01-18 11:07:57 +01:00
$this -> versionGuard -> validate ( $packagesAndVersions );
$this -> packageAndVersions = $packagesAndVersions ;
2021-01-16 13:23:37 +01:00
}
}