Skip to content

Commit e51b3d2

Browse files
Halleck45Halleck45
authored
Merge pull request #467 from roelbaka/addJsonSummary
Add command to get summary as Json
2 parents da1e22d + 71647d0 commit e51b3d2

File tree

7 files changed

+287
-99
lines changed

7 files changed

+287
-99
lines changed

‎src/Hal/Application/Application.php‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ public function run(array $argv)
9292
(new Report\Html\Reporter($config, $output))->generate($metrics);
9393
(new Report\Csv\Reporter($config, $output))->generate($metrics);
9494
(new Report\Json\Reporter($config, $output))->generate($metrics);
95+
(new Report\Json\SummaryReporter($config, $output))->generate($metrics);
9596
(new Report\Violations\Xml\Reporter($config, $output))->generate($metrics);
9697

9798
// exit status

‎src/Hal/Application/Config/Validator.php‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ public function validate(Config $config)
7171
$validator->validates($config->get('searches'));
7272

7373
// parameters with values
74-
$keys = ['report-html', 'report-csv', 'report-violation', 'report-json', 'extensions', 'config'];
74+
$keys = ['report-html', 'report-csv', 'report-violation', 'report-json', 'report-summary-json', 'extensions', 'config'];
7575
foreach ($keys as $key) {
7676
$value = $config->get($key);
7777
if ($config->has($key) && empty($value) || true === $value) {
@@ -103,6 +103,7 @@ public function help()
103103
--report-html=<directory> Folder where report HTML will be generated
104104
--report-csv=<file> File where report CSV will be generated
105105
--report-json=<file> File where report Json will be generated
106+
--report-summary-json=<file> File where the summary report Json will be generated
106107
--report-violations=<file> File where XML violations report will be generated
107108
--git[=</path/to/git_binary>] Perform analyses based on Git History (default binary path: "git")
108109
--junit[=</path/to/junit.xml>] Evaluates metrics according to JUnit logs

‎src/Hal/Report/Cli/Reporter.php‎

Lines changed: 3 additions & 98 deletions
Original file line numberDiff line numberDiff line change
@@ -29,109 +29,14 @@ public function __construct(Config $config, Output $output)
2929
$this->output = $output;
3030
}
3131

32-
3332
public function generate(Metrics $metrics)
3433
{
3534
if ($this->config->has('quiet')) {
3635
return;
3736
}
3837

39-
// grouping results
40-
$consolidated = new Consolidated($metrics);
41-
$sum = $consolidated->getSum();
42-
$avg = $consolidated->getAvg();
43-
44-
$methodsByClass = $locByClass = $locByMethod = 0;
45-
if ($sum->nbClasses > 0) {
46-
$methodsByClass = round($sum->nbMethods / $sum->nbClasses, 2);
47-
$locByClass = round($sum->lloc / $sum->nbClasses);
48-
}
49-
if ($sum->nbMethods > 0) {
50-
$locByMethod = round($sum->lloc / $sum->nbMethods);
51-
}
52-
53-
$out = <<<EOT
54-
LOC
55-
Lines of code {$sum->loc}
56-
Logical lines of code {$sum->lloc}
57-
Comment lines of code {$sum->cloc}
58-
Average volume {$avg->volume}
59-
Average comment weight {$avg->commentWeight}
60-
Average intelligent content {$avg->commentWeight}
61-
Logical lines of code by class {$locByClass}
62-
Logical lines of code by method {$locByMethod}
63-
64-
Object oriented programming
65-
Classes {$sum->nbClasses}
66-
Interface {$sum->nbInterfaces}
67-
Methods {$sum->nbMethods}
68-
Methods by class {$methodsByClass}
69-
Lack of cohesion of methods {$avg->lcom}
70-
71-
Coupling
72-
Average afferent coupling {$avg->afferentCoupling}
73-
Average efferent coupling {$avg->efferentCoupling}
74-
Average instability {$avg->instability}
75-
Depth of Inheritance Tree {$metrics->get('tree')->get('depthOfInheritanceTree')}
76-
77-
Package
78-
Packages {$sum->nbPackages}
79-
Average classes per package {$avg->classesPerPackage}
80-
Average distance {$avg->distance}
81-
Average incoming class dependencies {$avg->incomingCDep}
82-
Average outgoing class dependencies {$avg->outgoingCDep}
83-
Average incoming package dependencies {$avg->incomingPDep}
84-
Average outgoing package dependencies {$avg->outgoingPDep}
85-
86-
Complexity
87-
Average Cyclomatic complexity by class {$avg->ccn}
88-
Average Weighted method count by class {$avg->wmc}
89-
Average Relative system complexity {$avg->relativeSystemComplexity}
90-
Average Difficulty {$avg->difficulty}
91-
92-
Bugs
93-
Average bugs by class {$avg->bugs}
94-
Average defects by class (Kan) {$avg->kanDefect}
95-
96-
Violations
97-
Critical {$sum->violations->critical}
98-
Error {$sum->violations->error}
99-
Warning {$sum->violations->warning}
100-
Information {$sum->violations->information}
101-
102-
EOT;
103-
104-
// git
105-
if ($this->config->has('git')) {
106-
$commits = [];
107-
foreach ($consolidated->getFiles() as $name => $file) {
108-
$commits[$name] = $file['gitChanges'];
109-
}
110-
arsort($commits);
111-
$commits = array_slice($commits, 0, 10);
112-
113-
$out .= "\nTop 10 committed files";
114-
foreach ($commits as $file => $nb) {
115-
$out .= sprintf("\n %d %s", $nb, $file);
116-
}
117-
if (0 === count($commits)) {
118-
$out .= "\n NA";
119-
}
120-
$out .= "\n";
121-
}
122-
123-
// Junit
124-
if ($this->config->has('junit')) {
125-
$out .= <<<EOT
126-
127-
Unit testing
128-
Number of unit tests {$metrics->get('unitTesting')->get('nbSuites')}
129-
Classes called by tests {$metrics->get('unitTesting')->get('nbCoveredClasses')}
130-
Classes called by tests (percent) {$metrics->get('unitTesting')->get('percentCoveredClasses')} %
131-
EOT;
132-
}
133-
134-
$out .= "\n\n";
135-
$this->output->write($out);
38+
$this->output->write(
39+
(new SummaryWriter($metrics, new Consolidated($metrics), $this->config))->getReport()
40+
);
13641
}
13742
}

