Merge pull request #177 from kapilpandya22/fix/phpmd-3-compatibility

Support PHPMD 3 in the mess detector runner

Author: sprankhub

magento-mess-detector/LiveCodePhpmdRunner.php

@@ -56,6 +56,27 @@ public function canRun()
      */
     public function run(array $whiteList)
     {
+        $command = $this->createCommand();
+
+        // PHPMD 3 turned the command into a Symfony console command and dropped the array based
+        // CommandLineOptions constructor. Images that build Magento 2.4.7 still install PHPMD 2
+        // (it pins phpmd/phpmd ^2.12), so both APIs have to keep working.
+        if ($command instanceof \Symfony\Component\Console\Command\Command) {
+            $input = new \Symfony\Component\Console\Input\ArrayInput(
+                [
+                    'paths' => explode(',', $this->getSourceCodePath($whiteList)),
+                    '--format' => 'github',
+                    '--ruleset' => [$this->rulesetFile],
+                    '--reportfile-github' => $this->reportFile,
+                    '--suffixes' => ['php'],
+                    '--exclude' => ['vendor/', 'tmp/', 'var/', 'generated/', '.git/', '.idea/'],
+                ],
+                $command->getDefinition()
+            );
+
+            return $command->run($input, new \Symfony\Component\Console\Output\NullOutput());
+        }
+
         $commandLineArguments = [
             'run_file_mock', //emulate script name in console arguments
             $this->getSourceCodePath($whiteList),
@@ -71,11 +92,25 @@ public function run(array $whiteList)
 
         $options = new \PHPMD\TextUI\CommandLineOptions($commandLineArguments);
 
-        $command = new \PHPMD\TextUI\Command();
-
         return $command->run($options, new \PHPMD\RuleSetFactory());
     }
 
+    /**
+     * PHPMD 2.15 made the command require a \PHPMD\Console\Output, PHPMD 3 takes no arguments.
+     *
+     * @return \PHPMD\TextUI\Command
+     */
+    private function createCommand()
+    {
+        $constructor = (new \ReflectionClass(\PHPMD\TextUI\Command::class))->getConstructor();
+
+        if ($constructor !== null && $constructor->getNumberOfRequiredParameters() > 0) {
+            return new \PHPMD\TextUI\Command(new \PHPMD\Console\NullOutput());
+        }
+
+        return new \PHPMD\TextUI\Command();
+    }
+
     private function getSourceCodePath($whiteList): string
     {
         if (!empty($whiteList)) {

magento-mess-detector/PhpmdRunner.php

@@ -60,7 +60,7 @@ public function testCodeMess()
         }
 
         $this->assertEquals(
-            Command::EXIT_SUCCESS,
+            $this->getSuccessExitCode(),
             $result,
             "PHP Code Mess has found error(s):" . PHP_EOL . $output
         );
@@ -71,5 +71,15 @@ public function testCodeMess()
         }
     }
 
+    /**
+     * PHPMD 3 renamed Command::EXIT_SUCCESS to Command::SUCCESS.
+     *
+     * @return int
+     */
+    private function getSuccessExitCode(): int
+    {
+        return defined(Command::class . '::EXIT_SUCCESS') ? Command::EXIT_SUCCESS : Command::SUCCESS;
+    }
+
 }