Replace StyleCI to PHP CS Fixer (#283)

vjik · web-flow · commit 76a641a4b645 · 2025-12-11T09:56:22.000+03:00
diff --git a/.github/workflows/rector-cs.yml b/.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.4']
+      php: '8.1'
diff --git a/.gitignore b/.gitignore
@@ -29,3 +29,6 @@ phpunit.phar
 # phpunit cache
 .phpunit.result.cache
 /.phpunit.cache
+
+# PHP CS Fixer
+/.php-cs-fixer.cache
diff --git a/.php-cs-fixer.dist.php b/.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);
diff --git a/.styleci.yml b/.styleci.yml
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,12 +2,12 @@
 
 ## 2.1.1 under development
 
-- no changes in this release.
+- Enh #282: Add PHP 8.5 support (@vjik)
 
 ## 2.1.0 April 04, 2025
 
 - New #275: Add optional `$clock` parameter to `Manager` constructor to get current time (@vjik)
-- Chg #276, #282: Change PHP constraint in `composer.json` to `8.1 - 8.5` (@vjik)
+- Chg #276: Change PHP constraint in `composer.json` to `8.1 - 8.4` (@vjik)
 - Bug #264: Fix bug when default roles were not checked in `Manager::userHasPermission()` (@KovYu, @arogachev)
 
 ## 2.0.0 March 07, 2024
diff --git a/composer.json b/composer.json
@@ -32,6 +32,7 @@
         "yiisoft/friendly-exception": "^1.1"
     },
     "require-dev": {
+        "friendsofphp/php-cs-fixer": "^3.91",
         "maglnet/composer-require-checker": "^4.7.1",
         "phpunit/phpunit": "^10.5.45",
         "psr/clock": "^1.0",
@@ -74,6 +75,7 @@
         }
     },
     "scripts": {
+        "cs-fix": "php-cs-fixer fix",
         "test": "phpunit --testdox --no-interaction",
         "test-watch": "phpunit-watcher watch"
     }
diff --git a/src/Assignment.php b/src/Assignment.php
@@ -20,8 +20,7 @@ public function __construct(
         private readonly string $userId,
         private string $itemName,
         private readonly int $createdAt,
-    ) {
-    }
+    ) {}
 
     public function getUserId(): string
     {
diff --git a/src/CompositeRule.php b/src/CompositeRule.php
@@ -37,8 +37,8 @@ public function __construct(
                 sprintf(
                     'Operator could be either %1$s::AND or %1$s::OR, "%2$s" given.',
                     self::class,
-                    $operator
-                )
+                    $operator,
+                ),
             );
         }
     }
diff --git a/src/Exception/RuleInterfaceNotImplementedException.php b/src/Exception/RuleInterfaceNotImplementedException.php
@@ -17,7 +17,7 @@ public function __construct(string $name, int $code = 0, ?Throwable $previous =
         parent::__construct(
             "Rule \"$name\" must implement \"$interfaceName\".",
             $code,
-            $previous
+            $previous,
         );
     }
 }
diff --git a/src/Item.php b/src/Item.php
@@ -43,9 +43,7 @@ abstract class Item
     /**
      * @param string $name The name of the item. This must be globally unique.
      */
