|
| 1 | +<?php |
| 2 | + |
| 3 | +declare(strict_types=1); |
| 4 | + |
| 5 | +namespace a9f\FractorRuleGenerator\Console\Command; |
| 6 | + |
| 7 | +use a9f\Fractor\Exception\ShouldNotHappenException; |
| 8 | +use a9f\Fractor\FileSystem\FileInfoFactory; |
| 9 | +use a9f\FractorRuleGenerator\Factory\Typo3FractorTypeFactory; |
| 10 | +use a9f\FractorRuleGenerator\FileSystem\ConfigFilesystem; |
| 11 | +use a9f\FractorRuleGenerator\Finder\TemplateFinder; |
| 12 | +use a9f\FractorRuleGenerator\Generator\FileGenerator; |
| 13 | +use a9f\FractorRuleGenerator\ValueObject\Typo3FractorRecipe; |
| 14 | +use a9f\FractorRuleGenerator\ValueObject\Typo3Version; |
| 15 | +use RuntimeException; |
| 16 | +use Symfony\Component\Console\Attribute\AsCommand; |
| 17 | +use Symfony\Component\Console\Command\Command; |
| 18 | +use Symfony\Component\Console\Helper\QuestionHelper; |
| 19 | +use Symfony\Component\Console\Input\InputInterface; |
| 20 | +use Symfony\Component\Console\Output\OutputInterface; |
| 21 | +use Symfony\Component\Console\Question\ChoiceQuestion; |
| 22 | +use Symfony\Component\Console\Question\Question; |
| 23 | +use Webmozart\Assert\Assert; |
| 24 | + |
| 25 | +#[AsCommand(name: 'generate-rule', description: 'Generate a new Fractor rule in a proper location, with tests')] |
| 26 | +final class GenerateRuleCommand extends Command |
| 27 | +{ |
| 28 | + /** |
| 29 | + * @var string |
| 30 | + */ |
| 31 | + private const FRACTOR_FQN_NAME_PATTERN = 'a9f\Typo3Fractor\TYPO3__MajorPrefixed__\__Type__\__Name__'; |
| 32 | + |
| 33 | + public function __construct( |
| 34 | + private readonly TemplateFinder $templateFinder, |
| 35 | + private readonly FileGenerator $fileGenerator, |
| 36 | + private readonly OutputInterface $outputStyle, |
| 37 | + private readonly ConfigFilesystem $configFilesystem, |
| 38 | + private readonly FileInfoFactory $fileInfoFactory |
| 39 | + ) { |
| 40 | + parent::__construct(); |
| 41 | + } |
| 42 | + |
| 43 | + protected function configure(): void |
| 44 | + { |
| 45 | + } |
| 46 | + |
| 47 | + protected function execute(InputInterface $input, OutputInterface $output): int |
| 48 | + { |
| 49 | + /** @var QuestionHelper $helper */ |
| 50 | + $helper = $this->getHelper('question'); |
| 51 | + /** @var Typo3Version $typo3Version */ |
| 52 | + $typo3Version = $helper->ask($input, $output, $this->askForTypo3Version()); |
| 53 | + $changelogUrl = $helper->ask($input, $output, $this->askForChangelogUrl()); |
| 54 | + $name = $helper->ask($input, $output, $this->askForName()); |
| 55 | + $description = $helper->ask($input, $output, $this->askForDescription()); |
| 56 | + $type = $helper->ask($input, $output, $this->askForType()); |
| 57 | + |
| 58 | + $recipe = new Typo3FractorRecipe( |
| 59 | + $typo3Version, |
| 60 | + $changelogUrl, |
| 61 | + $name, |
| 62 | + $description, |
| 63 | + Typo3FractorTypeFactory::fromString($type) |
| 64 | + ); |
| 65 | + |
| 66 | + $templateFileInfos = $this->templateFinder->find($recipe->getFractorFixtureFileExtension()); |
| 67 | + |
| 68 | + $templateVariables = [ |
| 69 | + '__MajorPrefixed__' => $recipe->getMajorVersionPrefixed(), |
| 70 | + '__Major__' => $recipe->getMajorVersion(), |
| 71 | + '__MinorPrefixed__' => $recipe->getMinorVersionPrefixed(), |
| 72 | + '__Type__' => $recipe->getFractorTypeFolderName(), |
| 73 | + '__FixtureFileExtension__' => $recipe->getFractorFixtureFileExtension(), |
| 74 | + '__Name__' => $recipe->getFractorName(), |
| 75 | + '__Test_Directory__' => $recipe->getTestDirectory(), |
| 76 | + '__Changelog_Annotation__' => $recipe->getChangelogAnnotation(), |
| 77 | + '__Description__' => addslashes($recipe->getDescription()), |
| 78 | + '__Use__' => $recipe->getUseImports(), |
| 79 | + '__Traits__' => $recipe->getTraits(), |
| 80 | + '__ExtendsImplements__' => $recipe->getExtendsImplements(), |
| 81 | + '__Base_Fractor_Body_Template__' => $recipe->getFractorBodyTemplate(), |
| 82 | + ]; |
| 83 | + |
| 84 | + $targetDirectory = __DIR__ . '/../../../../typo3-fractor'; |
| 85 | + |
| 86 | + $generatedFilePaths = $this->fileGenerator->generateFiles( |
| 87 | + $templateFileInfos, |
| 88 | + $templateVariables, |
| 89 | + $targetDirectory |
| 90 | + ); |
| 91 | + |
| 92 | + $this->configFilesystem->addRuleToConfigurationFile( |
| 93 | + $recipe->getSet(), |
| 94 | + $templateVariables, |
| 95 | + self::FRACTOR_FQN_NAME_PATTERN |
| 96 | + ); |
| 97 | + |
| 98 | + $testCaseDirectoryPath = $this->resolveTestCaseDirectoryPath($generatedFilePaths); |
| 99 | + $this->printSuccess($recipe->getFractorName(), $generatedFilePaths, $testCaseDirectoryPath); |
| 100 | + |
| 101 | + return Command::SUCCESS; |
| 102 | + } |
| 103 | + |
| 104 | + private function askForTypo3Version(): Question |
| 105 | + { |
| 106 | + $whatTypo3Version = new Question('TYPO3-Version (i.e. 12.0): '); |
| 107 | + $whatTypo3Version->setNormalizer( |
| 108 | + static fn ($version): Typo3Version => Typo3Version::createFromString(trim((string) $version)) |
| 109 | + ); |
| 110 | + $whatTypo3Version->setMaxAttempts(2); |
| 111 | + $whatTypo3Version->setValidator( |
| 112 | + static function (Typo3Version $version): Typo3Version { |
| 113 | + Assert::greaterThanEq($version->getMajor(), 7); |
| 114 | + Assert::greaterThanEq($version->getMinor(), 0); |
| 115 | + |
| 116 | + return $version; |
| 117 | + } |
| 118 | + ); |
| 119 | + |
| 120 | + return $whatTypo3Version; |
| 121 | + } |
| 122 | + |
| 123 | + private function askForChangelogUrl(): Question |
| 124 | + { |
| 125 | + $whatIsTheUrlToChangelog = new Question( |
| 126 | + 'Url to changelog (i.e. https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/...) or "x" for none: ' |
| 127 | + ); |
| 128 | + $whatIsTheUrlToChangelog->setMaxAttempts(3); |
| 129 | + $whatIsTheUrlToChangelog->setValidator( |
| 130 | + static function (?string $url): string { |
| 131 | + Assert::notNull($url); |
| 132 | + |
| 133 | + if (strtolower($url) === 'x') { |
| 134 | + return ''; |
| 135 | + } |
| 136 | + |
| 137 | + if (! filter_var($url, FILTER_VALIDATE_URL)) { |
| 138 | + throw new RuntimeException('Please enter a valid Url'); |
| 139 | + } |
| 140 | + |
| 141 | + Assert::startsWith($url, 'https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/'); |
| 142 | + |
| 143 | + return $url; |
| 144 | + } |
| 145 | + ); |
| 146 | + |
| 147 | + return $whatIsTheUrlToChangelog; |
| 148 | + } |
| 149 | + |
| 150 | + private function askForName(): Question |
| 151 | + { |
| 152 | + $giveMeYourName = new Question('Name (i.e MigrateRequiredFlag): '); |
| 153 | + $giveMeYourName->setNormalizer( |
| 154 | + static fn ($name): ?string => preg_replace('/Fractor$/', '', ucfirst((string) $name)) |
| 155 | + ); |
| 156 | + $giveMeYourName->setMaxAttempts(3); |
| 157 | + $giveMeYourName->setValidator(static function (string $name): string { |
| 158 | + Assert::minLength($name, 5); |
| 159 | + Assert::maxLength($name, 60); |
| 160 | + Assert::notContains($name, ' ', 'The name must not contain spaces'); |
| 161 | + // Pattern from: https://www.php.net/manual/en/language.oop5.basic.php |
| 162 | + Assert::regex( |
| 163 | + $name, |
| 164 | + '/^[a-zA-Z_\x80-\xff][a-zA-Z0-9_\x80-\xff]*$/', |
| 165 | + 'The name must be a valid PHP class name. A valid class name starts with a letter or underscore, followed by any number of letters, numbers, or underscores.' |
| 166 | + ); |
| 167 | + |
| 168 | + return $name; |
| 169 | + }); |
| 170 | + |
| 171 | + return $giveMeYourName; |
| 172 | + } |
| 173 | + |
| 174 | + private function askForDescription(): Question |
| 175 | + { |
| 176 | + $description = new Question('Description (i.e. Migrate required flag): '); |
| 177 | + $description->setMaxAttempts(3); |
| 178 | + $description->setValidator(static function (?string $description): string { |
| 179 | + Assert::notNull($description, 'Please enter a description'); |
| 180 | + Assert::minLength($description, 5); |
| 181 | + Assert::maxLength($description, 120); |
| 182 | + |
| 183 | + return $description; |
| 184 | + }); |
| 185 | + |
| 186 | + return $description; |
| 187 | + } |
| 188 | + |
| 189 | + private function askForType(): Question |
| 190 | + { |
| 191 | + $question = new ChoiceQuestion('Please select the Fractor type', [ |
| 192 | + 'flexform', |
| 193 | + 'fluid', |
| 194 | + 'typoscript', |
| 195 | + 'yaml', |
| 196 | + 'composer', |
| 197 | + ]); |
| 198 | + $question->setMaxAttempts(3); |
| 199 | + $question->setErrorMessage('Type %s is invalid.'); |
| 200 | + |
| 201 | + return $question; |
| 202 | + } |
| 203 | + |
| 204 | + /** |
| 205 | + * @param string[] $generatedFilePaths |
| 206 | + */ |
| 207 | + private function printSuccess(string $name, array $generatedFilePaths, string $testCaseFilePath): void |
| 208 | + { |
| 209 | + $message = sprintf('<info>New files generated for "%s":</info>', $name); |
| 210 | + $this->outputStyle->writeln($message); |
| 211 | + |
| 212 | + sort($generatedFilePaths); |
| 213 | + |
| 214 | + foreach ($generatedFilePaths as $generatedFilePath) { |
| 215 | + $fileInfo = $this->fileInfoFactory->createFileInfoFromPath($generatedFilePath); |
| 216 | + $this->outputStyle->writeln(' * ' . $fileInfo->getRelativePathname()); |
| 217 | + } |
| 218 | + |
| 219 | + $message = sprintf( |
| 220 | + '<info>Run tests for this fractor:</info>%svendor/bin/phpunit %s', |
| 221 | + PHP_EOL . PHP_EOL, |
| 222 | + $testCaseFilePath . PHP_EOL |
| 223 | + ); |
| 224 | + $this->outputStyle->writeln($message); |
| 225 | + } |
| 226 | + |
| 227 | + /** |
| 228 | + * @param string[] $generatedFilePaths |
| 229 | + */ |
| 230 | + private function resolveTestCaseDirectoryPath(array $generatedFilePaths): string |
| 231 | + { |
| 232 | + foreach ($generatedFilePaths as $generatedFilePath) { |
| 233 | + if (! \str_ends_with($generatedFilePath, 'Test.php') |
| 234 | + && ! \str_ends_with($generatedFilePath, 'Test.php.inc') |
| 235 | + ) { |
| 236 | + continue; |
| 237 | + } |
| 238 | + |
| 239 | + $generatedFileInfo = $this->fileInfoFactory->createFileInfoFromPath($generatedFilePath); |
| 240 | + return $generatedFileInfo->getRelativePath(); |
| 241 | + } |
| 242 | + |
| 243 | + throw new ShouldNotHappenException(); |
| 244 | + } |
| 245 | +} |
0 commit comments