Merge pull request #886 from ergebnis/feature/named

Enhancement: Extract named constructor
ergebnis · Sep 18, 2023 · 3b18622 · 3b18622
2 parents 34fffc3 + 4ba852a
commit 3b18622
Show file tree

Hide file tree

Showing 28 changed files with 249 additions and 79 deletions.
diff --git a/.php-cs-fixer.php b/.php-cs-fixer.php
@@ -26,7 +26,7 @@
 
 $license->save();
 
-$config = PhpCsFixer\Config\Factory::fromRuleSet(new PhpCsFixer\Config\RuleSet\Php81($license->header()));
+$config = PhpCsFixer\Config\Factory::fromRuleSet(PhpCsFixer\Config\RuleSet\Php81::create($license->header()));
 
 $config->getFinder()
     ->exclude([

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -19,6 +19,7 @@ For a full diff see [`5.16.0...main`][5.16.0...main].
 
 - Allow implementations of `Config\RuleSet` to declare and configure custom fixers ([#872]), by [@localheinz]
 - Renamed `Config\RuleSet::targetPhpVersion()` to `Config\RuleSet::phpVersion()` ([#878]), by [@localheinz]
+- Reduced visibility of constructors and extracted named constructors `Config\RuleSet\Php53::create()`, `Config\RuleSet\Php54::create()`, `Config\RuleSet\Php55::create()`, `Config\RuleSet\Php56::create()`, `Config\RuleSet\Php70::create()`, `Config\RuleSet\Php71::create()`, `Config\RuleSet\Php72::create()`, `Config\RuleSet\Php73::create()`, `Config\RuleSet\Php74::create()`, `Config\RuleSet\Php80::create()`,  `Config\RuleSet\Php81::create()`,  `Config\RuleSet\Php82::create()` ([#886]), by [@localheinz]
 
 ### Fixed
 
@@ -1196,6 +1197,7 @@ For a full diff see [`d899e77...1.0.0`][d899e77...1.0.0].
 [#881]: https://github.com/ergebnis/php-cs-fixer-config/pull/881
 [#883]: https://github.com/ergebnis/php-cs-fixer-config/pull/883
 [#885]: https://github.com/ergebnis/php-cs-fixer-config/pull/885
+[#886]: https://github.com/ergebnis/php-cs-fixer-config/pull/886
 
 [@dependabot]: https://github.com/apps/dependabot
 [@linuxjuggler]: https://github.com/linuxjuggler

diff --git a/README.md b/README.md
@@ -50,7 +50,7 @@ declare(strict_types=1);
 
 use Ergebnis\PhpCsFixer\Config;
 
-$config = Config\Factory::fromRuleSet(new Config\RuleSet\Php82());
+$config = Config\Factory::fromRuleSet(Config\RuleSet\Php82::create());
 
 $config->getFinder()->in(__DIR__);
 $config->setCacheFile(__DIR__ . '/.build/php-cs-fixer/.php-cs-fixer.cache');
@@ -87,8 +87,8 @@ All configuration examples use the caching feature, and if you want to use it as
 +@see https://github.com/ergebnis/php-cs-fixer-config
 +EOF;
 
--$config = Config\Factory::fromRuleSet(new Config\RuleSet\Php82());
-+$config = Config\Factory::fromRuleSet(new Config\RuleSet\Php82($header));
+-$config = Config\Factory::fromRuleSet(Config\RuleSet\Php82::create());
++$config = Config\Factory::fromRuleSet(Config\RuleSet\Php82::create($header));
 
  $config->getFinder()->in(__DIR__);
  $config->setCacheFile(__DIR__ . '/.build/php-cs-fixer/.php-cs-fixer.cache');
@@ -125,8 +125,8 @@ 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\Rules::fromArray([
+-$config = Config\Factory::fromRuleSet(Config\RuleSet\Php82::create());
++$config = Config\Factory::fromRuleSet(Config\RuleSet\Php82::create(), Config\Rules::fromArray([
 +    'mb_str_functions' => false,
 +    'strict_comparison' => false,
 +]));

diff --git a/src/RuleSet/Php53.php b/src/RuleSet/Php53.php
@@ -26,7 +26,19 @@ final class Php53 implements RuleSet
     private readonly PhpVersion $phpVersion;
     private readonly Rules $rules;
 
-    public function __construct(?string $header = null)
+    private function __construct(
+        Fixers $customFixers,
+        Name $name,
+        PhpVersion $phpVersion,
+        Rules $rules,
+    ) {
+        $this->customFixers = $customFixers;
+        $this->name = $name;
+        $this->phpVersion = $phpVersion;
+        $this->rules = $rules;
+    }
+
+    public static function create(?string $header = null): self
     {
         $fixers = Fixers::empty();
         $phpVersion = PhpVersion::create(
@@ -846,10 +858,12 @@ public function __construct(?string $header = null)
             ]));
         }
 
-        $this->customFixers = $fixers;
-        $this->name = $name;
-        $this->phpVersion = $phpVersion;
-        $this->rules = $rules;
+        return new self(
+            $fixers,
+            $name,
+            $phpVersion,
+            $rules,
+        );
     }
 
     public function customFixers(): Fixers

diff --git a/src/RuleSet/Php54.php b/src/RuleSet/Php54.php
@@ -26,7 +26,19 @@ final class Php54 implements RuleSet
     private readonly PhpVersion $phpVersion;
     private readonly Rules $rules;
 
-    public function __construct(?string $header = null)
+    private function __construct(
+        Fixers $customFixers,
+        Name $name,
+        PhpVersion $phpVersion,
+        Rules $rules,
+    ) {
+        $this->customFixers = $customFixers;
+        $this->name = $name;
+        $this->phpVersion = $phpVersion;
+        $this->rules = $rules;
+    }
+
+    public static function create(?string $header = null): self
     {
         $fixers = Fixers::empty();
         $phpVersion = PhpVersion::create(
@@ -848,10 +860,12 @@ public function __construct(?string $header = null)
             ]));
         }
 
-        $this->customFixers = $fixers;
-        $this->name = $name;
-        $this->phpVersion = $phpVersion;
-        $this->rules = $rules;
+        return new self(
+            $fixers,
+            $name,
+            $phpVersion,
+            $rules,
+        );
     }
 
     public function customFixers(): Fixers

diff --git a/src/RuleSet/Php55.php b/src/RuleSet/Php55.php
@@ -26,7 +26,19 @@ final class Php55 implements RuleSet
     private readonly PhpVersion $phpVersion;
     private readonly Rules $rules;
 
-    public function __construct(?string $header = null)
+    private function __construct(
+        Fixers $customFixers,
+        Name $name,
+        PhpVersion $phpVersion,
+        Rules $rules,
+    ) {
+        $this->customFixers = $customFixers;
+        $this->name = $name;
+        $this->phpVersion = $phpVersion;
+        $this->rules = $rules;
+    }
+
+    public static function create(?string $header = null): self
     {
         $fixers = Fixers::empty();
         $phpVersion = PhpVersion::create(
@@ -857,10 +869,12 @@ public function __construct(?string $header = null)
             ]));
         }
 
-        $this->customFixers = $fixers;
-        $this->name = $name;
-        $this->phpVersion = $phpVersion;
-        $this->rules = $rules;
+        return new self(
+            $fixers,
+            $name,
+            $phpVersion,
+            $rules,
+        );
     }
 
     public function customFixers(): Fixers

diff --git a/src/RuleSet/Php56.php b/src/RuleSet/Php56.php
@@ -26,7 +26,19 @@ final class Php56 implements RuleSet
     private readonly PhpVersion $phpVersion;
     private readonly Rules $rules;
 
-    public function __construct(?string $header = null)
+    private function __construct(
+        Fixers $customFixers,
+        Name $name,
+        PhpVersion $phpVersion,
+        Rules $rules,
+    ) {
+        $this->customFixers = $customFixers;
+        $this->name = $name;
+        $this->phpVersion = $phpVersion;
+        $this->rules = $rules;
+    }
+
+    public static function create(?string $header = null): self
     {
         $fixers = Fixers::empty();
         $phpVersion = PhpVersion::create(
@@ -857,10 +869,12 @@ public function __construct(?string $header = null)
             ]));
         }
 
-        $this->customFixers = $fixers;
-        $this->name = $name;
-        $this->phpVersion = $phpVersion;
-        $this->rules = $rules;
+        return new self(
+            $fixers,
+            $name,
+            $phpVersion,
+            $rules,
+        );
     }
 
     public function customFixers(): Fixers

diff --git a/src/RuleSet/Php70.php b/src/RuleSet/Php70.php
@@ -26,7 +26,19 @@ final class Php70 implements RuleSet
     private readonly PhpVersion $phpVersion;
     private readonly Rules $rules;
 
-    public function __construct(?string $header = null)
+    private function __construct(
+        Fixers $customFixers,
+        Name $name,
+        PhpVersion $phpVersion,
+        Rules $rules,
+    ) {
+        $this->customFixers = $customFixers;
+        $this->name = $name;
+        $this->phpVersion = $phpVersion;
+        $this->rules = $rules;
+    }
+
+    public static function create(?string $header = null): self
     {
         $fixers = Fixers::empty();
         $phpVersion = PhpVersion::create(
@@ -857,10 +869,12 @@ public function __construct(?string $header = null)
             ]));
         }
 
