=10\\.|10\\.)#';
public function __construct(SymfonyStyle $symfonyStyle)
{
$this->symfonyStyle = $symfonyStyle;
parent::__construct();
}
protected function configure() : void
{
$this->setName('custom-rule');
$this->setDescription('Create base of local custom rule with tests');
}
protected function execute(InputInterface $input, OutputInterface $output) : int
{
// ask for rule name
$rectorName = $this->symfonyStyle->ask('What is the name of the rule class (e.g. "LegacyCallToDbalMethodCall")?', null, static function (string $answer) : string {
if ($answer === '') {
throw new ShouldNotHappenException('Rector name cannot be empty');
}
return $answer;
});
// suffix with Rector by convention
if (\substr_compare((string) $rectorName, 'Rector', -\strlen('Rector')) !== 0) {
$rectorName .= 'Rector';
}
$rectorName = \ucfirst((string) $rectorName);
// find all files in templates directory
$finder = Finder::create()->files()->in(__DIR__ . '/../../../templates/custom-rule')->notName('__Name__Test.php');
// 0. resolve if local phpunit is at least PHPUnit 10 (which supports #[DataProvider])
// to provide annotation if not
$arePHPUnitAttributesSupported = $this->detectPHPUnitAttributeSupport();
if ($arePHPUnitAttributesSupported) {
$finder->append([new SplFileInfo(__DIR__ . '/../../../templates/custom-rule/utils/rector/tests/Rector/__Name__/__Name__Test.php', 'utils/rector/tests/Rector/__Name__', 'utils/rector/tests/Rector/__Name__/__Name__Test.php')]);
} else {
// use @annotations for PHPUnit 9 and bellow
$finder->append([new SplFileInfo(__DIR__ . '/../../../templates/custom-rules-annotations/utils/rector/tests/Rector/__Name__/__Name__Test.php', 'utils/rector/tests/Rector/__Name__', 'utils/rector/tests/Rector/__Name__/__Name__Test.php')]);
}
$currentDirectory = \getcwd();
$generatedFilePaths = [];
$fileInfos = \iterator_to_array($finder->getIterator());
foreach ($fileInfos as $fileInfo) {
// replace __Name__ with $rectorName
$newContent = $this->replaceNameVariable($rectorName, $fileInfo->getContents());
$newFilePath = $this->replaceNameVariable($rectorName, $fileInfo->getRelativePathname());
FileSystem::write($currentDirectory . '/' . $newFilePath, $newContent, null);
$generatedFilePaths[] = $newFilePath;
}
$this->symfonyStyle->title('Generated files');
$this->symfonyStyle->listing($generatedFilePaths);
$this->symfonyStyle->success(\sprintf('Base for the "%s" rule was created. Now you can fill the missing parts', $rectorName));
// 2. update autoload-dev in composer.json
$composerJsonFilePath = $currentDirectory . '/composer.json';
if (\file_exists($composerJsonFilePath)) {
$hasChanged = \false;
$composerJson = JsonFileSystem::readFilePath($composerJsonFilePath);
if (!isset($composerJson['autoload-dev']['psr-4']['Utils\\Rector\\'])) {
$composerJson['autoload-dev']['psr-4']['Utils\\Rector\\'] = 'utils/rector/src';
$composerJson['autoload-dev']['psr-4']['Utils\\Rector\\Tests\\'] = 'utils/rector/tests';
$hasChanged = \true;
}
if ($hasChanged) {
$this->symfonyStyle->success('We also update composer.json autoload-dev, to load Rector rules. Now run "composer dump-autoload" to update paths');
JsonFileSystem::writeFile($composerJsonFilePath, $composerJson);
}
}
// 3. update phpunit.xml(.dist) to include rector test suite
$this->setupRectorTestSuite($currentDirectory);
return Command::SUCCESS;
}
private function setupRectorTestSuite(string $currentDirectory) : void
{
if (!\extension_loaded('dom')) {
$this->symfonyStyle->warning('The "dom" extension is not loaded. Rector could not add the rector test suite to phpunit.xml');
return;
}
$phpunitXmlExists = \file_exists($currentDirectory . '/phpunit.xml');
$phpunitXmlDistExists = \file_exists($currentDirectory . '/phpunit.xml.dist');
if (!$phpunitXmlExists && !$phpunitXmlDistExists) {
$this->symfonyStyle->warning('No phpunit.xml or phpunit.xml.dist found. Rector could not add the rector test suite to it');
return;
}
$phpunitFile = $phpunitXmlExists ? 'phpunit.xml' : 'phpunit.xml.dist';
$phpunitFilePath = $currentDirectory . '/' . $phpunitFile;
$domDocument = new DOMDocument('1.0');
$domDocument->preserveWhiteSpace = \false;
$domDocument->formatOutput = \true;
$domDocument->loadXML(FileSystem::read($phpunitFilePath));
if ($this->hasRectorTestSuite($domDocument)) {
$this->symfonyStyle->success('The rector test suite already exists in ' . $phpunitFilePath . ". No changes were made.\n You can run the rector tests by running: phpunit --testsuite rector");
return;
}
$testsuitesElement = $domDocument->getElementsByTagName('testsuites')->item(0);
if (!$testsuitesElement instanceof DOMElement) {
$this->symfonyStyle->warning('No element found in ' . $phpunitFilePath . '. Rector could not add the rector test suite to it');
return;
}
$phpunitXML = $this->updatePHPUnitXMLFile($domDocument, $testsuitesElement);
FileSystem::write($phpunitFilePath, $phpunitXML, null);
$this->symfonyStyle->success('We also update ' . $phpunitFilePath . ", to add a rector test suite.\n You can run the rector tests by running: phpunit --testsuite rector");
}
private function hasRectorTestSuite(DOMDocument $domDocument) : bool
{
foreach ($this->getTestSuiteElements($domDocument) as $testSuiteElement) {
foreach ($testSuiteElement->getElementsByTagName('directory') as $directoryNode) {
if (!$directoryNode instanceof DOMElement) {
continue;
}
$name = $testSuiteElement->getAttribute('name');
if ($name !== 'rector') {
continue;
}
$directory = $directoryNode->textContent;
if ($directory === 'utils/rector/tests') {
return \true;
}
}
}
return \false;
}
private function updatePHPUnitXMLFile(DOMDocument $domDocument, DOMElement $testsuitesElement) : string
{
$domElement = $domDocument->createElement('testsuite');
$domElement->setAttribute('name', 'rector');
$rectorTestSuiteDirectory = $domDocument->createElement('directory', 'utils/rector/tests');
$domElement->appendChild($rectorTestSuiteDirectory);
$testsuitesElement->appendChild($domElement);
$phpunitXML = $domDocument->saveXML();
if ($phpunitXML === \false) {
throw new ShouldNotHappenException('Could not save XML');
}
return $phpunitXML;
}
/**
* @return Generator
*/
private function getTestSuiteElements(DOMDocument $domDocument) : Generator
{
$domxPath = new DOMXPath($domDocument);
$testSuiteNodes = $domxPath->query('testsuites/testsuite');
if ($testSuiteNodes === \false) {
return;
}
if ($testSuiteNodes->length === 0) {
$testSuiteNodes = $domxPath->query('testsuite');
if ($testSuiteNodes === \false) {
return;
}
}
if ($testSuiteNodes->length === 1) {
$element = $testSuiteNodes->item(0);
if ($element instanceof DOMElement) {
(yield $element);
}
return;
}
foreach ($testSuiteNodes as $testSuiteNode) {
if (!$testSuiteNode instanceof DOMElement) {
continue;
}
(yield $testSuiteNode);
}
}
private function replaceNameVariable(string $rectorName, string $contents) : string
{
return \str_replace('__Name__', $rectorName, $contents);
}
private function detectPHPUnitAttributeSupport() : bool
{
$composerJsonFilePath = \getcwd() . '/composer.json';
if (!\file_exists($composerJsonFilePath)) {
// be safe
return \false;
}
$composerJson = JsonFileSystem::readFilePath($composerJsonFilePath);
$phpunitVersion = $composerJson['require-dev']['phpunit/phpunit'] ?? null;
if ($phpunitVersion === null) {
return \false;
}
return (bool) Strings::match($phpunitVersion, self::START_WITH_10_REGEX);
}
}