CommentVisitor::enterNode() - Code Metrics - Inspection of "return infection" - savinmikhail/Comments-Density - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( 0f6316...2e020c )

by mikhail

created 2025-01-04 07:41 UTC

CommentVisitor::enterNode() A

↳ Parent: CommentVisitor

Complexity

Conditions	3
Paths	3

Size

Total Lines	19
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	14
CRAP Score	3.0026

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
cc	3
eloc	13
nc	3
nop	1
dl	0
loc	19
ccs	14
cts	15
cp	0.9333
crap	3.0026
rs	9.8333
c	1
b	0
f	1

<?php

declare(strict_types=1);

namespace SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer\Visitors;

use PhpParser\Node;
use PhpParser\NodeVisitorAbstract;
use SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer\DTO\Output\CommentDTO;
filter:
    dependency_paths: ["lib/*"]
use SavinMikhail\CommentsDensity\AnalyzeComments\Comments\CommentTypeFactory;
filter:
    dependency_paths: ["lib/*"]

final class CommentVisitor extends NodeVisitorAbstract
{
    /** @var CommentDTO[] */
    public array $comments = [];

    public function __construct(
        private readonly string $filename,
        private readonly CommentTypeFactory $commentFactory,
    ) {}

    public function enterNode(Node $node): null
    {
        $comments = array_filter([$node->getDocComment(), ...$node->getComments()]);
        foreach ($comments as $comment) {
            $commentType = $this->commentFactory->classifyComment($comment->getText());
            if ($commentType === null) {
                continue;
            }
            $this->comments[] =
                new CommentDTO(
                    $commentType->getName(),
                    $commentType->getColor(),
                    $this->filename,
                    $comment->getStartLine(),
                    $comment->getText(),
                );
        }

        return null;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer\Visitors;
6
7		use PhpParser\Node;
8		use PhpParser\NodeVisitorAbstract;
9		use SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer\DTO\Output\CommentDTO;
		0 ignored issues – show Bug introduced 2025-01-03 06:00 UTC by Report Bug Copy Issue Report The type `SavinMikhail\CommentsDen...r\DTO\Output\CommentDTO` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
10		use SavinMikhail\CommentsDensity\AnalyzeComments\Comments\CommentTypeFactory;
		0 ignored issues – show Bug introduced 2025-01-03 09:30 UTC by Report Bug Copy Issue Report The type `SavinMikhail\CommentsDen...ents\CommentTypeFactory` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
11
12		final class CommentVisitor extends NodeVisitorAbstract
13		{
14		/** @var CommentDTO[] */
15		public array $comments = [];
16
17	31	public function __construct(
18		private readonly string $filename,
19		private readonly CommentTypeFactory $commentFactory,
20	31	) {}
21
22	31	public function enterNode(Node $node): null
23		{
24	31	$comments = array_filter([$node->getDocComment(), ...$node->getComments()]);
25	31	foreach ($comments as $comment) {
26	14	$commentType = $this->commentFactory->classifyComment($comment->getText());
27	14	if ($commentType === null) {
28		continue;
29		}
30	14	$this->comments[] =
31	14	new CommentDTO(
32	14	$commentType->getName(),
33	14	$commentType->getColor(),
34	14	$this->filename,
35	14	$comment->getStartLine(),
36	14	$comment->getText(),
37	14	);
38		}
39
40	31	return null;
41		}
42		}
43

savinmikhail / Comments-Density

Push — main ( 0f6316...2e020c )

CommentVisitor::enterNode() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like