Merging master

bin/cognitive-analysis

@@ -7,6 +7,6 @@ if (file_exists(__DIR__ . '/../../../autoload.php')) {
     require_once __DIR__ . '/../vendor/autoload.php';
 }
 
-use Phauthentic\CodeQualityMetrics\Application;
+use Phauthentic\CognitiveCodeAnalysis\Application;
 
 (new Application())->run();

composer.json

@@ -12,12 +12,12 @@
     },
     "autoload": {
         "psr-4": {
-            "Phauthentic\\CodeQualityMetrics\\": "src/"
+            "Phauthentic\\CognitiveCodeAnalysis\\": "src/"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "Phauthentic\\CodeQualityMetrics\\Tests\\": "tests/"
+            "Phauthentic\\CognitiveCodeAnalysis\\Tests\\": "tests/"
         }
     },
     "authors": [

config.yml

@@ -28,11 +28,3 @@ cognitive:
     elseCount:
       threshold: 1
       scale: 1.0
-
-halstead:
-  threshold:
-    difficulty: 0.0
-    effort: 0.0
-    time: 0.0
-    bugs: 0.0
-    volume: 0.0

readme.md

@@ -26,12 +26,6 @@ You can also pass a baseline file to compare the results to. The JSON report is
 bin/cognitive-analysis metrics:cognitive <path-to-folder> --baseline cognitive.json
 ```
 
-Halstead Complexity Analysis
-
-```bash
-bin/cognitive-analysis metrics:halstead <path-to-folder>
-```
-
 ## Documentation
 
 * [Cognitive Complexity Analysis](./docs/Cognitive-Complexity-Analysis.md#cognitive-complexity-analysis)
@@ -45,7 +39,6 @@ bin/cognitive-analysis metrics:halstead <path-to-folder>
   * [Examples](#examples)
     * [Wordpress WP_Debug_Data](#wordpress-wp_debug_data)
     * [Doctrine Paginator](#doctrine-paginator)
-* [Halstead Complexity Analysis](./docs/Halstead-Complexity-Analysis.md)
 
 ## Resources
 

src/Application.php

@@ -2,21 +2,18 @@
 
 declare(strict_types=1);
 
-namespace Phauthentic\CodeQualityMetrics;
-
-use Phauthentic\CodeQualityMetrics\Business\Cognitive\BaselineService;
-use Phauthentic\CodeQualityMetrics\Business\Cognitive\CognitiveMetricsCollector;
-use Phauthentic\CodeQualityMetrics\Business\Cognitive\ScoreCalculator;
-use Phauthentic\CodeQualityMetrics\Business\DirectoryScanner;
-use Phauthentic\CodeQualityMetrics\Business\Halstead\HalsteadMetricsCollector;
-use Phauthentic\CodeQualityMetrics\Command\Cognitive\CognitiveCollectorShellOutputPlugin;
-use Phauthentic\CodeQualityMetrics\Command\CognitiveMetricsCommand;
-use Phauthentic\CodeQualityMetrics\Command\HalsteadMetricsCommand;
-use Phauthentic\CodeQualityMetrics\Business\MetricsFacade;
-use Phauthentic\CodeQualityMetrics\Command\Presentation\CognitiveMetricTextRenderer;
-use Phauthentic\CodeQualityMetrics\Command\Presentation\HalsteadMetricTextRenderer;
-use Phauthentic\CodeQualityMetrics\Config\ConfigLoader;
-use Phauthentic\CodeQualityMetrics\Config\ConfigService;
+namespace Phauthentic\CognitiveCodeAnalysis;
+
+use Phauthentic\CognitiveCodeAnalysis\Business\Cognitive\BaselineService;
+use Phauthentic\CognitiveCodeAnalysis\Business\Cognitive\CognitiveMetricsCollector;
+use Phauthentic\CognitiveCodeAnalysis\Business\Cognitive\ScoreCalculator;
+use Phauthentic\CognitiveCodeAnalysis\Business\DirectoryScanner;
+use Phauthentic\CognitiveCodeAnalysis\Command\Cognitive\CognitiveCollectorShellOutputPlugin;
+use Phauthentic\CognitiveCodeAnalysis\Command\CognitiveMetricsCommand;
+use Phauthentic\CognitiveCodeAnalysis\Business\MetricsFacade;
+use Phauthentic\CognitiveCodeAnalysis\Command\Presentation\CognitiveMetricTextRenderer;
+use Phauthentic\CognitiveCodeAnalysis\Config\ConfigLoader;
+use Phauthentic\CognitiveCodeAnalysis\Config\ConfigService;
 use PhpParser\NodeTraverser;
 use PhpParser\NodeTraverserInterface;
 use PhpParser\ParserFactory;
@@ -44,9 +41,6 @@ public function __construct()
 
     private function registerServices(): void
     {
-        $this->containerBuilder->register(HalsteadMetricsCollector::class, HalsteadMetricsCollector::class)
-            ->setPublic(true);
-
         $this->containerBuilder->register(CognitiveMetricsCollector::class, CognitiveMetricsCollector::class)
             ->setPublic(true);
 
@@ -56,9 +50,6 @@ private function registerServices(): void
         $this->containerBuilder->register(ConfigService::class, ConfigService::class)
             ->setPublic(true);
 
-        $this->containerBuilder->register(HalsteadMetricTextRenderer::class, HalsteadMetricTextRenderer::class)
-            ->setPublic(true);
-
         $this->containerBuilder->register(CognitiveMetricTextRenderer::class, CognitiveMetricTextRenderer::class)
             ->setPublic(true);
 
@@ -100,14 +91,14 @@ private function registerServices(): void
     private function bootstrap(): void
     {
         $this->registerServices();
-        $this->registerMetricsCollectors();
-        $this->registerConfigService();
+        $this->bootstrapMetricsCollectors();
+        $this->configureConfigService();
         $this->registerMetricsFacade();
         $this->registerCommands();
-        $this->registerApplication();
+        $this->configureApplication();
     }
 
-    private function registerMetricsCollectors(): void
+    private function bootstrapMetricsCollectors(): void
     {
         $this->containerBuilder->register(CognitiveMetricsCollector::class, CognitiveMetricsCollector::class)
             ->setArguments([
@@ -120,17 +111,9 @@ private function registerMetricsCollectors(): void
                 ]
             ])
             ->setPublic(true);
-
-        $this->containerBuilder->register(HalsteadMetricsCollector::class, HalsteadMetricsCollector::class)
-            ->setArguments([
-                new Reference(ParserFactory::class),
-                new Reference(NodeTraverserInterface::class),
-                new Reference(DirectoryScanner::class),
-            ])
-            ->setPublic(true);
     }
 
-    private function registerConfigService(): void
+    private function configureConfigService(): void
     {
         $this->containerBuilder->register(ConfigService::class, ConfigService::class)
             ->setArguments([
@@ -144,7 +127,6 @@ private function registerMetricsFacade(): void
     {
         $this->containerBuilder->register(MetricsFacade::class, MetricsFacade::class)
             ->setArguments([
-                new Reference(HalsteadMetricsCollector::class),
                 new Reference(CognitiveMetricsCollector::class),
                 new Reference(ScoreCalculator::class),
                 new Reference(ConfigService::class),
@@ -161,21 +143,13 @@ private function registerCommands(): void
                 new Reference(BaselineService::class),
             ])
             ->setPublic(true);
-
-        $this->containerBuilder->register(HalsteadMetricsCommand::class, HalsteadMetricsCommand::class)
-            ->setArguments([
-                new Reference(MetricsFacade::class),
-                new Reference(HalsteadMetricTextRenderer::class),
-            ])
-            ->setPublic(true);
     }
 
-    private function registerApplication(): void
+    private function configureApplication(): void
     {
         $this->containerBuilder->register(SymfonyApplication::class, SymfonyApplication::class)
             ->setPublic(true)
-            ->addMethodCall('add', [new Reference(CognitiveMetricsCommand::class)])
-            ->addMethodCall('add', [new Reference(HalsteadMetricsCommand::class)]);
+            ->addMethodCall('add', [new Reference(CognitiveMetricsCommand::class)]);
     }
 
     public function run(): void

src/Business/Cognitive/BaselineService.php

@@ -2,8 +2,9 @@
 
 declare(strict_types=1);
 
-namespace Phauthentic\CodeQualityMetrics\Business\Cognitive;
+namespace Phauthentic\CognitiveCodeAnalysis\Business\Cognitive;
 
+use JsonException;
 use RuntimeException;
 
 /**
@@ -30,13 +31,12 @@ public function calculateDeltas(CognitiveMetricsCollection $metricsCollection, a
         }
     }
 
-
     /**
      * Loads the baseline file and returns the data as an array.
      *
      * @param string $baselineFile
      * @return array<string, array<string, mixed>> $baseline
-     * @throws \JsonException
+     * @throws JsonException
      */
     public function loadBaseline(string $baselineFile): array
     {

src/Business/Cognitive/CognitiveMetrics.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Phauthentic\CodeQualityMetrics\Business\Cognitive;
+namespace Phauthentic\CognitiveCodeAnalysis\Business\Cognitive;
 
 use InvalidArgumentException;
 use JsonSerializable;

src/Business/Cognitive/CognitiveMetricsCollection.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Phauthentic\CodeQualityMetrics\Business\Cognitive;
+namespace Phauthentic\CognitiveCodeAnalysis\Business\Cognitive;
 
 use ArrayIterator;
 use Closure;

src/Business/Cognitive/CognitiveMetricsCollector.php

@@ -2,12 +2,12 @@
 
 declare(strict_types=1);
 
-namespace Phauthentic\CodeQualityMetrics\Business\Cognitive;
+namespace Phauthentic\CognitiveCodeAnalysis\Business\Cognitive;
 
-use Phauthentic\CodeQualityMetrics\Business\DirectoryScanner;
-use Phauthentic\CodeQualityMetrics\CognitiveAnalysisException;
-use Phauthentic\CodeQualityMetrics\Config\ConfigService;
-use Phauthentic\CodeQualityMetrics\PhpParser\CognitiveMetricsVisitor;
+use Phauthentic\CognitiveCodeAnalysis\Business\DirectoryScanner;
+use Phauthentic\CognitiveCodeAnalysis\CognitiveAnalysisException;
+use Phauthentic\CognitiveCodeAnalysis\Config\ConfigService;
+use Phauthentic\CognitiveCodeAnalysis\PhpParser\CognitiveMetricsVisitor;
 use PhpParser\Error;
 use PhpParser\NodeTraverserInterface;
 use PhpParser\Parser;
@@ -34,17 +34,29 @@ public function __construct(
         $this->parser = $parserFactory->createForHostVersion();
     }
 
+    /**
+     * @param array<string, mixed> $config
+     * @return array<int, string>
+     */
+    private function getExcludePatternsFromConfig(array $config): array
+    {
+        if (isset($config['excludePatterns'])) {
+            return $config['excludePatterns'];
+        }
+
+        return [];
+    }
+
     /**
      * Collect cognitive metrics from the given path
      *
      * @param string $path
      * @param array<string, mixed> $config
      * @return CognitiveMetricsCollection
-     * @throws CognitiveAnalysisException
      */
     public function collect(string $path, array $config = []): CognitiveMetricsCollection
     {
-        $files = $this->findSourceFiles($path);
+        $files = $this->findSourceFiles($path, $this->getExcludePatternsFromConfig($config));
 
         return $this->findMetrics($files);
     }
@@ -54,9 +66,8 @@ public function collect(string $path, array $config = []): CognitiveMetricsColle
      *
      * @param iterable<SplFileInfo> $files
      * @return CognitiveMetricsCollection
-     * @throws CognitiveAnalysisException
      */
-    protected function findMetrics(iterable $files): CognitiveMetricsCollection
+    private function findMetrics(iterable $files): CognitiveMetricsCollection
     {
         $metricsCollection = new CognitiveMetricsCollection();
         $visitor = new CognitiveMetricsVisitor();
@@ -126,7 +137,7 @@ private function processMethodMetrics(
         }
     }
 
-    public function isExcluded(string $classAndMethod): bool
+    private function isExcluded(string $classAndMethod): bool
     {
         $regexes = $this->configService->getConfig()['cognitive']['excludePatterns'];
 
@@ -143,20 +154,18 @@ public function isExcluded(string $classAndMethod): bool
      * Find source files using DirectoryScanner
      *
      * @param string $path Path to the directory or file to scan
+     * @param array<int, string> $exclude List of regx to exclude
      * @return iterable<mixed, SplFileInfo> An iterable of SplFileInfo objects
      */
-    protected function findSourceFiles(string $path): iterable
+    private function findSourceFiles(string $path, array $exclude = []): iterable
     {
-        return $this->directoryScanner->scan(
-            [$path],
-            ['^(?!.*\.php$).+'] + $this->configService->getConfig()['cognitive']['excludeFilePatterns']
-        );
+        return $this->directoryScanner->scan([$path], ['^(?!.*\.php$).+'] + $exclude); // Exclude non-PHP files
     }
 
     /**
      * @throws CognitiveAnalysisException
      */
-    protected function traverseAbstractSyntaxTree(string $code): void
+    private function traverseAbstractSyntaxTree(string $code): void
     {
         try {
             $ast = $this->parser->parse($code);

src/Business/Cognitive/Delta.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Phauthentic\CodeQualityMetrics\Business\Cognitive;
+namespace Phauthentic\CognitiveCodeAnalysis\Business\Cognitive;
 
 /**
  *

src/Business/Cognitive/Exporter/CsvExporter.php

@@ -2,9 +2,9 @@
 
 declare(strict_types=1);
 
-namespace Phauthentic\CodeQualityMetrics\Business\Cognitive\Exporter;
+namespace Phauthentic\CognitiveCodeAnalysis\Business\Cognitive\Exporter;
 
-use Phauthentic\CodeQualityMetrics\Business\Cognitive\CognitiveMetricsCollection;
+use Phauthentic\CognitiveCodeAnalysis\Business\Cognitive\CognitiveMetricsCollection;
 use RuntimeException;
 
 /**

src/Business/Cognitive/Exporter/DataExporterInterface.php

@@ -2,9 +2,9 @@
 
 declare(strict_types=1);
 
-namespace Phauthentic\CodeQualityMetrics\Business\Cognitive\Exporter;
+namespace Phauthentic\CognitiveCodeAnalysis\Business\Cognitive\Exporter;
 
-use Phauthentic\CodeQualityMetrics\Business\Cognitive\CognitiveMetricsCollection;
+use Phauthentic\CognitiveCodeAnalysis\Business\Cognitive\CognitiveMetricsCollection;
 
 /**
  *

src/Business/Cognitive/Exporter/HtmlExporter.php

@@ -2,9 +2,9 @@
 
 declare(strict_types=1);
 
-namespace Phauthentic\CodeQualityMetrics\Business\Cognitive\Exporter;
+namespace Phauthentic\CognitiveCodeAnalysis\Business\Cognitive\Exporter;
 
-use Phauthentic\CodeQualityMetrics\Business\Cognitive\CognitiveMetricsCollection;
+use Phauthentic\CognitiveCodeAnalysis\Business\Cognitive\CognitiveMetricsCollection;
 use RuntimeException;
 
 /**

src/Business/Cognitive/Exporter/JsonExporter.php

@@ -2,9 +2,9 @@
 
 declare(strict_types=1);
 
-namespace Phauthentic\CodeQualityMetrics\Business\Cognitive\Exporter;
+namespace Phauthentic\CognitiveCodeAnalysis\Business\Cognitive\Exporter;
 
-use Phauthentic\CodeQualityMetrics\Business\Cognitive\CognitiveMetricsCollection;
+use Phauthentic\CognitiveCodeAnalysis\Business\Cognitive\CognitiveMetricsCollection;
 use RuntimeException;
 
 /**

src/Business/Cognitive/FindMetricsPluginInterface.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Phauthentic\CodeQualityMetrics\Business\Cognitive;
+namespace Phauthentic\CognitiveCodeAnalysis\Business\Cognitive;
 
 use SplFileInfo;