Code quality: added PHPMD, updated workflow (#4303)

* added phpmd to workflow

* replaced variabvĺe $_item

* replaced variabvĺe $_rss_url

* replaced variabvĺe $_storeIds

* replaced variabvĺe $_buyRequest

* replaced variabvĺe $_typeId

* replaced variabvĺe $_serviceCode

* replaced variabvĺe $access_key

* replaced variabvĺe $method_arr

* replaced variabvĺe $font_size

* phpcs

* phpstan

* fix phpunit workflow

* phpstan baseline

* tmp - disabled ShortVariable phpmd rule

* phpmd - ignore long class/variable names

* phpmd - ignore BooleanGetMethodName

* replaced variabvĺe $increment_id

* replaced variabvĺe $_profilerKey

* replaced variabvĺe $_option

* replaced variabvĺe $drawing_text

* replaced variabvĺe $read_adapter

* replaced variabvĺe $rules_set

* replaced variabvĺe $select_id

* replaced variabvĺe $currency_code

* replaced variabvĺe $_selection

* replaced variabvĺe $_checkedPaths

* replaced variabvĺe $_optionId

* replaced variabvĺe $url_prefix

* replaced variabvĺe $logo_src

* replaced variabvĺe $_printValue

* replaced variabvĺe $entity_id

* replaced variabvĺe $_key

* replaced variabvĺe $_value

* replaced variabvĺe $item_id

* replaced variable $tax_amount

* replaced variable $tax_info

* replaced variable ...

* replaced variable $total_reviews

* replaced variable $_truncatedValue

* replaced variable ...

* replaced variable ...

* replaced variable ...

* replaced variable ...

* update

* copyright dates

* fix

* rector

* updated commands

* updated commands

* removed some phpcs comments

* added phpcs default config (for phpstorm)

* added github label

* phpcs

* update baseline

.ddev/commands/web/phpcs

@@ -4,4 +4,4 @@
 ## Usage: phpcs
 ## Example: ddev phpcs <path-to-files>
 
-php vendor/bin/phpcs -s -p --report=full,summary "$@"
+php vendor/bin/phpcs -s -p --standard=.phpcs.dist.xml --cache=.phpcs.result.cache --report=full,summary "$@"

.ddev/commands/web/phpmd

@@ -4,4 +4,4 @@
 ## Usage: phpmd
 ## Example: ddev phpmd <path-to-files>
 
-php vendor/bin/phpmd "$@" text .phpmd.dist.xml
+php vendor/bin/phpmd "$@" text .phpmd.dist.xml --color --cache --baseline-file .phpmd.dist.baseline.xml

.ddev/commands/web/phpmd-no-baseline

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+## Description: run PHPMD
+## Usage: phpmd-no-baseline
+## Example: ddev phpmd-no-baseline <path-to-files>
+
+php vendor/bin/phpmd "$@" text .phpmd.dist.xml

.ddev/commands/web/phpunit

@@ -4,4 +4,4 @@
 ## Usage: phpunit
 ## Example: ddev phpunit
 
-php vendor/bin/phpunit --no-coverage "$@" --testdox
+php vendor/bin/phpunit --configuration .phpunit.dist.xml --no-coverage "$@" --testdox

.ddev/commands/web/phpunit-coverage

@@ -5,5 +5,5 @@
 ## Example: ddev phpunit-coverage
 
 enable_xdebug
-XDEBUG_MODE=coverage php vendor/bin/phpunit "$@" --testdox
+XDEBUG_MODE=coverage php vendor/bin/phpunit --configuration .phpunit.dist.xml --testdox "$@"
 disable_xdebug

.ddev/commands/web/phpunit-coverage-local

@@ -5,5 +5,5 @@
 ## Example: ddev phpunit-coverage-local
 
 enable_xdebug
-XDEBUG_MODE=coverage php vendor/bin/phpunit --coverage-html build/coverage "$@" --testdox
+XDEBUG_MODE=coverage php vendor/bin/phpunit --configuration .phpunit.dist.xml --coverage-html build/coverage --testdox "$@"
 disable_xdebug

.ddev/commands/web/rector

@@ -4,4 +4,4 @@
 ## Usage: rector
 ## Example: ddev rector <path-to-files>
 
-php vendor/bin/rector process "$@"
+php vendor/bin/rector process --config .rector.php "$@"

.gitattributes

@@ -14,10 +14,11 @@
 /.phpcs.ecg.xml.dist export-ignore
 /.phpcs.php.xml.dist export-ignore
 /.phpcs.xml.dist export-ignore
+/.phpmd.dist.baseline.xml export-ignore
 /.phpmd.dist.xml export-ignore
 /.phpstan.dist.baseline.neon export-ignore
 /.phpstan.dist.neon export-ignore
-/rector.php export-ignore
+/.rector.php export-ignore
 
 /README.md export-ignore
 
@@ -35,4 +36,4 @@
 *.sql text eol=lf
 *.svg text eol=lf
 *.txt text eol=lf
-*.phtml text eol=lf
+*.phtml text eol=lf

.github/labeler.yml

@@ -884,18 +884,24 @@
       .github/workflows/php-cs-fixer.yml
     ]
 
