NormalizeCommand.php

<?php

declare(strict_types=1);

/**
 * Copyright (c) 2018-2021 Andreas Möller
 *
 * For the full copyright and license information, please view
 * the LICENSE.md file that was distributed with this source code.
 *
 * @see https://github.com/ergebnis/composer-normalize
 */

namespace Ergebnis\Composer\Normalize\Command;

use Composer\Command;
use Composer\Console\Application;
use Composer\Factory;
use Composer\IO;
use Composer\Package;
use Ergebnis\Composer\Normalize\Exception;
use Ergebnis\Composer\Normalize\Version;
use Ergebnis\Json\Normalizer;
use Localheinz\Diff;
use Symfony\Component\Console;

/**
 * @internal
 */
final class NormalizeCommand extends Command\BaseCommand
{
    private Factory $factory;
    private Normalizer\NormalizerInterface $normalizer;
    private Normalizer\Format\FormatterInterface $formatter;
    private Diff\Differ $differ;

    public function __construct(
        Factory $factory,
        Normalizer\NormalizerInterface $normalizer,
        Normalizer\Format\FormatterInterface $formatter,
        Diff\Differ $differ
    ) {
        parent::__construct('normalize');

        $this->factory = $factory;
        $this->normalizer = $normalizer;
        $this->formatter = $formatter;
        $this->differ = $differ;
    }

    protected function configure(): void
    {
        $this->setDescription('Normalizes composer.json according to its JSON schema (https://getcomposer.org/schema.json).');
        $this->setDefinition([
            new Console\Input\InputArgument(
                'file',
                Console\Input\InputArgument::OPTIONAL,
                'Path to composer.json file',
            ),
            new Console\Input\InputOption(
                'diff',
                null,
                Console\Input\InputOption::VALUE_NONE,
                'Show the results of normalizing',
            ),
            new Console\Input\InputOption(
                'dry-run',
                null,
                Console\Input\InputOption::VALUE_NONE,
                'Show the results of normalizing, but do not modify any files',
            ),
            new Console\Input\InputOption(
                'indent-size',
                null,
                Console\Input\InputOption::VALUE_REQUIRED,
                'Indent size (an integer greater than 0); should be used with the --indent-style option',
            ),
            new Console\Input\InputOption(
                'indent-style',
                null,
                Console\Input\InputOption::VALUE_REQUIRED,
                \sprintf(
                    'Indent style (one of "%s"); should be used with the --indent-size option',
                    \implode('", "', \array_keys(Normalizer\Format\Indent::CHARACTERS)),
                ),
            ),
            new Console\Input\InputOption(
                'no-check-lock',
                null,
                Console\Input\InputOption::VALUE_NONE,
                'Do not check if lock file is up to date',
            ),
            new Console\Input\InputOption(
                'no-update-lock',
                null,
                Console\Input\InputOption::VALUE_NONE,
                'Do not update lock file if it exists',
            ),
        ]);
    }

