BestIt\Helper\DocSummaryHelper

Complexity

Total Complexity

23

Size/Duplication

Total Lines	276
Duplicated Lines	7.97 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	getCommentSummaryPointer()	0	19	2
A	getCommentSummaryToken()	0	4	1
B	checkCommentSummary()	0	25	2
A	checkSummaryCapitalLetter()	0	18	3
A	checkSummaryLineLength()	0	12	2
A	checkSummaryIsFirstLine()	0	14	3
B	checkLineAfterSummary()	0	30	3
A	fixNoLineAfterSummary()	14	14	1
A	fixSummaryNotFirst()	0	20	4
A	fixSummaryUcFirst()	8	8	1

<?php

namespace BestIt\Helper;

use BestIt\AbstractDocSniff;
use PHP_CodeSniffer_File;

/**
 * Class DocSummaryHelper
 *
 * @package BestIt\Helper
 * @author Nick Lubisch <nick.lubisch@bestit-online.de>
 */
class DocSummaryHelper
{
    /**
     * The php cs file.
     *
     * @var PHP_CodeSniffer_File
     */
    private $file;

    /**
     * The doc comment helper.
     *
     * @var DocHelper
     */
    private $docHelper;

    /**
     * Token stack of the current file.
     *
     * @var array
     */
    private $tokens;

    /**
     * DocSummaryHelper constructor.
     *
     * @param PHP_CodeSniffer_File $file The php cs file
     * @param DocHelper $docHelper The doc comment helper
     */
    public function __construct(PHP_CodeSniffer_File $file, DocHelper $docHelper)
    {
        $this->file = $file;
        $this->tokens = $file->getTokens();
        $this->docHelper = $docHelper;
    }

    /**
     * Returns pointer to the comment summary.
     *
     * @return bool|int Pointer to the token or false
     */
    public function getCommentSummaryPointer()
    {
        $commentStartPtr = $this->docHelper->getCommentStartPointer();
        $commentEndPtr = $this->docHelper->getCommentEndPointer();

        $summaryPtr = $this->file->findNext(
            [
                T_DOC_COMMENT_WHITESPACE,
                T_DOC_COMMENT_STAR
            ],
            $commentStartPtr + 1,
            $commentEndPtr,

It seems like $commentEndPtr defined by $this->docHelper->getCommentEndPointer() on line 58 can also be of type boolean; however, PHP_CodeSniffer_File::findNext() does only seem to accept integer|null, maybe add an additional type check?

            true
        );

        $summaryToken = $this->tokens[$summaryPtr];

        return $summaryToken['code'] === T_DOC_COMMENT_STRING ? $summaryPtr : false;
    }

    /**
     * Returns comment summary token.
     *
     * @return array Summary token array
     */
    public function getCommentSummaryToken()
    {
        return $this->tokens[$this->getCommentSummaryPointer()];
    }

    /**
     * Check class comment summary.
     *
     * @return void
     */
    public function checkCommentSummary()
    {
        $commentEndPtr = $this->docHelper->getCommentEndPointer();
        $commentStartPtr = $this->docHelper->getCommentStartPointer();
        $commentStartToken = $this->docHelper->getCommentStartToken();

        $summaryPtr = $this->getCommentSummaryPointer();

        if ($summaryPtr === false) {
            $this->file->addError(
                AbstractDocSniff::MESSAGE_NO_SUMMARY,
                $commentStartPtr,
                AbstractDocSniff::CODE_NO_SUMMARY
            );

            return;
        }

        $summaryToken = $this->tokens[$summaryPtr];

        $this->checkSummaryIsFirstLine($commentStartToken, $summaryToken, $summaryPtr);
        $this->checkSummaryCapitalLetter($summaryToken, $summaryPtr);
        $this->checkSummaryLineLength($summaryToken, $summaryPtr);
        $this->checkLineAfterSummary($summaryPtr, $commentEndPtr);

It seems like $commentEndPtr defined by $this->docHelper->getCommentEndPointer() on line 92 can also be of type boolean; however, BestIt\Helper\DocSummaryHelper::checkLineAfterSummary() does only seem to accept integer, maybe add an additional type check?

    }

    /**
     * Checks that the first character of the summary is upper case.
     *
     * @param array $summaryToken Token of the summary
     * @param int $summaryPtr Pointer to the summary
     *
     * @return void
     */
    private function checkSummaryCapitalLetter(array $summaryToken, $summaryPtr)
    {
        $summaryText = $summaryToken['content'];

        if (ucfirst($summaryText) === $summaryText) {
            return;
        }

        $fixUcFirst = $this->file->addFixableError(
            AbstractDocSniff::MESSAGE_SUMMARY_UC_FIRST,
            $summaryPtr,
            AbstractDocSniff::CODE_SUMMARY_UC_FIRST
        );

        if ($fixUcFirst) {
            $this->fixSummaryUcFirst($summaryToken, $summaryPtr);
        }
    }