+'phpmd':
+  - changed-files:
+    - any-glob-to-any-file: [
+      .phpmd*,
+      .github/workflows/phpmd.yml
+    ]
+
 'phpstan':
   - changed-files:
     - any-glob-to-any-file: [
       .phpstan*,
-      phpstan*,
       .github/workflows/phpstan.yml
     ]
 
 'phpunit':
   - changed-files:
     - any-glob-to-any-file: [
-      phpunit*,
+      .phpunit*,
       tests/*,
       .github/workflows/phpunit.yml
     ]
@@ -910,6 +916,6 @@
 'rector':
   - changed-files:
       - any-glob-to-any-file: [
-        rector.php,
+        .rector.php,
         .github/workflows/rector.yml
       ]

.github/workflows/check-files.yml

@@ -27,6 +27,9 @@ on:
       php-cs-fixer:
         description: "Count changed PHP-CS-Fixer files"
         value: ${{ jobs.check.outputs.php-cs-fixer }}
+      phpmd:
+        description: "Count changed PHPMD files"
+        value: ${{ jobs.check.outputs.phpmd }}
       phpstan:
         description: "Count changed PHPStan files"
         value: ${{ jobs.check.outputs.phpstan }}
@@ -52,6 +55,7 @@ jobs:
       workflow: ${{ steps.changes-workflow.outputs.workflow }}
       phpcs: ${{ steps.changes-phpcs.outputs.phpcs }}
       php-cs-fixer: ${{ steps.changes-php-cs-fixer.outputs.php-cs-fixer }}
+      phpmd: ${{ steps.changes-phpstan.outputs.phpmd }}
       phpstan: ${{ steps.changes-phpstan.outputs.phpstan }}
       phpunit-test: ${{ steps.changes-phpunit-test.outputs.phpunit-test }}
       phpunit: ${{ steps.changes-phpunit.outputs.phpunit }}
@@ -87,8 +91,9 @@ jobs:
             .github/workflows/**
             **phpcs**
             **php-cs-fixer**
+            **phpmd**
             **phpstan**
-            rector.php
+            .rector.php
             tests/
             phpunit*
 
@@ -158,6 +163,14 @@ jobs:
           echo "$count PHP-CS-Fixer file(s) changed"
           echo "php-cs-fixer=$count" >> $GITHUB_OUTPUT
 
+      - name: Check if PHPMD files changed
+        id: changes-phpmd
+        if: steps.changed-files-specific.outputs.any_modified == 'true'
+        run: |
+          count="$(grep -oE "**phpmd**" <<< "${{ steps.changed-files-specific.outputs.all_modified_files }}" | wc -l)"
+          echo "$count PHPMD file(s) changed"
+          echo "phpmd=$count" >> $GITHUB_OUTPUT
+
       - name: Check if PHPStan files changed
         id: changes-phpstan
         if: steps.changed-files-specific.outputs.any_modified == 'true'
@@ -178,6 +191,6 @@ jobs:
         id: changes-phpunit
         if: steps.changed-files-specific.outputs.any_modified == 'true'
         run: |
-          count="$(grep -oE "phpunit*" <<< "${{ steps.changed-files-specific.outputs.all_modified_files }}" | wc -l)"
+          count="$(grep -oE "**phpunit**" <<< "${{ steps.changed-files-specific.outputs.all_modified_files }}" | wc -l)"
           echo "$count PHPUnit file(s) changed"
           echo "phpunit=$count" >> $GITHUB_OUTPUT

.github/workflows/phpcs.yml

@@ -14,11 +14,11 @@ jobs:
       matrix:
         rules:
           - label: Default
-            path: .phpcs.xml.dist
+            path: .phpcs.dist.xml
           - label: Ecg
-            path: .phpcs.ecg.xml.dist
+            path: .phpcs.dist.ecg.xml
           - label: PhpCompatibility
-            path: .phpcs.php.xml.dist
+            path: .phpcs.dist.php.xml
 
     steps:
       - name: Setup PHP
@@ -44,4 +44,4 @@ jobs:
         run: composer install --prefer-dist --no-progress --ignore-platform-req=ext-*
 
       - name: PHPCodeSniffer
-        run: php vendor/bin/phpcs -s --report=full --standard=${{ matrix.rules.path }}
+        run: php vendor/bin/phpcs -s -p --report=full --standard=${{ matrix.rules.path }}

.github/workflows/phpmd.yml

@@ -0,0 +1,32 @@
+name: PHPMD
+
+on:
+  workflow_call:
+  # Allow manually triggering the workflow.
+  workflow_dispatch:
+
+jobs:
+  phpcs:
+    name: Mess Detector
+    runs-on: [ubuntu-latest]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Get composer cache directory
+        id: composer-cache
+        run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+
+      - name: Cache dependencies
+        uses: actions/cache@v4
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: ${{ runner.os }}-composer-
+
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-progress --ignore-platform-req=ext-*
+
+      - name: PHPMD
+        run: php vendor/bin/phpmd app/code/core/Mage/ github .phpmd.dist.xml --baseline-file .phpmd.dist.baseline.xml

.github/workflows/phpstan.yml

@@ -37,7 +37,7 @@ jobs:
         run: composer install --prefer-dist --no-progress --ignore-platform-req=ext-*
 
       - name: Restore result cache
-        uses: actions/cache/restore@v3
+        uses: actions/cache/restore@v4
         with:
           path: .phpstan.cache
           key: "phpstan-result-cache-${{ github.run_id }}"
@@ -48,7 +48,7 @@ jobs:
         run: XDEBUG_MODE=off php vendor/bin/phpstan.phar analyze
 
       - name: Save result cache
-        uses: actions/cache/save@v3
+        uses: actions/cache/save@v4
         if: always()
         with:
           path: .phpstan.cache

.github/workflows/phpunit.yml

@@ -87,7 +87,7 @@ jobs:
           --skip_url_validation 'yes'
 
       - name: Run phpUnit
-        run: php -f vendor/bin/phpunit
+        run: php vendor/bin/phpunit --configuration .phpunit.dist.xml
 
       - name: Publish Unit Test Results
         uses: EnricoMi/publish-unit-test-result-action@v2

.github/workflows/rector.yml

@@ -34,4 +34,4 @@ jobs:
         run: composer install --prefer-dist --no-progress --ignore-platform-req=ext-*
 
       - name: Rector
-        run: php vendor/bin/rector process --dry-run
+        run: php vendor/bin/rector process --config .rector.php --dry-run

.github/workflows/release.yml

@@ -13,7 +13,7 @@ jobs:
         php-versions: ['7.4']
     steps:
     - name: Checkout repository
-      uses: actions/checkout@master
+      uses: actions/checkout@4
 
     - name: Get composer cache directory
       id: composer-cache

.github/workflows/workflow.yml

@@ -11,11 +11,11 @@ on:
       - '**.js'
       - '**.xml'
       - '.php-cs-fixer.dist.php'
-      - '.phpcs.xml.dist'
-      - '.phpcs.ecg.xml.dist'
-      - '.phpcs.php.xml.dist'
-      - 'phpstan.dist.neon'
-      - 'phpstan.dist.baseline.neon'
+      - '.phpcs.dist.xml'
+      - '.phpcs.dist.ecg.xml'
+      - '.phpcs.dist.php.xml'
+      - '.phpstan.dist.neon'
+      - '.phpstan.dist.baseline.neon'
 
   pull_request:
     paths:
@@ -27,11 +27,11 @@ on:
       - '**.js'
       - '**.xml'
       - '.php-cs-fixer.dist.php'
-      - '.phpcs.xml.dist'
-      - '.phpcs.ecg.xml.dist'
-      - '.phpcs.php.xml.dist'
-      - 'phpstan.dist.neon'
-      - 'phpstan.dist.baseline.neon'
+      - '.phpcs.dist.xml'
+      - '.phpcs.dist.ecg.xml'
+      - '.phpcs.dist.php.xml'
+      - '.phpstan.dist.neon'
+      - '.phpstan.dist.baseline.neon'
 
 jobs:
   debug:
@@ -84,6 +84,16 @@ jobs:
       needs.check.outputs.workflow > 0
     uses: ./.github/workflows/php-cs-fixer.yml
 
+  phpmd:
+    name: PHPMD
+    needs: [check, composer]
+    if: |
+      needs.check.outputs.php > 0 ||
+      needs.check.outputs.phpmd > 0 ||
+      needs.check.outputs.composer > 0 ||
+      needs.check.outputs.workflow > 0
+    uses: ./.github/workflows/phpmd.yml
+
   phpstan:
     name: PHPStan
     needs: [check, composer]

.gitignore

@@ -60,8 +60,15 @@
 .php-cs-fixer*
 !.php-cs-fixer.dist.*
 
+# PHPCS cache
+.phpcs.result.cache
 .phpcs*.xml
-!.phpcs*.xml.dist
+!.phpcs.dist*.xml
+!.phpcs.xml
+phpcs.xml
+
+# PHPMD cache
+.phpmd.result-cache.php
 
 # PhpStan
 .phpstan.cache
@@ -75,7 +82,7 @@ tests/coverage
 tests/logging
 .phpunit.result.cache
 phpunit.xml
-!phpunit.xml.dist
+!.phpunit.dist.xml
 
 # build
 /build