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

Author: exussum12

.gitignore

@@ -4,3 +4,4 @@ composer.lock
 diff.txt
 phpmd.xml
 phpmd-tests.xml
+diffFilter.phar

CreatePhar.php

@@ -1,6 +1,11 @@
 <?php
 
+chdir(__DIR__);
+
 $pharName = 'diffFilter.phar';
+
+cleanUp($pharName);
+
 $pharFile = getcwd() . '/diffFilter.phar';
 
 if (file_exists($pharFile)) {
@@ -47,8 +52,20 @@ function addDir($dir, $phar)
     foreach ($iterator as $file) {
         $fullPath = $file->getPathname();
         $path = $dir . substr($fullPath, $codeLength);
+
+        if (strpos($path, '/test/') !== false) {
+            continue;
+        }
+
         if (is_file($path)) {
-            $phar->addFile($path);
+            $phar->addFromString($path, php_strip_whitespace($path));
         }
     }
 }
+
+function cleanUp($pharName)
+{
+    shell_exec("rm -rf vendor");
+    shell_exec("rm $pharName");
+    shell_exec("composer install --no-dev -o");
+}

README.md

@@ -26,7 +26,7 @@ Phar is a packaged format which should be a single download. The latest Phar can
 After downloading run `chmod +x diffFilter.phar` and then call as `./diffFilter.phar` followed by the normal options
 
 ## Manually
-Clone this repository somewhere your your build plan can be accessed, composer install is prefered but there is a non composer class loader which will be used if composer is not installed. If composer is not used some PHP specific features will not work as expected.
+Clone this repository somewhere your your build plan can be accessed, composer install is preferred but there is a non composer class loader which will be used if composer is not installed. If composer is not used some PHP specific features will not work as expected.
 Then call the script you need
 
 