‎src/Hal/Report/Cli/SummaryWriter.php‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
<?php
2+
3+
namespace Hal\Report\Cli;
4+
5+
use Hal\Report\SummaryProvider;
6+
7+
class SummaryWriter extends SummaryProvider
8+
{
9+
public function getReport()
10+
{
11+
$out = <<<EOT
12+
LOC
13+
Lines of code {$this->sum->loc}
14+
Logical lines of code {$this->sum->lloc}
15+
Comment lines of code {$this->sum->cloc}
16+
Average volume {$this->avg->volume}
17+
Average comment weight {$this->avg->commentWeight}
18+
Average intelligent content {$this->avg->commentWeight}
19+
Logical lines of code by class {$this->locByClass}
20+
Logical lines of code by method {$this->locByMethod}
21+
Object oriented programming
22+
Classes {$this->sum->nbClasses}
23+
Interface {$this->sum->nbInterfaces}
24+
Methods {$this->sum->nbMethods}
25+
Methods by class {$this->methodsByClass}
26+
Lack of cohesion of methods {$this->avg->lcom}
27+
28+
Coupling
29+
Average afferent coupling {$this->avg->afferentCoupling}
30+
Average efferent coupling {$this->avg->efferentCoupling}
31+
Average instability {$this->avg->instability}
32+
Depth of Inheritance Tree {$this->treeInheritenceDepth}
33+
34+
Package
35+
Packages {$this->sum->nbPackages}
36+
Average classes per package {$this->avg->classesPerPackage}
37+
Average distance {$this->avg->distance}
38+
Average incoming class dependencies {$this->avg->incomingCDep}
39+
Average outgoing class dependencies {$this->avg->outgoingCDep}
40+
Average incoming package dependencies {$this->avg->incomingPDep}
41+
Average outgoing package dependencies {$this->avg->outgoingPDep}
42+
Complexity
43+
Average Cyclomatic complexity by class {$this->avg->ccn}
44+
Average Weighted method count by class {$this->avg->wmc}
45+
Average Relative system complexity {$this->avg->relativeSystemComplexity}
46+
Average Difficulty {$this->avg->difficulty}
47+
48+
Bugs
49+
Average bugs by class {$this->avg->bugs}
50+
Average defects by class (Kan) {$this->avg->kanDefect}
51+
Violations
52+
Critical {$this->sum->violations->critical}
53+
Error {$this->sum->violations->error}
54+
Warning {$this->sum->violations->warning}
55+
Information {$this->sum->violations->information}
56+
EOT;
57+
58+
// git
59+
if ($this->config->has('git')) {
60+
$commits = [];
61+
foreach ($this->consolidated->getFiles() as $name => $file) {
62+
$commits[$name] = $file['gitChanges'];
63+
}
64+
arsort($commits);
65+
$commits = array_slice($commits, 0, 10);
66+
67+
$out .= "\nTop 10 committed files";
68+
foreach ($commits as $file => $nb) {
69+
$out .= sprintf("\n %d %s", $nb, $file);
70+
}
71+
if (0 === count($commits)) {
72+
$out .= "\n NA";
73+
}
74+
$out .= "\n";
75+
}
76+
77+
// Junit
78+
if ($this->config->has('junit')) {
79+
$out .= <<<EOT
80+
81+
Unit testing
82+
Number of unit tests {$this->metrics->get('unitTesting')->get('nbSuites')}
83+
Classes called by tests {$this->metrics->get('unitTesting')->get('nbCoveredClasses')}
84+
Classes called by tests (percent) {$this->metrics->get('unitTesting')->get('percentCoveredClasses')} %
85+
EOT;
86+
}
87+
88+
$out .= "\n\n";
89+
90+
return $out;
91+
}
92+
}

