Gskema\TypeSniff\Sniffs\CodeElement\FqcnDescriptionSniff

Complexity

Total Complexity

11

Size/Duplication

Total Lines	57
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
B	process()	0	14	7
A	register()	0	6	1
A	configure()	0	10	3

<?php

namespace Gskema\TypeSniff\Sniffs\CodeElement;

use Gskema\TypeSniff\Core\CodeElement\Element\ClassElement;
use Gskema\TypeSniff\Core\CodeElement\Element\CodeElementInterface;
use Gskema\TypeSniff\Core\CodeElement\Element\InterfaceElement;
use Gskema\TypeSniff\Core\CodeElement\Element\TraitElement;
use PHP_CodeSniffer\Files\File;

class FqcnDescriptionSniff implements CodeElementSniffInterface
{
    /** @var string[] */
    protected $invalidPatterns = [
        '^(Class|Trait|Interface)\s+\w+\s*$',
    ];

    /** @var string[] */
    protected $invalidTags = [
        '@package'
    ];

    /**
     * @inheritDoc
     */
    public function configure(array $config): void
    {
        $this->invalidPatterns = array_merge($this->invalidPatterns, $config['invalidPatterns'] ?? []);
        foreach ($this->invalidPatterns as &$invalidPattern) {
            $invalidPattern = '#'.$invalidPattern.'#i';
        }

        $this->invalidTags = array_merge($this->invalidTags, $config['invalidTags'] ?? []);
        foreach ($this->invalidTags as &$invalidTag) {
             $invalidTag = substr($invalidTag, 1);
        }
    }

    /**
     * @inheritDoc
     */
    public function register(): array
    {
        return [
            ClassElement::class,
            InterfaceElement::class,
            TraitElement::class,
        ];
    }

    /**
     * @inheritDoc
     */
    public function process(File $file, CodeElementInterface $element): void
    {
        foreach ($element->getDocBlock()->getDescriptionLines() as $lineNum => $descriptionLine) {
            foreach ($this->invalidPatterns as $invalidPattern) {
                if (preg_match($invalidPattern, $descriptionLine)) {
                    $file->addWarningOnLine('Useless description', $lineNum, 'FqcnDescriptionSniff');
                }
            }
        }

        foreach ($element->getDocBlock()->getTags() as $tag) {
            foreach ($this->invalidTags as $invalidTagName) {
                if ($tag->getName() === $invalidTagName) {
                    $file->addWarningOnLine('Useless tag', $tag->getLine(), 'FqcnDescriptionSniff');
                }
            }
        }
    }
}