    protected function execute(
        Console\Input\InputInterface $input,
        Console\Output\OutputInterface $output
    ): int {
        $io = $this->getIO();

        $io->write([
            \sprintf(
                'Running %s.',
                Version::long(),
            ),
            '',
        ]);

        $indent = null;

        try {
            $indentFromInput = self::indentFromInput($input);
        } catch (\RuntimeException $exception) {
            $io->writeError(\sprintf(
                '<error>%s</error>',
                $exception->getMessage(),
            ));

            return 1;
        }

        if (null !== $indentFromInput) {
            $indent = $indentFromInput;
        }

        $composerFile = $input->getArgument('file');

        if (null === $composerFile) {
            $composerFile = Factory::getComposerFile();
        }

        $composer = $this->factory->createComposer(
            $io,
            $composerFile,
        );

        try {
            $indentFromExtra = self::indentFromExtra($composer->getPackage()->getExtra());
        } catch (\RuntimeException $exception) {
            $io->writeError(\sprintf(
                '<error>%s</error>',
                $exception->getMessage(),
            ));

            return 1;
        }

        if (null !== $indentFromExtra) {
            $indent = $indentFromExtra;
        }

        if (
            null !== $indentFromInput
            && null !== $indentFromExtra
        ) {
            $io->write('<warning>Configuration provided via options and composer extra. Using configuration from composer extra.</warning>');
        }

        if (
            false === $input->getOption('dry-run')
            && !\is_writable($composerFile)
        ) {
            $io->writeError(\sprintf(
                '<error>%s is not writable.</error>',
                $composerFile,
            ));

            return 1;
        }

        $locker = $composer->getLocker();

        if (
            false === $input->getOption('no-check-lock')
            && $locker instanceof Package\Locker
            && $locker->isLocked()
            && !$locker->isFresh()
        ) {
            $io->writeError('<error>The lock file is not up to date with the latest changes in composer.json, it is recommended that you run `composer update --lock`.</error>');

            return 1;
        }

        /** @var string $encoded */
        $encoded = \file_get_contents($composerFile);

        $json = Normalizer\Json::fromEncoded($encoded);

        try {
            $normalized = $this->normalizer->normalize($json);
        } catch (Normalizer\Exception\OriginalInvalidAccordingToSchemaException $exception) {
            $io->writeError('<error>Original composer.json does not match the expected JSON schema:</error>');

            self::showValidationErrors(
                $io,
                ...$exception->errors(),
            );

            return 1;
        } catch (Normalizer\Exception\NormalizedInvalidAccordingToSchemaException $exception) {
            $io->writeError('<error>Normalized composer.json does not match the expected JSON schema:</error>');

            self::showValidationErrors(
                $io,
                ...$exception->errors(),
            );

            return 1;
        } catch (\RuntimeException $exception) {
            $io->writeError(\sprintf(
                '<error>%s</error>',
                $exception->getMessage(),
            ));

            return 1;
        }

        $format = $json->format();

        if (null !== $indent) {
            $format = $format->withIndent($indent);
        }

        $formatted = $this->formatter->format(
            $normalized,
            $format,
        );

        if ($json->encoded() === $formatted->encoded()) {
            $io->write(\sprintf(
                '<info>%s is already normalized.</info>',
                $composerFile,
            ));

            return 0;
        }

        if (
            true === $input->getOption('diff')
            || true === $input->getOption('dry-run')
        ) {
            $io->writeError(\sprintf(
                '<error>%s is not normalized.</error>',
                $composerFile,
            ));

            $diff = $this->differ->diff(
                $json->encoded(),
                $formatted->encoded(),
            );

            $io->write([
                '',
                '<fg=yellow>---------- begin diff ----------</>',
                self::formatDiff($diff),
                '<fg=yellow>----------- end diff -----------</>',
                '',
            ]);
        }

        if (true === $input->getOption('dry-run')) {
            return 1;
        }

        \file_put_contents(
            $composerFile,
            $formatted->encoded(),
        );

        $io->write(\sprintf(
            '<info>Successfully normalized %s.</info>',
            $composerFile,
        ));

        if (
            true === $input->getOption('no-update-lock')
            || !$locker instanceof Package\Locker
            || false === $locker->isLocked()
        ) {
            return 0;
        }

        $io->write('<info>Updating lock file.</info>');

        $application = new Application();

        $application->setAutoExit(false);

        return self::updateLockerInWorkingDirectory(
            $application,
            $output,
            \dirname($composerFile),
        );
    }

    /**
     * @throws \RuntimeException
     */
    private static function indentFromInput(Console\Input\InputInterface $input): ?Normalizer\Format\Indent
    {
        /** @var null|string $indentSize */
        $indentSize = $input->getOption('indent-size');

        /** @var null|string $indentStyle */
        $indentStyle = $input->getOption('indent-style');

        if (
            null === $indentSize
            && null === $indentStyle
        ) {
            return null;
        }

        if (null === $indentSize) {
            throw new \RuntimeException('When using the indent-style option, an indent size needs to be specified using the indent-size option.');
        }

        if (null === $indentStyle) {
            throw new \RuntimeException(\sprintf(
                'When using the indent-size option, an indent style (one of "%s") needs to be specified using the indent-style option.',
                \implode('", "', \array_keys(Normalizer\Format\Indent::CHARACTERS)),
            ));
        }

        if (
            (string) (int) $indentSize !== $indentSize
            || 1 > $indentSize
        ) {
            throw new \RuntimeException(\sprintf(
                'Indent size needs to be an integer greater than 0, but "%s" is not.',
                $indentSize,
            ));
        }

        if (!\array_key_exists($indentStyle, Normalizer\Format\Indent::CHARACTERS)) {
            throw new \RuntimeException(\sprintf(
                'Indent style needs to be one of "%s", but "%s" is not.',
                \implode('", "', \array_keys(Normalizer\Format\Indent::CHARACTERS)),
                $indentStyle,
            ));
        }

        return Normalizer\Format\Indent::fromSizeAndStyle(
            (int) $indentSize,
            $indentStyle,
        );
    }

