class SpreadOperatorSpacingAfterSniff

class SpreadOperatorSpacingAfterSniff implements Sniff {
    
    /**
     * The number of spaces desired after a spread token.
     *
     * @var integer
     */
    public $spacing = 0;
    
    /**
     * Allow newlines instead of spaces.
     *
     * @var boolean
     */
    public $ignoreNewlines = false;
    
    /**
     * Returns an array of tokens this test wants to listen for.
     *
     * @return array<int|string>
     */
    public function register() {
        return [
            T_ELLIPSIS,
        ];
    }
    
    //end register()
    
    /**
     * Processes this test, when one of its tokens is encountered.
     *
     * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
     * @param int                         $stackPtr  The position of the current token in
     *                                               the stack passed in $tokens.
     *
     * @return void
     */
    public function process(File $phpcsFile, $stackPtr) {
        $tokens = $phpcsFile->getTokens();
        $this->spacing = (int) $this->spacing;
        $pluralizeSpace = 's';
        if ($this->spacing === 1) {
            $pluralizeSpace = '';
        }
        $nextNonEmpty = $phpcsFile->findNext(Tokens::$emptyTokens, $stackPtr + 1, null, true);
        if ($nextNonEmpty === false) {
            return;
        }
        if ($tokens[$nextNonEmpty]['code'] === T_CLOSE_PARENTHESIS) {
            // Ignore PHP 8.1 first class callable syntax.
            return;
        }
        if ($this->ignoreNewlines === true && $tokens[$stackPtr]['line'] !== $tokens[$nextNonEmpty]['line']) {
            $phpcsFile->recordMetric($stackPtr, 'Spacing after spread operator', 'newline');
            return;
        }
        if ($this->spacing === 0 && $nextNonEmpty === $stackPtr + 1) {
            $phpcsFile->recordMetric($stackPtr, 'Spacing after spread operator', 0);
            return;
        }
        $nextNonWhitespace = $phpcsFile->findNext(T_WHITESPACE, $stackPtr + 1, null, true);
        if ($nextNonEmpty !== $nextNonWhitespace) {
            $error = 'Expected %s space%s after the spread operator; comment found';
            $data = [
                $this->spacing,
                $pluralizeSpace,
            ];
            $phpcsFile->addError($error, $stackPtr, 'CommentFound', $data);
            if ($tokens[$stackPtr + 1]['code'] === T_WHITESPACE) {
                $phpcsFile->recordMetric($stackPtr, 'Spacing after spread operator', $tokens[$stackPtr + 1]['length']);
            }
            else {
                $phpcsFile->recordMetric($stackPtr, 'Spacing after spread operator', 0);
            }
            return;
        }
        $found = 0;
        if ($tokens[$stackPtr]['line'] !== $tokens[$nextNonEmpty]['line']) {
            $found = 'newline';
        }
        else {
            if ($tokens[$stackPtr + 1]['code'] === T_WHITESPACE) {
                $found = $tokens[$stackPtr + 1]['length'];
            }
        }
        $phpcsFile->recordMetric($stackPtr, 'Spacing after spread operator', $found);
        if ($found === $this->spacing) {
            return;
        }
        $error = 'Expected %s space%s after the spread operator; %s found';
        $data = [
            $this->spacing,
            $pluralizeSpace,
            $found,
        ];
        $errorCode = 'TooMuchSpace';
        if ($this->spacing !== 0) {
            if ($found === 0) {
                $errorCode = 'NoSpace';
            }
            else {
                if ($found !== 'newline' && $found < $this->spacing) {
                    $errorCode = 'TooLittleSpace';
                }
            }
        }
        $fix = $phpcsFile->addFixableError($error, $stackPtr, $errorCode, $data);
        if ($fix === true) {
            $padding = str_repeat(' ', $this->spacing);
            if ($found === 0) {
                $phpcsFile->fixer
                    ->addContent($stackPtr, $padding);
            }
            else {
                $phpcsFile->fixer
                    ->beginChangeset();
                $start = $stackPtr + 1;
                if ($this->spacing > 0) {
                    $phpcsFile->fixer
                        ->replaceToken($start, $padding);
                    ++$start;
                }
                for ($i = $start; $i < $nextNonWhitespace; $i++) {
                    $phpcsFile->fixer
                        ->replaceToken($i, '');
                }
                $phpcsFile->fixer
                    ->endChangeset();
            }
        }
    }
    
    //end process()

}