Made it possible to pass multiple files and folders (#48)

This will allow it to check only certain files and folders. This is useful when you want to check only changed files and limits the time it takes to run this.

Author: floriankraemer

src/Business/Cognitive/CognitiveMetricsCollector.php

@@ -44,17 +44,29 @@ public function __construct(
      */
     public function collect(string $path, CognitiveConfig $config): CognitiveMetricsCollection
     {
-        $files = $this->findSourceFiles($path, $config->excludeFilePatterns);
+        return $this->collectFromPaths([$path], $config);
+    }
 
-        /** @var SplFileInfo[] $clonedFiles */
-        $clonedFiles = [];
-        foreach ($files as $file) {
-            $clonedFiles[] = $file;
+    /**
+     * Collect cognitive metrics from multiple paths and merge them into a single collection
+     *
+     * @param array<string> $paths Array of paths to process
+     * @param CognitiveConfig $config
+     * @return CognitiveMetricsCollection Merged collection of metrics from all paths
+     * @throws CognitiveAnalysisException|ExceptionInterface
+     */
+    public function collectFromPaths(array $paths, CognitiveConfig $config): CognitiveMetricsCollection
+    {
+        $allFiles = [];
+
+        foreach ($paths as $path) {
+            $files = $this->findSourceFiles($path, $config->excludeFilePatterns);
+            $allFiles = array_merge($allFiles, iterator_to_array($files));
         }
 
-        $this->messageBus->dispatch(new SourceFilesFound($clonedFiles));
+        $this->messageBus->dispatch(new SourceFilesFound($allFiles));
 
-        return $this->findMetrics($clonedFiles);
+        return $this->findMetrics($allFiles);
     }
 
     /**

src/Business/MetricsFacade.php

@@ -52,6 +52,23 @@ public function getCognitiveMetrics(string $path): CognitiveMetricsCollection
         return $metricsCollection;
     }
 
+    /**
+     * Collects and returns cognitive metrics for multiple paths.
+     *
+     * @param array<string> $paths Array of file or directory paths to collect metrics from.
+     * @return CognitiveMetricsCollection The collected cognitive metrics from all paths.
+     */
+    public function getCognitiveMetricsFromPaths(array $paths): CognitiveMetricsCollection
+    {
+        $metricsCollection = $this->cognitiveMetricsCollector->collectFromPaths($paths, $this->configService->getConfig());
+
+        foreach ($metricsCollection as $metric) {
+            $this->scoreCalculator->calculate($metric, $this->configService->getConfig());
+        }
+
+        return $metricsCollection;
+    }
+
     /**
      * @return array<string, array<string, mixed>>
      */

src/Command/CognitiveMetricsCommand.php

@@ -54,7 +54,7 @@ protected function configure(): void
             ->addArgument(
                 name: self::ARGUMENT_PATH,
                 mode: InputArgument::REQUIRED,
-                description: 'Path to PHP files or directories to parse.'
+                description: 'Path to PHP files or directories to parse. Can be a single path or comma-separated list of paths.'
             )
             ->addOption(
                 name: self::OPTION_CONFIG_FILE,
@@ -110,14 +110,15 @@ protected function configure(): void
      */
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
-        $path = $input->getArgument(self::ARGUMENT_PATH);
+        $pathInput = $input->getArgument(self::ARGUMENT_PATH);
+        $paths = $this->parsePaths($pathInput);
 
         $configFile = $input->getOption(self::OPTION_CONFIG_FILE);
         if ($configFile && !$this->loadConfiguration($configFile, $output)) {
             return Command::FAILURE;
         }
 
-        $metricsCollection = $this->metricsFacade->getCognitiveMetrics($path);
+        $metricsCollection = $this->metricsFacade->getCognitiveMetricsFromPaths($paths);
 
         $this->handleBaseLine($input, $metricsCollection);
 
@@ -147,6 +148,20 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         return Command::SUCCESS;
     }
 
+    /**
+     * Parses the path input to handle both single paths and comma-separated multiple paths.
+     *
+     * @param string $pathInput The input path(s) from the command argument
+     * @return array<string> Array of paths to process
+     */
+    private function parsePaths(string $pathInput): array
+    {
+        $paths = array_map('trim', explode(',', $pathInput));
+        return array_filter($paths, function ($path) {
+            return !empty($path);
+        });
+    }
+
     /**
      * Handles the baseline option and loads the baseline file if provided.
      *

tests/Unit/Business/Cognitive/CognitiveMetricsCollectorTest.php

@@ -327,4 +327,32 @@ public function simpleMethod() {
             }
         }
     }
+
+    #[Test]
+    public function testCollectFromPaths(): void
+    {
+        $paths = [
+            './tests/TestCode/Paginator.php',
+            './tests/TestCode/FileWithTwoClasses.php'
+        ];
+
+        $metricsCollection = $this->metricsCollector->collectFromPaths($paths, $this->configService->getConfig());
+
+        $this->assertInstanceOf(CognitiveMetricsCollection::class, $metricsCollection);
+        $this->assertGreaterThan(2, $metricsCollection->count(), 'Should have metrics from both files');
+    }
+
+    #[Test]
+    public function testCollectFromPathsWithMixedTypes(): void
+    {
+        $paths = [
+            './tests/TestCode',  // Directory
+            './tests/TestCode/Paginator.php'  // File
+        ];
+
+        $metricsCollection = $this->metricsCollector->collectFromPaths($paths, $this->configService->getConfig());
+
+        $this->assertInstanceOf(CognitiveMetricsCollection::class, $metricsCollection);
+        $this->assertGreaterThan(0, $metricsCollection->count(), 'Should have metrics from directory and file');
+    }
 }

tests/Unit/Business/MetricsFacadeTest.php

@@ -34,6 +34,20 @@ public function testGetCognitiveMetrics(): void
         $this->assertCount(23, $cognitiveMetrics);
     }
 
+    #[Test]
+    public function testGetCognitiveMetricsFromPaths(): void
+    {
+        $paths = [
+            $this->testCodePath . '/Paginator.php',
+            $this->testCodePath . '/FileWithTwoClasses.php'
+        ];
+
+        $cognitiveMetrics = $this->metricsFacade->getCognitiveMetricsFromPaths($paths);
+
+        $this->assertNotEmpty($cognitiveMetrics);
+        $this->assertGreaterThan(0, $cognitiveMetrics->count());
+    }
+
     #[Test]
     public function testLoadConfig(): void
     {

tests/Unit/Command/CognitiveMetricsCommandTest.php

@@ -48,6 +48,21 @@ public function testAnalyse(): void
         $this->assertEquals(Command::SUCCESS, $tester->getStatusCode(), 'Command should succeed');
     }
 
+    #[Test]
+    #[DataProvider('multiplePathsDataProvider')]
+    public function testAnalyseWithMultiplePaths(string $path, string $description): void
+    {
+        $application = new Application();
+        $command = $application->getContainer()->get(CognitiveMetricsCommand::class);
+        $tester = new CommandTester($command);
+
+        $tester->execute([
+            'path' => $path,
+        ]);
+
+        $this->assertEquals(Command::SUCCESS, $tester->getStatusCode(), $description);
+    }
+
     #[Test]
     #[DataProvider('reportDataProvider')]
     public function testAnalyseWithJsonReport(array $input, int $returnCode): void
@@ -176,7 +191,7 @@ public function testOutputWithoutOptions(): void
         $this->assertStringEqualsFile(__DIR__ . '/OutputWithoutOptions.txt', $tester->getDisplay(true));
     }
 
-    #[\PHPUnit\Framework\Attributes\DataProvider('configurationOutputProvider')]
+    #[DataProvider('configurationOutputProvider')]
     public function testConfigurationOutput(string $configFile, string $expectedOutputFile, string $description): void
     {
         $application = new Application();
@@ -238,4 +253,35 @@ public static function configurationOutputProvider(): array
             ],
         ];
     }
+
+    /**
+     * Data provider for multiple paths tests
+     *
+     * @return array<int, array{string, string}>
+     */
+    public static function multiplePathsDataProvider(): array
+    {
+        return [
+            'multiple files' => [
+                __DIR__ . '/../../../src/Command/CognitiveMetricsCommand.php,' . __DIR__ . '/../../../src/Business/MetricsFacade.php',
+                'Command should succeed with multiple files'
+            ],
+            'multiple files with spaces' => [
+                __DIR__ . '/../../../src/Command/CognitiveMetricsCommand.php, ' . __DIR__ . '/../../../src/Business/MetricsFacade.php, ' . __DIR__ . '/../../../src/Business/DirectoryScanner.php',
+                'Command should succeed with multiple files and spaces'
+            ],
+            'multiple directories' => [
+                __DIR__ . '/../../../src/Command,' . __DIR__ . '/../../../src/Business',
+                'Command should succeed with multiple directories'
+            ],
+            'mixed paths' => [
+                __DIR__ . '/../../../src/Command,' . __DIR__ . '/../../../src/Business/MetricsFacade.php',
+                'Command should succeed with mixed directories and files'
+            ],
+            'mixed paths with spaces' => [
+                __DIR__ . '/../../../src/Command, ' . __DIR__ . '/../../../src/Business/MetricsFacade.php, ' . __DIR__ . '/../../../src/Business/DirectoryScanner.php',
+                'Command should succeed with mixed paths and spaces'
+            ],
+        ];
+    }
 }