Update to GrumPHP 1.1 and add the shim version of various tools.

Author: matthijs-va

composer.json

@@ -24,14 +24,14 @@
         "drupal/core": "^8.9 || ^9",
         "drupal/drupal-extension": "^4.1",
         "ergebnis/composer-normalize": "^2.8",
+        "irstea/phpcpd-shim": "^6.0",
+        "irstea/phpmd-shim": "^2.9",
         "mglaman/phpstan-drupal": "^0.12.6",
         "nette/neon": "^3.2",
-        "phpmd/phpmd": "^2.9",
-        "phpro/grumphp": "^0.18.1",
+        "phpro/grumphp-shim": "^1.1",
         "phpspec/prophecy": "^1.10",
         "phpstan/phpstan-deprecation-rules": "^0.12.5",
         "phpunit/phpunit": "^7.5",
-        "sebastian/phpcpd": "^4.0",
         "symfony/dotenv": "^3.4",
         "symfony/phpunit-bridge": "^3.4.3"
     },

configs/grumphp-extension.yml

@@ -1,14 +1,15 @@
-parameters:
-  hooks_dir: ~
-  hooks_preset: local
-  stop_on_failure: true
+grumphp:
   hide_circumvention_tip: true
-  ascii: ~
+  ascii:
+    failed: ~
+    succeeded: ~
   fixer:
     enabled: true
     fix_by_default: true
-  extensions:
-    - Digipolisgent\QA\Drupal\GrumPHPExtension
+  environment:
+    paths:
+      - .env
+      - .env.local
   testsuites:
     git_commit_msg:
       tasks:
@@ -53,11 +54,8 @@ parameters:
         - "/^([A-Z][A-Z0-9]+-\\d+(, [A-Z]+-\\d+)*: )?(Add|Change|Fix|Update|Remove) /"
       case_insensitive: false
     phpcpd:
-      names_exclude:
-        - "*.api.php"
-        - "*Test.php"
-        - "*TestBase.php"
-        - "*TestCase.php"
+      exclude:
+        - tests
       min_lines: 10
       triggered_by:
         - php
@@ -92,7 +90,6 @@ parameters:
         - profile
     phpstan:
       configuration: .phpstan.qa-drupal.neon
-      level: 4
       ignore_patterns:
         - "#(^|/)tests/#"
       triggered_by:
@@ -107,3 +104,11 @@ parameters:
     yamllint:
       ignore_patterns:
         - node_modules/
+
+services:
+  listener.qa_drupal.task:
+    class: Digipolisgent\QA\Drupal\GrumPHP\EventListener\TaskEventListener
+    tags:
+      - { name: grumphp.event_listener, event: grumphp.task.run, method: createTaskConfig, priority: 100 }
+      - { name: grumphp.event_listener, event: grumphp.task.complete, method: removeTaskConfig }
+      - { name: grumphp.event_listener, event: grumphp.task.failed, method: removeTaskConfig }

configs/grumphp-site.yml

@@ -1,14 +1,15 @@
-parameters:
-  hooks_dir: ~
-  hooks_preset: local
-  stop_on_failure: false
+grumphp:
   hide_circumvention_tip: true
-  ascii: ~
+  ascii:
+    failed: ~
+    succeeded: ~
   fixer:
     enabled: true
     fix_by_default: true
-  extensions:
-    - Digipolisgent\QA\Drupal\GrumPHPExtension
+  environment:
+    paths:
+      - .env
+      - .env.local
   testsuites:
     git_commit_msg:
       tasks:
@@ -62,17 +63,11 @@ parameters:
       directory:
         - web
       exclude:
-        - core
-        - libraries
-        - modules/contrib
-        - themes/contrib
-        - profiles/contrib
-        - sites
-      names_exclude:
-        - "*.api.php"
-        - "*Test.php"
-        - "*TestBase.php"
-        - "*TestCase.php"
+        - web/core
+        - web/libraries
+        - web/*/contrib
+        - web/modules/custom/*/tests
+        - web/sites
       min_lines: 10
       triggered_by:
         - php
