add parallel phpmd processing and polish

.codeclimate.yml

@@ -1,8 +1,13 @@
 engines:
   fixme:
-    enabled: true
+    enabled: false
   phpmd:
     enabled: true
+  phpcodesniffer:
+    enabled: true
+    config:
+      - file_extensions: "php"
+      - standard: ["PSR1", "PSR2"]
 
 exclude_paths:
 - .git/**/*

Dockerfile

@@ -4,7 +4,7 @@ WORKDIR /usr/src/app
 COPY composer.json /usr/src/app/
 COPY composer.lock /usr/src/app/
 
-RUN apk --update add git php-common php-xml php-dom php-ctype php-iconv php-json php-phar php-openssl curl && \
+RUN apk --update add git php-common php-xml php-dom php-ctype php-iconv php-json php-pcntl php-phar php-openssl php-opcache php-sockets curl && \
     curl -sS https://getcomposer.org/installer | php && \
     /usr/src/app/composer.phar install && \
     apk del build-base && rm -fr /usr/share/ri

JSONRenderer.php

@@ -49,33 +49,33 @@ public function renderReport(Report $report)
         $writer = $this->getWriter();
 
         foreach ($report->getRuleViolations() as $violation) {
-          $rule = $violation->getRule();
-          $checkName = preg_replace("/^PHPMD\/Rule\//", "", str_replace("\\", "/", get_class($rule)));
+            $rule = $violation->getRule();
+            $checkName = preg_replace("/^PHPMD\/Rule\//", "", str_replace("\\", "/", get_class($rule)));
 
-          $path = preg_replace("/^\/code\//", "", $violation->getFileName());
-          $category = $this->ruleCategories[$checkName];
+            $path = preg_replace("/^\/code\//", "", $violation->getFileName());
+            $category = $this->ruleCategories[$checkName];
 
-          if ($category == null) {
-            $category = "Style";
-          }
+            if ($category == null) {
+                $category = "Style";
+            }
 
-          $issue = array(
-            "type" => "issue",
-            "check_name" => $checkName,
-            "description" => $violation->getDescription(),
-            "categories" => array($category),
-            "location" => array(
-              "path" => $path,
-              "lines" => array(
-                "begin" => $violation->getBeginLine(),
-                "end" => $violation->getEndLine()
-              )
-            )
-          );
+            $issue = array(
+                "type" => "issue",
+                "check_name" => $checkName,
+                "description" => $violation->getDescription(),
+                "categories" => array($category),
+                "location" => array(
+                    "path" => $path,
+                    "lines" => array(
+                        "begin" => $violation->getBeginLine(),
+                        "end" => $violation->getEndLine()
+                    )
+                )
+            );
 
-          $json = json_encode($issue, JSON_UNESCAPED_SLASHES, JSON_UNESCAPED_UNICODE);
-          $writer->write($json);
-          $writer->write(chr(0));
+            $json = json_encode($issue, JSON_UNESCAPED_SLASHES, JSON_UNESCAPED_UNICODE);
+            $writer->write($json);
+            $writer->write(chr(0));
         }
     }
 }

README.md

@@ -1,4 +1,36 @@
 # Code Climate PHP Mess Detector (PHPMD) Engine
 
