Merge pull request #127 from ember-nexus/github-issue/114

Add PHP Mess Detector, closes #114.

.github/workflows/ci-test.yml

@@ -150,11 +150,29 @@ jobs:
         with:
           name: docker-image-api-dev-amd
           path: /tmp/docker
-      - name: Mutant Test
+      - name: Leak Test
         run: |
           docker load < /tmp/docker/api-dev-amd.tar.gz
           docker run -v $(pwd):/var/www/html api:dev-amd sh -c "composer install --quiet && composer test:leak"
 
+  test-mess-detector:
+    runs-on: ubuntu-latest
+    name: 'Mess Detector'
+    needs:
+      - build-docker-image
+    continue-on-error: true
+    steps:
+      - uses: actions/checkout@v3
+      - run: mkdir -p /tmp/docker
+      - uses: actions/download-artifact@v3
+        with:
+          name: docker-image-api-dev-amd
+          path: /tmp/docker
+      - name: Mess Detector
+        run: |
+          docker load < /tmp/docker/api-dev-amd.tar.gz
+          docker run -v $(pwd):/var/www/html api:dev-amd sh -c "composer install --quiet && composer mess"
+
   test-feature:
     runs-on: buildjet-4vcpu-ubuntu-2204
     name: 'Feature Test'
@@ -216,7 +234,7 @@ jobs:
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
-      - name: Feature Test
+      - name: Example Generation Test
         run: |
           chmod 777 test-feature-prepare
           docker load < /tmp/docker/api-dev-amd.tar.gz

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Add WebDAV HTTP methods to the allowed HTTP method lists.
 - Add 'Example Generation Test' to CI.
 - Enable phpstan rule for enforcing [safe functions](https://github.com/thecodingmachine/safe), closes #55.
+- Add PHP Mess Detector, closes #114.
 
 ## 0.0.28 - 2023-09-14
 ### Added

composer.json

@@ -39,6 +39,7 @@
     "guzzlehttp/guzzle": "^7.5",
     "infection/infection": "^0.27",
     "phpbench/phpbench": "^1.2",
+    "phpmd/phpmd": "^2.13",
     "phpspec/prophecy-phpunit": "^2.0",
     "phpstan/phpstan": "^1.6",
     "phpunit/php-code-coverage": "^9.2",
@@ -105,6 +106,7 @@
     "psalm:fix-dry": "php vendor/bin/psalm --alter --issues=MissingParamType,MissingReturnType,InvalidReturnType,InvalidNullableReturnType,MismatchingDocblockParamType --dry-run",
     "psalm:fix-apply": "php vendor/bin/psalm --alter --issues=MissingParamType,MissingReturnType,InvalidReturnType,InvalidNullableReturnType,MismatchingDocblockParamType",
     "phpstan": "vendor/bin/phpstan",
+    "mess": "vendor/bin/phpmd src,lib,tests text phpmd.xml",
     "benchmark": "vendor/bin/phpbench run --report=aggregate --progress dots",
     "benchmark:csv": "vendor/bin/phpbench run --report=bare --output=csv-file",
     "benchmark:plot": "python benchmark/plot/plot.py",

lib/EmberNexusBundle/src/Service/EmberNexusConfiguration.php

@@ -4,6 +4,10 @@
 
 use Exception;
 
+/**
+ * @SuppressWarnings(PHPMD.CyclomaticComplexity)
+ * @SuppressWarnings(PHPMD.NPathComplexity)
+ */
 class EmberNexusConfiguration
 {
     public const PAGE_SIZE = 'pageSize';
@@ -42,7 +46,7 @@ class EmberNexusConfiguration
     private static function getValueFromConfig(array $configuration, array $keyParts): mixed
     {
         $currentKeyParts = [];
-        foreach ($keyParts as $i => $keyPart) {
+        foreach ($keyParts as $keyPart) {
             $currentKeyParts[] = $keyPart;
             if (!array_key_exists($keyPart, $configuration)) {
                 throw new Exception(sprintf("Configuration must contain key '%s'.", implode('.', $currentKeyParts)));

phpmd.xml

@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ruleset name="pcsg-generated-ruleset"
+         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>Created with the PHP Coding Standard Generator. http://edorian.github.com/php-coding-standard-generator/
+    </description>
+    <rule ref="rulesets/cleancode.xml">
+        <exclude name="StaticAccess"/>
+        <exclude name="ElseExpression"/>
+        <exclude name="BooleanArgumentFlag"/>
+    </rule>
+    <rule ref="rulesets/codesize.xml">
+        <exclude name="ExcessiveMethodLength"/>
+        <exclude name="TooManyPublicMethods"/>
+        <exclude name="TooManyMethods"/>
+        <exclude name="ExcessivePublicCount"/>
+    </rule>
+    <rule ref="rulesets/controversial.xml">
+        <exclude name="CamelCaseClassName"/>
+        <exclude name="CamelCaseParameterName"/>
+        <exclude name="Superglobals"/>
+    </rule>
+    <rule ref="rulesets/design.xml">
+        <exclude name="NumberOfChildren"/>
+        <exclude name="CouplingBetweenObjects"/>
+    </rule>
+    <rule ref="rulesets/naming.xml">
+        <exclude name="ShortVariable"/>
+        <exclude name="LongVariable"/>
+        <exclude name="LongClassName"/>
+    </rule>
+    <rule ref="rulesets/unusedcode.xml"/>
+</ruleset>

src/Command/BackupFetchCommand.php

@@ -218,6 +218,9 @@ public function copyFile(FilesystemOperator $source, string $sourcePath, Filesys
         );
     }
 
+    /**
+     * @SuppressWarnings(PHPMD.CountInLoopExpression)
+     */
     private function findBackupRootFolder(Filesystem $filesystem): ?string
     {
         $stack = ['/'];

src/Command/TestCommand.php

@@ -19,6 +19,9 @@ public function __construct(
         parent::__construct();
     }
 
+    /**
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $dataUuid = UuidV4::fromString('3a3c2f8b-d1bd-40fd-b381-82de60539c9f');

src/Controller/Element/PostIndexController.php

@@ -22,6 +22,10 @@
 use Symfony\Component\Routing\Annotation\Route;
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
 
+/**
+ * @SuppressWarnings(PHPMD.CyclomaticComplexity)
+ * @SuppressWarnings(PHPMD.NPathComplexity)
+ */
 class PostIndexController extends AbstractController
 {
     public function __construct(

src/Controller/Element/PutElementController.php

@@ -58,7 +58,7 @@ public function putElement(string $uuid, Request $request): Response
          */
         $data = \Safe\json_decode($request->getContent(), true);
 
-        foreach ($element->getProperties() as $name => $value) {
+        foreach (array_keys($element->getProperties()) as $name) {
             if ('id' === $name) {
                 continue;
             }

src/Controller/File/DeleteElementFileController.php

@@ -9,6 +9,9 @@
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Routing\Annotation\Route;
 
+/**
+ * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+ */
 class DeleteElementFileController extends AbstractController
 {
     public function __construct(

src/Controller/File/GetElementFileController.php

@@ -9,6 +9,9 @@
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Routing\Annotation\Route;
 
+/**
+ * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+ */
 class GetElementFileController extends AbstractController
 {
     public function __construct(