Merge pull request #2 from Space48/S48-635-reporting-format

S48 635 reporting format

Author: stkec

README.md

@@ -50,7 +50,7 @@ Do you want to create a grumphp.yml file? [Yes]: no
 Copy files and install npm packages:
 ```shell
 warden env exec php-fpm chmod +x vendor/space48/magento2-code-quality/script/install.sh
-warden env exec ./vendor/space48/magento2-code-quality/script/install.sh
+warden env exec php-fpm ./vendor/space48/magento2-code-quality/script/install.sh
 vendor/bin/grumphp git:init
 ```
 

composer.json

@@ -5,6 +5,7 @@
     "license": "proprietary",
     "require": {
         "phpro/grumphp": "^1.3",
+        "symfony/dom-crawler": "*",
         "magento/magento-coding-standard": "*",
         "phpmd/phpmd": "^2",
         "squizlabs/php_codesniffer": ">=2.9.2 <4.0.0",

grumphp.yml

@@ -1,14 +1,42 @@
+## rewrite classes to format output to have rule names in it
+services:
+    formatter.phpmd:
+        class: \Space48\CodeQuality\Formatter\PhpmdFormatter
+    formatter.phpcs:
+        class: \Space48\CodeQuality\Formatter\PhpcsFormatter
+    GrumPHP\Task\PhpMd:
+        ## rewrite class to whitelist 'xml' format
+        class: \Space48\CodeQuality\Task\PhpMd
+        ## set 'phpmd' formatter for PhpMd Task
+        arguments:
+            - '@process_builder'
+            - '@formatter.phpmd'
+        tags:
+            - { name: grumphp.task, task: phpmd }
+    ## workaround to add '-s' option to PhpCs Task
+    process_builder:
+        class: \Space48\CodeQuality\Process\ProcessBuilder
+        arguments:
+            - '@GrumPHP\Locator\ExternalCommand'
+            - '@grumphp.io'
+            - '@GrumPHP\Configuration\Model\ProcessConfig'
+        public: true
+
+## linter settings
 grumphp:
     git_hook_variables:
         EXEC_GRUMPHP_COMMAND: 'warden env run --rm php-fpm'
     ignore_unstaged_changes: false
+    fixer:
+        enabled: false
+        fix_by_default: true
     tasks:
         phpmd:
             whitelist_patterns:
                 - /^app/
             triggered_by: [ 'php', 'phtml' ]
             exclude: [ ]
-            report_format: ansi
+            report_format: xml
             ruleset: [ 'phpmd.xml' ]
         phpcs:
             standard: [ 'ruleset.xml' ]

rulesets/PhpMd/extra.xml

@@ -6,6 +6,18 @@
          xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 http://pmd.sf.net/ruleset_xml_schema.xsd"
          xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd">
 
+    <rule ref="rulesets/naming.xml" >
+        <exclude name="LongVariable" />
+        <exclude name="ShortMethodName" />
+    </rule>
+
+    <rule ref="rulesets/cleancode.xml" >
+        <exclude name="BooleanArgumentFlag" />
+        <exclude name="ElseExpression" />
+        <exclude name="StaticAccess" />
+        <exclude name="MissingImport" />
+    </rule>
+
     <rule name="ExcessiveParameterList"
           since="0.1"
           message="The {0} {1} has {2} parameters. Consider reducing the number of parameters to less than {3}."
@@ -32,4 +44,5 @@ class Foo {
         </example>
 
     </rule>
+
 </ruleset>

src/Formatter/PhpcsFormatter.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Space48\CodeQuality\Formatter;
+
+use Symfony\Component\Process\Process;
+
+class PhpcsFormatter extends \GrumPHP\Formatter\PhpcsFormatter
+{
+
+    public function format(Process $process): string
+    {
+        $output = sprintf("\n%'-90s\n", '-');
+        $output .= 'PHPCS. (To exclude: "//phpcs:disable Rule.Name". Disables rule to the end of the file)' . "\n";
+        $output .= sprintf("%'-90s\n\n", '-');
+
+        return $output . parent::format($process);
+    }
+}

src/Formatter/PhpmdFormatter.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace Space48\CodeQuality\Formatter;
+
+use Symfony\Component\Process\Process;
+use Symfony\Component\DomCrawler\Crawler;
+
+class PhpmdFormatter implements \GrumPHP\Formatter\ProcessFormatterInterface
+{
+
+    public function format(Process $process): string
+    {
+        $output = trim($process->getOutput());
+        if (!$output) {
+            return $process->getErrorOutput();
+        }
+
+        $xml = new Crawler($output);
+        try {
+            // will throw an exception if $output is not in expected format
+            $xml->filter('file')->children();
+        } catch (\Exception $e) {
+            return $output;
+        }
+
+        $formattedOutput = 'PHPMD. (To exclude rule add "@SuppressWarnings(PHPMD.RuleName)" to function or class phpdoc)' . "\n";
+        foreach ($xml->filter('file') as $node) {
+            $name = $node->attributes->getNamedItem('name')->value;
+            $formattedOutput .= sprintf("%'-". \strlen($name) . "s\n", '-');
+            $formattedOutput .= $name . "\n";
+            $formattedOutput .= sprintf("%'-". \strlen($name) . "s\n", '-');
+
+            foreach ($node->childNodes as $violation) {
+                if ($violation->nodeName == '#text') {
+                    continue;
+                }
+
+                $formattedOutput .= sprintf(
+                    "% 11s | Line: % 3s | %s | %s\n",
+                    strtoupper($violation->nodeName),
+                    $violation->attributes->getNamedItem('beginline')->value,
+                    $violation->attributes->getNamedItem('rule')->value,
+                    trim($violation->textContent)
+                );
+            }
+        }
+
+        return $formattedOutput;
+    }
+}

src/Process/ProcessBuilder.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Space48\CodeQuality\Process;
+
+use GrumPHP\Collection\ProcessArgumentsCollection;
+use GrumPHP\Exception\PlatformException;
+use Symfony\Component\Process\Process;
+
+class ProcessBuilder extends \GrumPHP\Process\ProcessBuilder
+{
+
+    /**
+     * @throws PlatformException
+     */
+    public function buildProcess(ProcessArgumentsCollection $arguments): Process
+    {
+        // A workaround to add '-s' flag to PhpCs linter that prints rule name next to violation.
+        // Alternative is to completely replace PhpCs Task as runtime arguments are hardcoded there.
+        if (array_filter($arguments->toArray(), function ($argument) { return preg_match('/\/phpcs$/', $argument); })) {
+            $arguments->add('-s');
+        }
+
+        return parent::buildProcess($arguments);
+    }
+
+}

src/Task/PhpMd.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Space48\CodeQuality\Task;
+
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+/**
+ * PhpMd task.
+ */
+class PhpMd extends \GrumPHP\Task\PhpMd
+{
+    public static function getConfigurableOptions(): OptionsResolver
+    {
+        $resolver = parent::getConfigurableOptions();
+        $resolver->addAllowedValues('report_format', ['xml']);
+
+        return $resolver;
+    }
+
+}