-`codeclimate-phpmd` is a Code Climate Engine that wraps the PHP Mess
-Detector (PHPMD) static analysis tool.
+`codeclimate-phpmd` is a Code Climate Engine that wraps the PHP Mess Detector (PHPMD) static analysis tool.
+
+### Installation
+
+1. If you haven't already, [install the Code Climate CLI](https://github.com/codeclimate/codeclimate).
+2. Run `codeclimate engines:enable phpmd`. This command both installs the engine and enables it in your `.codeclimate.yml` file.
+3. You're ready to analyze! Browse into your project's folder and run `codeclimate analyze`.
+
+###Config Options
+
+Format the values for these config options per the [PHPMD documentation](http://phpmd.org/documentation/index.html).
+
+* file_extensions - This is where you can configure the file extensions for the files that you want PHPMD to analyze.
+* rulesets - This is the list of rulesets that you want PHPMD to use while analyzing your files.
+
+###Sample Config
+
+    exclude_paths:
+     - "/examples/**/*"
+    engines:
+      phpmd:
+        enabled: true
+        config:
+          file_extensions: "php"
+          rulesets: "unusedcode"
+    ratings:
+      paths:
+      - "**.php"
+
+### Need help?
+
+For help with PHPMD, [check out their documentation](http://phpmd.org/documentation/index.html).
+
+If you're running into a Code Climate issue, first look over this project's [GitHub Issues](https://github.com/phpmd/phpmd/issues), as your question may have already been covered. If not, [go ahead and open a support ticket with us](https://codeclimate.com/help).

Runner.php

@@ -0,0 +1,73 @@
+<?php
+
+namespace CodeClimate\PHPMD;
+
+use PHPMD\PHPMD;
+use PHPMD\RuleSetFactory;
+use PHPMD\Writer\StreamWriter;
+use PHPMD\Renderer\JSONRenderer;
+
+class Runner
+{
+    private $config;
+    private $server;
+
+    public function __construct($config, $server)
+    {
+        $this->config = $config;
+        $this->server = $server;
+    }
+
+    public function queueDirectory($dir, $prefix = '')
+    {
+        $dir = rtrim($dir, '\\/');
+
+        foreach (scandir($dir) as $f) {
+            if (in_array("$prefix$f", $this->config["exclude_paths"])) {
+                continue;
+            }
+
+            if ($f !== '.' and $f !== '..') {
+                if (is_dir("$dir/$f")) {
+                    $this->queueDirectory("$dir/$f", "$prefix$f/");
+                    continue;
+                }
+
+                $this->server->addwork(array("/code/$prefix$f"));
+            }
+        }
+
+        $this->server->process_work(false);
+    }
+
+    public function run($files)
+    {
+        $resultFile = tempnam(sys_get_temp_dir(), 'phpmd');
+
+        $renderer = new JSONRenderer();
+        $renderer->setWriter(new StreamWriter($resultFile));
+
+        $ruleSetFactory = new RuleSetFactory();
+
+        $phpmd = new PHPMD();
+
+        if (isset($this->config['config']['file_extensions'])) {
+            $phpmd->setFileExtensions(explode(',', $this->config['config']['file_extensions']));
+        }
+
+        $rulesets = "cleancode,codesize,controversial,design,naming,unusedcode";
+
+        if (isset($this->config['config']['rulesets'])) {
+            $rulesets = $this->config['config']['rulesets'];
+        }
+
+        $phpmd->processFiles(
+            implode(",", $files),
+            $rulesets,
+            array($renderer),
+            $ruleSetFactory
+        );
+
+        return $resultFile;
+    }
+}

composer.json

@@ -1,5 +1,6 @@
 {
     "require": {
-        "phpmd/phpmd": "2.2.3"
+        "phpmd/phpmd": "2.2.3",
+        "barracudanetworks/forkdaemon-php": "1.0.*"
     }
 }

engine.php

@@ -1,70 +1,40 @@
 <?php
 
+declare(ticks=1);
+
 namespace PHPMD\TextUI;
 
+use CodeClimate\PHPMD\Runner;
+
 error_reporting(E_ERROR | E_PARSE | E_NOTICE);
 date_default_timezone_set('UTC');
 ini_set('memory_limit', -1);
 
 require_once __DIR__.'/vendor/autoload.php';
 require_once "JSONRenderer.php";
+require_once "Runner.php";
 
 use PHPMD\PHPMD;
 use PHPMD\RuleSetFactory;
 use PHPMD\Writer\StreamWriter;
 use PHPMD\Renderer\JSONRenderer;
 
+// obtain the config
 $config = json_decode(file_get_contents('/config.json'), true);
 
-$renderer = new JSONRenderer();
-$renderer->setWriter(new StreamWriter(STDOUT));
-
-$ruleSetFactory = new RuleSetFactory();
-
-$all_files = scandir_recursive("/code");
-
-if ($config["exclude_paths"]) {
-  $files = array();
-
-  foreach ($all_files as $file) {
-    if (!in_array($file, $config["exclude_paths"])) {
-      $files[] = "/code/".$file;
-    }
-  }
-} else {
-  foreach ($all_files as $file) {
-    if (!in_array($file, $ignorePatterns)) {
-      $files[] = "/code/".$file;
-    }
-  }
-}
-
-$phpmd = new PHPMD();
-
-// if ($extensions !== null) {
-//     $phpmd->setFileExtensions(explode(',', $extensions));
-// }
-
-$phpmd->processFiles(
-    implode(",", $files),
-    "cleancode,codesize,controversial,design,naming,unusedcode",
-    array($renderer),
-    $ruleSetFactory
-);
+// setup forking daemon
+$server = new \fork_daemon();
+$server->max_children_set(3);
+$server->max_work_per_child_set(50);
+$server->store_result_set(true);
+$runner = new Runner($config, $server);
+$server->register_child_run(array($runner, "run"));
 
-function scandir_recursive($dir, $prefix = '') {
-  $dir = rtrim($dir, '\\/');
-  $result = array();
+$runner->queueDirectory("/code");
 
-  foreach (scandir($dir) as $f) {
-    if ($f !== '.' and $f !== '..') {
-      if (is_dir("$dir/$f")) {
-        $result = array_merge($result, scandir_recursive("$dir/$f", "$prefix$f/"));
-      } else {
-        $result[] = $prefix.$f;
-      }
-    }
-  }
+$server->process_work(true);
 
-  return $result;
+foreach ($server->get_all_results() as $result_file) {
+    echo file_get_contents($result_file);
+    unlink($result_file);
 }