From 59072051c1194377fc301a273c4c77437b09d3b1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Zden=C4=9Bk=20Draho=C5=A1?= <drahoszdenek@gmail.com>
Date: Sat, 15 Oct 2016 10:17:04 +0200
Subject: [PATCH] Reports  - searchable pdepend dependencies

Inspired by dependencies in Qafoo
https://github.com/Qafoo/QualityAnalyzer
---
 README.md                  |  2 +-
 app/report/pdepend.xsl     | 90 +++++++++++++++++++++++++++++++++++---
 app/report/phpqa.html.twig |  1 +
 src/CodeAnalysisTasks.php  |  3 +-
 4 files changed, 89 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index d1e2b904..0fa67adc 100644
--- a/README.md
+++ b/README.md
@@ -121,7 +121,7 @@ Tool | `--output file` (default) - generated files | `--output cli` |
 phploc | [phploc.xml](https://edgedesigncz.github.io/phpqa/report/phploc.xml) | [✓](https://github.com/sebastianbergmann/phploc#analyse-a-directory-and-print-the-result) |
 phpcpd | [phpcpd.xml](https://edgedesigncz.github.io/phpqa/report/phpcpd.xml) | [✓](https://github.com/sebastianbergmann/phpcpd#usage-example) |
 phpcs | [checkstyle.xml](https://edgedesigncz.github.io/phpqa/report/checkstyle.xml) | [full report](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Reporting#printing-full-and-summary-reports) |
-pdepend | [pdepend-jdepend.xml](https://edgedesigncz.github.io/phpqa/report/pdepend-jdepend.xml), [pdepend-summary.xml](https://edgedesigncz.github.io/phpqa/report/pdepend-summary.xml), [pdepend-jdepend.svg](https://edgedesigncz.github.io/phpqa/report/pdepend-jdepend.svg), [pdepend-pyramid.svg](https://edgedesigncz.github.io/phpqa/report/pdepend-pyramid.svg) | ✗ |
+pdepend | [pdepend-jdepend.xml](https://edgedesigncz.github.io/phpqa/report/pdepend-jdepend.xml), [pdepend-summary.xml](https://edgedesigncz.github.io/phpqa/report/pdepend-summary.xml), [pdepend-dependencies.xml](https://edgedesigncz.github.io/phpqa/report/pdepend-dependencies.xml), [pdepend-jdepend.svg](https://edgedesigncz.github.io/phpqa/report/pdepend-jdepend.svg), [pdepend-pyramid.svg](https://edgedesigncz.github.io/phpqa/report/pdepend-pyramid.svg) | ✗ |
 phpmd | [phpmd.xml](https://edgedesigncz.github.io/phpqa/report/phpmd.xml) | [✓](https://github.com/phpmd/phpmd/blob/master/src/main/php/PHPMD/Renderer/TextRenderer.php#L47) |
 phpmetrics | [phpmetrics.html](https://edgedesigncz.github.io/phpqa/report/phpmetrics.html), [phpmetrics.xml](https://edgedesigncz.github.io/phpqa/report/phpmetrics.xml) | [✓](https://github.com/phpmetrics/PhpMetrics#usage) |
 
diff --git a/app/report/pdepend.xsl b/app/report/pdepend.xsl
index ea32cd91..0f773e70 100644
--- a/app/report/pdepend.xsl
+++ b/app/report/pdepend.xsl
@@ -51,13 +51,13 @@
         margin-right:2em;
       }
 
-        .fixed-links {
+        .fixed-navbar {
             list-style-type: none;
             position: fixed;
-            top: 3em;
+            top: 0;
             right: 1em;
         }
-        .fixed-links li {
+        .fixed-navbar li {
             display: inline-block;
             margin-left: 1ex;
         }
@@ -100,6 +100,9 @@
                     <li role="presentation">
                         <a href="#packages" aria-controls="packages" role="tab" data-toggle="tab">Packages</a>
                     </li>
+                    <li role="presentation">
+                        <a href="#dependencies" aria-controls="dependencies" role="tab" data-toggle="tab">Dependencies</a>
+                    </li>
                     <li role="presentation">
                         <a href="#metrics" aria-controls="metrics" role="tab" data-toggle="tab">Metrics</a>
                     </li>
@@ -153,6 +156,9 @@
                 <div role="tabpanel" class="tab-pane" id="packages">
                     <xsl:apply-templates select="./Packages"></xsl:apply-templates>
                 </div>
+                <div role="tabpanel" class="tab-pane" id="dependencies">
+                    <xsl:apply-templates select="./dependencies"></xsl:apply-templates>
+                </div>
                 <div role="tabpanel" class="tab-pane" id="metrics">
                     <xsl:apply-templates select="./metrics"></xsl:apply-templates>
                 </div>
@@ -171,7 +177,7 @@
 <!-- XSL from https://github.com/elnebuloso/phing-commons/blob/cc8478f930b38fe7542542d9490128e73d707356/resources/ -->
 <xsl:template match="Packages">
 
-    <ul class="fixed-links">
+    <ul class="fixed-navbar">
         <li><a class="label label-default" href="#NVsummary">summary</a></li>
         <li><a class="label label-default" href="#NVpackages">packages</a></li>
         <li><a class="label label-default" href="#NVcycles">cycles</a></li>
@@ -358,9 +364,83 @@
 
 </xsl:template>
 
+<!-- inspired by Dependencies in Qafoo https://github.com/Qafoo/QualityAnalyzer/blob/master/src/images/screen.png -->
+<xsl:template match="dependencies">
+    <div class="fixed-navbar">
+        <div class="input-group" style="width: 20em">
+            <span class="input-group-addon">Filter</span>
+            <input data-search="dependencies" type="text" class="form-control" placeholder="progressbar..." />
+        </div>
+        <small class="help-block">Results count: <strong data-results-count=""></strong></small>
+    </div>
+
+    <script>
+    onDocumentReady.push(function () {
+        var rows = $('[data-filterable] tbody tr');
+        var dependencies = rows.find('[data-dependency], small.text-muted');
+        var resultsCount = $('[data-results-count]');
+
+        $("[data-search]").keyup(function () {
+            var term = $(this).val().toLowerCase();
+
+            rows.hide();
+            var visibleRows = matchElements(rows);
+            visibleRows.show();
+            resultsCount.text(visibleRows.length);
+
+            dependencies.removeClass('highlight');
+            if (term) {
+                matchElements(dependencies).addClass('highlight');
+            }
+
+            function matchElements(elements) {
+                return elements.filter(function () {
+                    var rowContent = $(this).text().toLowerCase();
+                    return rowContent.indexOf(term) !== -1
+                });
+            }
+        });
+    });
+    </script>
+    <style>.highlight {background: yellow}</style>
+
+    <table class="table table-bordered details" data-filterable="dependencies">
+        <thead>
+            <tr>
+                <th>Dependency</th>
+                <th>Efferent Couplings</th>
+                <th>Afferent Couplings</th>
+            </tr>
+        </thead>
+    <xsl:for-each select="./package"> 
+        <xsl:for-each select="./*"> 
+        <tr>
+            <td>
+                <strong data-dependency=""> 
+                    <xsl:value-of select="./../@name"/>\<xsl:value-of select="@name"/> 
+                </strong> 
+                <br />
+                <small class="text-muted"><xsl:value-of select="name(.)"/></small>
+            </td> 
+            <td>
+                <xsl:for-each select="./efferent/type"> 
+                    <span data-dependency=""><xsl:value-of select="@namespace" />\<xsl:value-of select="@name" /></span><br />
+                </xsl:for-each> 
+            </td>
+            <td>
+                <xsl:for-each select="./afferent/type"> 
+                    <span data-dependency=""><xsl:value-of select="@namespace" />\<xsl:value-of select="@name" /></span><br />
+                </xsl:for-each> 
+            </td>
+        </tr>
+        </xsl:for-each> 
+    </xsl:for-each> 
+    </table>
+</xsl:template>
+
 <!-- XSL from https://gist.github.com/garex/5cd9b97c40f3369cb8cf60f253868df9 -->
 <xsl:template match="metrics">
-    <div class="fixed-links">
+    <div class="fixed-navbar">
         <div class="checkbox-inline">
             <label>
                 <input type="checkbox" id="class-ranks" />
diff --git a/app/report/phpqa.html.twig b/app/report/phpqa.html.twig
index f68ec526..3038269f 100644
--- a/app/report/phpqa.html.twig
+++ b/app/report/phpqa.html.twig
@@ -10,6 +10,7 @@ set tabs = {
     'pdepend': {
         'overview': 'Overview',
         'packages': 'Packages',
+        'dependencies': 'Dependencies',
         'metrics': 'Metrics',
     }
 }
diff --git a/src/CodeAnalysisTasks.php b/src/CodeAnalysisTasks.php
index 0d26920e..7ce1ec05 100644
--- a/src/CodeAnalysisTasks.php
+++ b/src/CodeAnalysisTasks.php
@@ -25,7 +25,7 @@ trait CodeAnalysisTasks
         ),
         'pdepend' => array(
             'optionSeparator' => '=',
-            'xml' => ['pdepend-jdepend.xml', 'pdepend-summary.xml'],
+            'xml' => ['pdepend-jdepend.xml', 'pdepend-summary.xml', 'pdepend-dependencies.xml'],
         ),
         'phpcpd' => array(
             'optionSeparator' => ' ',
@@ -181,6 +181,7 @@ private function pdepend()
         return array(
             'jdepend-xml' => $this->options->toFile('pdepend-jdepend.xml'),
             'summary-xml' => $this->options->toFile('pdepend-summary.xml'),
+            'dependency-xml' => $this->options->toFile('pdepend-dependencies.xml'),
             'jdepend-chart' => $this->options->toFile('pdepend-jdepend.svg'),
             'overview-pyramid' => $this->options->toFile('pdepend-pyramid.svg'),
             $this->options->ignore->pdepend(),