-    final public function __construct(private string $name)
-    {
-    }
+    final public function __construct(private string $name) {}
 
     /**
      * @return string Type of the item.
diff --git a/src/Manager.php b/src/Manager.php
@@ -85,8 +85,8 @@ public function userHasPermission(
 
         foreach ($hierarchy as $data) {
             if (
-                !array_key_exists($data['item']->getName(), $userItemNamesMap) ||
-                !$this->executeRule($userId === null ? $userId : (string) $userId, $data['item'], $parameters)
+                !array_key_exists($data['item']->getName(), $userItemNamesMap)
+                || !$this->executeRule($userId === null ? $userId : (string) $userId, $data['item'], $parameters)
             ) {
                 continue;
             }
@@ -168,7 +168,7 @@ public function assign(string $itemName, int|Stringable|string $userId, ?int $cr
 
         if (!$this->enableDirectPermissions && $item->getType() === Item::TYPE_PERMISSION) {
             throw new InvalidArgumentException(
-                'Assigning permissions directly is disabled. Prefer assigning roles only.'
+                'Assigning permissions directly is disabled. Prefer assigning roles only.',
             );
         }
 
@@ -218,7 +218,7 @@ public function getRolesByUserId(int|Stringable|string $userId): array
         return array_merge(
             $this->getDefaultRoles(),
             $this->itemsStorage->getRolesByNames($assignmentNames),
-            $this->itemsStorage->getAllChildRoles($assignmentNames)
+            $this->itemsStorage->getAllChildRoles($assignmentNames),
         );
     }
 
@@ -457,8 +457,8 @@ private function assertItemNameForUpdate(Item $item, string $name): void
         }
 
         throw new InvalidArgumentException(
-            'Unable to change the role or the permission name. ' .
-            "The name \"{$item->getName()}\" is already used by another role or permission.",
+            'Unable to change the role or the permission name. '
+            . "The name \"{$item->getName()}\" is already used by another role or permission.",
         );
     }
 
diff --git a/src/RuleContext.php b/src/RuleContext.php
@@ -9,8 +9,7 @@ final class RuleContext
     public function __construct(
         private readonly RuleFactoryInterface $ruleFactory,
         private readonly array $parameters,
-    ) {
-    }
+    ) {}
 
     public function getParameters(): array
     {
diff --git a/src/SimpleItemsStorage.php b/src/SimpleItemsStorage.php
@@ -39,7 +39,7 @@ public function getByNames(array $names): array
     {
         return array_filter(
             $this->getAll(),
-            static fn (Item $item): bool => in_array($item->getName(), $names, strict: true),
+            static fn(Item $item): bool => in_array($item->getName(), $names, strict: true),
         );
     }
 
@@ -243,7 +243,7 @@ private function getItemsByType(string $type): array
     {
         return array_filter(
             $this->getAll(),
-            static fn (Permission|Role $item): bool => $item->getType() === $type,
+            static fn(Permission|Role $item): bool => $item->getType() === $type,
         );
     }
 
@@ -381,7 +381,7 @@ private function fillChildrenRecursive(string $name, array &$result, array $base
      */
     private function filterRoles(array $items): array
     {
-        return array_filter($items, static fn (Permission|Role $item): bool => $item instanceof Role);
+        return array_filter($items, static fn(Permission|Role $item): bool => $item instanceof Role);
     }
 
     /**
@@ -392,6 +392,6 @@ private function filterRoles(array $items): array
      */
     private function filterPermissions(array $items): array
     {
-        return array_filter($items, static fn (Permission|Role $item): bool => $item instanceof Permission);
+        return array_filter($items, static fn(Permission|Role $item): bool => $item instanceof Permission);
     }
 }
diff --git a/tests/Common/AssignmentsStorageTestTrait.php b/tests/Common/AssignmentsStorageTestTrait.php
@@ -117,8 +117,8 @@ public function testGetByItemNames(array $itemNames, array $expectedAssignments)
         foreach ($assignments as $assignment) {
             foreach ($expectedAssignments as $expectedAssignment) {
                 if (
-                    $assignment->getItemName() === $expectedAssignment[0] &&
-                    $assignment->getUserId() === $expectedAssignment[1]
+                    $assignment->getItemName() === $expectedAssignment[0]
+                    && $assignment->getUserId() === $expectedAssignment[1]
                 ) {
                     $assignmentFound = true;
                 }
diff --git a/tests/Common/ManagerConfigurationTestTrait.php b/tests/Common/ManagerConfigurationTestTrait.php
@@ -31,9 +31,7 @@ protected function createManager(
             'clock' => $currentDateTime === null
                 ? null
                 : new class ($currentDateTime) implements ClockInterface {
-                    public function __construct(private readonly DateTimeImmutable $dateTime)
-                    {
-                    }
+                    public function __construct(private readonly DateTimeImmutable $dateTime) {}
 
                     public function now(): DateTimeImmutable
                     {
diff --git a/tests/Common/ManagerLogicTestTrait.php b/tests/Common/ManagerLogicTestTrait.php
diff --git a/tests/CompositeRuleTest.php b/tests/CompositeRuleTest.php
diff --git a/tests/Support/FakeAssignmentsStorage.php b/tests/Support/FakeAssignmentsStorage.php
diff --git a/tests/Support/FakeItemsStorage.php b/tests/Support/FakeItemsStorage.php

Original file line number	Diff line number	Diff line change
`@@ -20,8 +20,7 @@ public function __construct(`
`20`	`20`	`private readonly string $userId,`
`21`	`21`	`private string $itemName,`
`22`	`22`	`private readonly int $createdAt,`
`23`		`- ) {`
`24`		`- }`
	`23`	`+ ) {}`
`25`	`24`
`26`	`25`	`public function getUserId(): string`
`27`	`26`	`{`
Original file line number	Diff line number	Diff line change
`@@ -37,8 +37,8 @@ public function __construct(`
`37`	`37`	`sprintf(`
`38`	`38`	`'Operator could be either %1$s::AND or %1$s::OR, "%2$s" given.',`
`39`	`39`	`self::class,`
`40`		`- $operator`
`41`		`- )`
	`40`	`+ $operator,`
	`41`	`+ ),`
`42`	`42`	`);`
`43`	`43`	`}`
`44`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ public function __construct(string $name, int $code = 0, ?Throwable $previous =`
`17`	`17`	`parent::__construct(`
`18`	`18`	`"Rule \"$name\" must implement \"$interfaceName\".",`
`19`	`19`	`$code,`
`20`		`- $previous`
	`20`	`+ $previous,`
`21`	`21`	`);`
`22`	`22`	`}`
`23`	`23`	`}`