#48 - @kubawerlos custom fixers added (#47)

* - readonlies fix * #48 - custom fixers added
blumilksoftware · Feb 20, 2022 · e9d1c81 · e9d1c81
1 parent c1e06d9
commit e9d1c81
Show file tree

Hide file tree

Showing 10 changed files with 89 additions and 21 deletions.
diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml
@@ -8,6 +8,7 @@ on:
 
 jobs:
   build:
+    name: "Checking the package: testing and linting"
     runs-on: ubuntu-20.04
 
     strategy:

diff --git a/composer.json b/composer.json
@@ -5,7 +5,8 @@
   "type": "library",
   "require": {
     "php": "^8.0",
-    "symplify/easy-coding-standard": "10.0.8"
+    "kubawerlos/php-cs-fixer-custom-fixers": "^3.7",
+    "symplify/easy-coding-standard": "10.0.21"
   },
   "require-dev": {
     "composer/composer": "2.*",

diff --git a/src/Configuration/Defaults/CommonAdditionalRules.php b/src/Configuration/Defaults/CommonAdditionalRules.php
@@ -20,6 +20,15 @@
 use PhpCsFixer\Fixer\Phpdoc\PhpdocLineSpanFixer;
 use PhpCsFixer\Fixer\Strict\DeclareStrictTypesFixer;
 use PhpCsFixer\Fixer\Whitespace\NoExtraBlankLinesFixer;
+use PhpCsFixerCustomFixers\Fixer\ConstructorEmptyBracesFixer;
+use PhpCsFixerCustomFixers\Fixer\InternalClassCasingFixer;
+use PhpCsFixerCustomFixers\Fixer\MultilinePromotedPropertiesFixer;
+use PhpCsFixerCustomFixers\Fixer\NoUselessCommentFixer;
+use PhpCsFixerCustomFixers\Fixer\PhpdocArrayStyleFixer;
+use PhpCsFixerCustomFixers\Fixer\PromotedConstructorPropertyFixer;
+use PhpCsFixerCustomFixers\Fixer\SingleSpaceAfterStatementFixer;
+use PhpCsFixerCustomFixers\Fixer\SingleSpaceBeforeStatementFixer;
+use PhpCsFixerCustomFixers\Fixer\StringableInterfaceFixer;
 
 class CommonAdditionalRules extends Rules implements AdditionalRules
 {
@@ -62,5 +71,14 @@ class CommonAdditionalRules extends Rules implements AdditionalRules
             ],
         ],
         NullableTypeDeclarationForDefaultNullValueFixer::class => null,
+        ConstructorEmptyBracesFixer::class => null,
+        InternalClassCasingFixer::class => null,
+        MultilinePromotedPropertiesFixer::class => null,
+        NoUselessCommentFixer::class => null,
+        PhpdocArrayStyleFixer::class => null,
+        PromotedConstructorPropertyFixer::class => null,
+        SingleSpaceAfterStatementFixer::class => null,
+        SingleSpaceBeforeStatementFixer::class => null,
+        StringableInterfaceFixer::class => null,
     ];
 }
diff --git a/src/Configuration/Defaults/CommonSetLists.php b/src/Configuration/Defaults/CommonSetLists.php
@@ -20,7 +20,7 @@ public function get(): array
         return $this->setLists;
     }
 
