Gskema\TypeSniff\Inspection\Subject\AbstractTypeSubject

Complexity

Total Complexity

24

Size/Duplication

Total Lines	165
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

19 Methods

Rating	Name	Duplication	Size	Complexity
A	getId()	0	3	1
A	hasAttribute()	0	3	1
A	writeViolationsTo()	0	13	4
A	hasDefinedDocType()	0	3	2
A	getFnTypeWarnings()	0	3	1
A	getDocBlock()	0	3	1
A	hasDocTypeTag()	0	3	1
A	__construct()	0	20	1
A	hasDefinedDocBlock()	0	3	1
A	getName()	0	3	1
A	getDocTypeWarnings()	0	3	1
A	getFnTypeLine()	0	3	1
A	hasDefinedFnType()	0	3	2
A	addDocTypeWarning()	0	3	1
A	addFnTypeWarning()	0	3	1
A	getDocType()	0	3	1
A	getValueType()	0	3	1
A	getDocTypeLine()	0	3	1
A	getFnType()	0	3	1

<?php

namespace Gskema\TypeSniff\Inspection\Subject;

use Gskema\TypeSniff\Core\DocBlock\DocBlock;
use Gskema\TypeSniff\Core\DocBlock\UndefinedDocBlock;
use Gskema\TypeSniff\Core\SniffHelper;
use Gskema\TypeSniff\Core\Type\Common\UndefinedType;
use Gskema\TypeSniff\Core\Type\TypeInterface;
use PHP_CodeSniffer\Files\File;

/**
 * @see AbstractTypeSubjectTest
 */
abstract class AbstractTypeSubject
{
    protected ?TypeInterface $docType; // null = missing in PHPDoc

    protected TypeInterface $fnType;

    protected ?TypeInterface $valueType; // null = could not be detected

    protected ?int $docTypeLine; // null = missing in PHPDoc

    protected int $fnTypeLine;

    protected string $name; // "parameter $param1", "property $prop1", "constant CONST1"

    protected string $id; // TestClass::method1(), etc.

    protected DocBlock $docBlock;

    /** @var string[] */
    protected array $docTypeWarnings = [];

    /** @var string[] */
    protected array $fnTypeWarnings = [];

    /** @var string[] */
    protected array $attributeNames = [];

    /**
     * @param TypeInterface|null $docType
     * @param TypeInterface      $fnType
     * @param TypeInterface|null $valueType
     * @param int|null           $docTypeLine
     * @param int                $fnTypeLine
     * @param string             $name
     * @param DocBlock           $docBlock
     * @param string[]           $attributeNames
     * @param string             $id
     */
    public function __construct(
        ?TypeInterface $docType,
        TypeInterface $fnType,
        ?TypeInterface $valueType,
        ?int $docTypeLine,
        int $fnTypeLine,
        string $name,
        DocBlock $docBlock,
        array $attributeNames,
        string $id
    ) {
        $this->docType = $docType;
        $this->fnType = $fnType;
        $this->valueType = $valueType;
        $this->docTypeLine = $docTypeLine;
        $this->fnTypeLine = $fnTypeLine;
        $this->name = $name;
        $this->docBlock = $docBlock;
        $this->attributeNames = $attributeNames;
        $this->id = $id;
    }

    public function getDocType(): ?TypeInterface
    {
        return $this->docType;
    }

    public function getFnType(): TypeInterface
    {
        return $this->fnType;
    }

    public function getValueType(): ?TypeInterface
    {
        return $this->valueType;
    }

    public function getDocTypeLine(): ?int
    {
        return $this->docTypeLine;
    }

    public function getFnTypeLine(): int
    {
        return $this->fnTypeLine;
    }

    public function getName(): string
    {
        return $this->name;
    }

    public function getId(): string
    {
        return $this->id;
    }

    public function getDocBlock(): DocBlock
    {
        return $this->docBlock;
    }

    /**
     * @return string[]
     */
    public function getDocTypeWarnings(): array
    {
        return $this->docTypeWarnings;
    }

    /**
     * @return string[]
     */
    public function getFnTypeWarnings(): array
    {
        return $this->fnTypeWarnings;
    }

    public function hasDefinedDocType(): bool
    {
        return $this->docType && !($this->docType instanceof UndefinedType);
    }

    public function hasDefinedFnType(): bool
    {
        return $this->fnType && !($this->fnType instanceof UndefinedType);
    }

    public function hasDefinedDocBlock(): bool
    {
        return !($this->docBlock instanceof UndefinedDocBlock);
    }

    public function addDocTypeWarning(string $warning): void
    {
        $this->docTypeWarnings[] = $warning;
    }

    public function addFnTypeWarning(string $warning): void
    {
        $this->fnTypeWarnings[] = $warning;
    }

    public function writeViolationsTo(File $file, string $sniffCode, string $reportType, bool $addViolationId): void
    {
        $originId = $addViolationId ? $this->getId() : null;

        $ucName = ucfirst($this->name);
        foreach ($this->docTypeWarnings as $docTypeWarning) {
            $warning = str_replace([':subject:', ':Subject:'], [$this->name, $ucName], $docTypeWarning);
            SniffHelper::addViolation($file, $warning, $this->docTypeLine ?? $this->fnTypeLine, $sniffCode, $reportType, $originId);
        }

        foreach ($this->fnTypeWarnings as $fnTypeWarning) {
            $warning = str_replace([':subject:', ':Subject:'], [$this->name, $ucName], $fnTypeWarning);
            SniffHelper::addViolation($file, $warning, $this->fnTypeLine, $sniffCode, $reportType, $originId);
        }
    }

    public function hasDocTypeTag(): bool
    {
        return null !== $this->docType;
    }

    public function hasAttribute(string $attributeName): bool
    {
        return in_array($attributeName, $this->attributeNames);
    }
}