Adding a markdown report generator (#50)

floriankraemer · web-flow · commit 9a4afdbfce0c · 2025-10-02T23:04:53.000+02:00
diff --git a/src/Business/Cognitive/Exporter/MarkdownExporter.php b/src/Business/Cognitive/Exporter/MarkdownExporter.php
diff --git a/src/Business/MetricsFacade.php b/src/Business/MetricsFacade.php
@@ -13,6 +13,7 @@
 use Phauthentic\CognitiveCodeAnalysis\Business\Cognitive\Exporter\CsvExporter;
 use Phauthentic\CognitiveCodeAnalysis\Business\Cognitive\Exporter\HtmlExporter;
 use Phauthentic\CognitiveCodeAnalysis\Business\Cognitive\Exporter\JsonExporter;
+use Phauthentic\CognitiveCodeAnalysis\Business\Cognitive\Exporter\MarkdownExporter;
 use Phauthentic\CognitiveCodeAnalysis\Business\Cognitive\ScoreCalculator;
 use Phauthentic\CognitiveCodeAnalysis\CognitiveAnalysisException;
 use Phauthentic\CognitiveCodeAnalysis\Config\CognitiveConfig;
@@ -171,10 +172,13 @@ public function exportMetricsReport(
         string $reportType,
         string $filename
     ): void {
+        $config = $this->configService->getConfig();
+
         match ($reportType) {
             'json' => (new JsonExporter())->export($metricsCollection, $filename),
             'csv'  => (new CsvExporter())->export($metricsCollection, $filename),
             'html' => (new HtmlExporter())->export($metricsCollection, $filename),
+            'markdown' => (new MarkdownExporter($config))->export($metricsCollection, $filename),
             default => null,
         };
     }
diff --git a/src/Command/Handler/CognitiveMetricsReportHandler.php b/src/Command/Handler/CognitiveMetricsReportHandler.php
@@ -56,7 +56,7 @@ private function hasIncompleteReportOptions(?string $reportType, ?string $report
 
     private function isValidReportType(?string $reportType): bool
     {
-        return in_array($reportType, ['json', 'csv', 'html']);
+        return in_array($reportType, ['json', 'csv', 'html', 'markdown']);
     }
 
     /**
@@ -80,7 +80,7 @@ private function handleExceptions(Exception $exception): int
     public function handleInvalidReporType(?string $reportType): int
     {
         $this->output->writeln(sprintf(
-            '<error>Invalid report type `%s` provided. Only `json`, `csv`, and `html` are accepted.</error>',
+            '<error>Invalid report type `%s` provided. Only `json`, `csv`, `html`, and `markdown` are accepted.</error>',
             $reportType
         ));
 
diff --git a/tests/Unit/Business/Cognitive/Exporter/MarkdownExporterContent_AllMetrics.md b/tests/Unit/Business/Cognitive/Exporter/MarkdownExporterContent_AllMetrics.md
@@ -0,0 +1,27 @@
+# Cognitive Metrics Report
+
+**Generated:** 2023-10-01 12:00:00
+
+**Total Classes:** 2
+
+---
+
+* **Class:** TestClass
+* **File:** TestClass.php
+
+| Method | Lines | Args | Returns | Variables | Property Calls | If | If Nesting | Else | Cognitive Complexity | Halstead Volume | Halstead Difficulty | Halstead Effort | Cyclomatic Complexity |
+|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|
+| testMethod | 10 (0.500) | 2 (0.300) | 1 (0.200) | 5 (0.400) | 3 (0.300) | 4 (0.600) | 2 (0.500) | 1 (0.200) | 0.300 | 573.211 | 12.500 | 7,165.138 | 5 (low) |
+| anotherMethod | 5 (0.200) | 1 (0.100) | 1 (0.100) | 2 (0.100) | 1 (0.100) | 1 (0.200) | 1 (0.100) | 0 (0.000) | 0.050 | 185.470 | 6.250 | 1,159.188 | 2 (low) |
+
+---
+
+* **Class:** AnotherClass
+* **File:** AnotherClass.php
+
+| Method | Lines | Args | Returns | Variables | Property Calls | If | If Nesting | Else | Cognitive Complexity | Halstead Volume | Halstead Difficulty | Halstead Effort | Cyclomatic Complexity |
+|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|
+| complexMethod | 20 (1.000) | 4 (0.600) | 3 (0.500) | 10 (0.800) | 5 (0.500) | 8 (1.200) | 3 (1.000) | 4 (0.600) | 0.800 | 1,357.824 | 25.000 | 33,945.600 | 12 (medium) |
+
+---
+
diff --git a/tests/Unit/Business/Cognitive/Exporter/MarkdownExporterContent_CyclomaticOnly.md b/tests/Unit/Business/Cognitive/Exporter/MarkdownExporterContent_CyclomaticOnly.md
@@ -0,0 +1,27 @@
+# Cognitive Metrics Report
+
+**Generated:** 2023-10-01 12:00:00
+
+**Total Classes:** 2
+
+---
+
+* **Class:** TestClass
+* **File:** TestClass.php
+
+| Method | Lines | Args | Returns | Variables | Property Calls | If | If Nesting | Else | Cognitive Complexity | Cyclomatic Complexity |
+|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|
+| testMethod | 10 (0.500) | 2 (0.300) | 1 (0.200) | 5 (0.400) | 3 (0.300) | 4 (0.600) | 2 (0.500) | 1 (0.200) | 0.300 | 5 (low) |
+| anotherMethod | 5 (0.200) | 1 (0.100) | 1 (0.100) | 2 (0.100) | 1 (0.100) | 1 (0.200) | 1 (0.100) | 0 (0.000) | 0.050 | 2 (low) |
+
+---
+
+* **Class:** AnotherClass
+* **File:** AnotherClass.php
+
+| Method | Lines | Args | Returns | Variables | Property Calls | If | If Nesting | Else | Cognitive Complexity | Cyclomatic Complexity |
+|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|
+| complexMethod | 20 (1.000) | 4 (0.600) | 3 (0.500) | 10 (0.800) | 5 (0.500) | 8 (1.200) | 3 (1.000) | 4 (0.600) | 0.800 | 12 (medium) |
+
+---
+
diff --git a/tests/Unit/Business/Cognitive/Exporter/MarkdownExporterContent_HalsteadOnly.md b/tests/Unit/Business/Cognitive/Exporter/MarkdownExporterContent_HalsteadOnly.md
@@ -0,0 +1,27 @@
+# Cognitive Metrics Report
+
+**Generated:** 2023-10-01 12:00:00
+
+**Total Classes:** 2
+
+---
+
+* **Class:** TestClass
+* **File:** TestClass.php
+
+| Method | Lines | Args | Returns | Variables | Property Calls | If | If Nesting | Else | Cognitive Complexity | Halstead Volume | Halstead Difficulty | Halstead Effort |
+|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|
+| testMethod | 10 (0.500) | 2 (0.300) | 1 (0.200) | 5 (0.400) | 3 (0.300) | 4 (0.600) | 2 (0.500) | 1 (0.200) | 0.300 | 573.211 | 12.500 | 7,165.138 |
+| anotherMethod | 5 (0.200) | 1 (0.100) | 1 (0.100) | 2 (0.100) | 1 (0.100) | 1 (0.200) | 1 (0.100) | 0 (0.000) | 0.050 | 185.470 | 6.250 | 1,159.188 |
+
+---
+
+* **Class:** AnotherClass
+* **File:** AnotherClass.php
+
+| Method | Lines | Args | Returns | Variables | Property Calls | If | If Nesting | Else | Cognitive Complexity | Halstead Volume | Halstead Difficulty | Halstead Effort |
+|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|
+| complexMethod | 20 (1.000) | 4 (0.600) | 3 (0.500) | 10 (0.800) | 5 (0.500) | 8 (1.200) | 3 (1.000) | 4 (0.600) | 0.800 | 1,357.824 | 25.000 | 33,945.600 |
+
+---
+
diff --git a/tests/Unit/Business/Cognitive/Exporter/MarkdownExporterContent_Minimal.md b/tests/Unit/Business/Cognitive/Exporter/MarkdownExporterContent_Minimal.md
@@ -0,0 +1,27 @@
+# Cognitive Metrics Report
+
+**Generated:** 2023-10-01 12:00:00
+
+**Total Classes:** 2
+
+---
+
+* **Class:** TestClass
+* **File:** TestClass.php
+
+| Method | Cognitive Complexity |
+|--------|--------|
+| testMethod | 0.300 |
+| anotherMethod | 0.050 |
+
+---
+
+* **Class:** AnotherClass
+* **File:** AnotherClass.php
+
+| Method | Cognitive Complexity |
+|--------|--------|
+| complexMethod | 0.800 |
+
+---
+
diff --git a/tests/Unit/Business/Cognitive/Exporter/MarkdownExporterContent_NoDetailedMetrics.md b/tests/Unit/Business/Cognitive/Exporter/MarkdownExporterContent_NoDetailedMetrics.md
@@ -0,0 +1,27 @@
+# Cognitive Metrics Report
+
+**Generated:** 2023-10-01 12:00:00
+
+**Total Classes:** 2
+
+---
+
+* **Class:** TestClass
+* **File:** TestClass.php
+
+| Method | Cognitive Complexity | Halstead Volume | Halstead Difficulty | Halstead Effort | Cyclomatic Complexity |
+|--------|--------|--------|--------|--------|--------|
+| testMethod | 0.300 | 573.211 | 12.500 | 7,165.138 | 5 (low) |
+| anotherMethod | 0.050 | 185.470 | 6.250 | 1,159.188 | 2 (low) |
+
+---
+
+* **Class:** AnotherClass
+* **File:** AnotherClass.php
+
+| Method | Cognitive Complexity | Halstead Volume | Halstead Difficulty | Halstead Effort | Cyclomatic Complexity |
+|--------|--------|--------|--------|--------|--------|
+| complexMethod | 0.800 | 1,357.824 | 25.000 | 33,945.600 | 12 (medium) |
+
+---
+
diff --git a/tests/Unit/Business/Cognitive/Exporter/MarkdownExporterContent_SingleTable.md b/tests/Unit/Business/Cognitive/Exporter/MarkdownExporterContent_SingleTable.md
@@ -0,0 +1,11 @@
+# Cognitive Metrics Report
+
+**Generated:** 2023-10-01 12:00:00
+
+## All Methods (3 total)
+
+| Class | Method | Lines | Args | Returns | Variables | Property Calls | If | If Nesting | Else | Cognitive Complexity | Halstead Volume | Halstead Difficulty | Halstead Effort | Cyclomatic Complexity |
+|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|
+| TestClass | testMethod | 10 (0.500) | 2 (0.300) | 1 (0.200) | 5 (0.400) | 3 (0.300) | 4 (0.600) | 2 (0.500) | 1 (0.200) | 0.300 | 573.211 | 12.500 | 7,165.138 | 5 (low) |
+| TestClass | anotherMethod | 5 (0.200) | 1 (0.100) | 1 (0.100) | 2 (0.100) | 1 (0.100) | 1 (0.200) | 1 (0.100) | 0 (0.000) | 0.050 | 185.470 | 6.250 | 1,159.188 | 2 (low) |
+| AnotherClass | complexMethod | 20 (1.000) | 4 (0.600) | 3 (0.500) | 10 (0.800) | 5 (0.500) | 8 (1.200) | 3 (1.000) | 4 (0.600) | 0.800 | 1,357.824 | 25.000 | 33,945.600 | 12 (medium) |
diff --git a/tests/Unit/Business/Cognitive/Exporter/MarkdownExporterContent_Threshold.md b/tests/Unit/Business/Cognitive/Exporter/MarkdownExporterContent_Threshold.md
@@ -0,0 +1,28 @@
+# Cognitive Metrics Report
+
+**Generated:** 2023-10-01 12:00:00
+
+**Total Classes:** 2
+
+**Note:** Only showing methods exceeding threshold of 0.100
+
+---
+
+* **Class:** TestClass
+* **File:** TestClass.php
+
+| Method | Lines | Args | Returns | Variables | Property Calls | If | If Nesting | Else | Cognitive Complexity | Halstead Volume | Halstead Difficulty | Halstead Effort | Cyclomatic Complexity |
+|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|
+| testMethod | 10 (0.500) | 2 (0.300) | 1 (0.200) | 5 (0.400) | 3 (0.300) | 4 (0.600) | 2 (0.500) | 1 (0.200) | 0.300 | 573.211 | 12.500 | 7,165.138 | 5 (low) |
+
+---
+
+* **Class:** AnotherClass
+* **File:** AnotherClass.php
+
+| Method | Lines | Args | Returns | Variables | Property Calls | If | If Nesting | Else | Cognitive Complexity | Halstead Volume | Halstead Difficulty | Halstead Effort | Cyclomatic Complexity |
+|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|--------|
+| complexMethod | 20 (1.000) | 4 (0.600) | 3 (0.500) | 10 (0.800) | 5 (0.500) | 8 (1.200) | 3 (1.000) | 4 (0.600) | 0.800 | 1,357.824 | 25.000 | 33,945.600 | 12 (medium) |
+
+---
+
diff --git a/tests/Unit/Business/Cognitive/Exporter/MarkdownExporterTest.php b/tests/Unit/Business/Cognitive/Exporter/MarkdownExporterTest.php

Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ private function hasIncompleteReportOptions(?string $reportType, ?string $report`
`56`	`56`
`57`	`57`	`private function isValidReportType(?string $reportType): bool`
`58`	`58`	`{`
`59`		`- return in_array($reportType, ['json', 'csv', 'html']);`
	`59`	`+ return in_array($reportType, ['json', 'csv', 'html', 'markdown']);`
`60`	`60`	`}`
`61`	`61`
`62`	`62`	`/**`
`@@ -80,7 +80,7 @@ private function handleExceptions(Exception $exception): int`
`80`	`80`	`public function handleInvalidReporType(?string $reportType): int`
`81`	`81`	`{`
`82`	`82`	`$this->output->writeln(sprintf(`
`83`		- '<error>Invalid report type `%s` provided. Only `json`, `csv`, and `html` are accepted.</error>',
	`83`	+ '<error>Invalid report type `%s` provided. Only `json`, `csv`, `html`, and `markdown` are accepted.</error>',
`84`	`84`	`$reportType`
`85`	`85`	`));`
`86`	`86`