Merge pull request #874 from ergebnis/feature/rules

Enhancement: Extract `Config\Rules` as a value object
ergebnis · Sep 17, 2023 · cad932a · cad932a
2 parents e2825e9 + e44e178
commit cad932a
Show file tree

Hide file tree

Showing 36 changed files with 307 additions and 147 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,7 @@ For a full diff see [`5.15.1...main`][5.15.1...main].
 
 - Extracted `Config\Name` as a value object ([#870]), by [@localheinz]
 - Extracted `Config\PhpVersion` as a value object ([#871]), by [@localheinz]
+- Extracted `Config\Rules` as a value object ([#873]), by [@localheinz]
 
 ### Changed
 
@@ -1170,6 +1171,7 @@ For a full diff see [`d899e77...1.0.0`][d899e77...1.0.0].
 [#870]: https://github.com/ergebnis/php-cs-fixer-config/pull/870
 [#871]: https://github.com/ergebnis/php-cs-fixer-config/pull/871
 [#872]: https://github.com/ergebnis/php-cs-fixer-config/pull/872
+[#873]: https://github.com/ergebnis/php-cs-fixer-config/pull/873
 
 [@dependabot]: https://github.com/apps/dependabot
 [@linuxjuggler]: https://github.com/linuxjuggler

diff --git a/README.md b/README.md
@@ -126,10 +126,10 @@ file headers will be added to PHP files, for example:
  use Ergebnis\PhpCsFixer\Config;
 
 -$config = Config\Factory::fromRuleSet(new Config\RuleSet\Php82());
-+$config = Config\Factory::fromRuleSet(new Config\RuleSet\Php82(), [
++$config = Config\Factory::fromRuleSet(new Config\RuleSet\Php82(), Config\Rules::fromArray([
 +    'mb_str_functions' => false,
 +    'strict_comparison' => false,
-+]);
++]));
 
  $config->getFinder()->in(__DIR__);
  $config->setCacheFile(__DIR__ . '/.build/php-cs-fixer/.php-cs-fixer.cache');

diff --git a/infection.json b/infection.json
@@ -3,8 +3,8 @@
   "logs": {
     "text": ".build/infection/infection-log.txt"
   },
-  "minCoveredMsi": 99,
-  "minMsi": 99,
+  "minCoveredMsi": 98,
+  "minMsi": 98,
   "phpUnit": {
     "configDir": "test\/Unit"
   },

diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -6,118 +6,116 @@
     </PossiblyUnusedMethod>
   </file>
   <file src="src/RuleSet/Php53.php">
-    <MixedReturnTypeCoercion>
+    <MixedArgumentTypeCoercion>
       <code><![CDATA[$this->rules]]></code>
-      <code>array</code>
-    </MixedReturnTypeCoercion>
+    </MixedArgumentTypeCoercion>
     <NonInvariantDocblockPropertyType>
       <code>$rules</code>
     </NonInvariantDocblockPropertyType>
   </file>
   <file src="src/RuleSet/Php54.php">
-    <MixedReturnTypeCoercion>
+    <MixedArgumentTypeCoercion>
       <code><![CDATA[$this->rules]]></code>
-      <code>array</code>
-    </MixedReturnTypeCoercion>
+    </MixedArgumentTypeCoercion>
     <NonInvariantDocblockPropertyType>
       <code>$rules</code>
     </NonInvariantDocblockPropertyType>
   </file>
   <file src="src/RuleSet/Php55.php">
-    <MixedReturnTypeCoercion>
+    <MixedArgumentTypeCoercion>
       <code><![CDATA[$this->rules]]></code>
-      <code>array</code>
-    </MixedReturnTypeCoercion>
+    </MixedArgumentTypeCoercion>
     <NonInvariantDocblockPropertyType>
       <code>$rules</code>
     </NonInvariantDocblockPropertyType>
   </file>
   <file src="src/RuleSet/Php56.php">
-    <MixedReturnTypeCoercion>
+    <MixedArgumentTypeCoercion>
       <code><![CDATA[$this->rules]]></code>
-      <code>array</code>
-    </MixedReturnTypeCoercion>
+    </MixedArgumentTypeCoercion>
     <NonInvariantDocblockPropertyType>
       <code>$rules</code>
     </NonInvariantDocblockPropertyType>
   </file>
   <file src="src/RuleSet/Php70.php">
-    <MixedReturnTypeCoercion>
+    <MixedArgumentTypeCoercion>
       <code><![CDATA[$this->rules]]></code>
-      <code>array</code>
-    </MixedReturnTypeCoercion>
+    </MixedArgumentTypeCoercion>
     <NonInvariantDocblockPropertyType>
       <code>$rules</code>
     </NonInvariantDocblockPropertyType>
   </file>
   <file src="src/RuleSet/Php71.php">
-    <MixedReturnTypeCoercion>
+    <MixedArgumentTypeCoercion>
       <code><![CDATA[$this->rules]]></code>
-      <code>array</code>
-    </MixedReturnTypeCoercion>
+    </MixedArgumentTypeCoercion>
     <NonInvariantDocblockPropertyType>
       <code>$rules</code>
     </NonInvariantDocblockPropertyType>
   </file>
   <file src="src/RuleSet/Php72.php">
-    <MixedReturnTypeCoercion>
+    <MixedArgumentTypeCoercion>
       <code><![CDATA[$this->rules]]></code>
-      <code>array</code>
-    </MixedReturnTypeCoercion>
+    </MixedArgumentTypeCoercion>
     <NonInvariantDocblockPropertyType>
       <code>$rules</code>
     </NonInvariantDocblockPropertyType>
   </file>
   <file src="src/RuleSet/Php73.php">
-    <MixedReturnTypeCoercion>
+    <MixedArgumentTypeCoercion>
       <code><![CDATA[$this->rules]]></code>
-      <code>array</code>
-    </MixedReturnTypeCoercion>
+    </MixedArgumentTypeCoercion>
     <NonInvariantDocblockPropertyType>
       <code>$rules</code>
     </NonInvariantDocblockPropertyType>
   </file>
   <file src="src/RuleSet/Php74.php">
-    <MixedReturnTypeCoercion>
+    <MixedArgumentTypeCoercion>
       <code><![CDATA[$this->rules]]></code>
-      <code>array</code>
-    </MixedReturnTypeCoercion>
+    </MixedArgumentTypeCoercion>
     <NonInvariantDocblockPropertyType>
       <code>$rules</code>
     </NonInvariantDocblockPropertyType>
   </file>
   <file src="src/RuleSet/Php80.php">
-    <MixedReturnTypeCoercion>
+    <MixedArgumentTypeCoercion>
       <code><![CDATA[$this->rules]]></code>
-      <code>array</code>
-    </MixedReturnTypeCoercion>
+    </MixedArgumentTypeCoercion>
     <NonInvariantDocblockPropertyType>
       <code>$rules</code>
     </NonInvariantDocblockPropertyType>
   </file>
   <file src="src/RuleSet/Php81.php">
-    <MixedReturnTypeCoercion>
+    <MixedArgumentTypeCoercion>
       <code><![CDATA[$this->rules]]></code>
-      <code>array</code>
-    </MixedReturnTypeCoercion>
+    </MixedArgumentTypeCoercion>
     <NonInvariantDocblockPropertyType>
       <code>$rules</code>
     </NonInvariantDocblockPropertyType>
   </file>
   <file src="src/RuleSet/Php82.php">
-    <MixedReturnTypeCoercion>
+    <MixedArgumentTypeCoercion>
       <code><![CDATA[$this->rules]]></code>
-      <code>array</code>
-    </MixedReturnTypeCoercion>
+    </MixedArgumentTypeCoercion>
     <NonInvariantDocblockPropertyType>
       <code>$rules</code>
     </NonInvariantDocblockPropertyType>
   </file>
+  <file src="src/Rules.php">
+    <MixedArgumentTypeCoercion>
+      <code><![CDATA[\array_merge(
+            $this->value,
+            $other->value,
+        )]]></code>
+    </MixedArgumentTypeCoercion>
+    <MixedReturnTypeCoercion>
+      <code><![CDATA[$this->value]]></code>
+      <code><![CDATA[array<string, array<string, mixed>|bool>]]></code>
+    </MixedReturnTypeCoercion>
+  </file>
   <file src="test/Double/Config/RuleSet/DummyRuleSet.php">
     <MixedReturnTypeCoercion>
       <code><![CDATA[$this->customFixers]]></code>
-      <code><![CDATA[$this->rules]]></code>
-      <code>array</code>
       <code>iterable</code>
     </MixedReturnTypeCoercion>
   </file>

diff --git a/src/Factory.php b/src/Factory.php
@@ -20,13 +20,11 @@ final class Factory
     /**
      * Creates a configuration based on a rule set.
      *
-     * @param array<string, array<string, mixed>|bool> $overrideRules
-     *
      * @throws \RuntimeException
      */
     public static function fromRuleSet(
         RuleSet $ruleSet,
-        array $overrideRules = [],
+        ?Rules $overrideRules = null,
     ): Config {
         $currentPhpVersion = PhpVersion::current();
 
@@ -42,10 +40,11 @@ public static function fromRuleSet(
 
         $config->registerCustomFixers($ruleSet->customFixers());
         $config->setRiskyAllowed(true);
-        $config->setRules(\array_merge(
-            $ruleSet->rules(),
-            $overrideRules,
-        ));
+        $config->setRules($ruleSet->rules()->toArray());
+
+        if ($overrideRules instanceof Rules) {
+            $config->setRules($ruleSet->rules()->merge($overrideRules)->toArray());
+        }
 
         return $config;
     }

diff --git a/src/RuleSet.php b/src/RuleSet.php
@@ -28,11 +28,9 @@ public function customFixers(): iterable;
     public function name(): Name;
 
     /**
-     * Returns an array of rules along with their configuration.
-     *
-     * @return array<string, array<string, mixed>|bool>
+     * Returns rules along with their configuration.
      */
-    public function rules(): array;
+    public function rules(): Rules;
 
     /**
      * Returns the minimum required PHP version.

diff --git a/src/RuleSet/Php53.php b/src/RuleSet/Php53.php
@@ -15,6 +15,7 @@
 
 use Ergebnis\PhpCsFixer\Config\Name;
 use Ergebnis\PhpCsFixer\Config\PhpVersion;
+use Ergebnis\PhpCsFixer\Config\Rules;
 
 final class Php53 extends AbstractRuleSet implements ExplicitRuleSet
 {
@@ -823,9 +824,9 @@ public function name(): Name
         return Name::fromPhpVersion($this->targetPhpVersion());
     }
 
-    public function rules(): array
+    public function rules(): Rules
     {
-        return $this->rules;
+        return Rules::fromArray($this->rules);
     }
 
     public function targetPhpVersion(): PhpVersion

diff --git a/src/RuleSet/Php54.php b/src/RuleSet/Php54.php
@@ -15,6 +15,7 @@
 
 use Ergebnis\PhpCsFixer\Config\Name;
 use Ergebnis\PhpCsFixer\Config\PhpVersion;
+use Ergebnis\PhpCsFixer\Config\Rules;
 
 final class Php54 extends AbstractRuleSet implements ExplicitRuleSet
 {
@@ -825,9 +826,9 @@ public function name(): Name
         return Name::fromPhpVersion($this->targetPhpVersion());
     }
 
-    public function rules(): array
+    public function rules(): Rules
     {
-        return $this->rules;
+        return Rules::fromArray($this->rules);
     }
 
     public function targetPhpVersion(): PhpVersion

diff --git a/src/RuleSet/Php55.php b/src/RuleSet/Php55.php
@@ -15,6 +15,7 @@
 
 use Ergebnis\PhpCsFixer\Config\Name;
 use Ergebnis\PhpCsFixer\Config\PhpVersion;
+use Ergebnis\PhpCsFixer\Config\Rules;
 
 final class Php55 extends AbstractRuleSet implements ExplicitRuleSet
 {
@@ -834,9 +835,9 @@ public function name(): Name
         return Name::fromPhpVersion($this->targetPhpVersion());
     }
 
-    public function rules(): array
+    public function rules(): Rules
     {
-        return $this->rules;
+        return Rules::fromArray($this->rules);
     }
 
     public function targetPhpVersion(): PhpVersion

diff --git a/src/RuleSet/Php56.php b/src/RuleSet/Php56.php
@@ -15,6 +15,7 @@
 
 use Ergebnis\PhpCsFixer\Config\Name;
 use Ergebnis\PhpCsFixer\Config\PhpVersion;
+use Ergebnis\PhpCsFixer\Config\Rules;
 
 final class Php56 extends AbstractRuleSet implements ExplicitRuleSet
 {
@@ -834,9 +835,9 @@ public function name(): Name
         return Name::fromPhpVersion($this->targetPhpVersion());
     }
 
-    public function rules(): array
+    public function rules(): Rules
     {
-        return $this->rules;
+        return Rules::fromArray($this->rules);
     }
 
     public function targetPhpVersion(): PhpVersion

diff --git a/src/RuleSet/Php70.php b/src/RuleSet/Php70.php
@@ -15,6 +15,7 @@
 
 use Ergebnis\PhpCsFixer\Config\Name;
 use Ergebnis\PhpCsFixer\Config\PhpVersion;
+use Ergebnis\PhpCsFixer\Config\Rules;
 
 final class Php70 extends AbstractRuleSet implements ExplicitRuleSet
 {
@@ -834,9 +835,9 @@ public function name(): Name
         return Name::fromPhpVersion($this->targetPhpVersion());
     }
 
-    public function rules(): array
+    public function rules(): Rules
     {
-        return $this->rules;
+        return Rules::fromArray($this->rules);
     }
 
     public function targetPhpVersion(): PhpVersion

diff --git a/src/RuleSet/Php71.php b/src/RuleSet/Php71.php
@@ -15,6 +15,7 @@
 
 use Ergebnis\PhpCsFixer\Config\Name;
 use Ergebnis\PhpCsFixer\Config\PhpVersion;
+use Ergebnis\PhpCsFixer\Config\Rules;
 
 final class Php71 extends AbstractRuleSet implements ExplicitRuleSet
 {
@@ -837,9 +838,9 @@ public function name(): Name
         return Name::fromPhpVersion($this->targetPhpVersion());
     }
 
-    public function rules(): array
+    public function rules(): Rules
     {
-        return $this->rules;
+        return Rules::fromArray($this->rules);
     }
 
     public function targetPhpVersion(): PhpVersion

diff --git a/src/RuleSet/Php72.php b/src/RuleSet/Php72.php
@@ -15,6 +15,7 @@
 
 use Ergebnis\PhpCsFixer\Config\Name;
 use Ergebnis\PhpCsFixer\Config\PhpVersion;
+use Ergebnis\PhpCsFixer\Config\Rules;
 
 final class Php72 extends AbstractRuleSet implements ExplicitRuleSet
 {
@@ -837,9 +838,9 @@ public function name(): Name
         return Name::fromPhpVersion($this->targetPhpVersion());
     }
 
-    public function rules(): array
+    public function rules(): Rules
     {
-        return $this->rules;
+        return Rules::fromArray($this->rules);
     }
 
     public function targetPhpVersion(): PhpVersion

diff --git a/src/RuleSet/Php73.php b/src/RuleSet/Php73.php
@@ -15,6 +15,7 @@
 
 use Ergebnis\PhpCsFixer\Config\Name;
 use Ergebnis\PhpCsFixer\Config\PhpVersion;
+use Ergebnis\PhpCsFixer\Config\Rules;
 
 final class Php73 extends AbstractRuleSet implements ExplicitRuleSet
 {
@@ -838,9 +839,9 @@ public function name(): Name
         return Name::fromPhpVersion($this->targetPhpVersion());
     }
 
-    public function rules(): array
+    public function rules(): Rules
     {
-        return $this->rules;
+        return Rules::fromArray($this->rules);
     }
 
     public function targetPhpVersion(): PhpVersion