Fixed issue with incorrect table header on the complexity report page

PR #421 accidentally moved the column "Relative system complexity" to the end
of the table header causing an issue where the order of the header columns
don't match the order of the data columns. A unit test has been added to validate
the expected order of the columns.

Author: Dennis Coorn

composer.json

@@ -39,7 +39,8 @@
     "require-dev": {
         "phpunit/phpunit": "^4.8.36 || ^5.7.27 || ^6.5.14",
         "sebastian/comparator": ">=1.2.3",
-        "squizlabs/php_codesniffer": "^3.5"
+        "squizlabs/php_codesniffer": "^3.5",
+        "symfony/dom-crawler": "^3.0 || ^4.0 || ^5.0"
     },
     "bin": [
         "bin/phpmetrics"

templates/html_report/complexity.php

@@ -59,13 +59,14 @@
                         <th class="js-sort-number">WMC</th>
                         <th class="js-sort-number">Class cycl.</th>
                         <th class="js-sort-number">Max method cycl.</th>
+                        <th class="js-sort-number">Relative system complexity</th>
                         <th class="js-sort-number">Relative data complexity</th>
                         <th class="js-sort-number">Relative structural complexity</th>
                         <th class="js-sort-number">Bugs</th>
                         <th class="js-sort-number">Defects</th>
                         <?php if ($config->has('junit')) { ?>
                             <th class="js-sort-number">Unit testsuites calling it</th>
-                        <?php } ?><th class="js-sort-number">Relative system complexity</th>
+                        <?php } ?>
                     </tr>
                     </thead>
                     <?php

tests/Report/Html/ComplexityReportRegressionTest.php

@@ -0,0 +1,91 @@
+<?php
+
+namespace Test\Hal\Reporter\Html;
+
+use DOMNode;
+use Hal\Application\Config\Config;
+use Hal\Component\Output\TestOutput;
+use Hal\Metric\Group\Group;
+use Hal\Metric\Metrics;
+use Hal\Report\Html\Reporter;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\DomCrawler\Crawler;
+
+/**
+ * @group reporter
+ * @group html
+ */
+class ComplexityReportRegressionTest extends TestCase
+{
+    /**
+     * @dataProvider tableHeaderDataProvider
+     */
+    public function testComplexityHtmlReportContainsCorrectOrderOfTableColumns($junitEnabled, $expectedTableHeader)
+    {
+        $config = new Config();
+        $output = new TestOutput();
+        $reporter = new Reporter($config, $output);
+
+        // prepares data for report
+        $groups = [];
+        $groups[] = new Group('group', '.*');
+        $config->set('groups', $groups);
+
+        if ($junitEnabled) {
+            $config->set('junit', ['file' => '/tmp/junit.xml']);
+        }
+
+        // prepares destination
+        $destination = implode(DIRECTORY_SEPARATOR, [
+            sys_get_temp_dir(),
+            'phpmetrics-html' . uniqid('', true)
+        ]);
+
+        $config->set('report-html', $destination);
+
+        // generates report
+        $metrics = new Metrics();
+        $reporter->generate($metrics);
+
+        // ensure complexity report contains expected table header columns
+        $content = file_get_contents(sprintf('%s/complexity.html', $destination));
+        $actualTableHeader = $this->getActualTableHeader($content);
+
+        $this->assertEquals($expectedTableHeader, $actualTableHeader);
+    }
+
+    public function tableHeaderDataProvider()
+    {
+        $defaultTableHeader = [
+            'Class',
+            'WMC',
+            'Class cycl.',
+            'Max method cycl.',
+            'Relative system complexity',
+            'Relative data complexity',
+            'Relative structural complexity',
+            'Bugs',
+            'Defects',
+        ];
+
+        $junitTableHeader = array_merge($defaultTableHeader, [
+            'Unit testsuites calling it'
+        ]);
+
+        return [
+            'junit disabled' => [false, $defaultTableHeader],
+            'junit enabled' => [true, $junitTableHeader],
+        ];
+    }
+
+    private function getActualTableHeader($content)
+    {
+        $tableHeaderColumnNodes = (new Crawler($content))
+            ->filterXPath('.//table[contains(concat(" ",normalize-space(@class)," ")," js-sort-table ")]/thead/tr')
+            ->children();
+
+        return array_map(function (DomNode $node) {
+            return $node->textContent;
+        }, iterator_to_array($tableHeaderColumnNodes));
+    }
+}