Merge pull request #428 from phpmetrics/config_group

Way to analyze by layer

Author: Halleck45

README.md

@@ -23,13 +23,55 @@ PhpMetrics provides metrics about PHP project and classes, with beautiful and re
 ## Quick start
 
     composer require phpmetrics/phpmetrics --dev
-    php ./vendor/bin/phpmetrics --report-html=myreport .
+    php ./vendor/bin/phpmetrics --report-html=myreport <folder-to-analyze>
 
 Then open the generated `./myreport/index.html` file in your browser. 
 
+## Configuration file
+
+Use the `--config=<file>.json` option. For example:
+
+```json
+{
+    "includes": [   // directory and files to analyze, relative to config file directory 
+        "src"
+    ],
+    "exclude": [    // regex of files (or directory) to exclude from analyze
+      "tests"
+    ],
+    "report": {     // list of reports to generate (html, json, csv or violation)
+        "html": "/tmp/report/",             // destination directory of HTML report 
+        "csv": "/tmp/report.csv",           // destination file for CSV report
+        "json": "/tmp/report.json",         // destination file for JSON report
+        "violations": "/tmp/violations.xml" // destination file for XML violations report
+    },
+    "groups": [     // "layers" of code. You can group your classes and packages by regex, to visualise specific HTML report for each of them
+        {
+            "name": "Component",      // name of the layer
+            "match": "!component!i"   // regular expression used to match the group (based on the name of the fully qualified class name)
+                                      // remember to double escape (for json, then for regex): set "!\\\\MyPackage\\\\!" if you want to capture expression "\MyPackage\"
+        },
+        {
+            "name": "Example",
+            "match": "!example!"
+        }
+    ],
+    "plugins": {
+        "git": {
+            "binary": "git"           // if defined, runs git analyze
+        },
+        "junit": {
+            "file": "/tmp/junit.xml"  // if defined, JUnit report file will be analyzed            
+        }
+    }
+    "extensions": [ "php", "php8" ],        // default: ["php", "inc"]
+}
+```
+
 ## More
 
