BestIt\Sniffs\Formatting\SpaceAroundConcatSniff

Complexity

Total Complexity

8

Size/Duplication

Total Lines	118
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	fixDefaultProblem()	0	20	3
A	processToken()	0	14	3
A	register()	0	4	1
A	setUp()	0	10	1

<?php

declare(strict_types=1);

namespace BestIt\Sniffs\Formatting;

use BestIt\CodeSniffer\CodeError;
use BestIt\CodeSniffer\CodeWarning;
use BestIt\Sniffs\AbstractSniff;
use const T_STRING_CONCAT;
use const T_WHITESPACE;

/**
 * Checks for the space around concat dots and fixes them if they are missing.
 *
 * @author blange <bjoern.lange@bestit-online.de>
 * @package BestIt\Sniffs\Formatting
 */
class SpaceAroundConcatSniff extends AbstractSniff
{
    /**
     * You MUST wrap your concat-dot with a whitespace char.
     *
     * @var string
     */
    public const CODE_MISSING_SPACE_AROUND_CONCAT = 'MissingSpaceAroundConcat';

    /**
     * The message to the user for this error.
     *
     * @var string
     */
    private const MESSAGE_MISSING_SPACE_AROUND_CONCAT = 'Please wrap your concatinations with a whitespace char.';

    /**
     * Is the next token whitespace?
     *
     * @var bool|void
     */
    private $nextIsWhitespace;

    /**
     * Is the prev token whitespace?
     *
     * @var void|bool
     */
    private $prevIsWhitespace;

    /**
     * Adds whitespace around the concats.
     *
     * @param CodeWarning $warning
     *
     * @return void
     */
    protected function fixDefaultProblem(CodeWarning $warning): void
    {
        $newContent = '';

        if (!$this->prevIsWhitespace) {

The expression $this->prevIsWhitespace of type null|boolean is loosely compared to false; this is ambiguous if the boolean can be false. You might want to explicitly use !== null instead.

            $newContent = ' ';
        }

        $newContent .= '.';

        if (!$this->nextIsWhitespace) {

The expression $this->nextIsWhitespace of type boolean|null is loosely compared to false; this is ambiguous if the boolean can be false. You might want to explicitly use !== null instead.

            $newContent .= ' ';
        }

        $fixer = $this->getFile()->fixer;

        $fixer->beginChangeset();
        $fixer->replaceToken($this->stackPos, $newContent);
        $fixer->endChangeset();
    }

    /**
     * Processes the token.
     *
     * @throws CodeError
     *
     * @return void
     *
     */
    protected function processToken(): void
    {
        if (!(($this->nextIsWhitespace) && ($this->prevIsWhitespace))) {

The expression $this->nextIsWhitespace of type boolean|null is loosely compared to false; this is ambiguous if the boolean can be false. You might want to explicitly use !== null instead.

The expression $this->prevIsWhitespace of type null|boolean is loosely compared to false; this is ambiguous if the boolean can be false. You might want to explicitly use !== null instead.

            $error = new CodeError(
                static::CODE_MISSING_SPACE_AROUND_CONCAT,
                self::MESSAGE_MISSING_SPACE_AROUND_CONCAT,
                $this->stackPos
            );

            $error->isFixable(true);

            throw $error;
        }
    }

    /**
     * Registers the tokens that this sniff wants to listen for.
     *
     * An example return value for a sniff that wants to listen for whitespace
     * and any comments would be:
     *
     * <code>
     *    return array(
     *            T_WHITESPACE,
     *            T_DOC_COMMENT,
     *            T_COMMENT,
     *           );
     * </code>
     *
     * @return int[]
     */
    public function register(): array
    {
        return [T_STRING_CONCAT];
    }

    /**
     * Sets up the sniff.
     *
     * @return void
     */
    protected function setUp(): void
    {
        parent::setUp();

        $nextToken = $this->tokens[$this->stackPos + 1];
        $prevToken = $this->tokens[$this->stackPos - 1];

        $this->nextIsWhitespace = $nextToken['code'] === T_WHITESPACE;
        $this->prevIsWhitespace = $prevToken['code'] === T_WHITESPACE;
    }
}