exussum12 / coverageChecker

src/Loaders/Phpcpd.php

<?php
namespace exussum12\CoverageChecker\Loaders;

use exussum12\CoverageChecker\FileChecker;

class Phpcpd implements FileChecker
{
    protected $file;

    protected $duplicateCode = [];

    public function __construct($file)
    {
        $this->file = fopen($file, 'r');
    }

    public function parseLines(): array
    {
        $block = [];
        $this->duplicateCode = [];
        while (($line = fgets($this->file)) !== false) {

It seems like $this->file can also be of type boolean; however, parameter $handle of fgets() does only seem to accept resource, maybe add an additional type check?

            if (!$this->hasFileName($line)) {
                continue;
            }

            if ($this->startOfBlock($line)) {
                $this->handleEndOfBlock($block);
                $block = [];
            }

            $block += $this->addFoundBlock($line);
        }

        return array_keys($this->duplicateCode);
    }


    public function getErrorsOnLine(string $file, int $lineNumber)
    {
        $errors = [];
        if (isset($this->duplicateCode[$file][$lineNumber])) {
            $errors = $this->duplicateCode[$file][$lineNumber];
        }

        return $errors;
    }

    public function handleNotFoundFile()
    {
        return true;
    }

    public static function getDescription(): string
    {
        return "Parses the text output from phpcpd (Copy Paste Detect)";
    }

    private function startOfBlock(string $line)
    {
        return preg_match('/^\s+-/', $line);
    }

    private function hasFileName(string $line)
    {
        return preg_match('/:\d+-\d+/', $line);
    }

    private function addFoundBlock(string $line)
    {
        $matches = [];
        preg_match('/\s+(?:- )?(?<fileName>.*?):(?<startLine>\d+)-(?<endLine>\d+)$/', $line, $matches);
        return [$matches['fileName'] => range($matches['startLine'], $matches['endLine'])];
    }

    private function handleEndOfBlock(array $block)
    {
        foreach ($block as $filename => $lines) {
            foreach ($lines as $lineNumber) {
                foreach ($block as $duplicate => $dupeLines) {
                    if ($filename == $duplicate) {
                        continue;
                    }
                    $start = reset($dupeLines);
                    $end = end($dupeLines);
                    $message = "Duplicate of " . $duplicate . ':' . $start . '-' . $end;
                    $this->duplicateCode[$filename][$lineNumber][] = $message;
                }
            }
        }
    }
}