ExpectsWithCallbackFixer.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\Analyzer\ArgumentsAnalyzer;
use PhpCsFixer\Tokenizer\Token;
use PhpCsFixer\Tokenizer\Tokens;

final class ExpectsWithCallbackFixer extends AbstractFixer
{
    use IndentationFixerTrait;

    public function getDefinition(): FixerDefinitionInterface
    {
        return new FixerDefinition(
            'Unless there are several $this->callback() calls, there must not be a line break before the call.',
            [
                new CodeSample(
                    <<<'EOT'
                        <?php

                        public function testFoo(): void
                        {
                            $foo = $this->createMock(Foo::class);
                            $foo
                                ->method("bar")
                                ->with($this->callback(
                                    function () {
                                    }
                                ));
                        }
                        EOT,
                ),
                new CodeSample(
                    <<<'EOT'
                        <?php

                        public function testFoo(): void
                        {
                            $foo = $this->createMock(Foo::class);
                            $foo
                                ->method("bar")
                                ->with(
                                    $this->callback(
                                        function () {
                                        }
                                    ),
                                    $this->callback(
                                        function () {
                                        }
                                    ),
                                );
                        }
                        EOT,
                ),
            ],
        );
    }

    public function isCandidate(Tokens $tokens): bool
    {
        return $tokens->isTokenKindFound(T_STRING);
    }

    /**
     * Must run after MultiLineLambdaFunctionArgumentsFixer,
     * MultilineWhitespaceBeforeSemicolonsFixer.
     */
    public function getPriority(): int
    {
        return 1;
    }

    protected function applyFix(\SplFileInfo $file, Tokens $tokens): void
    {
        for ($index = 1, $count = \count($tokens); $index < $count; ++$index) {
            if (!$tokens[$index]->isGivenKind(T_STRING)) {
                continue;
            }

            if (
                'callback' !== $tokens[$index]->getContent()
                || !$tokens[$index - 1]->isGivenKind(T_OBJECT_OPERATOR)
                || !$tokens[$index + 1]->equals('(')
            ) {
                continue;
            }

            if (!$start = $this->findParentMethodStart($tokens, $index - 1)) {
                continue;
            }

            $end = $tokens->findBlockEnd(Tokens::BLOCK_TYPE_PARENTHESIS, $start);

            $argumentsAnalyzer = new ArgumentsAnalyzer();
            $argumentsIndexes = $argumentsAnalyzer->getArguments($tokens, $start, $end);

            $needsLineBreak = \count($argumentsIndexes) > 1;
            $hasLineBreak = $tokens[$start + 1]->isGivenKind(T_WHITESPACE);

            if ($needsLineBreak && !$hasLineBreak) {
                $this->addLineBreak($tokens, $argumentsIndexes, $start, $end);
            } elseif (!$needsLineBreak && $hasLineBreak) {
                $this->removeLineBreak($tokens, $start, $end);
            }
        }
    }

    private function findParentMethodStart(Tokens $tokens, int $start): int
    {
        do {
            if (!$start = (int) $tokens->getPrevTokenOfKind($start, ['('])) {
                return 0;
            }
        } while ('with' !== $tokens[$start - 1]->getContent());

        return $start;
    }

    /**
     * @param array<int, int> $argumentsIndexes
     */
    private function addLineBreak(Tokens $tokens, array $argumentsIndexes, int $start, int $end): void
    {
        $indent = $this->getIndent($tokens, $start);

        foreach ($argumentsIndexes as $argEnd) {
            if ($tokens[$argEnd + 1]->equals(',') && !str_contains($tokens[$argEnd + 2]->getContent(), "\n")) {
                $tokens->offsetSet($argEnd + 2, new Token([T_WHITESPACE, $indent]));
            }
        }

        $whitespaces = $tokens->findGivenKind(T_WHITESPACE, $start + 2, $end);

        foreach ($whitespaces as $pos => $whitespace) {
            $content = $whitespace->getContent();

            if (str_contains($content, "\n")) {
                $tokens->offsetSet($pos, new Token([T_WHITESPACE, $content.'    ']));
            }
        }

        $tokens->insertAt($start + 1, new Token([T_WHITESPACE, $indent.'    ']));

        if ($tokens[$end + 1]->equals(')')) {
            $tokens->insertAt($end + 1, new Token([T_WHITESPACE, $indent]));
        }
    }

    private function removeLineBreak(Tokens $tokens, int $start, int $end): void
    {
        $whitespaces = $tokens->findGivenKind(T_WHITESPACE, $start, $end);

        foreach ($whitespaces as $pos => $whitespace) {
            $content = $whitespace->getContent();

            if (str_contains($content, "\n")) {
                $tokens->offsetSet($pos, new Token([T_WHITESPACE, substr($content, 0, -4)]));
            }
        }

        $tokens->clearAt($start + 1);
        $tokens->clearAt($end - 1);
    }
}