Churn\Assessor\CyclomaticComplexityAssessor

Complexity

Total Complexity

14

Size/Duplication

Total Lines	146
Duplicated Lines	0 %

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	countTheTernaryOperators()	0	3	1
A	getFileContents()	0	3	1
A	countTheLogicalAnds()	0	3	1
A	countTheLogicalOrs()	0	3	1
A	countTheForLoops()	0	3	1
A	countTheIfStatements()	0	3	1
A	countTheCaseStatements()	0	3	1
A	countTheElseIfStatements()	0	3	1
A	countTheWhileLoops()	0	3	1
A	hasAtLeastOneMethod()	0	5	2
A	howManyPatternMatches()	0	3	1
A	assess()	0	19	2

<?php declare(strict_types = 1);

namespace Churn\Assessor;

use function preg_match;
use function preg_match_all;
use function file_get_contents;

class CyclomaticComplexityAssessor
{
    /**
     * The total cyclomatic complexity score.
     * @var integer.

The doc comment integer. at position 0 could not be parsed: Unknown type name 'integer.' at position 0 in integer..

     */
    protected $score;

    /**
     * Asses the files cyclomatic complexity.
     * @param  string $filePath Path and file name.
     * @return integer
     */
    public function assess(string $filePath): int
    {
        $this->score = 0;

        $contents = $this->getFileContents($filePath);
        $this->hasAtLeastOneMethod($contents);
        $this->countTheIfStatements($contents);
        $this->countTheElseIfStatements($contents);
        $this->countTheWhileLoops($contents);
        $this->countTheForLoops($contents);
        $this->countTheCaseStatements($contents);
        $this->countTheTernaryOperators($contents);
        $this->countTheLogicalAnds($contents);
        $this->countTheLogicalOrs($contents);

        if ($this->score === 0) {
            $this->score = 1;
        }
        return $this->score;
    }

    /**
     * Does the class have at least one method?
     * @param  string $contents File contents.
     * @return void
     */
    protected function hasAtLeastOneMethod(string $contents): void
    {
        preg_match("/[ ]function[ ]/", $contents, $matches);
        if (isset($matches[0])) {
            $this->score++;
        }
    }

    /**
     * Count how many if statements there are.
     * @param  string $contents File contents.
     * @return void
     */
    protected function countTheIfStatements(string $contents): void
    {
        $this->score += $this->howManyPatternMatches("/[ ]if[ ]{0,}\(/", $contents);
    }

    /**
     * Count how many else if statements there are.
     * @param  string $contents File contents.
     * @return void
     */
    protected function countTheElseIfStatements(string $contents): void
    {
        $this->score += $this->howManyPatternMatches("/else[ ]{0,}if[ ]{0,}\(/", $contents);
    }

    /**
     * Count how many while loops there are.
     * @param  string $contents File contents.
     * @return void
     */
    protected function countTheWhileLoops(string $contents): void
    {
        $this->score += $this->howManyPatternMatches("/while[ ]{0,}\(/", $contents);
    }

    /**
     * Count how many for loops there are.
     * @param  string $contents File contents.
     * @return void
     */
    protected function countTheForLoops(string $contents): void
    {
        $this->score += $this->howManyPatternMatches("/[ ]for(each){0,1}[ ]{0,}\(/", $contents);
    }

    /**
     * Count how many case statements there are.
     * @param  string $contents File contents.
     * @return void
     */
    protected function countTheCaseStatements(string $contents): void
    {
        $this->score += $this->howManyPatternMatches("/[ ]case[ ]{1}(.*)\:/", $contents);
    }

    /**
     * Count how many ternary operators there are.
     * @param  string $contents File contents.
     * @return void
     */
    protected function countTheTernaryOperators(string $contents): void
    {
        $this->score += $this->howManyPatternMatches("/[ ]\?.*:.*;/", $contents);
    }

    /**
     * Count how many '&&' there are.
     * @param  string $contents File contents.
     * @return void
     */
    protected function countTheLogicalAnds(string $contents): void
    {
        $this->score += $this->howManyPatternMatches("/[ ]&&[ ]/", $contents);
    }

    /**
     * Count how many '||' there are.
     * @param  string $contents File contents.
     * @return void
     */
    protected function countTheLogicalOrs(string $contents): void
    {
        $this->score += $this->howManyPatternMatches("/[ ]\|\|[ ]/", $contents);
    }

    /**
     * For the given $pattern on $string, how many matches are returned?
     * @param  string $pattern Regex pattern.
     * @param  string $string  Any string.
     * @return integer
     */
    protected function howManyPatternMatches(string $pattern, string $string): int
    {
        return preg_match_all($pattern, $string);
    }

    /**
     * Return the contents of the provided file at $filePath.
     * @param  string $filePath Path and filename.
     * @return string
     */
    protected function getFileContents(string $filePath): string
    {
        return file_get_contents($filePath);
    }
}