@@ -38,7 +38,7 @@ First of all a diff is needed
      
 See [here](https://github.com/exussum12/coverageChecker/wiki/Generating-a-diff) for a more in depth examples of what diff you should generate
 
-Then the outut for the tool you wish to check (such as phpcs, PHPUnit, phpmd etc) for example
+Then the output for the tool you wish to check (such as phpcs, PHPUnit, phpmd etc) for example
 
      phpcs --standard=psr2 --report=json || true > phpcs.json
      
@@ -57,7 +57,7 @@ A more in depth guide can be [found on the wiki](https://github.com/exussum12/co
 
 # Full list of available diff filters
 
-Below is a list of all tools and a breif description
+Below is a list of all tools and a brief description
 
 ```
 --buddy		Parses buddy (magic number detection) output
@@ -79,6 +79,7 @@ Below is a list of all tools and a breif description
 --phpstan	Parses the text output of phpstan
 --phpunit	Parses text output in clover (xml) format generated with coverage-clover=file.xml
 --pylint	Parses PyLint output
+--psalm		Parses Psalm output
 ```
 
 

src/Loaders/Psalm.php

@@ -0,0 +1,147 @@
+<?php
+namespace exussum12\CoverageChecker\Loaders;
+
+use exussum12\CoverageChecker\FileChecker;
+use XMLReader;
+
+/**
+ * Class Psalm
+ * Used for parsing psalm output
+ *
+ * @package exussum12\CoverageChecker
+ */
+class Psalm implements FileChecker
+{
+    /**
+     * @var string
+     */
+    protected $file;
+
+    /**
+     * @var array
+     */
+    protected $errors = [];
+
+    /**
+     * @var array
+     */
+    protected $errorRanges = [];
+
+    /**
+     * Psalm constructor.
+     *
+     * @param string $file the path to the psalm xml file
+     */
+    public function __construct($file)
+    {
+        $this->file = $file;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function parseLines(): array
+    {
+        $this->errors = [];
+        $this->errorRanges = [];
+        $reader = new XMLReader;
+        $reader->open($this->file);
+
+        while ($reader->read()) {
+            if ($this->isElementBeginning($reader, 'item')) {
+                $this->parseItem($reader);
+            }
+        }
+
+        return array_keys($this->errors);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getErrorsOnLine(string $file, int $lineNumber)
+    {
+        $errors = [];
+        foreach ($this->errorRanges[$file] as $number => $error) {
+            if ((
+                $error['start'] <= $lineNumber
+                && $error['end'] >= $lineNumber
+            )) {
+                $errors[] = $error['error'];
+                unset($this->errorRanges[$file][$number]);
+            }
+        }
+
+        return $errors;
+    }
+
+    /**
+     * @param XMLReader $reader
+     */
+    protected function parseItem(XMLReader $reader)
+    {
+        $attributes = [];
+
+        while ($reader->read()) {
+            if ($this->isElementEnd($reader, 'item')) {
+                break;
+            }
+
+            if ($reader->nodeType == XMLReader::ELEMENT) {
+                $attributes[$reader->name] = $reader->readString();
+            }
+        }
+
+        $error = $attributes['message'];
+        $start = $attributes['line_from'];
+        $end = $attributes['line_to'];
+        $fileName = $attributes['file_name'];
+
+        $this->errorRanges[$fileName][] = [
+            'start' => $start,
+            'end' => $end,
+            'error' => $error,
+        ];
+
+        $this->addForAllLines($fileName, $start, $end, $error);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function handleNotFoundFile()
+    {
+        return true;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public static function getDescription(): string
+    {
+        return 'Parses the xml report format of psalm';
+    }
+
+    protected function addForAllLines($currentFile, $start, $end, $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;
+            }
+        }
+    }
+
+    protected function isElementBeginning(XMLReader $reader, string $name): bool
+    {
+        return $reader->name === $name && $reader->nodeType == XMLReader::ELEMENT;
+    }
+
+    protected function isElementEnd(XMLReader $reader, string $name): bool
+    {
+        return $reader->name === $name && $reader->nodeType == XMLReader::END_ELEMENT;
+    }
+}

src/Runners/generic.php

@@ -57,6 +57,7 @@
     'phpstan' => 'PhpStan',
     'phpunit' => 'PhpUnit',
     'pylint' => 'Pylint',
+    'psalm' => 'Psalm',
 ];
 
 $fileCheck = CoverageChecker\getFileChecker(

tests/PsalmDiffFilterTest.php

@@ -0,0 +1,47 @@
+<?php
+namespace exussum12\CoverageChecker\tests;
+
+use PHPUnit\Framework\TestCase;
+use Exception;
+
+/**
+ * Ignored due to acceptance test needing to write values
+ * @SuppressWarnings(PHPMD.Superglobals)
+ */
+class PsalmDiffFilterTest extends TestCase
+{
+
+    public function testValid()
+    {
+        $GLOBALS['argv'] = [
+            'diffFilter',
+            '--psalm',
+            __DIR__ . '/fixtures/change.txt',
+            __DIR__ . '/fixtures/psalm.xml'
+        ];
+        ob_start();
+        require(__DIR__ . "/../src/Runners/generic.php");
+        $output = ob_get_clean();
+        $this->assertContains('100.00% Covered', $output);
+    }
+
+    public function testNoValidLines()
+    {
+        $GLOBALS['argv'] = [
+            'diffFilter',
+            '--psalm',
+            __DIR__ . '/fixtures/change.txt',
+            __DIR__ . '/fixtures/psalm-change.xml',
+        ];
+        try {
+            ob_start();
+            require(__DIR__ . "/../src/Runners/generic.php");
+        } catch (Exception $exception) {
+            $output = ob_get_clean();
+            $this->assertEquals(2, $exception->getCode());
+            $this->assertContains('0.00%', $output);
+            return;
+        }
+        $this->fail("no exception thrown");
+    }
+}

tests/fixtures/psalm-change.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<report>
+    <item>
+        <severity>info</severity>
+        <line_from>3</line_from>
+        <line_to>4</line_to>
+        <type>MissingPropertyType</type>
+        <message>Violation message</message>
+        <file_name>/full/path/to/file/src/changedFile.php</file_name>
+        <file_path>/full/path/to/file/src/changedFile.php</file_path>
+        <snippet>    protected $foo;</snippet>
+        <selected_text>protected $foo;</selected_text>
+        <from>192</from>
+        <to>222</to>
+        <snippet_from>188</snippet_from>
+        <snippet_to>222</snippet_to>
+        <column_from>5</column_from>
+        <column_to>35</column_to>
+    </item>
+</report>

tests/fixtures/psalm.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<report>
+    <item>
+        <severity>info</severity>
+        <line_from>11</line_from>
+        <line_to>11</line_to>
+        <type>MissingPropertyType</type>
+        <message>Violation message</message>
+        <file_name>full/path/to/file/src/CoverageCheck.php</file_name>
+        <file_path>/full/path/to/file/src/CoverageCheck.php</file_path>
+        <snippet>    protected $foo;</snippet>
+        <selected_text>protected $foo;</selected_text>
+        <from>192</from>
+        <to>222</to>
+        <snippet_from>188</snippet_from>
+        <snippet_to>222</snippet_to>
+        <column_from>5</column_from>
+        <column_to>35</column_to>
+    </item>
+</report>