package by feature

Taskfile.yml

@@ -58,6 +58,12 @@ tasks:
     deps: [install]
     cmd: 'vendor/bin/composer-unused {{.CLI_ARGS}}'
 
+  run:
+    cmd: './bin/comments_density analyze:comments'
+
+  base:
+    cmd: './bin/comments_density generate:baseline'
+
   check:
     cmds:
       - task: cs

bin/comments_density

@@ -4,8 +4,8 @@
 declare(strict_types=1);
 
 use Composer\XdebugHandler\XdebugHandler;
-use SavinMikhail\CommentsDensity\Commands\AnalyzeCommentCommand;
-use SavinMikhail\CommentsDensity\Commands\BaselineCommand;
+use SavinMikhail\CommentsDensity\AnalyzeComments\Commands\AnalyzeCommentCommand;
+use SavinMikhail\CommentsDensity\Baseline\Commands\BaselineCommand;
 use Symfony\Component\Console\Application;
 
 // Display all errors and warnings

comments_density.php

@@ -2,10 +2,9 @@
 
 declare(strict_types=1);
 
-use SavinMikhail\CommentsDensity\Config\DTO\ConfigDTO;
-use SavinMikhail\CommentsDensity\Config\DTO\ConsoleOutputDTO;
-use SavinMikhail\CommentsDensity\Config\DTO\MissingDocblockConfigDTO;
-use SavinMikhail\CommentsDensity\Config\DTO\OutputDTO;
+use SavinMikhail\CommentsDensity\AnalyzeComments\Config\DTO\ConfigDTO;
+use SavinMikhail\CommentsDensity\AnalyzeComments\Config\DTO\ConsoleOutputDTO;
+use SavinMikhail\CommentsDensity\AnalyzeComments\Config\DTO\MissingDocblockConfigDTO;
 
 return new ConfigDTO(
     thresholds: [

src/Analyzer/AnalyzeFileTask.php → src/AnalyzeComments/Analyzer/AnalyzeFileTask.php

@@ -2,24 +2,22 @@
 
 declare(strict_types=1);
 
-namespace SavinMikhail\CommentsDensity\Analyzer;
+namespace SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer;
 
-use SavinMikhail\CommentsDensity\Analyzer\DTO\Output\CommentDTO;
-use SavinMikhail\CommentsDensity\Comments\CommentFactory;
-use SavinMikhail\CommentsDensity\Config\DTO\ConfigDTO;
-use SavinMikhail\CommentsDensity\MissingDocblock\MissingDocBlockAnalyzer;
+use SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer\DTO\Output\CommentDTO;
+use SavinMikhail\CommentsDensity\AnalyzeComments\Comments\CommentFactory;
+use SavinMikhail\CommentsDensity\AnalyzeComments\Config\DTO\ConfigDTO;
+use SavinMikhail\CommentsDensity\AnalyzeComments\MissingDocblock\MissingDocBlockAnalyzer;
 use SplFileInfo;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Contracts\Cache\CacheInterface;
-
 use function array_merge;
 use function count;
 use function file;
 use function file_get_contents;
 use function in_array;
 use function is_array;
 use function token_get_all;
-
 use const T_COMMENT;
 use const T_DOC_COMMENT;
 

src/Analyzer/Analyzer.php → src/AnalyzeComments/Analyzer/Analyzer.php

@@ -2,20 +2,19 @@
 
 declare(strict_types=1);
 
-namespace SavinMikhail\CommentsDensity\Analyzer;
-
-use SavinMikhail\CommentsDensity\Analyzer\DTO\Output\CommentDTO;
-use SavinMikhail\CommentsDensity\Analyzer\DTO\Output\CommentStatisticsDTO;
-use SavinMikhail\CommentsDensity\Analyzer\DTO\Output\OutputDTO;
+namespace SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer;
+
+use SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer\DTO\Output\CommentDTO;
+use SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer\DTO\Output\CommentStatisticsDTO;
+use SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer\DTO\Output\OutputDTO;
+use SavinMikhail\CommentsDensity\AnalyzeComments\Comments\CommentFactory;
+use SavinMikhail\CommentsDensity\AnalyzeComments\Config\DTO\ConfigDTO;
+use SavinMikhail\CommentsDensity\AnalyzeComments\Metrics\MetricsFacade;
+use SavinMikhail\CommentsDensity\AnalyzeComments\MissingDocblock\MissingDocBlockAnalyzer;
 use SavinMikhail\CommentsDensity\Baseline\Storage\BaselineStorageInterface;
-use SavinMikhail\CommentsDensity\Comments\CommentFactory;
-use SavinMikhail\CommentsDensity\Config\DTO\ConfigDTO;
-use SavinMikhail\CommentsDensity\Metrics\MetricsFacade;
-use SavinMikhail\CommentsDensity\MissingDocblock\MissingDocBlockAnalyzer;
 use SplFileInfo;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Contracts\Cache\CacheInterface;
-
 use function array_push;
 
 final class Analyzer

src/Analyzer/AnalyzerFactory.php → src/AnalyzeComments/Analyzer/AnalyzerFactory.php

@@ -2,16 +2,16 @@
 
 declare(strict_types=1);
 
-namespace SavinMikhail\CommentsDensity\Analyzer;
+namespace SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer;
 
+use SavinMikhail\CommentsDensity\AnalyzeComments\Comments\CommentFactory;
+use SavinMikhail\CommentsDensity\AnalyzeComments\Config\DTO\ConfigDTO;
+use SavinMikhail\CommentsDensity\AnalyzeComments\Metrics\CDS;
+use SavinMikhail\CommentsDensity\AnalyzeComments\Metrics\ComToLoc;
+use SavinMikhail\CommentsDensity\AnalyzeComments\Metrics\MetricsFacade;
+use SavinMikhail\CommentsDensity\AnalyzeComments\Metrics\ResourceUtilization;
+use SavinMikhail\CommentsDensity\AnalyzeComments\MissingDocblock\MissingDocBlockAnalyzer;
 use SavinMikhail\CommentsDensity\Baseline\Storage\BaselineStorageInterface;
-use SavinMikhail\CommentsDensity\Comments\CommentFactory;
-use SavinMikhail\CommentsDensity\Config\DTO\ConfigDTO;
-use SavinMikhail\CommentsDensity\Metrics\CDS;
-use SavinMikhail\CommentsDensity\Metrics\ComToLoc;
-use SavinMikhail\CommentsDensity\Metrics\MetricsFacade;
-use SavinMikhail\CommentsDensity\Metrics\ResourceUtilization;
-use SavinMikhail\CommentsDensity\MissingDocblock\MissingDocBlockAnalyzer;
 use Symfony\Component\Cache\Adapter\FilesystemAdapter;
 use Symfony\Component\Console\Output\OutputInterface;
 

src/Analyzer/CommentStatisticsAggregator.php → src/AnalyzeComments/Analyzer/CommentStatisticsAggregator.php

@@ -2,17 +2,15 @@
 
 declare(strict_types=1);
 
-namespace SavinMikhail\CommentsDensity\Analyzer;
-
-use SavinMikhail\CommentsDensity\Analyzer\DTO\Output\CommentDTO;
-use SavinMikhail\CommentsDensity\Analyzer\DTO\Output\CommentStatisticsDTO;
-use SavinMikhail\CommentsDensity\Comments\CommentFactory;
-use SavinMikhail\CommentsDensity\Config\DTO\ConfigDTO;
-use SavinMikhail\CommentsDensity\Exception\CommentsDensityException;
-use SavinMikhail\CommentsDensity\MissingDocblock\MissingDocBlockAnalyzer;
+namespace SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer;
 
+use SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer\DTO\Output\CommentDTO;
+use SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer\DTO\Output\CommentStatisticsDTO;
+use SavinMikhail\CommentsDensity\AnalyzeComments\Comments\CommentFactory;
+use SavinMikhail\CommentsDensity\AnalyzeComments\Config\DTO\ConfigDTO;
+use SavinMikhail\CommentsDensity\AnalyzeComments\Exception\CommentsDensityException;
+use SavinMikhail\CommentsDensity\AnalyzeComments\MissingDocblock\MissingDocBlockAnalyzer;
 use function substr_count;
-
 use const PHP_EOL;
 
 final readonly class CommentStatisticsAggregator

src/Analyzer/DTO/Output/CdsDTO.php → src/AnalyzeComments/Analyzer/DTO/Output/CdsDTO.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace SavinMikhail\CommentsDensity\Analyzer\DTO\Output;
+namespace SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer\DTO\Output;
 
 final readonly class CdsDTO
 {

src/Analyzer/DTO/Output/ComToLocDTO.php → src/AnalyzeComments/Analyzer/DTO/Output/ComToLocDTO.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace SavinMikhail\CommentsDensity\Analyzer\DTO\Output;
+namespace SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer\DTO\Output;
 
 final readonly class ComToLocDTO
 {

src/Analyzer/DTO/Output/CommentDTO.php → src/AnalyzeComments/Analyzer/DTO/Output/CommentDTO.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace SavinMikhail\CommentsDensity\Analyzer\DTO\Output;
+namespace SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer\DTO\Output;
 
 final readonly class CommentDTO
 {

src/Analyzer/DTO/Output/CommentStatisticsDTO.php → src/AnalyzeComments/Analyzer/DTO/Output/CommentStatisticsDTO.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace SavinMikhail\CommentsDensity\Analyzer\DTO\Output;
+namespace SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer\DTO\Output;
 
 final readonly class CommentStatisticsDTO
 {

src/Analyzer/DTO/Output/OutputDTO.php → src/AnalyzeComments/Analyzer/DTO/Output/OutputDTO.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace SavinMikhail\CommentsDensity\Analyzer\DTO\Output;
+namespace SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer\DTO\Output;
 
 final readonly class OutputDTO
 {

src/Analyzer/DTO/Output/PerformanceMetricsDTO.php → src/AnalyzeComments/Analyzer/DTO/Output/PerformanceMetricsDTO.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace SavinMikhail\CommentsDensity\Analyzer\DTO\Output;
+namespace SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer\DTO\Output;
 
 final readonly class PerformanceMetricsDTO
 {

src/Commands/AnalyzeCommentCommand.php → src/AnalyzeComments/Commands/AnalyzeCommentCommand.php

@@ -2,12 +2,18 @@
 
 declare(strict_types=1);
 
-namespace SavinMikhail\CommentsDensity\Commands;
+namespace SavinMikhail\CommentsDensity\AnalyzeComments\Commands;
 
-use SavinMikhail\CommentsDensity\Analyzer\AnalyzerFactory;
+use RecursiveDirectoryIterator;
+use RecursiveIteratorIterator;
+use SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer\AnalyzerFactory;
+use SavinMikhail\CommentsDensity\AnalyzeComments\Config\ConfigLoader;
+use SavinMikhail\CommentsDensity\AnalyzeComments\Config\DTO\ConfigDTO;
+use SavinMikhail\CommentsDensity\AnalyzeComments\Exception\CommentsDensityException;
+use SavinMikhail\CommentsDensity\AnalyzeComments\Reporters\ReporterFactory;
 use SavinMikhail\CommentsDensity\Baseline\Storage\TreePhpBaselineStorage;
-use SavinMikhail\CommentsDensity\Reporters\ReporterFactory;
-use Symfony\Component\Console\Command\Command as SymfonyCommand;
+use SplFileInfo;
+use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
@@ -22,14 +28,15 @@ protected function configure(): void
 
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
-        $path = __DIR__ . '/../../baseline.php';
+        $configLoader = new ConfigLoader();
+        $path = $configLoader->getProjectRoot() . '/baseline.php';
 
         $storage = new TreePhpBaselineStorage();
         $storage->init($path);
 
-        $configDto = $this->getConfigDto();
-
+        $configDto = $configLoader->getConfigDto();
         $files = $this->getFilesFromDirectories($configDto->directories);
+
         $reporter = (new ReporterFactory())->createReporter($output, $configDto);
         $analyzerFactory = new AnalyzerFactory();
 
@@ -42,10 +49,24 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         if ($outputDTO->exceedThreshold) {
             $output->writeln('<error>Comment thresholds were exceeded!</error>');
 
-            return SymfonyCommand::FAILURE;
+            return Command::FAILURE;
         }
         $output->writeln('<info>Comment thresholds are passed!</info>');
 
-        return SymfonyCommand::SUCCESS;
+        return Command::SUCCESS;
+    }
+
+    /**
+     * @param string[] $directories
+     * @return SplFileInfo[]
+     */
+    protected function getFilesFromDirectories(array $directories): iterable
+    {
+        foreach ($directories as $directory) {
+            $iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($directory));
+            foreach ($iterator as $file) {
+                yield $file;
+            }
+        }
     }
 }

src/Comments/Comment.php → src/AnalyzeComments/Comments/Comment.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace SavinMikhail\CommentsDensity\Comments;
+namespace SavinMikhail\CommentsDensity\AnalyzeComments\Comments;
 
 use Stringable;
 

src/Comments/CommentConstantsInterface.php → src/AnalyzeComments/Comments/CommentConstantsInterface.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace SavinMikhail\CommentsDensity\Comments;
+namespace SavinMikhail\CommentsDensity\AnalyzeComments\Comments;
 
 interface CommentConstantsInterface
 {

src/Comments/CommentFactory.php → src/AnalyzeComments/Comments/CommentFactory.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace SavinMikhail\CommentsDensity\Comments;
+namespace SavinMikhail\CommentsDensity\AnalyzeComments\Comments;
 
 use function in_array;
 

src/Comments/CommentTypeInterface.php → src/AnalyzeComments/Comments/CommentTypeInterface.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace SavinMikhail\CommentsDensity\Comments;
+namespace SavinMikhail\CommentsDensity\AnalyzeComments\Comments;
 
 interface CommentTypeInterface
 {

src/Comments/DocBlockComment.php → src/AnalyzeComments/Comments/DocBlockComment.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace SavinMikhail\CommentsDensity\Comments;
+namespace SavinMikhail\CommentsDensity\AnalyzeComments\Comments;
 
 final class DocBlockComment extends Comment
 {

src/Comments/FixMeComment.php → src/AnalyzeComments/Comments/FixMeComment.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace SavinMikhail\CommentsDensity\Comments;
+namespace SavinMikhail\CommentsDensity\AnalyzeComments\Comments;
 
 final class FixMeComment extends Comment
 {

src/Comments/LicenseComment.php → src/AnalyzeComments/Comments/LicenseComment.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace SavinMikhail\CommentsDensity\Comments;
+namespace SavinMikhail\CommentsDensity\AnalyzeComments\Comments;
 
 final class LicenseComment extends Comment
 {

src/Comments/RegularComment.php → src/AnalyzeComments/Comments/RegularComment.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace SavinMikhail\CommentsDensity\Comments;
+namespace SavinMikhail\CommentsDensity\AnalyzeComments\Comments;
 
 final class RegularComment extends Comment
 {

src/Comments/TodoComment.php → src/AnalyzeComments/Comments/TodoComment.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace SavinMikhail\CommentsDensity\Comments;
+namespace SavinMikhail\CommentsDensity\AnalyzeComments\Comments;
 
 final class TodoComment extends Comment
 {

src/Config/ConfigLoader.php → src/AnalyzeComments/Config/ConfigLoader.php

@@ -2,21 +2,19 @@
 
 declare(strict_types=1);
 
-namespace SavinMikhail\CommentsDensity\Config;
-
-use SavinMikhail\CommentsDensity\Config\DTO\ConfigDTO;
-use SavinMikhail\CommentsDensity\Exception\CommentsDensityException;
+namespace SavinMikhail\CommentsDensity\AnalyzeComments\Config;
 
+use SavinMikhail\CommentsDensity\AnalyzeComments\Config\DTO\ConfigDTO;
+use SavinMikhail\CommentsDensity\AnalyzeComments\Exception\CommentsDensityException;
 use function defined;
 use function dirname;
 use function file_exists;
-
 use const DIRECTORY_SEPARATOR;
 
 final readonly class ConfigLoader
 {
     private const CONFIG_FILE = 'comments_density.php';
-    private const DIR_LEVEL = COMMENTS_DENSITY_ENVIRONMENT === 'dev' ? 2 : 5;
+    private const DIR_LEVEL = COMMENTS_DENSITY_ENVIRONMENT === 'dev' ? 3 : 6;
 
     /**
      * @throws CommentsDensityException
@@ -46,7 +44,7 @@ public function getConfigDto(): ConfigDTO
         return $config;
     }
 
-    private function getProjectRoot(): string
+    public function getProjectRoot(): string
     {
         return dirname(__DIR__, self::DIR_LEVEL);
     }

src/Config/DTO/ConfigDTO.php → src/AnalyzeComments/Config/DTO/ConfigDTO.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace SavinMikhail\CommentsDensity\Config\DTO;
+namespace SavinMikhail\CommentsDensity\AnalyzeComments\Config\DTO;
 
 final readonly class ConfigDTO
 {