SuffixExtendsRule::__construct() - Code Metrics - Inspection of "Add PHPStan checks to test code" - gacela-project/gacela - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — main (#327)

by Chema

created 2025-05-30 23:59 UTC

SuffixExtendsRule::__construct() A

↳ Parent: SuffixExtendsRule

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	0

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	0
c	1
b	0
f	0
dl	0
loc	4
rs	10
cc	1
nc	1
nop	2

<?php

declare(strict_types=1);

namespace Gacela\PHPStan\Rules;

use PhpParser\Node;
use PhpParser\Node\Stmt\Class_;
use PHPStan\Analyser\Scope;
use PHPStan\Reflection\ClassReflection;
use PHPStan\Rules\Rule;

use function strlen;

/**
 * @implements Rule<Class_>
 */

final class SuffixExtendsRule implements Rule
{
    public function __construct(
        private string $suffix,
        private string $expectedParent,
    ) {
    }

    public function getNodeType(): string
    {
        return Class_::class;
    }

    public function processNode(Node $node, Scope $scope): array
    {
        if ($node->isAnonymous()) {
        if ($node->/** @scrutinizer ignore-call */ isAnonymous()) {
            return [];
        }

        $classReflection = $scope->getClassReflection();
        if (!$classReflection instanceof ClassReflection) {
            return [];
        }

        $className = $classReflection->getName();
        $pos = strrpos($className, '\\');
        $shortName = $pos === false ? $className : substr($className, $pos + 1);

        if (substr($shortName, -strlen($this->suffix)) !== $this->suffix) {
            return [];
        }

        if (
            $className !== $this->expectedParent &&
            !$classReflection->isSubclassOf($this->expectedParent)
        ) {
            return [sprintf('Class %s should extend %s', $className, $this->expectedParent)];
        }

        return [];
    }
}


gacela-project / gacela

Pull Request — main (#327)

SuffixExtendsRule::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like