renderer for phpmd using checkstyle

HuasoFoundries · Dec 30, 2020 · 8ff8b47 · 8ff8b47
1 parent 49c994f
commit 8ff8b47
Show file tree

Hide file tree

Showing 2 changed files with 124 additions and 12 deletions.
diff --git a/.reviewdog.yml b/.reviewdog.yml
@@ -4,20 +4,24 @@ runner:
     level: info
 
   psalm:
-    cmd: vendor/bin/psalm --config=psalm.xml  --diff --diff-methods   --output-format=checkstyle
+    cmd: vendor/bin/psalm --config=psalm.xml  --diff    --output-format=checkstyle
     level: info
-    name: checkstyle
 
   csfixer:
-      cmd:  vendor/bin/php-cs-fixer fix --config=.php_cs.php --cache-file=.build/phpcs/csfixer.cache --format=checkstyle --dry-run  --diff
-      level: info
-      name: checkstyle
-
-  phpcs:
-    cmd:  phpcs  --standard=.phpcs.xml  --parallel=2 --cache=.build/phpcs/php-cs.cache --report=checkstyle src/*
+    cmd:  vendor/bin/php-cs-fixer fix --config=.php_cs.php --cache-file=.build/phpcs/csfixer.cache --format=checkstyle --dry-run  --diff
     level: info
-    name: checkstyle
+    format: checkstyle
+
+  phpmd:
+    cmd: phpmd src/classes Renderer .phpmd.xml 
+    level: info 
+    format: checkstyle
+
+  #phpcs:
+    #cmd:  phpcs  --standard=.phpcs.xml  --parallel=2 --cache=.build/phpcs/php-cs.cache --report=checkstyle src/*
+    #level: info
+    #name: checkstyle
 
-  eslint:
-    cmd: node_modules/.bin/eslint --ext js --ignore-path .eslintignore assets
-    level: info
+  #eslint:
+    #cmd: node_modules/.bin/eslint --ext js --ignore-path .eslintignore assets
+    #level: info
diff --git a/Renderer.php b/Renderer.php
@@ -0,0 +1,108 @@
+<?php
+
+/**
+ * PHPPgAdmin 6.1.3
+ */
+
+use PHPMD\AbstractRenderer;
+use PHPMD\PHPMD;
+use PHPMD\Report;
+
+/**
+ * This class will render a Java-PMD compatible xml-report.
+ */
+class Renderer extends AbstractRenderer
+{
+    /**
+     * Temporary property that holds the name of the last rendered file, it is
+     * used to detect the next processed file.
+     *
+     * @var string
+     */
+    private $fileName;
+
+    /**
+     * This method will be called on all renderers before the engine starts the
+     * real report processing.
+     */
+    public function start(): void
+    {
+        $this->getWriter()->write('<?xml version="1.0" encoding="UTF-8" ?>');
+        $this->getWriter()->write(\PHP_EOL);
+    }
+
+    /**
+     * This method will be called when the engine has finished the source analysis
+     * phase.
+     *
+     * @param \PHPMD\Report $report
+     */
+    public function renderReport(Report $report): void
+    {
+        $writer = $this->getWriter();
+        $writer->write('<checkstyle version="3.5.3">');
+        $writer->write(\PHP_EOL);
+
+        foreach ($report->getRuleViolations() as $violation) {
+            $fileName = \str_replace(__DIR__ . \DIRECTORY_SEPARATOR, '', $violation->getFileName());
+
+            if ($this->fileName !== $fileName) {
+                // Not first file
+                if (null !== $this->fileName) {
+                    $writer->write('  </file>' . \PHP_EOL);
+                }
+                // Store current file name
+                $this->fileName = $fileName;
+
+                $writer->write('  <file name="' . $fileName . '">' . \PHP_EOL);
+            }
+
+            $rule = $violation->getRule();
+
+            $writer->write('    <error');
+            $writer->write(' line="' . $violation->getBeginLine() . '"');
+            $writer->write(' endline="' . $violation->getEndLine() . '"');
+            $writer->write(\sprintf(' severity="%s"', 2 < $rule->getPriority() ? 'warning' : 'error'));
+            $writer->write(\sprintf(' message="%s (%s, %s) "', \htmlspecialchars($violation->getDescription()), $rule->getName(), $rule->getRuleSetName()));
+
+            $this->maybeAdd('package', $violation->getNamespaceName());
+            $this->maybeAdd('externalInfoUrl', $rule->getExternalInfoUrl());
+            $this->maybeAdd('function', $violation->getFunctionName());
+            $this->maybeAdd('class', $violation->getClassName());
+            $this->maybeAdd('method', $violation->getMethodName());
+            //$this->_maybeAdd('variable', $violation->getVariableName());
+
+            $writer->write(' />' . \PHP_EOL);
+        }
+
+        // Last file and at least one violation
+        if (null !== $this->fileName) {
+            $writer->write('  </file>' . \PHP_EOL);
+        }
+
+        foreach ($report->getErrors() as $error) {
+            $writer->write('  <file name="' . $error->getFile() . '">');
+            $writer->write($error->getFile());
+            $writer->write('<error  msg="');
+            $writer->write(\htmlspecialchars($error->getMessage()));
+            $writer->write(' severity="error" />' . \PHP_EOL);
+        }
+
+        $writer->write('</checkstyle>' . \PHP_EOL);
+    }
+
+    /**
+     * This method will write a xml attribute named <b>$attr</b> to the output
+     * when the given <b>$value</b> is not an empty string and is not <b>null</b>.
+     *
+     * @param string $attr  the xml attribute name
+     * @param string $value the attribute value
+     */
+    private function maybeAdd($attr, $value): void
+    {
+        if (null === $value || '' === \trim($value)) {
+            return;
+        }
+        $this->getWriter()->write(' ' . $attr . '="' . $value . '"');
+    }
+}