SavinMikhail\CommentsDensity\Comments\CommentFactory

Complexity

Total Complexity

11

Size/Duplication

Total Lines	50
Duplicated Lines	0 %

Test Coverage

Coverage

95.83%

Importance

Changes	4
Bugs	0	Features	1

4 Methods

Rating	Name	Duplication	Size	Complexity
A	classifyComment()	0	14	5
A	getCommentType()	0	8	3
A	__construct()	0	8	1
A	getCommentTypes()	0	4	2

<?php

declare(strict_types=1);

namespace SavinMikhail\CommentsDensity\Comments;

use Generator;

use function in_array;

final class CommentFactory
{
    /** @var array<array-key, CommentTypeInterface> */

The doc comment array<array-key, CommentTypeInterface> at position 2 could not be parsed: Unknown type name 'array-key' at position 2 in array<array-key, CommentTypeInterface>.

    private array $commentTypes;

    /**
     * @param string[] $allowedTypes
     */
    public function __construct(private readonly array $allowedTypes = [])
    {
        $this->commentTypes =  [
            new TodoComment(),
            new FixMeComment(),
            new RegularComment(),
            new LicenseComment(),
            new DocBlockComment(),
        ];
    }

    public function getCommentTypes(): Generator
    {
        foreach ($this->commentTypes as $commentType) {
            yield $commentType;
        }
    }

    public function getCommentType(string $name): ?CommentTypeInterface
    {
        foreach ($this->commentTypes as $commentType) {
            if ($commentType->getName() === $name) {
                return $commentType;
            }
        }
        return null;
    }

    public function classifyComment(string $token): ?CommentTypeInterface
    {
        foreach ($this->commentTypes as $commentType) {
            if (! $commentType->matchesPattern($token)) {
                continue;
            }
            if (
                empty($this->allowedTypes)
                || in_array($commentType->getName(), $this->allowedTypes, true)
            ) {
                return $commentType;
            }
        }
        return null;
    }
}