TokenSkipper.php

<?php

declare(strict_types=1);

namespace Symplify\CodingStandard\TokenRunner\Analyzer\FixerAnalyzer;

use PhpCsFixer\Tokenizer\CT;
use PhpCsFixer\Tokenizer\Token;
use PhpCsFixer\Tokenizer\Tokens;
use Symplify\CodingStandard\Exception\ShouldNotHappenException;
use Symplify\CodingStandard\TokenRunner\Exception\TokenNotFoundException;
use Symplify\CodingStandard\TokenRunner\ValueObject\BlockInfo;

final readonly class TokenSkipper
{
    public function __construct(
        private BlockFinder $blockFinder
    ) {
    }

    /**
     * @param Tokens<Token> $tokens
     */
    public function skipBlocks(Tokens $tokens, int $position): int
    {
        if (! isset($tokens[$position])) {
            throw new TokenNotFoundException($position);
        }

        $token = $tokens[$position];

        if ($token->getContent() === '{') {
            $blockInfo = $this->blockFinder->findInTokensByEdge($tokens, $position);
            if (! $blockInfo instanceof BlockInfo) {
                return $position;
            }

            return $blockInfo->getEnd();
        }

        if ($token->isGivenKind([CT::T_ARRAY_SQUARE_BRACE_OPEN, T_ARRAY])) {
            $blockInfo = $this->blockFinder->findInTokensByEdge($tokens, $position);
            if (! $blockInfo instanceof BlockInfo) {
                return $position;
            }

            return $blockInfo->getEnd();
        }

        return $position;
    }

    /**
     * @param Tokens<Token> $tokens
     */
    public function skipBlocksReversed(Tokens $tokens, int $position): int
    {
        /** @var Token $token */
        $token = $tokens[$position];
        if (! $token->isGivenKind(CT::T_ARRAY_SQUARE_BRACE_CLOSE) && ! $token->equals(')') && ! $token->isGivenKind(CT::T_ATTRIBUTE_CLOSE)) {
            return $position;
        }

        // Check if this is an attribute closing bracket
        if ($token->isGivenKind(CT::T_ATTRIBUTE_CLOSE)) {
            $attributeStartPosition = $this->findAttributeStart($tokens, $position);
            if ($attributeStartPosition !== null) {
                return $attributeStartPosition;
            }
        }

        $blockInfo = $this->blockFinder->findInTokensByEdge($tokens, $position);
        if (! $blockInfo instanceof BlockInfo) {
            throw new ShouldNotHappenException();
        }

        return $blockInfo->getStart();
    }

    /**
     * @param Tokens<Token> $tokens
     */
    private function findAttributeStart(Tokens $tokens, int $closingBracketPosition): ?int
    {
        // Search backwards for T_ATTRIBUTE token (#[)
        for ($i = $closingBracketPosition - 1; $i >= 0; --$i) {
            $currentToken = $tokens[$i];

            if ($currentToken->isGivenKind(T_ATTRIBUTE)) {
                return $i;
            }

            // If we hit another ] or reach a statement boundary, stop searching
            if ($currentToken->equals(']') || $currentToken->equals(';') || $currentToken->equals('{') || $currentToken->equals('}')) {
                break;
            }
        }

        return null;
    }
}