Add PHPMD to dev tools

- Add PHPMD
- Define ruleset.xml
- Ignore some complex code blocks

.github/workflows/phpmd.yml

@@ -47,7 +47,7 @@ jobs:
  tools: phpmd
 
  - name: Run PHPMD
- run: phpmd . sarif codesize --reportfile phpmd-results.sarif
+ run: phpmd --ignore-violations-on-exit . sarif phpmd.ruleset.xml --reportfile phpmd-results.sarif
  continue-on-error: true
 
  - name: Upload analysis results to GitHub

composer.json

@@ -25,7 +25,8 @@
  "scripts": {
  "phpcs": "phpcs",
  "phpstan": "phpstan analyse",
- "phpunit": "phpunit"
+ "phpunit": "phpunit",
+ "phpmd": "phpmd src,tests ansi phpmd.ruleset.xml"
  },
  "require": {
  "php": "^7.3 || ^8.0",
@@ -34,6 +35,7 @@
  "require-dev": {
  "httpwg/structured-field-tests": "*@dev",
  "paragonie/constant_time_encoding": "^2.6.3",
+ "phpmd/phpmd": "^2.15",
  "phpstan/phpstan": "^1.9",
  "phpstan/phpstan-phpunit": "^1.3",
  "phpunit/phpunit": "^9.5.27",

phpmd.ruleset.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0"?>
+<ruleset name="PHPMD Ruleset"
+ 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>PHPMD Ruleset</description>
+
+ <rule ref="rulesets/codesize.xml"/>
+ <rule ref="rulesets/unusedcode.xml"/>
+</ruleset>

src/Parser.php

@@ -4,6 +4,9 @@
 
 namespace gapple\StructuredFields;
 
+/**
+ * @SuppressWarnings(PHPMD.ExcessiveClassComplexity)
+ */
 class Parser
 {
  public static function parseDictionary(string $string): Dictionary
@@ -276,6 +279,9 @@ private static function parseString(string &$string): string
  throw new ParseException("Invalid end of string");
  }
 
+ /**
+ * @SuppressWarnings(PHPMD.CyclomaticComplexity)
+ */
  private static function parseDisplayString(string &$string): DisplayString
  {
  if (strpos($string, '%"') !== 0) {

src/Serializer.php

@@ -4,6 +4,9 @@
 
 namespace gapple\StructuredFields;
 
+/**
+ * @SuppressWarnings(PHPMD.ExcessiveClassComplexity)
+ */
 class Serializer
 {
  /**
@@ -145,6 +148,8 @@ private static function serializeInnerList(array $value, ?object $parameters = n
 
  /**
  * @param mixed $value
+ *
+ * @SuppressWarnings(PHPMD.CyclomaticComplexity)
  */
  private static function serializeBareItem($value): string
  {

tests/Httpwg/HttpwgTest.php

@@ -29,6 +29,9 @@ abstract class HttpwgTest extends RulesetTest
  */
  protected $ruleset;
 
+ /**
+ * @SuppressWarnings(PHPMD.CyclomaticComplexity)
+ */
  protected function rulesetDataProvider(): array
  {
  $path = __DIR__ . '/../../vendor/httpwg/structured-field-tests/' . $this->ruleset . '.json';