chore: add phpmd (#362)

* chore(phpmd): install

* chore(phpmd): add BooleanArgumentFlag rule

* chore(phpmd): add CyclomaticComplexity rule

* chore(phpmd): add ExcessiveMethodLength rule

* chore(phpmd): add ExcessiveClassLength rule

* chore(phpmd): add ExcessiveParameterList rule

* chore(phpmd): add TooManyMethods rule

* chore(phpmd): add ExcessiveClassComplexity rule

Author: rgomezcasas

.github/workflows/ci.yml

@@ -31,6 +31,9 @@ jobs:
       - name: 🏗️ Architecture
         run: make test-architecture
 
+      - name: 🗑️ Mess detector
+        run: make mess-detector
+
       - name: 🦭 Wait for the database to get up
         run: |
           while ! make ping-mysql &>/dev/null; do

Makefile

@@ -21,6 +21,9 @@ lint:
 test-architecture:
 	docker exec codely-php_ddd_skeleton-mooc_backend-php php -d memory_limit=4G ./vendor/bin/phpstan analyse
 
+mess-detector:
+	docker exec codely-php_ddd_skeleton-mooc_backend-php ./vendor/bin/phpmd apps,src,tests text phpmd.xml
+
 start:
 	@if [ ! -f .env.local ]; then echo '' > .env.local; fi
 	UID=${shell id -u} GID=${shell id -g} docker compose up --build -d

apps/backoffice/backend/src/Controller/Courses/CoursesGetController.php

@@ -28,8 +28,8 @@ public function __invoke(Request $request): JsonResponse
         $response = $this->queryBus->ask(
             new SearchBackofficeCoursesByCriteriaQuery(
                 (array) $request->query->get('filters'),
-                $orderBy === null ? null : $orderBy,
-                $order === null ? null : $order,
+                $orderBy,
+                $order,
                 $limit === null ? null : (int) $limit,
                 $offset === null ? null : (int) $offset
             )

composer.json

@@ -59,7 +59,8 @@
     "psalm/plugin-symfony": "^5.0",
     "psalm/plugin-phpunit": "^0.18.4",
     "phpstan/phpstan": "^1.10",
-    "phpat/phpat": "dev-add-has_one_public_method"
+    "phpat/phpat": "dev-add-has_one_public_method",
+    "phpmd/phpmd": "^2.14"
   },
   "autoload": {
     "psr-4": {

composer.lock

@@ -0,0 +1,48 @@
+<?xml version="1.0"?>
+<ruleset xmlns="https://pmd.sf.net/ruleset/1.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://pmd.sf.net/ruleset_xml_schema.xsd">
+
+    <exclude-pattern>apps/*/*/var/*</exclude-pattern>
+    <exclude-pattern>*SimilarComparator*</exclude-pattern>
+    <exclude-pattern>*IsSimilar*</exclude-pattern>
+    <!-- Fix CyclomaticComplexity -->
+    <exclude-pattern>src/Shared/Infrastructure/Symfony/AddJsonBodyToRequestListener.php</exclude-pattern>
+    <!-- Fix ExcessiveClassLength -->
+    <exclude-pattern>tests/Shared/Infrastructure/Bus/Event/RabbitMq/RabbitMqEventBusTest.php</exclude-pattern>
+    <!-- Fix TooManyMethods -->
+    <exclude-pattern>tests/Shared/Infrastructure/PhpUnit/UnitTestCase.php</exclude-pattern>
+
+    <rule ref="rulesets/cleancode.xml/BooleanArgumentFlag"/>
+
+    <rule ref="rulesets/codesize.xml/CyclomaticComplexity">
+        <properties>
+            <property name="reportLevel" value="5"/>
+        </properties>
+    </rule>
+    <rule ref="rulesets/codesize.xml/ExcessiveMethodLength">
+        <properties>
+            <property name="minimum" value="35"/>
+        </properties>
+    </rule>
+    <rule ref="rulesets/codesize.xml/ExcessiveClassLength">
+        <properties>
+            <property name="minimum" value="100"/>
+        </properties>
+    </rule>
+    <rule ref="rulesets/codesize.xml/ExcessiveParameterList">
+        <properties>
+            <property name="minimum" value="10"/>
+        </properties>
+    </rule>
+    <rule ref="rulesets/codesize.xml/TooManyMethods">
+        <properties>
+            <property name="maxmethods" value="10"/>
+        </properties>
+    </rule>
+    <rule ref="rulesets/codesize.xml/ExcessiveClassComplexity">
+        <properties>
+            <property name="maximum" value="20"/>
+        </properties>
+    </rule>
+</ruleset>