@@ -132,3 +127,11 @@ parameters:
         - "#^web/(modules|themes|profiles)/custom/#"
       ignore_patterns:
         - node_modules/
+
+services:
+  listener.qa_drupal.task:
+    class: Digipolisgent\QA\Drupal\GrumPHP\EventListener\TaskEventListener
+    tags:
+      - { name: grumphp.event_listener, event: grumphp.task.run, method: createTaskConfig, priority: 100 }
+      - { name: grumphp.event_listener, event: grumphp.task.complete, method: removeTaskConfig }
+      - { name: grumphp.event_listener, event: grumphp.task.failed, method: removeTaskConfig }

configs/phpstan.neon

@@ -3,6 +3,7 @@ includes:
   - vendor/phpstan/phpstan-deprecation-rules/rules.neon
 
 parameters:
+  level: 4
   tipsOfTheDay: false
   reportUnmatchedIgnoredErrors: false
   ignoreErrors:

src/EventSubscriber/GrumphpEventSubscriber.php renamed to src/GrumPHP/EventListener/TaskEventListener.php

@@ -1,27 +1,22 @@
 <?php
 
-namespace Digipolisgent\QA\Drupal\EventSubscriber;
+namespace Digipolisgent\QA\Drupal\GrumPHP\EventListener;
 
-use GrumPHP\Event\RunnerEvent;
-use GrumPHP\Event\RunnerEvents;
 use GrumPHP\Event\TaskEvent;
-use GrumPHP\Event\TaskEvents;
 use GrumPHP\Task\Behat;
 use GrumPHP\Task\Phpcs;
 use GrumPHP\Task\PhpMd;
 use GrumPHP\Task\PhpStan;
 use GrumPHP\Task\Phpunit;
 use GrumPHP\Task\TaskInterface;
 use Nette\Neon\Neon;
-use Symfony\Component\Dotenv\Dotenv;
-use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\Filesystem\Filesystem;
 use Symfony\Component\Yaml\Yaml;
 
 /**
- * Event subscriber for GrumPHP events.
+ * Listener for GrumPHP task events.
  */
-class GrumphpEventSubscriber implements EventSubscriberInterface
+class TaskEventListener
 {
     /**
      * Configuration file types.
@@ -37,39 +32,6 @@ class GrumphpEventSubscriber implements EventSubscriberInterface
      */
     protected $isExtension;
 
-    /**
-     * @inheritDoc
-     */
-    public static function getSubscribedEvents()
-    {
-        return [
-            RunnerEvents::RUNNER_RUN => 'loadEnvironmentFiles',
-            TaskEvents::TASK_RUN => 'createTaskConfig',
-            TaskEvents::TASK_SKIPPED => 'removeTaskConfig',
-            TaskEvents::TASK_FAILED => 'removeTaskConfig',
-            TaskEvents::TASK_COMPLETE => 'removeTaskConfig',
-        ];
-    }
-
-    /**
-     * Load the environment files.
-     *
-     * @param RunnerEvent $eventThe GrumPHP runner event.
-     */
-    public function loadEnvironmentFiles(RunnerEvent $event)
-    {
-        $fs = new Filesystem();
-        $env = new Dotenv();
-
-        if ($fs->exists('.env')) {
-            $env->load('.env');
-        }
-
-        if ($fs->exists('.env.local')) {
-            $env->load('.env.local');
-        }
-    }
-
     /**
      * Create the task configuration file.
      *
@@ -84,7 +46,7 @@ public function createTaskConfig(TaskEvent $event)
         // Candidate configuration files.
         $key_prefix = strtoupper($info['filename']) . '_SKIP_';
         $type_suffix = ($this->isExtension() ? 'extension' : 'site');
-        $package_path = __DIR__ . '/../../configs/';
+        $package_path = __DIR__ . '/../../../configs/';
 
         $candidates = [
             $key_prefix . 'LOCAL' => $info['filename'] . '.local.' . $info['extension'],