Adding phpstan to the CI process

.github/workflows/ci.yaml

@@ -69,3 +69,6 @@ jobs:
 
     - name: Run phpstan
       run: bin/phpstan -V && bin/phpstan --error-format=github
+
+    - name: Run phpstan
+      run: bin/phpmd --version && composer phpmd

composer.json

@@ -70,14 +70,15 @@
             "phpstan analyse src/"
         ],
         "phpmd": [
-            "bin/phpmd ./src text cleancode,codesize,controversial,design"
+            "bin/phpmd ./src/ text phpmd.xml"
         ],
         "benchmark": [
             "bin/phpbench run tests/Benchmark/ --report=aggregate"
         ],
         "all": [
             "@cscheck",
             "@analyze",
+            "@phpmd",
             "@test"
         ],
         "build-phar": [

phpmd.xml

@@ -0,0 +1,21 @@
+<?xml version="1.0"?>
+<ruleset name="My first PHPMD rule set"
+         xmlns="http://pmd.sf.net/ruleset/1.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0
+                     http://pmd.sf.net/ruleset_xml_schema.xsd"
+         xsi:noNamespaceSchemaLocation="
+                     http://pmd.sf.net/ruleset_xml_schema.xsd">
+    <description>
+        Phauthentic PHPMD rule set
+    </description>
+
+    <!-- Import the entire unused code rule set -->
+    <rule ref="rulesets/cleancode.xml" />
+    <rule ref="rulesets/unusedcode.xml" />
+    <rule ref="rulesets/naming.xml">
+        <exclude name="LongVariable" />
+    </rule>
+    <rule ref="rulesets/codesize.xml" />
+
+</ruleset>

src/Application.php

@@ -86,13 +86,9 @@ private function registerServices(): void
         $this->containerBuilder->register(NodeTraverserInterface::class, NodeTraverser::class)
             ->setPublic(true);
 
-        if (getenv('APP_ENV') === 'test') {
-            $this->containerBuilder->register(OutputInterface::class, NullOutput::class)
-                ->setPublic(true);
-        } else {
-            $this->containerBuilder->register(OutputInterface::class, ConsoleOutput::class)
-                ->setPublic(true);
-        }
+        $outputClass = getenv('APP_ENV') === 'test' ? NullOutput::class : ConsoleOutput::class;
+        $this->containerBuilder->register(OutputInterface::class, $outputClass)
+            ->setPublic(true);
 
         $this->containerBuilder->register(InputInterface::class, ArgvInput::class)
             ->setPublic(true);
@@ -207,9 +203,9 @@ public function run(): void
         );
     }
 
-    public function get(string $id): mixed
+    public function get(string $identifier): mixed
     {
-        return $this->containerBuilder->get($id);
+        return $this->containerBuilder->get($identifier);
     }
 
     public function getContainer(): ContainerBuilder

src/Business/Cognitive/BaselineService.php

@@ -25,7 +25,7 @@ public function calculateDeltas(CognitiveMetricsCollection $metricsCollection, a
                     continue;
                 }
 
-                $previousMetrics = CognitiveMetrics::fromArray($methodData);
+                $previousMetrics = new CognitiveMetrics($methodData);
                 $metrics->calculateDeltas($previousMetrics);
             }
         }

src/Business/Cognitive/CognitiveMetrics.php

@@ -8,7 +8,7 @@
 use JsonSerializable;
 
 /**
- *
+ * @SuppressWarnings(PHPMD)
  */
 class CognitiveMetrics implements JsonSerializable
 {

src/Business/Cognitive/CognitiveMetricsCollector.php

@@ -125,7 +125,7 @@ private function isExcluded(string $classAndMethod): bool
         $regexes = $this->configService->getConfig()->excludePatterns;
 
         foreach ($regexes as $regex) {
-            if (preg_match('/' . $regex . '/', $classAndMethod, $matches)) {
+            if (preg_match('/' . $regex . '/', $classAndMethod)) {
                 return true;
             }
         }

src/Command/EventHandler/ProgressBarHandler.php

@@ -26,10 +26,7 @@ public function __construct(
     public function __invoke(SourceFilesFound|FileProcessed $event): void
     {
         if ($event instanceof SourceFilesFound) {
-            foreach ($event->files as $file) {
-                $this->totalFiles++;
-            }
-
+            $this->totalFiles = count($event->files);
             $this->output->writeln('Found ' . $this->totalFiles . ' files. Starting analysis.');
             $this->progressBar = new ProgressBar($this->output, $this->totalFiles);
         }

src/Command/EventHandler/VerboseHandler.php

@@ -53,13 +53,13 @@ public function __invoke(SourceFilesFound|FileProcessed $event): void
     private function formatBytes(int $size): string
     {
         $units = ['B', 'KB', 'MB', 'GB', 'TB'];
-        $i = 0;
+        $index = 0;
 
-        while ($size >= 1024 && $i < count($units) - 1) {
+        while ($size >= 1024 && $index < count($units) - 1) {
             $size /= 1024;
-            $i++;
+            $index++;
         }
 
-        return round($size, 2) . ' ' . $units[$i];
+        return round($size, 2) . ' ' . $units[$index];
     }
 }

src/Config/ConfigService.php

@@ -17,6 +17,9 @@ class ConfigService
      */
     private array $config;
 
+    /**
+     * @SuppressWarnings(PHPMD.StaticAccess)
+     */
     public function __construct(
         private readonly Processor $processor,
         private readonly ConfigLoader $configuration
@@ -26,6 +29,9 @@ public function __construct(
         ]);
     }
 
+    /**
+     * @SuppressWarnings(PHPMD.StaticAccess)
+     */
     public function loadConfig(string $configFilePath): void
     {
         $this->config = $this->processor->processConfiguration($this->configuration, [