exussum12\CoverageChecker\Loaders\Clover

Complexity

Total Complexity

16

Size/Duplication

Total Lines	97
Duplicated Lines	0 %

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	addLine()	0	8	2
A	getErrorsOnLine()	0	8	3
A	handleStatement()	0	7	3
A	getDescription()	0	3	1
A	parseLines()	0	13	2
A	handleNotFoundFile()	0	3	1
A	checkForNewFiles()	0	10	3

<?php
namespace exussum12\CoverageChecker\Loaders;

use exussum12\CoverageChecker\FileChecker;
use XMLReader;

/**
 * Class XMLReport
 * Used for reading in a phpunit clover XML file
 * @package exussum12\CoverageChecker
 */
class Clover implements FileChecker
{
    /**
     * @var string
     */
    protected $file;
    /**
     * @var array
     */
    protected $coveredLines;

    /**
     * XMLReport constructor.
     * @param string $file the path the to phpunit clover file
     */
    public function __construct($file)
    {
        $this->file = $file;
    }

    /**
     * {@inheritdoc}
     */
    public function parseLines(): array
    {
        $this->coveredLines = [];
        $reader = new XMLReader;
        $reader->open($this->file);
        $currentFile = '';
        while ($reader->read()) {
            $currentFile = $this->checkForNewFiles($reader, $currentFile);

            $this->handleStatement($reader, $currentFile);
        }

        return array_keys($this->coveredLines);
    }

    /**
     * {@inheritdoc}
     */
    public function getErrorsOnLine(string $file, int $line)
    {
        if (!isset($this->coveredLines[$file][$line])) {
            return null;
        }
        return $this->coveredLines[$file][$line] > 0 ?
            []:
            ['No unit test covering this line']
        ;
    }

    /**
     * {@inheritdoc}
     */
    public function handleNotFoundFile()
    {
        return null;
    }

    /**
     * {@inheritdoc}
     */
    public static function getDescription(): string
    {
        return 'Parses text output in clover (xml) format';
    }

    protected function checkForNewFiles(XMLReader $reader, string $currentFile)
    {
        if ((
            $reader->name === "file" &&
            $reader->nodeType == XMLReader::ELEMENT
        )) {
            $currentFile = $reader->getAttribute('name');
            $this->coveredLines[$currentFile] = [];
        }
        return $currentFile;
    }

    protected function addLine(XMLReader $reader, string $currentFile)
    {
        $covered = $reader->getAttribute('count') > 0;

        $this->coveredLines
        [$currentFile]
        [$reader->getAttribute('num')]
            = $covered ?: "No test coverage";
    }

    protected function handleStatement(XMLReader $reader, string $currentFile)
    {
        if ((
            $reader->name === "line" &&
            $reader->getAttribute("type") == "stmt"
        )) {
            $this->addLine($reader, $currentFile);
        }
    }
}