UpgradeWizardCommand.php

<?php

declare(strict_types=1);

/*
 * This file is part of the package friendsoftypo3/kickstarter.
 *
 * For the full copyright and license information, please read the
 * LICENSE file that was distributed with this source code.
 */

namespace FriendsOfTYPO3\Kickstarter\Command;

use FriendsOfTYPO3\Kickstarter\Command\Input\Question\ChooseExtensionKeyQuestion;
use FriendsOfTYPO3\Kickstarter\Command\Input\QuestionCollection;
use FriendsOfTYPO3\Kickstarter\Context\CommandContext;
use FriendsOfTYPO3\Kickstarter\Information\UpgradeWizardInformation;
use FriendsOfTYPO3\Kickstarter\Service\Creator\UpgradeWizardCreatorService;
use FriendsOfTYPO3\Kickstarter\Traits\CreatorInformationTrait;
use FriendsOfTYPO3\Kickstarter\Traits\ExtensionInformationTrait;
use FriendsOfTYPO3\Kickstarter\Traits\TryToCorrectClassNameTrait;
use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\SymfonyStyle;
use TYPO3\CMS\Core\Attribute\AsNonSchedulableCommand;

#[AsCommand('make:upgrade', 'Create a new Upgrade Wizard to your TYPO3 extension.')]
#[AsNonSchedulableCommand]
class UpgradeWizardCommand extends Command
{
    use CreatorInformationTrait;
    use ExtensionInformationTrait;
    use TryToCorrectClassNameTrait;

    public function __construct(
        private readonly UpgradeWizardCreatorService $upgradeWizardCreatorService,
        private readonly QuestionCollection $questionCollection,
    ) {
        parent::__construct();
    }

    protected function configure(): void
    {
        $this->addArgument(
            'extension_key',
            InputArgument::OPTIONAL,
            'Provide the extension key you want to extend',
        );
    }

    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $commandContext = new CommandContext($input, $output);
        $io = $commandContext->getIo();
        $io->title('Welcome to the TYPO3 Extension Builder');

        $io->text([
            'We are here to assist you in creating a new TYPO3 Upgrade Wizard.',
            'Now, we will ask you a few questions to customize the upgrade wizard according to your needs.',
            'Please take your time to answer them.',
        ]);

        $upgradeWizardInformation = $this->askForUpgradeWizardInformation($commandContext);
        $this->upgradeWizardCreatorService->create($upgradeWizardInformation);
        $this->printCreatorInformation($upgradeWizardInformation->getCreatorInformation(), $commandContext);

        return Command::SUCCESS;
    }

    private function askForUpgradeWizardInformation(CommandContext $commandContext): UpgradeWizardInformation
    {
        $io = $commandContext->getIo();
        $extensionInformation = $this->getExtensionInformation(
            (string)$this->questionCollection->askQuestion(
                ChooseExtensionKeyQuestion::ARGUMENT_NAME,
                $commandContext,
            ),
            $commandContext
        );

        return new UpgradeWizardInformation(
            $extensionInformation,
            $this->askForUpgradeWizardClassName($io),
        );
    }

    private function askForUpgradeWizardClassName(SymfonyStyle $io): string
    {
        $defaultUpgradeWizardClassName = null;

        do {
            $upgradeWizardClassName = (string)$io->ask(
                'Please provide the class name of your new Upgrade Wizard',
                $defaultUpgradeWizardClassName,
            );

            if (preg_match('/^\d/', $upgradeWizardClassName)) {
                $io->error('Class name should not start with a number.');
                $defaultUpgradeWizardClassName = $this->tryToCorrectClassName($upgradeWizardClassName, 'Upgrade');
                $validUpgradeWizardClassName = false;
            } elseif (preg_match('/[^a-zA-Z0-9]/', $upgradeWizardClassName)) {
                $io->error('Class name contains invalid chars. Please provide just letters and numbers.');
                $defaultUpgradeWizardClassName = $this->tryToCorrectClassName($upgradeWizardClassName, 'Upgrade');
                $validUpgradeWizardClassName = false;
            } elseif (preg_match('/^[A-Z][a-zA-Z0-9]+$/', $upgradeWizardClassName) === 0) {
                $io->error('Action must be written in UpperCamelCase like "CorrectPluginUpgrade".');
                $defaultUpgradeWizardClassName = $this->tryToCorrectClassName($upgradeWizardClassName, 'Upgrade');
                $validUpgradeWizardClassName = false;
            } elseif (!str_ends_with($upgradeWizardClassName, 'Upgrade')) {
                $io->error('Class name must end with "Upgrade".');
                $defaultUpgradeWizardClassName = $this->tryToCorrectClassName($upgradeWizardClassName, 'Upgrade');
                $validUpgradeWizardClassName = false;
            } else {
                $validUpgradeWizardClassName = true;
            }
        } while (!$validUpgradeWizardClassName);

        return $upgradeWizardClassName;
    }
}