Add support for rule customisation policies

Author: paulbalandan

README.md

@@ -153,6 +153,7 @@ containing your desired options.
 | isRiskyAllowed | `bool`                                   | `false`                              |
 | usingCache     | `bool`                                   | `true`                               |
 | customRules    | `array`                                  | `[]`                                 |
+| ruleCustomisers | `RuleCustomisationPolicyInterface` or `null` | `null`                            |
 
 ```diff
  <?php

phpstan-baseline.php

@@ -2,49 +2,61 @@
 
 $ignoreErrors = [];
 $ignoreErrors[] = [
-	'message' => '#^Call to method __construct\\(\\) of internal class PhpCsFixer\\\\FixerFactory from outside its root namespace PhpCsFixer\\.$#',
+	'rawMessage' => 'Access to constant VERSION of internal class PhpCsFixer\\Console\\Application from outside its root namespace PhpCsFixer.',
+	'identifier' => 'classConstant.internalClass',
+	'count' => 1,
+	'path' => __DIR__ . '/src/Factory.php',
+];
+$ignoreErrors[] = [
+	'rawMessage' => 'Comparison operation ">" between int<80100, 80599> and 80599 is always false.',
+	'identifier' => 'greater.alwaysFalse',
+	'count' => 1,
+	'path' => __DIR__ . '/src/Ruleset/AbstractRuleset.php',
+];
+$ignoreErrors[] = [
+	'rawMessage' => 'Call to method __construct() of internal class PhpCsFixer\\FixerFactory from outside its root namespace PhpCsFixer.',
 	'identifier' => 'method.internalClass',
 	'count' => 1,
 	'path' => __DIR__ . '/src/Test/FixerProvider.php',
 ];
 $ignoreErrors[] = [
-	'message' => '#^Call to method __construct\\(\\) of internal class PhpCsFixer\\\\RuleSet\\\\RuleSet from outside its root namespace PhpCsFixer\\.$#',
+	'rawMessage' => 'Call to method __construct() of internal class PhpCsFixer\\RuleSet\\RuleSet from outside its root namespace PhpCsFixer.',
 	'identifier' => 'method.internalClass',
 	'count' => 1,
 	'path' => __DIR__ . '/src/Test/FixerProvider.php',
 ];
 $ignoreErrors[] = [
-	'message' => '#^Call to method getFixers\\(\\) of internal class PhpCsFixer\\\\FixerFactory from outside its root namespace PhpCsFixer\\.$#',
+	'rawMessage' => 'Call to method getFixers() of internal class PhpCsFixer\\FixerFactory from outside its root namespace PhpCsFixer.',
 	'identifier' => 'method.internalClass',
 	'count' => 1,
 	'path' => __DIR__ . '/src/Test/FixerProvider.php',
 ];
 $ignoreErrors[] = [
-	'message' => '#^Call to method getRules\\(\\) of internal class PhpCsFixer\\\\RuleSet\\\\RuleSet from outside its root namespace PhpCsFixer\\.$#',
+	'rawMessage' => 'Call to method getRules() of internal class PhpCsFixer\\RuleSet\\RuleSet from outside its root namespace PhpCsFixer.',
 	'identifier' => 'method.internalClass',
 	'count' => 1,
 	'path' => __DIR__ . '/src/Test/FixerProvider.php',
 ];
 $ignoreErrors[] = [
-	'message' => '#^Call to method registerBuiltInFixers\\(\\) of internal class PhpCsFixer\\\\FixerFactory from outside its root namespace PhpCsFixer\\.$#',
+	'rawMessage' => 'Call to method registerBuiltInFixers() of internal class PhpCsFixer\\FixerFactory from outside its root namespace PhpCsFixer.',
 	'identifier' => 'method.internalClass',
 	'count' => 1,
 	'path' => __DIR__ . '/src/Test/FixerProvider.php',
 ];
 $ignoreErrors[] = [
-	'message' => '#^Instantiation of internal class PhpCsFixer\\\\FixerFactory\\.$#',
+	'rawMessage' => 'Instantiation of internal class PhpCsFixer\\FixerFactory.',
 	'identifier' => 'new.internalClass',
 	'count' => 1,
 	'path' => __DIR__ . '/src/Test/FixerProvider.php',
 ];
 $ignoreErrors[] = [
-	'message' => '#^Instantiation of internal class PhpCsFixer\\\\RuleSet\\\\RuleSet\\.$#',
+	'rawMessage' => 'Instantiation of internal class PhpCsFixer\\RuleSet\\RuleSet.',
 	'identifier' => 'new.internalClass',
 	'count' => 1,
 	'path' => __DIR__ . '/src/Test/FixerProvider.php',
 ];
 $ignoreErrors[] = [
-	'message' => '#^Call to static method PHPUnit\\\\Framework\\\\Assert\\:\\:assertEmpty\\(\\) with non\\-empty\\-array\\<string, PhpCsFixer\\\\Fixer\\\\FixerInterface\\> will always evaluate to false\\.$#',
+	'rawMessage' => 'Call to static method PHPUnit\\Framework\\Assert::assertEmpty() with non-empty-array<string, PhpCsFixer\\Fixer\\FixerInterface> will always evaluate to false.',
 	'identifier' => 'staticMethod.impossibleType',
 	'count' => 1,
 	'path' => __DIR__ . '/tests/Test/FixerProviderTest.php',

src/Factory.php

@@ -16,7 +16,9 @@
 use Nexus\CsConfig\Ruleset\ConfigurableAllowedUnsupportedPhpVersionRulesetInterface;
 use Nexus\CsConfig\Ruleset\RulesetInterface;
 use PhpCsFixer\Config;
+use PhpCsFixer\Config\RuleCustomisationPolicyInterface;
 use PhpCsFixer\ConfigInterface;
+use PhpCsFixer\Console\Application;
 use PhpCsFixer\Finder;
 use PhpCsFixer\Fixer\FixerInterface;
 use PhpCsFixer\Runner\Parallel\ParallelConfigFactory;
@@ -38,6 +40,7 @@ final class Factory
      *     lineEnding: non-empty-string,
      *     isRiskyAllowed: bool,
      *     usingCache: bool,
+     *     ruleCustomisers: null|RuleCustomisationPolicyInterface,
      *     rules: array<string, array<string, mixed>|bool>
      * } $options Array of resolved options
      */
@@ -61,6 +64,7 @@ private function __construct(
      *     lineEnding?: non-empty-string,
      *     isRiskyAllowed?: bool,
      *     usingCache?: bool,
+     *     ruleCustomisers?: null|RuleCustomisationPolicyInterface,
      *     customRules?: array<string, array<string, mixed>|bool>
      * } $options
      */
@@ -90,6 +94,7 @@ public static function create(RulesetInterface $ruleset, array $overrides = [],
         $options['lineEnding'] ??= "\n";
         $options['isRiskyAllowed'] ??= $ruleset->willAutoActivateIsRiskyAllowed();
         $options['usingCache'] ??= true;
+        $options['ruleCustomisers'] ??= null;
         $options['rules'] = array_merge($ruleset->getRules(), $overrides, $options['customRules'] ?? []);
 
         return new self($ruleset, $options);
@@ -169,11 +174,18 @@ private function invoke(array $overrides = []): ConfigInterface
 
         // @todo v4.0.0 Cleanup
         if ($this->ruleset instanceof ConfigurableAllowedUnsupportedPhpVersionRulesetInterface) {
+            /** @var Config $config */
             $config = $config->setUnsupportedPhpVersionAllowed(
                 $this->ruleset->isUnsupportedPhpVersionAllowed(),
             );
         }
 
+        // @todo v4.0.0 Cleanup
+        if (version_compare(Application::VERSION, '3.92.0', '>=')) {
+            /** @var Config $config */
+            $config = $config->setRuleCustomisationPolicy($this->options['ruleCustomisers']);
+        }
+
         return $config;
     }
 }

tests/FactoryTest.php

@@ -17,6 +17,7 @@
 use Nexus\CsConfig\Ruleset\Nexus81;
 use Nexus\CsConfig\Ruleset\RulesetInterface;
 use PhpCsFixer\Config;
+use PhpCsFixer\Config\RuleCustomisationPolicyInterface;
 use PhpCsFixer\Finder;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\MockObject\MockObject;
@@ -91,14 +92,19 @@ public function testFactoryReturnsDefaultOptionsWhenNoOptionsGiven(): void
 
     public function testFactoryConsumesPassedOptionsToIt(): void
     {
+        $stub = self::createStub(RuleCustomisationPolicyInterface::class);
+        $stub->method('getPolicyVersionForCache')->willReturn('v1');
+
         $options = [
             'cacheFile' => __DIR__.'/../../build/.php-cs-fixer.cache',
             'format' => 'junit',
             'hideProgress' => true,
             'indent' => "\t",
             'lineEnding' => "\r\n",
             'usingCache' => false,
+            'ruleCustomisers' => $stub,
         ];
+        /** @var Config $config */
         $config = Factory::create($this->mockRuleset(), [], $options)->forProjects();
 
         self::assertSame($options['cacheFile'], $config->getCacheFile());
@@ -107,6 +113,7 @@ public function testFactoryConsumesPassedOptionsToIt(): void
         self::assertSame($options['indent'], $config->getIndent());
         self::assertSame($options['lineEnding'], $config->getLineEnding());
         self::assertFalse($config->getUsingCache());
+        self::assertSame($stub, $config->getRuleCustomisationPolicy());
     }
 
     public function testCreateForLibraryCreatesPreformattedLicense(): void