‎src/Hal/Report/Json/SummaryReporter.php‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
<?php
2+
3+
namespace Hal\Report\Json;
4+
5+
use Hal\Application\Config\Config;
6+
use Hal\Component\Output\Output;
7+
use Hal\Metric\Consolidated;
8+
use Hal\Metric\Metrics;
9+
use Hal\Report\SummaryProvider;
10+
11+
class SummaryReporter
12+
{
13+
/**
14+
* @var Config
15+
*/
16+
private $config;
17+
18+
/**
19+
* @var Output
20+
*/
21+
private $output;
22+
23+
/**
24+
* @param Config $config
25+
* @param Output $output
26+
*/
27+
public function __construct(Config $config, Output $output)
28+
{
29+
$this->config = $config;
30+
$this->output = $output;
31+
}
32+
33+
public function generate(Metrics $metrics)
34+
{
35+
if ($this->config->has('quiet')) {
36+
return;
37+
}
38+
39+
$logFile = $this->config->get('report-summary-json');
40+
if (!$logFile) {
41+
return;
42+
}
43+
if (!file_exists(dirname($logFile)) || !is_writable(dirname($logFile))) {
44+
throw new \RuntimeException('You don\'t have permissions to write JSON report in ' . $logFile);
45+
}
46+
47+
$summaryWriter = new SummaryWriter($metrics, new Consolidated($metrics), $this->config);
48+
file_put_contents($logFile, json_encode($summaryWriter->getReport(), JSON_PRETTY_PRINT));
49+
}
50+
}

‎src/Hal/Report/Json/SummaryWriter.php‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
<?php
2+
3+
namespace Hal\Report\Json;
4+
5+
use Hal\Report\SummaryProvider;
6+
7+
class SummaryWriter extends SummaryProvider
8+
{
9+
public function getReport()
10+
{
11+
return [
12+
'LOC' => [
13+
'linesOfCode' => $this->sum->loc,
14+
'logicalLinesOfCode' => $this->sum->lloc,
15+
'commentLinesOfCode' => $this->sum->cloc,
16+
'avgVolume' => $this->avg->volume,
17+
'avgCommentWeight' => $this->avg->commentWeight,
18+
'avgIntelligentContent ' => $this->avg->commentWeight,
19+
'logicalLinesByClass' => $this->locByClass,
20+
'logicalLinesByMethod' => $this->locByMethod,
21+
],
22+
'OOP' => [
23+
'classes' => $this->sum->nbClasses,
24+
'interface' => $this->sum->nbInterfaces,
25+
'methods' => $this->sum->nbMethods,
26+
'methodsByClass' => $this->methodsByClass,
27+
'lackCohesionOfMethods' => $this->avg->lcom,
28+
],
29+
'Coupling' => [
30+
'avgAfferentCoupling' => $this->avg->afferentCoupling,
31+
'avgEfferentCoupling' => $this->avg->efferentCoupling,
32+
'avgInstability' => $this->avg->instability,
33+
'inheritanceTreeDepth' => $this->treeInheritenceDepth,
34+
],
35+
'Package' => [
36+
'packages' => $this->sum->nbPackages,
37+
'acgClassesPerPackage ' => $this->avg->classesPerPackage,
38+
'avgDistance' => $this->avg->distance,
39+
'avgIncomingClassDependencies' => $this->avg->incomingCDep,
40+
'avgOutgoingClassDependencies' => $this->avg->outgoingCDep,
41+
'avgIncomingPackageDependencies' => $this->avg->incomingPDep,
42+
'avgOutgoingPackageDependencies' => $this->avg->outgoingPDep,
43+
],
44+
'Complexity' => [
45+
'avgCyclomaticComplexityByClass' => $this->avg->ccn,
46+
'avgWeightedMethodCountByClass' => $this->avg->wmc,
47+
'avgRelativeSystemComplexity' => $this->avg->relativeSystemComplexity,
48+
'avgDifficulty' => $this->avg->difficulty,
49+
],
50+
'Bugs' => [
51+
'avgBugsByClass' => $this->avg->bugs,
52+
'avgDefectsByClass' => $this->avg->kanDefect,
53+
],
54+
'Violations' => [
55+
'critical' => $this->sum->violations->critical,
56+
'error' => $this->sum->violations->error,
57+
'warning' => $this->sum->violations->warning,
58+
'information' => $this->sum->violations->information,
59+
]
60+
];
61+
}
62+
}

0 commit comments

Comments
 (0)