SingleLineConfigureCommandFixer.php

<?php

declare(strict_types=1);

/*
 * This file is part of Contao.
 *
 * (c) Leo Feyer
 *
 * @license LGPL-3.0-or-later
 */

namespace Contao\EasyCodingStandard\Fixer;

use PhpCsFixer\AbstractFixer;
use PhpCsFixer\FixerDefinition\CodeSample;
use PhpCsFixer\FixerDefinition\FixerDefinition;
use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
use PhpCsFixer\Tokenizer\Token;
use PhpCsFixer\Tokenizer\Tokens;

final class SingleLineConfigureCommandFixer extends AbstractFixer
{
    public function getDefinition(): FixerDefinitionInterface
    {
        return new FixerDefinition(
            'Defining command arguments and options must be done in a single line.',
            [
                new CodeSample(
                    <<<'EOT'
                        <?php

                        use Symfony\Component\Console\Command\Command;
                        use Symfony\Component\Console\Input\InputArgument;
                        use Symfony\Component\Console\Input\InputOption;

                        class SomeCommand extends Command
                        {
                            protected function configure(): void
                            {
                                $this
                                    ->addArgument("foo", InputArgument::REQUIRED, "The argument")
                                    ->addOption("bar", null, InputOption::VALUE_NONE, "The option");
                            }
                        }
                        EOT,
                ),
            ],
        );
    }

    public function isCandidate(Tokens $tokens): bool
    {
        return $tokens->isAllTokenKindsFound([T_CLASS, T_FUNCTION, T_OBJECT_OPERATOR]);
    }

    protected function applyFix(\SplFileInfo $file, Tokens $tokens): void
    {
        for ($index = 1, $count = \count($tokens); $index < $count; ++$index) {
            switch (true) {
                case $tokens[$index]->isGivenKind(T_CLASS):
                    $prev = $tokens->getPrevMeaningfulToken($index);

                    if (null !== $prev && $tokens[$prev]->isGivenKind(T_PAAMAYIM_NEKUDOTAYIM)) {
                        break;
                    }

                    $next = $tokens->getNextMeaningfulToken($index);

                    if (null === $next) {
                        break;
                    }

                    // Skip the class if it is not a command
                    if (!str_ends_with($tokens[$next]->getContent(), 'Command')) {
                        $bodyStart = $tokens->getNextTokenOfKind($next, ['{']);

                        if (null === $bodyStart) {
                            break;
                        }

                        $index = $tokens->findBlockEnd(Tokens::BLOCK_TYPE_BRACE, $bodyStart);
                    }
                    break;

                case $tokens[$index]->isGivenKind(T_FUNCTION):
                    $next = $tokens->getNextMeaningfulToken($index);

                    if (null === $next) {
                        break;
                    }

                    // Skip the method if it is not the configure() method
                    if ('configure' !== $tokens[$next]->getContent()) {
                        $argsStart = $tokens->getNextTokenOfKind($next, ['(']);

                        if (null === $argsStart) {
                            break;
                        }

                        $argsEnd = $tokens->findBlockEnd(Tokens::BLOCK_TYPE_PARENTHESIS, $argsStart);
                        $bodyStart = $tokens->getNextTokenOfKind($argsEnd, ['{', ';']);

                        if (null === $bodyStart) {
                            break;
                        }

                        if ($tokens[$bodyStart]->equals('{')) {
                            $index = $tokens->findBlockEnd(Tokens::BLOCK_TYPE_BRACE, $bodyStart);
                        } else {
                            $index = $bodyStart;
                        }
                    }
                    break;

                case $tokens[$index]->isGivenKind(T_OBJECT_OPERATOR):
                    $next = $tokens->getNextMeaningfulToken($index);

                    if (null === $next) {
                        break;
                    }

                    if (!\in_array($tokens[$next]->getContent(), ['addArgument', 'addOption'], true)) {
                        continue 2;
                    }

                    $blockStart = $next + 1;
                    $blockEnd = $tokens->findBlockEnd(Tokens::BLOCK_TYPE_PARENTHESIS, $blockStart);

                    // Do not remove the line breaks that terminate comments.
                    if (array_filter($tokens->findGivenKind([T_COMMENT, T_DOC_COMMENT], $blockStart + 1, $blockEnd))) {
                        $index = $blockEnd;
                        continue 2;
                    }

                    if ($tokens[$blockStart + 1]->isGivenKind(T_WHITESPACE)) {
                        $tokens->clearAt(++$blockStart);
                    }

                    if ($tokens[$blockEnd - 1]->isGivenKind(T_WHITESPACE)) {
                        $tokens->clearAt(--$blockEnd);
                    }

                    for ($i = $blockStart + 1; $i < $blockEnd; ++$i) {
                        if ($tokens[$i]->isWhitespace()) {
                            $tokens->offsetSet($i, new Token([T_WHITESPACE, ' ']));
                        }
                    }
            }
        }
    }
}