bmitch/churn-php

View on GitHub
src/Assessor/CyclomaticComplexityAssessor.php

Summary

Maintainability
A
0 mins
Test Coverage
<?php

declare(strict_types=1);

namespace Churn\Assessor;

/**
 * @internal
 */
final class CyclomaticComplexityAssessor implements Assessor
{
    /**
     * @var array<int, int>
     */
    private $tokens = [
        \T_BOOLEAN_AND => 1,
        \T_BOOLEAN_OR => 1,
        \T_CASE => 1,
        \T_CATCH => 1,
        \T_CLASS => 1,
        \T_COALESCE => 1,
        \T_ELSEIF => 1,
        \T_FOR => 1,
        \T_FOREACH => 1,
        \T_IF => 1,
        \T_INTERFACE => 1,
        \T_LOGICAL_AND => 1,
        \T_LOGICAL_OR => 1,
        \T_TRAIT => 1,
        \T_WHILE => 1,
    ];

    /**
     * Class constructor.
     */
    public function __construct()
    {
        $this->init();
    }

    /**
     * Assess the files cyclomatic complexity.
     *
     * @param string $contents The contents of a PHP file.
     */
    public function assess(string $contents): int
    {
        $score = 0;
        foreach (\token_get_all($contents) as $token) {
            $score += $this->getComplexity($token[0]);
        }

        return \max(1, $score);
    }

    /**
     * Add missing tokens depending on the PHP version.
     */
    private function init(): void
    {
        $tokens = [
            // Since PHP 7.4
            'T_COALESCE_EQUAL',
            // Since PHP 8.1
            'T_ENUM',
        ];
        foreach ($tokens as $token) {
            if (!\defined($token)) {
                continue;
            }

            $this->tokens[(int) \constant($token)] = 1;
        }
    }

    /**
     * @param integer|string $code Code of a PHP token.
     */
    private function getComplexity($code): int
    {
        if ('?' === $code) {
            return 1;
        }

        return $this->tokens[$code] ?? 0;
    }
}