introduce plugin interface

Author: savinmikhail

comments_density.php

@@ -3,11 +3,8 @@
 declare(strict_types=1);
 
 use SavinMikhail\CommentsDensity\AnalyzeComments\Config\DTO\Config;
-use SavinMikhail\CommentsDensity\AnalyzeComments\Config\DTO\ConsoleOutputDTO;
-use SavinMikhail\CommentsDensity\AnalyzeComments\Config\DTO\MissingDocblockConfigDTO;
 
 return new Config(
-    output: ConsoleOutputDTO::create(),
     directories: [
         'src',
     ],

composer.json

@@ -21,6 +21,7 @@
         "composer/composer": "^2.8",
         "composer/xdebug-handler": "^3.0.5",
         "nikic/php-parser": "^5.1",
+        "php-defer/php-defer": "^5.0",
         "savinmikhail/primitive_wrappers": "^1.2",
         "symfony/cache": "^7.2",
         "symfony/cache-contracts": "^3.5",

composer.lock

@@ -23,7 +23,7 @@
 final readonly class Analyzer
 {
     public function __construct(
-        private Config $configDTO,
+        private Config $config,
         private CommentTypeFactory $commentFactory,
         private MetricsFacade $metrics,
         private BaselineStorageInterface $baselineStorage,
@@ -41,11 +41,11 @@ public function analyze(): Report
         $comments = [];
         $filesAnalyzed = 0;
         $totalLinesOfCode = 0;
-        $fileFinder = new FileFinder($this->configDTO);
+        $fileFinder = new FileFinder($this->config);
         foreach ($fileFinder() as $file) {
             $commentFinder = new CommentFinder(
                 $this->commentFactory,
-                $this->configDTO,
+                $this->config,
             );
             $contentExtractor = new FileContentExtractor($file);
 
@@ -61,13 +61,21 @@ public function analyze(): Report
             ++$filesAnalyzed;
         }
 
-        if ($this->configDTO->useBaseline) {
+        if ($this->config->useBaseline) {
             $comments = $this->baselineStorage->filterComments($comments);
         }
 
         $commentStatistics = $this->statisticsAggregator->calculateCommentStatistics($comments);
+        $report = $this->createReport($comments, $commentStatistics, $filesAnalyzed, $totalLinesOfCode);
 
-        return $this->createReport($comments, $commentStatistics, $filesAnalyzed, $totalLinesOfCode);
+        $config = $this->config;
+        defer($_, static function () use ($report, $config): void { // todo figure out how much sense it makes
+            foreach ($config->plugins as $plugin) {
+                $plugin->handle($report, $config);
+            }
+        });
+
+        return $report;
     }
 
     private function getCacheKey(SplFileInfo $file): string

src/AnalyzeComments/Analyzer/Analyzer.php

@@ -10,19 +10,23 @@
 use SavinMikhail\CommentsDensity\AnalyzeComments\Comments\MissingDocBlock;
 use SavinMikhail\CommentsDensity\AnalyzeComments\Comments\RegularComment;
 use SavinMikhail\CommentsDensity\AnalyzeComments\Comments\TodoComment;
+use SavinMikhail\CommentsDensity\Plugin\PluginInterface;
 
 final readonly class Config
 {
+    public OutputDTO $output;
+
     /**
      * @param array<string, float> $thresholds
+     * @param PluginInterface[] $plugins
      * @param string[] $exclude
      * @param string[] $directories
      * @param string[] $disable
      */
     public function __construct(
-        public OutputDTO $output,
         /** Directories to be scanned for comments */
         public array $directories,
+        ?OutputDTO $output = null,
         public MissingDocblockConfigDTO $docblockConfigDTO = new MissingDocblockConfigDTO(),
         /** Limit occurrences of each comment type */
         public array $thresholds = [],
@@ -33,7 +37,10 @@ public function __construct(
         public string $cacheDir = 'var/cache/comments-density',
         /** Disable certain types; set to empty array for full statistics */
         public array $disable = [],
-    ) {}
+        public array $plugins = [],
+    ) {
+        $this->output = $output ?? ConsoleOutputDTO::create();
+    }
 
     /**
      * @return non-empty-string[]

src/AnalyzeComments/Config/DTO/Config.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SavinMikhail\CommentsDensity\Plugin;
+
+use SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer\DTO\Output\Report;
+use SavinMikhail\CommentsDensity\AnalyzeComments\Config\DTO\Config;
+
+interface PluginInterface
+{
+    public function handle(Report $report, Config $config): void;
+}