exussum12\CoverageChecker\PhpMdLoader

Complexity

Total Complexity

18

Size/Duplication

Total Lines	131
Duplicated Lines	6.87 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	2
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
B	checkForViolation()	0	25	6
A	checkForNewFile()	9	13	3
A	handleNotFoundFile()	0	4	1
A	__construct()	0	4	1
A	getLines()	0	14	2
A	isValidLine()	0	16	4
A	getDescription()	0	6	1

<?php
namespace exussum12\CoverageChecker;

use XMLReader;

/**
 * Class PhpMdLoader
 * Used for parsing phpmd xml output
 * @package exussum12\CoverageChecker
 */
class PhpMdLoader implements FileChecker
{
    /**
     * @var string
     */
    protected $file;

    /**
     * @var array
     */
    protected $errors = [];

    /**
     * @var array
     */
    protected $errorRanges = [];

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

    /**
     * {@inheritdoc}
     */
    public function getLines()
    {
        $this->errors = [];
        $this->errorRanges = [];
        $reader = new XMLReader;
        $reader->open($this->file);
        $currentFile = "";
        while ($reader->read()) {
            $currentFile = $this->checkForNewFile($reader, $currentFile);
            $this->checkForViolation($reader, $currentFile);
        }

        return $this->errors;
    }

    /**
     * {@inheritdoc}
     */
    public function isValidLine($file, $lineNumber)
    {
        $valid = true;
        foreach ($this->errorRanges[$file] as $number => $errors) {
            if ((
                $errors['start'] <= $lineNumber &&
                $errors['end'] >= $lineNumber
            )) {
                //unset this error
                unset($this->errorRanges[$file][$number]);
                $valid = false;
            }
        }

        return $valid;
    }

    /**
     * @param XMLReader $reader
     * @param string $currentFile
     */
    protected function checkForViolation(XMLReader $reader, $currentFile)
    {
        if ((
            $reader->name === 'violation' &&
            $reader->nodeType == XMLReader::ELEMENT
        )) {
            $error = trim($reader->readString());
            $start = $reader->getAttribute('beginline');
            $end = $reader->getAttribute('endline');
            $this->errorRanges[$currentFile][] = [
                'start' => $start,
                'end' => $end,
                'error' => $error,
            ];

            for ($i = $start; $i <= $end; $i++) {
                if ((
                    !isset($this->errors[$currentFile][$i]) ||
                    !in_array($error, $this->errors[$currentFile][$i])
                )) {
                    $this->errors[$currentFile][$i][] = $error;
                }
            }
        }
    }

    /**
     * @param XMLReader $reader
     * @param string $currentFile
     * @return string the currentFileName
     */
    protected function checkForNewFile(XMLReader $reader, $currentFile)
    {
        if ((
            $reader->name === 'file' &&
            $reader->nodeType == XMLReader::ELEMENT
        )
        ) {
            $currentFile = $reader->getAttribute('name');
            $this->errors[$currentFile] = [];
            return $currentFile;
        }
        return $currentFile;
    }

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

    /**
     * {@inheritdoc}
     */
    public static function getDescription()
    {
        return 'Parses the xml report format of phpmd, this mode ' .
            'reports multi line violations once per diff, instead ' .
            'of on each line the violation occurs';
    }
}