-    public function add(string ...$setLists): self
+    public function add(string ...$setLists): static
     {
         foreach ($setLists as $setList) {
             if (!in_array($setList, $this->setLists, true)) {
@@ -31,14 +31,14 @@ public function add(string ...$setLists): self
         return $this;
     }
 
-    public function clear(): self
+    public function clear(): static
     {
         $this->setLists = [];
 
         return $this;
     }
 
-    public function filter(string ...$setLists): self
+    public function filter(string ...$setLists): static
     {
         foreach ($this->setLists as $index => $setList) {
             if (in_array($setList, $setLists, true)) {

diff --git a/src/Configuration/Defaults/Paths.php b/src/Configuration/Defaults/Paths.php
@@ -20,7 +20,7 @@ public function get(): array
         return $this->paths;
     }
 
-    public function add(string ...$paths): self
+    public function add(string ...$paths): static
     {
         foreach ($paths as $path) {
             if (!in_array($path, $this->paths, true)) {
@@ -31,14 +31,14 @@ public function add(string ...$paths): self
         return $this;
     }
 
-    public function clear(): self
+    public function clear(): static
     {
         $this->paths = [];
 
         return $this;
     }
 
-    public function filter(string ...$paths): self
+    public function filter(string ...$paths): static
     {
         foreach ($this->paths as $index => $path) {
             if (in_array($path, $paths, true)) {

diff --git a/src/Configuration/Defaults/Rules.php b/src/Configuration/Defaults/Rules.php
@@ -15,7 +15,7 @@ public function get(): array
         return $this->rules;
     }
 
-    public function add(Rule ...$rules): self
+    public function add(Rule ...$rules): static
     {
         foreach ($rules as $rule) {
             if (!in_array($rule->getFixerClassName(), array_keys($this->rules), true)) {
@@ -26,14 +26,14 @@ public function add(Rule ...$rules): self
         return $this;
     }
 
-    public function clear(): self
+    public function clear(): static
     {
         $this->rules = [];
 
         return $this;
     }
 
-    public function filter(string ...$rules): self
+    public function filter(string ...$rules): static
     {
         foreach (array_keys($this->rules) as $rule) {
             if (in_array($rule, $rules, true)) {

diff --git a/src/Configuration/Utils/Rule.php b/src/Configuration/Utils/Rule.php
@@ -6,14 +6,10 @@
 
 class Rule
 {
-    protected string $fixer;
-    protected ?array $options;
-
-    public function __construct(string $fixer, ?array $options = null)
-    {
-        $this->fixer = $fixer;
-        $this->options = $options;
-    }
+    public function __construct(
+        protected string $fixer,
+        protected ?array $options = null,
+    ) {}
 
     public function getFixerClassName(): string
     {

diff --git a/tests/codestyle/fixtures/readonlies/actual.php b/tests/codestyle/fixtures/readonlies/actual.php
@@ -1,10 +1,16 @@
 <?php
 
+declare(strict_types=1);
+
 class ReadonlyThing
 {
     protected readonly bool $true;
 
-    public function __construct(protected readonly string $string)
+    public function __construct(
+        protected readonly string $string,
+        protected readonly ?bool $nullable,
+        protected readonly ?bool $initializedNullable = null,
+    )
     {
     }
 }
diff --git a/tests/codestyle/fixtures/readonlies/expected.php b/tests/codestyle/fixtures/readonlies/expected.php
@@ -8,6 +8,7 @@ class ReadonlyThing
 
     public function __construct(
         protected readonly string $string,
-    ) {
-    }
+        protected readonly ?bool $nullable,
+        protected readonly ?bool $initializedNullable = null,
+    ) {}
 }
diff --git a/tests/unit/AdditionalRulesConfigurationTest.php b/tests/unit/AdditionalRulesConfigurationTest.php
@@ -22,6 +22,15 @@
 use PhpCsFixer\Fixer\Strict\DeclareStrictTypesFixer;
 use PhpCsFixer\Fixer\StringNotation\HeredocToNowdocFixer;
 use PhpCsFixer\Fixer\Whitespace\NoExtraBlankLinesFixer;
+use PhpCsFixerCustomFixers\Fixer\ConstructorEmptyBracesFixer;
+use PhpCsFixerCustomFixers\Fixer\InternalClassCasingFixer;
+use PhpCsFixerCustomFixers\Fixer\MultilinePromotedPropertiesFixer;
+use PhpCsFixerCustomFixers\Fixer\NoUselessCommentFixer;
+use PhpCsFixerCustomFixers\Fixer\PhpdocArrayStyleFixer;
+use PhpCsFixerCustomFixers\Fixer\PromotedConstructorPropertyFixer;
+use PhpCsFixerCustomFixers\Fixer\SingleSpaceAfterStatementFixer;
+use PhpCsFixerCustomFixers\Fixer\SingleSpaceBeforeStatementFixer;
+use PhpCsFixerCustomFixers\Fixer\StringableInterfaceFixer;
 use PHPUnit\Framework\TestCase;
 
 class AdditionalRulesConfigurationTest extends TestCase
@@ -71,6 +80,15 @@ public function testAdditionalRulesConfiguration(): void
                     ],
                 ],
                 NullableTypeDeclarationForDefaultNullValueFixer::class => null,
+                ConstructorEmptyBracesFixer::class => null,
+                InternalClassCasingFixer::class => null,
+                MultilinePromotedPropertiesFixer::class => null,
+                NoUselessCommentFixer::class => null,
+                PhpdocArrayStyleFixer::class => null,
+                PromotedConstructorPropertyFixer::class => null,
+                SingleSpaceAfterStatementFixer::class => null,
+                SingleSpaceBeforeStatementFixer::class => null,
+                StringableInterfaceFixer::class => null,
             ],
             $config->options()["rules"],
         );
@@ -126,6 +144,15 @@ public function testFilteringAdditionalRulesConfiguration(): void
                     ],
                 ],
                 NullableTypeDeclarationForDefaultNullValueFixer::class => null,
+                ConstructorEmptyBracesFixer::class => null,
+                InternalClassCasingFixer::class => null,
+                MultilinePromotedPropertiesFixer::class => null,
+                NoUselessCommentFixer::class => null,
+                PhpdocArrayStyleFixer::class => null,
+                PromotedConstructorPropertyFixer::class => null,
+                SingleSpaceAfterStatementFixer::class => null,
+                SingleSpaceBeforeStatementFixer::class => null,
+                StringableInterfaceFixer::class => null,
             ],
             $config->options()["rules"],
         );
@@ -178,6 +205,15 @@ public function testExtendingAdditionalRulesConfiguration(): void
                     ],
                 ],
                 NullableTypeDeclarationForDefaultNullValueFixer::class => null,
+                ConstructorEmptyBracesFixer::class => null,
+                InternalClassCasingFixer::class => null,
+                MultilinePromotedPropertiesFixer::class => null,
+                NoUselessCommentFixer::class => null,
+                PhpdocArrayStyleFixer::class => null,
+                PromotedConstructorPropertyFixer::class => null,
+                SingleSpaceAfterStatementFixer::class => null,
+                SingleSpaceBeforeStatementFixer::class => null,
+                StringableInterfaceFixer::class => null,
                 HeredocToNowdocFixer::class => null,
             ],
             $config->options()["rules"],
@@ -238,6 +274,15 @@ public function testExtendingWithOptionsAdditionalRulesConfiguration(): void
                     ],
                 ],
                 NullableTypeDeclarationForDefaultNullValueFixer::class => null,
+                ConstructorEmptyBracesFixer::class => null,
+                InternalClassCasingFixer::class => null,
+                MultilinePromotedPropertiesFixer::class => null,
+                NoUselessCommentFixer::class => null,
+                PhpdocArrayStyleFixer::class => null,
+                PromotedConstructorPropertyFixer::class => null,
+                SingleSpaceAfterStatementFixer::class => null,
+                SingleSpaceBeforeStatementFixer::class => null,
+                StringableInterfaceFixer::class => null,
                 NoMixedEchoPrintFixer::class => [
                     "use" => "echo",
                 ],