-        $this->customFixers = $fixers;
-        $this->name = $name;
-        $this->phpVersion = $phpVersion;
-        $this->rules = $rules;
+        return new self(
+            $fixers,
+            $name,
+            $phpVersion,
+            $rules,
+        );
     }
 
     public function customFixers(): Fixers

diff --git a/src/RuleSet/Php71.php b/src/RuleSet/Php71.php
@@ -26,7 +26,19 @@ final class Php71 implements RuleSet
     private readonly PhpVersion $phpVersion;
     private readonly Rules $rules;
 
-    public function __construct(?string $header = null)
+    private function __construct(
+        Fixers $customFixers,
+        Name $name,
+        PhpVersion $phpVersion,
+        Rules $rules,
+    ) {
+        $this->customFixers = $customFixers;
+        $this->name = $name;
+        $this->phpVersion = $phpVersion;
+        $this->rules = $rules;
+    }
+
+    public static function create(?string $header = null): self
     {
         $fixers = Fixers::empty();
         $phpVersion = PhpVersion::create(
@@ -860,10 +872,12 @@ public function __construct(?string $header = null)
             ]));
         }
 
-        $this->customFixers = $fixers;
-        $this->name = $name;
-        $this->phpVersion = $phpVersion;
-        $this->rules = $rules;
+        return new self(
+            $fixers,
+            $name,
+            $phpVersion,
+            $rules,
+        );
     }
 
     public function customFixers(): Fixers

