Replace StyleCI to PHP CS Fixer (#786)

Author: vjik

.github/workflows/rector.yml .github/workflows/rector-cs.yml.github/workflows/rector.yml renamed to .github/workflows/rector-cs.yml

@@ -1,3 +1,5 @@
+name: Rector + PHP CS Fixer
+
 on:
   pull_request_target:
     paths-ignore:
@@ -9,16 +11,18 @@ on:
       - 'infection.json.dist'
       - 'psalm.xml'
 
-name: rector
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 
 jobs:
   rector:
-    uses: yiisoft/actions/.github/workflows/rector.yml@master
+    uses: yiisoft/actions/.github/workflows/rector-cs.yml@master
     secrets:
       token: ${{ secrets.YIISOFT_GITHUB_TOKEN }}
     with:
       repository: ${{ github.event.pull_request.head.repo.full_name }}
-      os: >-
-        ['ubuntu-latest']
-      php: >-
-        ['8.5']
+      php: '8.1'

.gitignore

@@ -27,5 +27,8 @@ composer.phar
 /phpunit.xml
 /.phpunit.cache
 
+# PHP CS Fixer
+/.php-cs-fixer.cache
+
 # po4a .mo files
-*.mo
+*.mo

.php-cs-fixer.dist.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+use PhpCsFixer\Config;
+use PhpCsFixer\Finder;
+use PhpCsFixer\Runner\Parallel\ParallelConfigFactory;
+
+$finder = (new Finder())->in([
+    __DIR__ . '/src',
+    __DIR__ . '/tests',
+]);
+
+return (new Config())
+    ->setParallelConfig(ParallelConfigFactory::detect())
+    ->setRules([
+        '@PER-CS3.0' => true,
+        'no_unused_imports' => true,
+        'ordered_class_elements' => true,
+        'class_attributes_separation' => ['elements' => ['method' => 'one']],
+    ])
+    ->setFinder($finder);

.styleci.yml

@@ -39,6 +39,7 @@
     },
     "require-dev": {
         "bamarni/composer-bin-plugin": "^1.8.3",
+        "friendsofphp/php-cs-fixer": "^3.91",
         "jetbrains/phpstorm-attributes": "^1.2",
         "maglnet/composer-require-checker": "^4.7.1",
         "phpbench/phpbench": "^1.4.1",
@@ -93,6 +94,7 @@
         "rector": "vendor/bin/rector process",
         "infection": "vendor/bin/infection",
         "dry-run": "vendor/bin/rector process --dry-run",
-        "psalm": "vendor/bin/psalm --config=psalm.xml"
+        "psalm": "vendor/bin/psalm --config=psalm.xml",
+        "cs-fix": "php-cs-fixer fix"
     }
 }

composer.json

@@ -20,7 +20,7 @@ interface CountableLimitInterface
      *
      * @see getLessThanMinMessage() for related error message.
      */
-    public function getMin(): int|null;
+    public function getMin(): ?int;
 
     /**
      * Returns current maximum limit.
@@ -29,7 +29,7 @@ public function getMin(): int|null;
      *
      * @see getGreaterThanMaxMessage() for related error message.
      */
-    public function getMax(): int|null;
+    public function getMax(): ?int;
 
     /**
      * Returns current "exactly" value meant for strict comparison. It is a shortcut for the case when {@see getMin()}
@@ -40,7 +40,7 @@ public function getMax(): int|null;
      *
      * @see getNotExactlyMessage() for related error message
      */
-    public function getExactly(): int|null;
+    public function getExactly(): ?int;
 
     /**
      * Returns message used when a validated value is less than minimum set in {@see getMin()}.

src/CountableLimitInterface.php

@@ -27,8 +27,7 @@ public function __construct(
          * @var array A mapping between property names and their values.
          */
         private array $data = [],
-    ) {
-    }
+    ) {}
 
     /**
      * Returns a property value by its name.

src/DataSet/ArrayDataSet.php

@@ -188,17 +188,17 @@ public function __construct(
          * @var object An object containing rules and data.
          */
         private readonly object $object,
-        int $propertyVisibility = ReflectionProperty::IS_PRIVATE |
-        ReflectionProperty::IS_PROTECTED |
-        ReflectionProperty::IS_PUBLIC,
+        int $propertyVisibility = ReflectionProperty::IS_PRIVATE
+        | ReflectionProperty::IS_PROTECTED
+        | ReflectionProperty::IS_PUBLIC,
         bool $useCache = true,
     ) {
         $this->dataSetProvided = $this->object instanceof DataSetInterface;
         $this->rulesProvided = $this->object instanceof RulesProviderInterface;
         $this->parser = new ObjectParser(
             source: $object,
             propertyVisibility: $propertyVisibility,
-            useCache: $useCache
+            useCache: $useCache,
         );
     }
 

src/DataSet/ObjectDataSet.php

@@ -33,8 +33,7 @@ public function __construct(
          * @var mixed Single value of any (mixed) data type.
          */
         private readonly mixed $value,
-    ) {
-    }
+    ) {}
 
     /**
      * Returns a property value by its name. {@see SingleValueDataSet} does not support properties so `null` is always

src/DataSet/SingleValueDataSet.php

@@ -46,7 +46,7 @@ public function getSummary(): array
         }
 
         $count = count($this->validations);
-        $countValid = count(array_filter($this->validations, fn (array $data): bool => (bool)$data['result']));
+        $countValid = count(array_filter($this->validations, fn(array $data): bool => (bool) $data['result']));
         $countInvalid = $count - $countValid;
 
         return [