Add support for Infection

Author: exussum12

src/InfectionLoader.php

@@ -0,0 +1,145 @@
+<?php
+namespace exussum12\CoverageChecker;
+
+class InfectionLoader implements FileChecker
+{
+
+    protected $file;
+    protected $errors = [];
+
+    protected $errorTypes = [
+        'Escaped mutants',
+        'Errors mutants',
+        'Not covered mutants',
+    ];
+
+    protected $currentFile;
+
+    protected $currentLine;
+
+    protected $partialError;
+
+    protected $currentType;
+
+    public function __construct($filePath)
+    {
+        $this->file = fopen($filePath, 'r');
+    }
+
+    /**
+     * @return array the list of files from this change
+     */
+    public function parseLines()
+    {
+        $this->currentFile = '';
+        $this->currentLine = 0;
+        $this->partialError = '';
+        $this->currentType = '';
+
+        while (($line = fgets($this->file)) !== false) {
+            $this->handleLine($line);
+        }
+        // the last error in the file
+        $this->addError();
+
+        return $this->errors;
+    }
+
+    /**
+     * Method to determine if the line is valid in the context
+     * returning null does not include the line in the stats
+     * Returns an array containing errors on a certain line - empty array means no errors
+     * @param string $file
+     * @param int $lineNumber
+     * @return array|null
+     */
+    public function getErrorsOnLine($file, $lineNumber)
+    {
+        if (!isset($this->errors[$file][$lineNumber])) {
+            return [];
+        }
+
+        return $this->errors[$file][$lineNumber];
+    }
+
+    /**
+     * Method to determine what happens to files which have not been found
+     * true adds as covered
+     * false adds as uncovered
+     * null does not include the file in the stats
+     * @return bool|null
+     */
+    public function handleNotFoundFile()
+    {
+        return true;
+    }
+
+    /**
+     * Shows the description of the class, used for explaining why
+     * this checker would be used
+     * @return string
+     */
+    public static function getDescription()
+    {
+        return 'Parses the infection text log format';
+    }
+
+    protected function updateType($line)
+    {
+        $matches = [];
+        if (preg_match('/^([a-z ]+):$/i', $line, $matches)) {
+            $this->addError();
+            $this->currentFile = '';
+            $this->currentLine = '';
+            $this->partialError = '';
+            $this->currentType = $matches[1];
+
+            return true;
+        }
+
+        return false;
+    }
+
+    protected function updateFile($line)
+    {
+        $matches = [];
+        if (preg_match('/^[0-9]+\) (.*?):([0-9]+) (.*)/i', $line, $matches)) {
+            $this->addError();
+            $this->currentFile = $matches[1];
+            $this->currentLine = $matches[2];
+            $this->partialError = '';
+
+            return true;
+        }
+
+        return false;
+    }
+
+    protected function addError()
+    {
+        if (!($this->currentFile && $this->currentLine)) {
+            return;
+        }
+
+        if (!in_array($this->currentType, $this->errorTypes)) {
+            return;
+        }
+
+        $this->errors
+            [$this->currentFile]
+            [$this->currentLine][] = $this->currentType . $this->partialError;
+    }
+
+    protected function handleLine($line)
+    {
+        if ($this->updateType($line)) {
+            return;
+        }
+
+        if ($this->updateFile($line)) {
+            return;
+        }
+
+        $this->partialError .= $line;
+    }
+}

src/Runners/generic.php

@@ -32,6 +32,7 @@
     'clover' => 'CloverLoader',
     'codeclimate' => 'CodeClimateLoader',
     'humbug' => 'HumbugLoader',
+    'infecton' => 'InfectionLoader',
     'jacoco' => 'JacocoReport',
     'phan' => 'PhanTextLoader',
     'phanJson' => 'PhanJsonLoader',

src/functions.php

@@ -7,8 +7,11 @@
 function findAutoLoader()
 {
     $locations = [
+        // Vendor directory locally
         __DIR__ . '/../vendor/autoload.php',
+        // Vendor directory when installed with composer
         __DIR__ . '/../../../vendor/autoload.php',
+        // Local install (without composer)
         __DIR__ . '/../autoload.php'
     ];
 

tests/InfectionLoaderTest.php

@@ -0,0 +1,36 @@
+<?php
+namespace exussum12\CoverageChecker\tests;
+
+use exussum12\CoverageChecker\InfectionLoader;
+use PHPUnit\Framework\TestCase;
+
+class InfectionLoaderTest extends TestCase
+{
+
+    public function testCanParseFile()
+    {
+
+        $infection = new InfectionLoader(__DIR__ . '/fixtures/infection-log.txt');
+        $infection->parseLines();
+        $file = '/home/scott/code/coverageChecker/src/DiffFilter.php';
+
+        $this->assertFalse(
+            (bool)$infection->getErrorsOnLine(
+                $file,
+                20
+            )
+        );
+        $this->assertTrue(
+            (bool)$infection->getErrorsOnLine(
+                $file,
+                21
+            )
+        );
+    }
+
+    public function testFileNotFound()
+    {
+        $infection = new InfectionLoader(__DIR__ . '/fixtures/infection-log.txt');
+        $this->assertTrue($infection->handleNotFoundFile());
+    }
+}