update coding standard (#40)

.github/workflows/continuous-integration.yml

@@ -265,6 +265,58 @@ jobs:
       - name: "Run phpstan/phpstan"
         run: "vendor/bin/phpstan analyse -c phpstan.neon --memory-limit=768M --no-progress"
 
+  phpmd:
+    name: "Check Rules with PHPMD"
+
+    needs: "install"
+
+    runs-on: "${{ matrix.operating-system }}"
+
+    continue-on-error: false
+
+    strategy:
+      fail-fast: false
+
+      matrix:
+        operating-system:
+          - "ubuntu-20.04"
+
+        php-version:
+          - "7.4"
+
+        dependencies:
+          - ""
+
+    steps:
+      - name: "Checkout"
+        uses: "actions/[email protected]"
+
+      - name: "Install PHP"
+        uses: "shivammathur/[email protected]"
+        with:
+          php-version: "${{ matrix.php-version }}"
+          extensions: "${{ env.PHP_EXTENSIONS }}"
+          ini-values: "${{ env.PHP_INI_VALUES }}"
+          coverage: "none"
+          tools: "composer:v2"
+
+      - name: "Determine composer cache directory"
+        id: "determine-composer-cache-directory"
+        run: "echo \"::set-output name=directory::$(composer config cache-dir)\""
+
+      - name: "Cache dependencies installed with composer"
+        uses: "actions/[email protected]"
+        with:
+          path: "${{ steps.determine-composer-cache-directory.outputs.directory }}"
+          key: "php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-${{ hashFiles('composer.lock') }}"
+          restore-keys: "php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-"
+
+      - name: "Update dependencies with composer"
+        run: "composer update --optimize-autoloader --prefer-dist --prefer-stable --no-progress --no-interaction -v --ansi ${{ matrix.dependencies }}"
+
+      - name: "Run phpmd/phpmd"
+        run: "vendor/bin/phpmd src github phpmd.ruleset.xml"
+
   tests:
     name: "UnitTests with PHPUnit"
 

composer.json

@@ -28,7 +28,7 @@
     "laminas/laminas-dependency-plugin": "^2.1.2",
     "laminas/laminas-modulemanager": "^2.10.2",
     "mikey179/vfsstream": "^1.6.9",
-    "mimmi20/coding-standard": "^2.2.3",
+    "mimmi20/coding-standard": "^2.3.0",
     "pepakriz/phpstan-exception-rules": "^0.11.7",
     "php-amqplib/php-amqplib": "^3.0.0",
     "php-console/php-console": "^3.1.8",

phpmd.ruleset.xml

@@ -0,0 +1,60 @@
+<?xml version="1.0"?>
+<ruleset name="mimmi20-cs"
+         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>The coding standard.</description>
+
+    <rule ref="rulesets/cleancode.xml">
+        <exclude name="BooleanArgumentFlag"/>
+        <exclude name="ElseExpression"/>
+        <exclude name="MissingImport"/>
+        <exclude name="StaticAccess"/>
+    </rule>
+
+    <rule ref="rulesets/cleancode.xml/StaticAccess">
+        <properties>
+            <property name="exceptions">
+                <value>
+                    \DateTime,
+                    \DateInterval,
+                    \DateTimeZone
+                </value>
+            </property>
+        </properties>
+    </rule>
+
+    <rule ref="rulesets/codesize.xml">
+        <exclude name="CyclomaticComplexity"/>
+        <exclude name="NPathComplexity"/>
+        <exclude name="ExcessiveMethodLength"/>
+    </rule>
+
+    <rule ref="rulesets/codesize.xml/ExcessiveMethodLength">
+        <properties>
+            <property name="minimum">
+                <value>130</value>
+            </property>
+        </properties>
+    </rule>
+
+    <rule ref="rulesets/controversial.xml"/>
+    <rule ref="rulesets/design.xml">
+        <exclude name="CouplingBetweenObjects"/>
+    </rule>
+
+    <rule ref="rulesets/design.xml/CouplingBetweenObjects">
+        <properties>
+            <property name="maximum">
+                <value>15</value>
+            </property>
+        </properties>
+    </rule>
+
+    <rule ref="rulesets/naming.xml/ConstantNamingConventions"/>
+
+    <rule ref="rulesets/unusedcode.xml">
+        <exclude name="UnusedFormalParameter"/>
+    </rule>
+</ruleset>

phpunit.xml

@@ -33,7 +33,7 @@
         <directory>tests/</directory>
     </testsuite>
 
-    <coverage includeUncoveredFiles="true" processUncoveredFiles="true" pathCoverage="true">
+    <coverage includeUncoveredFiles="true" processUncoveredFiles="true">
         <include>
             <directory suffix=".php">src/</directory>
         </include>

src/ConfigProvider.php

@@ -183,6 +183,9 @@
 use Monolog\Processor\UidProcessor;
 use Monolog\Processor\WebProcessor;
 
+/**
+ * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ */
 final class ConfigProvider
 {
     /**