-If want, you can [install](https://github.com/phpmetrics/PhpMetrics/blob/master/doc/installation.md) PhpMetrics globally with your favorite package manager. You can also visit our [documentation](http://www.phpmetrics.org/documentation/index.html).
+If want, you can [install](doc/installation.md) PhpMetrics globally with your favorite package manager (APT, Brew...). You can also visit our [documentation](http://www.phpmetrics.org/documentation/index.html).
+
 
 ## Metrics list
 

config-example.json

@@ -0,0 +1,24 @@
+{
+    "includes": [
+        "Controller"
+    ],
+    "excludes": [
+        "tests"
+    ],
+    "report": {
+        "html": "/tmp/report/",
+        "csv": "/tmp/report.csv",
+        "json": "/tmp/report.json",
+        "violations": "/tmp/violations.xml"
+    },
+    "groups": [
+        {
+            "name": "Component",
+            "match": "!component!i"
+        },
+        {
+            "name": "Reporters",
+            "match": "!Report!"
+        }
+    ]
+}

config.json

@@ -0,0 +1,36 @@
+{
+    "includes": [
+        "src/Hal/Component"
+    ],
+    "excludes": [
+        "tests"
+    ],
+    "extensions": [
+        "php",
+        "php8"
+    ],
+    "report": {
+        "html": "/tmp/report/",
+        "csv": "/tmp/report.csv",
+        "json": "/tmp/report.json",
+        "violations": "/tmp/violations.xml"
+    },
+    "groups": [
+        {
+            "name": "Component",
+            "match": "!component!i"
+        },
+        {
+            "name": "App",
+            "match": "!app!i"
+        }
+    ],
+    "plugins": {
+        "git": {
+            "binary": "git"
+        },
+        "junit": {
+            "file": "/tmp/junit.xml"
+        }
+    }
+}

doc/installation.md

@@ -13,7 +13,7 @@ Please note that the `~/.composer/vendor/bin` directory must be in your `$PATH`.
 export PATH=~/.composer/vendor/bin:$PATH
 ```
 
-## Phar
+## Phar
 
 ```bash
 curl https://github.com/phpmetrics/PhpMetrics/releases/download/v2.6.2/phpmetrics.phar
@@ -40,7 +40,7 @@ brew install phpmetrics
 yaourt install phpmetrics
 ```
 
-## Docker
+## Docker
 
 ```bash
 docker run --rm \

src/Hal/Application/Config/File/ConfigFileReaderJson.php

@@ -36,36 +36,64 @@ public function read(Config $config)
 
         $jsonData = json_decode($jsonText, true);
 
-        if (false === $jsonData) {
+        if (false === $jsonData || null === $jsonData) {
             throw new \InvalidArgumentException("Bad json file '{$this->filename}'");
         }
 
-        $jsonDataImploded = $this->collapseArray($jsonData);
+        if (isset($jsonData['includes'])) {
+            $includes = $jsonData['includes'];
+            $files = [];
+            // with config file, includes are relative to config file
+            foreach ($includes as $include) {
+                $include = $this->resolvePath($include);
+                $files[] = $include;
+            }
+            $config->set('files', $files);
+        }
+
+        if (isset($jsonData['groups'])) {
+            $config->set('groups', $jsonData['groups']);
+        }
+
+        if (isset($jsonData['extensions'])) {
+            $config->set('extensions', implode(',', $jsonData['extensions']));
+        }
+
+        if (isset($jsonData['excludes'])) {
+            // retro-compatibility
+            // "exclude" is a string
+            // excludes is an array
+            $config->set('exclude', implode(',', $jsonData['excludes']));
+        } else if (isset($jsonData['exclude'])) {
+            $config->set('exclude', $jsonData['exclude']);
+        }
 
-        foreach ($jsonDataImploded as $key => $value) {
-            $config->set($key, $value);
+        if (isset($jsonData['plugins'], $jsonData['plugins']['git'], $jsonData['plugins']['git']['binary'])) {
+            $config->set('git', $jsonData['plugins']['git']['binary']);
+        }
+
+        if (isset($jsonData['plugins'], $jsonData['plugins']['junit'], $jsonData['plugins']['junit']["report"])) {
+            $config->set('junit', $jsonData['plugins']['junit']["report"]);
+        }
+
+        // reports
+        if (isset($jsonData['report']) && is_array($jsonData['report'])) {
+            foreach ($jsonData['report'] as $reportType => $path) {
+                $path = $this->resolvePath($path);
+                $config->set('report-' . $reportType, $path);
+            }
         }
     }
 
     /**
-     * Collapses array into a one-dimensional one by imploding nested keys with '-'
-     *
-     * @param array $arr
-     *
-     * @return array
+     * @return string
      */
-    private function collapseArray(array $arr)
+    private function resolvePath($path)
     {
-        $iterator = new RecursiveIteratorIterator(new RecursiveArrayIterator($arr));
-        $result = [];
-        foreach ($iterator as $leafValue) {
-            $keys = [];
-            foreach (range(0, $iterator->getDepth()) as $depth) {
-                $keys[] = $iterator->getSubIterator($depth)->key();
-            }
-            $result[implode('-', $keys)] = $leafValue;
+        if (DIRECTORY_SEPARATOR !== $path[0]) {
+             $path = dirname($this->filename) . DIRECTORY_SEPARATOR . $path;
         }
 
-        return $result;
+        return $path;
     }
 }

src/Hal/Application/Config/Validator.php

@@ -1,6 +1,9 @@
 <?php
+
 namespace Hal\Application\Config;
 
+use Hal\Metric\Group\Group;
+
 /**
  * @package Hal\Application\Config
  */
@@ -32,10 +35,26 @@ public function validate(Config $config)
         if (!$config->has('exclude')) {
             $config->set('exclude', 'vendor,test,Test,tests,Tests,testing,Testing,bower_components,node_modules,cache,spec');
         }
+
+        // retro-compatibility with excludes as string in config files
+        if (is_array($config->get('exclude'))) {
+            $config->set('exclude', implode(',', $config->get('exclude')));
+        }
         $config->set('exclude', array_filter(explode(',', $config->get('exclude'))));
 
+        // groups by regex
+        if (!$config->has('groups')) {
+            $config->set('groups', []);
+        }
+        $groupsRaw = $config->get('groups');
+
+        $groups = array_map(static function (array $groupRaw): Group {
+            return new Group($groupRaw['name'], $groupRaw['match']);
+        }, $groupsRaw);
+        $config->set('groups', $groups);
+
         // parameters with values
-        $keys = ['report-html', 'report-csv', 'report-violation', '--report-json', 'extensions'];
+        $keys = ['report-html', 'report-csv', 'report-violation', 'report-json', 'extensions', 'config'];
         foreach ($keys as $key) {
             $value = $config->get($key);
             if ($config->has($key) && empty($value) || true === $value) {
@@ -60,6 +79,7 @@ public function help()
 
 Optional:
 
+    --config=<file>                   Use a file for configuration
     --exclude=<directory>             List of directories to exclude, separated by a comma (,)
     --extensions=<php,inc>            List of extensions to parse, separated by a comma (,)
     --report-html=<directory>         Folder where report HTML will be generated

src/Hal/Metric/Group/Group.php

@@ -0,0 +1,70 @@
+<?php
+
+namespace Hal\Metric\Group;
+
+use Hal\Metric\Metrics;
+
+/**
+ * Class Group
+ * Allows to group metrics by regex, given them a name
+ * @package Hal\Metric\Group
+ */
+class Group
+{
+    /**
+     * @var string
+     */
+    private $name;
+
+    /**
+     * @var string
+     */
+    private $regex;
+
+    /**
+     * Group constructor.
+     * @param string $name
+     * @param string $regex
+     */
+    public function __construct($name, $regex)
+    {
+        $this->name = $name;
+        $this->regex = $regex;
+    }
+
+    /**
+     * @return string
+     */
+    public function getName()
+    {
+        return $this->name;
+    }
+
+    /**
+     * @return string
+     */
+    public function getRegex()
+    {
+        return $this->regex;
+    }
+
+    /**
+     * @param Metrics $metrics
+     * @return Metrics
+     */
+    public function reduceMetrics(Metrics $metrics)
+    {
+        $all = $metrics->all();
+        $matched = new Metrics();
+
+        foreach ($all as $metric) {
+            if (!preg_match($this->regex, $metric->getName())) {
+                continue;
+            }
+
+            $matched->attach($metric);
+        }
+
+        return $matched;
+    }
+}