    /**
     * @throws \RuntimeException
     */
    private static function indentFromExtra(array $extra): ?Normalizer\Format\Indent
    {
        if (!\array_key_exists('composer-normalize', $extra)) {
            return null;
        }

        $configuration = $extra['composer-normalize'];

        $requiredKeys = [
            'indent-size',
            'indent-style',
        ];

        if (!\is_array($configuration)) {
            throw new \RuntimeException(\sprintf(
                'Configuration in composer extra requires keys "%s" with corresponding values."',
                \implode('", "', $requiredKeys),
            ));
        }

        $missingKeys = \array_diff(
            $requiredKeys,
            \array_keys($configuration),
        );

        if ([] !== $missingKeys) {
            throw new \RuntimeException(\sprintf(
                'Configuration in composer extra requires keys "%s" with corresponding values."',
                \implode('", "', $requiredKeys),
            ));
        }

        $extraKeys = \array_diff(
            \array_keys($configuration),
            $requiredKeys,
        );

        if ([] !== $extraKeys) {
            throw new \RuntimeException(\sprintf(
                'Configuration in composer extra does not allow extra keys "%s"."',
                \implode('", "', $extraKeys),
            ));
        }

        $indentSize = $configuration['indent-size'];

        if (!\is_int($indentSize)) {
            throw new \RuntimeException(\sprintf(
                'Indent size needs to be an integer, got %s instead.',
                \gettype($indentSize),
            ));
        }

        if (1 > $indentSize) {
            throw new \RuntimeException(\sprintf(
                'Indent size needs to be an integer greater than 0, but %d is not.',
                $indentSize,
            ));
        }

        $indentStyle = $configuration['indent-style'];

        if (!\is_string($indentStyle)) {
            throw new \RuntimeException(\sprintf(
                'Indent style needs to be a string, got %s instead.',
                \gettype($indentStyle),
            ));
        }

        if (!\array_key_exists($indentStyle, Normalizer\Format\Indent::CHARACTERS)) {
            throw new \RuntimeException(\sprintf(
                'Indent style needs to be one of "%s", but "%s" is not.',
                \implode('", "', \array_keys(Normalizer\Format\Indent::CHARACTERS)),
                $indentStyle,
            ));
        }

        return Normalizer\Format\Indent::fromSizeAndStyle(
            $indentSize,
            $indentStyle,
        );
    }

    private static function showValidationErrors(
        IO\IOInterface $io,
        string ...$errors
    ): void {
        foreach ($errors as $error) {
            $io->writeError(\sprintf(
                '<error>- %s</error>',
                $error,
            ));
        }

        $io->writeError('<warning>See https://getcomposer.org/doc/04-schema.md for details on the schema</warning>');
    }

    private static function formatDiff(string $diff): string
    {
        $lines = \explode(
            "\n",
            $diff,
        );

        $formatted = \array_map(static function (string $line): string {
            $replaced = \preg_replace(
                [
                    '/^(\+.*)$/',
                    '/^(-.*)$/',
                ],
                [
                    '<fg=green>$1</>',
                    '<fg=red>$1</>',
                ],
                $line,
            );

            if (!\is_string($replaced)) {
                throw Exception\ShouldNotHappen::create();
            }

            return $replaced;
        }, $lines);

        return \implode(
            "\n",
            $formatted,
        );
    }

    /**
     * @see https://getcomposer.org/doc/03-cli.md#update
     *
     * @throws \Exception
     */
    private static function updateLockerInWorkingDirectory(
        Console\Application $application,
        Console\Output\OutputInterface $output,
        string $workingDirectory
    ): int {
        return $application->run(
            new Console\Input\ArrayInput([
                'command' => 'update',
                '--ignore-platform-reqs' => true,
                '--lock' => true,
                '--no-autoloader' => true,
                '--no-plugins' => true,
                '--no-scripts' => true,
                '--working-dir' => $workingDirectory,
            ]),
            $output,
        );
    }
}