    /**
     * Checks if the line length of the summary is maximum 120 chars.
     *
     * @param array $summaryToken Token array of the summary
     * @param int $summaryPtr Pointer of the summary
     *
     * @return void
     */
    private function checkSummaryLineLength($summaryToken, $summaryPtr)
    {
        $summaryLineLength = $summaryToken['column'] + $summaryToken['length'];

        if ($summaryLineLength > AbstractDocSniff::MAX_LINE_LENGTH) {
            $this->file->addError(
                AbstractDocSniff::MESSAGE_SUMMARY_TOO_LONG,
                $summaryPtr,
                AbstractDocSniff::CODE_SUMMARY_TOO_LONG
            );
        }
    }

    /**
     * Checks if the summary is the first line of the comment.
     *
     * @param array $commentStartToken Token array of the comment start
     * @param array $summaryToken Token of the summary
     * @param int $summaryPtr Pointer to the summary
     *
     * @return void
     */
    private function checkSummaryIsFirstLine($commentStartToken, $summaryToken, $summaryPtr)
    {
        if ($summaryToken['line'] !== $commentStartToken['line'] + 1) {
            $fixSummaryNotFirst = $this->file->addFixableError(
                AbstractDocSniff::MESSAGE_SUMMARY_NOT_FIRST,
                $summaryPtr,
                AbstractDocSniff::CODE_SUMMARY_NOT_FIRST
            );

            if ($fixSummaryNotFirst) {
                $this->fixSummaryNotFirst();
            }
        }
    }

    /**
     * Checks the line after the summary.
     *
     * @param int $summaryPtr Pointer to the summary
     * @param int $commentEndPtr Pointer to the end of the doc comment
     *
     * @return void
     */
    private function checkLineAfterSummary($summaryPtr, $commentEndPtr)
    {
        $summaryToken = $this->getCommentSummaryToken();

        $nextRelevantPtr = $this->file->findNext(
            [
                T_DOC_COMMENT_WHITESPACE,
                T_DOC_COMMENT_STAR
            ],
            $summaryPtr + 1,
            $commentEndPtr,
            true
        );

        $nextRelevantToken = $this->tokens[$nextRelevantPtr];

        if (($nextRelevantToken['line'] - $summaryToken['line']) === 1) {
            $fixLineAfterSummary = $this->file->addFixableError(
                AbstractDocSniff::MESSAGE_NO_LINE_AFTER_SUMMARY,
                $summaryPtr,
                AbstractDocSniff::CODE_NO_LINE_AFTER_SUMMARY
            );

            if ($fixLineAfterSummary) {
                $this->fixNoLineAfterSummary();
            }

            return;
        }
    }

    /**
     * Fixes no line after summary.
     *
     * @return void
     */
    private function fixNoLineAfterSummary()

This method seems to be duplicated in your project.

    {
        $summaryPtr = $this->getCommentSummaryPointer();
        $summaryToken = $this->getCommentSummaryToken();

        $this->file->fixer->beginChangeset();

        $this->file->fixer->addContent(
            $summaryPtr,

It seems like $summaryPtr defined by $this->getCommentSummaryPointer() on line 234 can also be of type false; however, PHP_CodeSniffer_Fixer::addContent() does only seem to accept integer, did you maybe forget to handle an error condition?

            $this->file->eolChar . str_repeat('    ', $summaryToken['level']) . ' *'
        );

        $this->file->fixer->endChangeset();
    }

    /**
     * Fixes summary not first statement.
     *
     * @return void
     */
    private function fixSummaryNotFirst()
    {
        $commentStartToken = $this->docHelper->getCommentStartToken();
        $summaryStartToken = $this->getCommentSummaryToken();

        $startLine = $commentStartToken['line'] + 1;
        $endLine = $summaryStartToken['line'] - 1;

        $this->file->fixer->beginChangeset();

        foreach ($this->tokens as $tokenPtr => $token) {
            for ($line = $startLine; $line <= $endLine; $line++) {
                if ($token['line'] === $line) {
                    $this->file->fixer->replaceToken($tokenPtr, '');
                }
            }
        }

        $this->file->fixer->endChangeset();
    }

    /**
     * Fixes the first letter of the summary to be uppercase.
     *
     * @param array $summaryToken Token array of the summary
     * @param int $summaryPtr Pointer to the summary
     *
     * @return void
     */
    private function fixSummaryUcFirst(array $summaryToken, $summaryPtr)

This method seems to be duplicated in your project.

    {
        $this->file->fixer->beginChangeset();

        $this->file->fixer->replaceToken($summaryPtr, ucfirst($summaryToken['content']));

        $this->file->fixer->endChangeset();
    }
}