diff --git a/src/RuleSet/Php72.php b/src/RuleSet/Php72.php
@@ -26,7 +26,19 @@ final class Php72 implements RuleSet
     private readonly PhpVersion $phpVersion;
     private readonly Rules $rules;
 
-    public function __construct(?string $header = null)
+    private function __construct(
+        Fixers $customFixers,
+        Name $name,
+        PhpVersion $phpVersion,
+        Rules $rules,
+    ) {
+        $this->customFixers = $customFixers;
+        $this->name = $name;
+        $this->phpVersion = $phpVersion;
+        $this->rules = $rules;
+    }
+
+    public static function create(?string $header = null): self
     {
         $fixers = Fixers::empty();
         $phpVersion = PhpVersion::create(
@@ -860,10 +872,12 @@ public function __construct(?string $header = null)
             ]));
         }
 
-        $this->customFixers = $fixers;
-        $this->name = $name;
-        $this->phpVersion = $phpVersion;
-        $this->rules = $rules;
+        return new self(
+            $fixers,
+            $name,
+            $phpVersion,
+            $rules,
+        );
     }
 
     public function customFixers(): Fixers

diff --git a/src/RuleSet/Php73.php b/src/RuleSet/Php73.php
@@ -26,7 +26,19 @@ final class Php73 implements RuleSet
     private readonly PhpVersion $phpVersion;
     private readonly Rules $rules;
 
-    public function __construct(?string $header = null)
+    private function __construct(
+        Fixers $customFixers,
+        Name $name,
+        PhpVersion $phpVersion,
+        Rules $rules,
+    ) {
+        $this->customFixers = $customFixers;
+        $this->name = $name;
+        $this->phpVersion = $phpVersion;
+        $this->rules = $rules;
+    }
+
+    public static function create(?string $header = null): self
     {
         $fixers = Fixers::empty();
         $phpVersion = PhpVersion::create(
@@ -861,10 +873,12 @@ public function __construct(?string $header = null)
             ]));
         }
 
-        $this->customFixers = $fixers;
-        $this->name = $name;
-        $this->phpVersion = $phpVersion;
-        $this->rules = $rules;
+        return new self(
+            $fixers,
+            $name,
+            $phpVersion,
+            $rules,
+        );
     }
 
     public function customFixers(): Fixers

diff --git a/src/RuleSet/Php74.php b/src/RuleSet/Php74.php
@@ -26,7 +26,19 @@ final class Php74 implements RuleSet
     private readonly PhpVersion $phpVersion;
     private readonly Rules $rules;
 
-    public function __construct(?string $header = null)
+    private function __construct(
+        Fixers $customFixers,
+        Name $name,
+        PhpVersion $phpVersion,
+        Rules $rules,
+    ) {
+        $this->customFixers = $customFixers;
+        $this->name = $name;
+        $this->phpVersion = $phpVersion;
+        $this->rules = $rules;
+    }
+
+    public static function create(?string $header = null): self
     {
         $fixers = Fixers::empty();
         $phpVersion = PhpVersion::create(
@@ -864,10 +876,12 @@ public function __construct(?string $header = null)
             ]));
         }
 
-        $this->customFixers = $fixers;
-        $this->name = $name;
-        $this->phpVersion = $phpVersion;
-        $this->rules = $rules;
+        return new self(
+            $fixers,
+            $name,
+            $phpVersion,
+            $rules,
+        );
     }
 
     public function customFixers(): Fixers