NodeNeedsDocblockChecker::requiresDocBlock() - Code Metrics - Inspection of "disable rules" - savinmikhail/Comments-Density - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — main ( b9a26a...3214d5 )

by mikhail

created 2025-01-02 16:01 UTC

NodeNeedsDocblockChecker::requiresDocBlock() A

↳ Parent: Project

Complexity

Conditions	5
Paths	5

Size

Total Lines	18
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	5

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	8
dl	0
loc	18
ccs	9
cts	9
cp	1
rs	9.6111
c	1
b	0
f	0
cc	5
nc	5
nop	1
crap	5

<?php

declare(strict_types=1);

namespace SavinMikhail\CommentsDensity\MissingDocblock\Visitors\Checkers;

use PhpParser\Node;
use PhpParser\Node\Stmt\Class_;
use PhpParser\Node\Stmt\ClassConst;
use PhpParser\Node\Stmt\ClassMethod;
use PhpParser\Node\Stmt\Enum_;
use PhpParser\Node\Stmt\Function_;
use PhpParser\Node\Stmt\Interface_;
use PhpParser\Node\Stmt\Property;
use PhpParser\Node\Stmt\Trait_;
use SavinMikhail\CommentsDensity\Config\DTO\MissingDocblockConfigDTO;

final readonly class NodeNeedsDocblockChecker

{
    public function __construct(
        private MissingDocblockConfigDTO $config,
    ) {}

    public function requiresDocBlock(Node $node): bool
    {
        if ($node instanceof Class_) {
            return $this->config->class && !$node->isAnonymous();
        }

        if ($this->isConfiguredNode($node)) {
            return true;
        }

        if ($this->isMethodOrFunction($node)) {
            return true;
        }

        return false;
    }

    private function isConfiguredNode(Node $node): bool
    {
        return $this->isConfiguredTrait($node)
            || $this->isConfiguredInterface($node)
            || $this->isConfiguredEnum($node)
            || $this->isConfiguredProperty($node)
            || $this->isConfiguredConstant($node);
    }

    private function isConfiguredTrait(Node $node): bool
    {
        return $node instanceof Trait_ && $this->config->trait;
    }

    private function isConfiguredInterface(Node $node): bool
    {
        return $node instanceof Interface_ && $this->config->interface;
    }

    private function isConfiguredEnum(Node $node): bool
    {
        return $node instanceof Enum_ && $this->config->enum;
    }

    private function isConfiguredProperty(Node $node): bool
    {
        return $node instanceof Property && $this->config->property;
    }

    private function isConfiguredConstant(Node $node): bool
    {
        return $node instanceof ClassConst && $this->config->constant;
    }

    private function isMethodOrFunction(Node $node): bool
    {
        return ($node instanceof ClassMethod || $node instanceof Function_) && $this->config->function;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace SavinMikhail\CommentsDensity\MissingDocblock\Visitors\Checkers;
6
7		use PhpParser\Node;
8		use PhpParser\Node\Stmt\Class_;
9		use PhpParser\Node\Stmt\ClassConst;
10		use PhpParser\Node\Stmt\ClassMethod;
11		use PhpParser\Node\Stmt\Enum_;
12		use PhpParser\Node\Stmt\Function_;
13		use PhpParser\Node\Stmt\Interface_;
14		use PhpParser\Node\Stmt\Property;
15		use PhpParser\Node\Stmt\Trait_;
16		use SavinMikhail\CommentsDensity\Config\DTO\MissingDocblockConfigDTO;
17
18		final readonly class NodeNeedsDocblockChecker
		0 ignored issues – show Bug introduced 2025-01-02 16:15 UTC by Report Bug Copy Issue Report A parse error occurred: Syntax error, unexpected T_READONLY, expecting T_CLASS on line 18 at column 6 Loading history...
19		{
20		public function __construct(
21		private MissingDocblockConfigDTO $config,
22		) {}
23
24		public function requiresDocBlock(Node $node): bool
25		{
26		if ($node instanceof Class_) {
27		return $this->config->class && !$node->isAnonymous();
28		}
29
30	77	if ($this->isConfiguredNode($node)) {
31		return true;
32		}
33	77
34		if ($this->isMethodOrFunction($node)) {
35	77	return true;
36		}
37	77
38	58	return false;
39		}
40	58
41		private function isConfiguredNode(Node $node): bool
42		{
43	77	return $this->isConfiguredTrait($node)
44	15	\|\| $this->isConfiguredInterface($node)
45		\|\| $this->isConfiguredEnum($node)
46		\|\| $this->isConfiguredProperty($node)
47	77	\|\| $this->isConfiguredConstant($node);
48		}
49	53
50		private function isConfiguredTrait(Node $node): bool
51		{
52	77	return $node instanceof Trait_ && $this->config->trait;
53		}
54
55	55	private function isConfiguredInterface(Node $node): bool
56		{
57	55	return $node instanceof Interface_ && $this->config->interface;
58		}
59
60		private function isConfiguredEnum(Node $node): bool
61		{
62		return $node instanceof Enum_ && $this->config->enum;
63		}
64	55
65	25	private function isConfiguredProperty(Node $node): bool
66		{
67	25	return $node instanceof Property && $this->config->property;
68		}
69
70	30	private function isConfiguredConstant(Node $node): bool
71	6	{
72		return $node instanceof ClassConst && $this->config->constant;
73	6	}
74
75		private function isMethodOrFunction(Node $node): bool
76	24	{
77		return ($node instanceof ClassMethod \|\| $node instanceof Function_) && $this->config->function;
78		}
79		}
80

savinmikhail / Comments-Density

Push — main ( b9a26a...3214d5 )

NodeNeedsDocblockChecker::requiresDocBlock() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like