ChangelogPromoteCommand.php

<?php

declare(strict_types=1);

/**
 * Fast Forward Development Tools for PHP projects.
 *
 * This file is part of fast-forward/dev-tools project.
 *
 * @author   Felipe Sayão Lobato Abreu <github@mentordosnerds.com>
 * @license  https://opensource.org/licenses/MIT MIT License
 *
 * @see      https://github.com/php-fast-forward/
 * @see      https://github.com/php-fast-forward/dev-tools
 * @see      https://github.com/php-fast-forward/dev-tools/issues
 * @see      https://php-fast-forward.github.io/dev-tools/
 * @see      https://datatracker.ietf.org/doc/html/rfc2119
 */

namespace FastForward\DevTools\Console\Command;

use FastForward\DevTools\Console\Command\Traits\LogsCommandResults;
use Throwable;
use Composer\Command\BaseCommand;
use FastForward\DevTools\Changelog\Manager\ChangelogManagerInterface;
use FastForward\DevTools\Console\Input\HasJsonOption;
use FastForward\DevTools\Filesystem\FilesystemInterface;
use Psr\Clock\ClockInterface;
use Psr\Log\LoggerInterface;
use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;

/**
 * Promotes the Unreleased section into a published changelog version.
 */
#[AsCommand(
    name: 'changelog:promote',
    description: 'Promotes Unreleased entries into a published changelog version.'
)]
final class ChangelogPromoteCommand extends BaseCommand implements LoggerAwareCommandInterface
{
    use HasJsonOption;
    use LogsCommandResults;

    /**
     * @param FilesystemInterface $filesystem
     * @param ChangelogManagerInterface $changelogManager
     * @param ClockInterface $clock
     * @param LoggerInterface $logger
     */
    public function __construct(
        private readonly FilesystemInterface $filesystem,
        private readonly ChangelogManagerInterface $changelogManager,
        private readonly ClockInterface $clock,
        private readonly LoggerInterface $logger,
    ) {
        parent::__construct();
    }

    /**
     * Configures the promotion arguments and options.
     */
    protected function configure(): void
    {
        $this->setHelp(
            'This command moves the current Unreleased entries into a released version section, records the'
            . ' release date, and restores an empty Unreleased section.'
        );

        $this->addJsonOption()
            ->addArgument(
                name: 'version',
                mode: InputArgument::REQUIRED,
                description: 'The semantic version that should receive the current Unreleased entries.',
            )
            ->addOption(
                name: 'date',
                mode: InputOption::VALUE_REQUIRED,
                description: 'The release date to record in YYYY-MM-DD format.',
            )
            ->addOption(
                name: 'file',
                mode: InputOption::VALUE_REQUIRED,
                description: 'Path to the changelog file.',
                default: 'CHANGELOG.md',
            );
    }

    /**
     * Promotes unreleased entries into the requested version section.
     *
     * @param InputInterface $input
     * @param OutputInterface $output
     */
    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        try {
            $file = $this->filesystem->getAbsolutePath((string) $input->getOption('file'));
            $version = (string) $input->getArgument('version');
            $date = (string) ($input->getOption('date') ?: $this->clock->now()->format('Y-m-d'));

            $this->changelogManager->promote($file, $version, $date);

            return $this->success(
                'Promoted Unreleased changelog entries to [{version}] in {absolute_file}.',
                $input,
                [
                    'absolute_file' => $file,
                    'version' => $version,
                    'date' => $date,
                ],
            );
        } catch (Throwable $throwable) {
            return $this->failure(
                'Unable to promote the changelog release.',
                $input,
                [
                    'exception_message' => $throwable->getMessage(),
                ],
                (string) $input->getOption('file'),
            );
        }
    }
}