CommentFactory::classifyComment() - Code Metrics - Inspection of "fix: phpstan" - savinmikhail/Comments-Density - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( 5c2914...7703d5 )

by mikhail

created 2024-07-21 18:43 UTC

CommentFactory::classifyComment() A

↳ Parent: CommentFactory

Complexity

Conditions	5
Paths	4

Size

Total Lines	14
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	5.0488

Importance

Changes	2
Bugs	0	Features	1

Metric	Value
cc	5
eloc	8
c	2
b	0
f	1
nc	4
nop	1
dl	0
loc	14
ccs	7
cts	8
cp	0.875
crap	5.0488
rs	9.6111

<?php

declare(strict_types=1);

namespace SavinMikhail\CommentsDensity\Comments;

use Generator;

use function in_array;

final class CommentFactory
{
    /** @var 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;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace SavinMikhail\CommentsDensity\Comments;
6
7		use Generator;
8
9		use function in_array;
10
11		final class CommentFactory
12		{
13		/** @var array<array-key, CommentTypeInterface> */
		0 ignored issues – show Documentation Bug introduced 2024-06-08 15:02 UTC by Report Bug Copy Issue Report 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>. Loading history...
14		private array $commentTypes;
15
16		/**
17		* @param string[] $allowedTypes
18		*/
19	13	public function __construct(private readonly array $allowedTypes = [])
20		{
21	13	$this->commentTypes = [
22	13	new TodoComment(),
23	13	new FixMeComment(),
24	13	new RegularComment(),
25	13	new LicenseComment(),
26	13	new DocBlockComment(),
27	13	];
28		}
29
30		public function getCommentTypes(): Generator
31		{
32		foreach ($this->commentTypes as $commentType) {
33		yield $commentType;
34		}
35		}
36
37	2	public function getCommentType(string $name): ?CommentTypeInterface
38		{
39	2	foreach ($this->commentTypes as $commentType) {
40	2	if ($commentType->getName() === $name) {
41	2	return $commentType;
42		}
43		}
44	2	return null;
45		}
46
47	9	public function classifyComment(string $token): ?CommentTypeInterface
48		{
49	9	foreach ($this->commentTypes as $commentType) {
50	9	if (! $commentType->matchesPattern($token)) {
51	7	continue;
52		}
53		if (
54	9	empty($this->allowedTypes)
55	9	\|\| in_array($commentType->getName(), $this->allowedTypes, true)
56		) {
57	9	return $commentType;
58		}
59		}
60		return null;
61		}
62		}
63

savinmikhail / Comments-Density

Push — main ( 5c2914...7703d5 )

CommentFactory::classifyComment() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like