Merge remote-tracking branch 'origin/master' into v1-prep

Author: exussum12

CreatePhar.php

@@ -25,6 +25,7 @@
 $phar->setStub(
     "#!/usr/bin/env php
     <?php
+    Phar::mapPhar('$pharName');
     require 'phar://$pharName/src/Runners/generic.php';
     __HALT_COMPILER();"
 );

src/Loaders/PhpMndXml.php

@@ -0,0 +1,97 @@
+<?php
+namespace exussum12\CoverageChecker\Loaders;
+
+use XMLReader;
+use exussum12\CoverageChecker\FileChecker;
+
+class PhpMndXml implements FileChecker
+{
+    protected $currentLine;
+    private $invalidLines = [];
+
+    private $file;
+
+    public function __construct($filename)
+    {
+        $this->file = $filename;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function parseLines(): array
+    {
+        $reader = new XMLReader;
+        $reader->open($this->file);
+        $currentFile = '';
+        while ($reader->read()) {
+            $currentFile = $this->checkForNewFiles($reader, $currentFile);
+
+            $this->handleLine($reader, $currentFile);
+            $this->handleErrors($reader, $currentFile);
+        }
+
+        return array_keys($this->invalidLines);
+    }
+
+    protected function checkForNewFiles(XMLReader $reader, $currentFile)
+    {
+        if ((
+            $reader->name === "file" &&
+            $reader->nodeType == XMLReader::ELEMENT
+        )) {
+            $currentFile = $reader->getAttribute('path');
+            $this->invalidLines[$currentFile] = [];
+        }
+        return $currentFile;
+    }
+
+    protected function handleLine(XMLReader $reader, $currentFile)
+    {
+        if ($reader->name === "entry") {
+            $this->currentLine = $reader->getAttribute("line");
+            if (!isset($this->invalidLines[$currentFile][$this->currentLine])) {
+                $this->invalidLines[$currentFile][$this->currentLine] = [];
+            }
+        }
+    }
+
+    protected function handleErrors(XMLReader $reader, $currentFile)
+    {
+        if ((
+            $reader->name === "snippet" &&
+            $reader->nodeType == XMLReader::ELEMENT
+        )) {
+            $this->invalidLines[$currentFile][$this->currentLine][] = $reader->readString();
+        }
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getErrorsOnLine($file, $lineNumber)
+    {
+        $errors = [];
+        if (isset($this->invalidLines[$file][$lineNumber])) {
+            $errors = $this->invalidLines[$file][$lineNumber];
+        }
+
+        return $errors;
+    }
+
+    /**
+     * return as true to include files, phpmnd only shows files with errors
+     */
+    public function handleNotFoundFile()
+    {
+        return true;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public static function getDescription(): string
+    {
+        return 'Parses the XML output of phpmnd (Magic Number Detection)';
+    }
+}

src/Runners/generic.php

@@ -13,6 +13,7 @@
 CoverageChecker\addExceptionHandler();
 CoverageChecker\findAutoLoader();
 $args = new CoverageChecker\ArgParser($argv);
+CoverageChecker\checkForVersion($args);
 CoverageChecker\checkCallIsCorrect($args);
 
 try {
@@ -52,6 +53,7 @@
     'phpmd' => 'PhpMd',
     'phpmdStrict' => 'PhpMdStrict',
     'phpmnd' => 'PhpMnd',
+    'phpmndXml' => 'PhpMndXml',
     'phpstan' => 'PhpStan',
     'phpunit' => 'PhpUnit',
     'pylint' => 'Pylint',

src/functions.php

@@ -180,3 +180,14 @@ function adjustArgument($argument, $tabWidth)
     }
     return $argument;
 }
+
+function checkForVersion(ArgParser $args)
+{
+    try {
+        $args->getArg("v");
+    } catch (ArgumentNotFound $e) {
+        return;
+    }
+
+    throw new Exception('Version: 0.10.3-dev', 0);
+}

tests/Loaders/PhpmndXmlDiffFilterTest.php

@@ -0,0 +1,47 @@
+<?php
+namespace exussum12\CoverageChecker\tests;
+
+use PHPUnit\Framework\TestCase;
+use exussum12\CoverageChecker\Loaders\PhpMndXml;
+
+class PhpmndXmlDiffFilterTest extends TestCase
+{
+    /** @var PhpMndXmlLoader */
+    private $mnd;
+
+    public function setUp()
+    {
+        parent::setUp();
+        $file = __DIR__ . "/../fixtures/phpmnd.xml";
+        $this->mnd = new PhpMndXml($file);
+    }
+
+    public function testValidFiles()
+    {
+        $files = $this->mnd->parseLines();
+        $expected = [
+            'bin/test/test.php',
+            'bin/test/test2.php',
+            'tests/files/test_1.php',
+        ];
+
+        $this->assertSame($expected, $files);
+    }
+
+    public function testShowsErrorOnLine()
+    {
+        $this->mnd->parseLines();
+
+        $this->assertNotEmpty(
+            $this->mnd->getErrorsOnLine('bin/test/test.php', 3)
+        );
+        $this->assertEmpty(
+            $this->mnd->getErrorsOnLine('bin/test/test.php', 1)
+        );
+    }
+
+    public function testFileNotFound()
+    {
+        $this->assertTrue($this->mnd->handleNotFoundFile());
+    }
+}

tests/VersionOutputTest.php

@@ -0,0 +1,23 @@
+<?php
+namespace exussum12\CoverageChecker\tests;
+
+use Exception;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * Ignored due to acceptance test needing to write values
+ * @SuppressWarnings(PHPMD.Superglobals)
+ */
+class VersionOutputTest extends TestCase
+{
+
+    public function testValid()
+    {
+        $this->expectException(Exception::class);
+        $GLOBALS['argv'] = [
+            'diffFilter',
+            '-v',
+        ];
+        require(__DIR__ . "/../src/Runners/generic.php");
+    }
+}

tests/fixtures/phpmnd.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0"?>
+<phpmnd version="2.0.0" fileCount="15" errorCount="11"><files><file path="bin/test/test.php" errors="2"><entry line="3" start="14" end="15"><snippet><![CDATA[if ($length < 7) {]]></snippet><suggestions/></entry><entry line="4" start="11" end="13"><snippet><![CDATA[    return 12;]]></snippet><suggestions/></entry></file><file path="bin/test/test2.php" errors="2"><entry line="3" start="14" end="15"><snippet><![CDATA[if ($length < 7) {]]></snippet><suggestions/></entry><entry line="4" start="11" end="13"><snippet><![CDATA[    return 12;]]></snippet><suggestions/></entry></file><file path="tests/files/test_1.php" errors="7"><entry line="14" start="19" end="20"><snippet><![CDATA[      if ($input > 2) {]]></snippet><suggestions/></entry><entry line="15" start="16" end="18"><snippet><![CDATA[         return 15;]]></snippet><suggestions/></entry><entry line="18" start="25" end="27"><snippet><![CDATA[      for ($i = 3; $i <= 10; $i++) {]]></snippet><suggestions/></entry><entry line="20" start="17" end="18"><snippet><![CDATA[            case 5:]]></snippet><suggestions/></entry><entry line="26" start="29" end="30"><snippet><![CDATA[      round($input, $input > 7);]]></snippet><suggestions/></entry><entry line="31" start="29" end="31"><snippet><![CDATA[         'adult' => $input > 18,]]></snippet><suggestions/></entry><entry line="50" start="13" end="15"><snippet><![CDATA[      return -2;]]></snippet><suggestions/></entry></file></files></phpmnd>