Code quality maintenance, fixes and general improvements

.github/workflows/main.yml

@@ -60,3 +60,37 @@ jobs:
           cache-to: type=gha,mode=max
       - name: Run analysis
         run: docker compose run --rm actions-tester composer test:phpstan
+  mess-detect:
+    runs-on: ubuntu-latest
+    name: Mess detector
+    steps:
+      - name: Setup Docker buildx
+        uses: docker/setup-buildx-action@v2
+      - uses: actions/checkout@v4
+      - name: Build Docker image
+        id: build-and-push
+        uses: docker/build-push-action@v4
+        with:
+          context: "{{defaultContext}}"
+          push: false
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+      - name: Run mess detector
+        run: docker compose run --rm actions-tester composer test:phpmd
+  doc-check:
+    runs-on: ubuntu-latest
+    name: Documentation check
+    steps:
+      - name: Setup Docker buildx
+        uses: docker/setup-buildx-action@v2
+      - uses: actions/checkout@v4
+      - name: Build Docker image
+        id: build-and-push
+        uses: docker/build-push-action@v4
+        with:
+          context: "{{defaultContext}}"
+          push: false
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+      - name: Run doc check
+        run: docker compose run --rm actions-tester composer test:docs

Dockerfile

@@ -1,5 +1,5 @@
-FROM composer:2.7.7
-FROM php:8.3.9-cli-alpine AS base
+FROM composer:2.7.9
+FROM php:8.3.11-cli-alpine AS base
 
 FROM base AS builder
 RUN apk update && apk add git

composer.json

@@ -40,13 +40,17 @@
         "symfony/console": "^5.4",
         "symfony/finder": "^5.4",
         "dealerdirect/phpcodesniffer-composer-installer": "^1.0",
-        "phpcompatibility/php-compatibility": "dev-develop"
+        "phpcompatibility/php-compatibility": "dev-develop",
+        "phpmd/phpmd": "^2.15",
+        "niels-de-blaauw/php-doc-check": "^0.4.0"
     },
     "scripts": {
         "test": [
             "@test:lint",
             "@test:phpunit",
-            "@test:phpstan"
+            "@test:phpstan",
+            "@test:phpmd",
+            "@test:docs"
         ],
         "test:lint": [
             "composer validate",
@@ -57,6 +61,12 @@
         ],
         "test:phpstan": [
             "./vendor/bin/phpstan analyse -c phpstan.neon.dist --memory-limit=2G"
+        ],
+        "test:phpmd": [
+            "./vendor/bin/phpmd src ansi phpmd.xml.dist"
+        ],
+        "test:docs": [
+            "./vendor/bin/php-doc-check src"
         ]
     }
 }

phpcs.xml.dist

@@ -1,8 +1,8 @@
 <?xml version="1.0"?>
 <!--suppress XmlUnboundNsPrefix -->
 <ruleset name="mozart">
-    <description>Coding standard ruleset based on the PSR-2 coding standard.</description>
-    <rule ref="PSR2"/>
+    <description>Coding standard ruleset based on the PSR-12 coding standard.</description>
+    <rule ref="PSR12"/>
 
     <rule ref="PHPCompatibility"/>
     <config name="testVersion" value="8.0-8.3"/>

phpmd.xml.dist

@@ -0,0 +1,16 @@
+<?xml version="1.0"?>
+<ruleset name="Rule set for PHPMD to detect code smells"
+         xmlns="https://phpmd.org/xml/ruleset/1.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="https://phpmd.org/xml/ruleset/1.0.0
+                       http://phpmd.org/xml/ruleset_xml_schema_1.0.0.xsd"
+         xsi:noNamespaceSchemaLocation="
+                       http://phpmd.org/xml/ruleset_xml_schema_1.0.0.xsd">
+
+  <rule ref="rulesets/codesize.xml" />
+  <rule ref="rulesets/cleancode.xml" />
+  <rule ref="rulesets/controversial.xml" />
+  <rule ref="rulesets/design.xml" />
+  <rule ref="rulesets/naming.xml" />
+  <rule ref="rulesets/unusedcode.xml" />
+</ruleset>

phpstan.neon.dist

@@ -1,6 +1,3 @@
-includes:
-    - phpstan-baseline.neon
-
 parameters:
     level: 8
     reportUnmatchedIgnoredErrors: false

src/Composer/Autoload/AbstractAutoloader.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace CoenJacobs\Mozart\Composer\Autoload;
+
+use CoenJacobs\Mozart\Config\Package;
+
+abstract class AbstractAutoloader implements Autoloader
+{
+    private Package $package;
+
+    public function getPackage(): Package
+    {
+        return $this->package;
+    }
+
+    public function setPackage(Package $package): void
+    {
+        $this->package = $package;
+    }
+
+    public function getOutputDir(string $basePath, string $autoloadPath): string
+    {
+        $outputDir = $basePath . $autoloadPath;
+        $outputDir = str_replace('\\', DIRECTORY_SEPARATOR, $outputDir);
+        return $outputDir;
+    }
+}

src/Composer/Autoload/Autoloader.php

@@ -2,11 +2,27 @@
 
 namespace CoenJacobs\Mozart\Composer\Autoload;
 
+use CoenJacobs\Mozart\FilesHandler;
+use Symfony\Component\Finder\SplFileInfo;
+
 interface Autoloader
 {
     /**
      * @param mixed $autoloadConfig
      */
     public function processConfig($autoloadConfig): void;
     public function getSearchNamespace(): string;
+    public function getOutputDir(string $basePath, string $autoloadPath): string;
+    /**
+     * @return array<string,SplFileInfo>
+     */
+    public function getFiles(FilesHandler $files): array;
+    /**
+     * Returns the intended target path of a file, where it should be moved by
+     * the Mover class. This requires access to the Mozart configuration, for it
+     * to determine the target directory. This is done by checking the paths
+     * that are being registered for this autoloader, to see if they can be
+     * matched with the full path name of the provided file.
+     */
+    public function getTargetFilePath(SplFileInfo $file): string;
 }