Replace StyleCI to PHP CS Fixer (#108)

Author: vjik

.github/workflows/cs.yml

@@ -0,0 +1,48 @@
+name: cs fixer
+
+on:
+  pull_request_target:
+    paths-ignore:
+      - 'docs/**'
+      - 'README.md'
+      - 'CHANGELOG.md'
+      - '.gitignore'
+      - '.gitattributes'
+      - 'infection.json.dist'
+      - 'psalm.xml'
+
+jobs:
+  fix:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.head_ref }}
+          repository: ${{ github.event.pull_request.head.repo.full_name }}
+          token: ${{ secrets.YIISOFT_GITHUB_TOKEN }}
+
+      - name: Install PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.4
+          tools: composer:v2
+          coverage: none
+
+      - name: Install Composer dependencies
+        uses: "ramsey/composer-install@v3"
+
+      - name: Run Rector
+        run: compose
+
+      - name: Run PHP CS Fixer
+        run: composer php-cs-fixer
+
+      - name: Commit changes
+        uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          commit_message: "Apply PHP CS Fixer and Rector changes (CI)"
+          file_pattern: '*.php'
+          disable_globbing: true

.github/workflows/rector.yml

@@ -26,3 +26,6 @@ composer.phar
 /phpunit.phar
 /phpunit.xml
 /.phpunit.cache
+
+# PHP CS Fixer
+/.php-cs-fixer.cache

.gitignore

@@ -0,0 +1,20 @@
+<?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-CS2.0' => true,
+        'no_unused_imports' => true,
+    ])
+    ->setFinder($finder);

.php-cs-fixer.dist.php

@@ -30,6 +30,7 @@
         "psr/container": "^1.0 || ^2.0"
     },
     "require-dev": {
+        "friendsofphp/php-cs-fixer": "^3.69",
         "maglnet/composer-require-checker": "^4.7.1",
         "phpunit/phpunit": "^10.5.45",
         "rector/rector": "^2.0.9",
@@ -57,6 +58,8 @@
         }
     },
     "scripts": {
+        "php-cs-fixer": "php-cs-fixer fix",
+        "rector": "rector",
         "test": "phpunit --testdox --no-interaction",
         "test-watch": "phpunit-watcher watch"
     }

.styleci.yml

@@ -27,11 +27,13 @@ The code is statically analyzed with [Psalm](https://psalm.dev/). To run static
 
 ## Code style
 
-Use [Rector](https://github.com/rectorphp/rector) to make codebase follow some specific rules or
-use either newest or any specific version of PHP:
+Package used [PHP CS Fixer](https://cs.symfony.com/) to maintain [PER CS 2.0](https://www.php-fig.org/per/coding-style/)
+code style and [Rector](https://github.com/rectorphp/rector) to make codebase follow some specific rules or use either
+newest or any specific version of PHP:
 
 ```shell
-./vendor/bin/rector
+composer php-cs-fixer
+composer rector
 ```
 
 ## Dependencies

composer.json

@@ -48,9 +48,8 @@ final class ArrayDefinition implements DefinitionInterface
     private function __construct(
         private string $class,
         private array $constructorArguments,
-        private array $methodsAndProperties
-    ) {
-    }
+        private array $methodsAndProperties,
+    ) {}
 
     /**
      * @param ContainerInterface|null $referenceContainer Container to resolve references with.
@@ -72,7 +71,7 @@ public static function fromConfig(array $config): self
         return new self(
             $config[self::CLASS_NAME],
             $config[self::CONSTRUCTOR] ?? [],
-            self::getMethodsAndPropertiesFromConfig($config)
+            self::getMethodsAndPropertiesFromConfig($config),
         );
     }
 
@@ -142,7 +141,7 @@ public function resolve(ContainerInterface $container): object
         $resolvedConstructorArguments = $this->resolveFunctionArguments(
             $container,
             DefinitionExtractor::fromClassName($class),
-            $this->getConstructorArguments()
+            $this->getConstructorArguments(),
         );
 
         /** @psalm-suppress MixedMethodCall */
@@ -182,7 +181,7 @@ public function resolve(ContainerInterface $container): object
     private function resolveFunctionArguments(
         ContainerInterface $container,
         array $dependencies,
-        array $arguments
+        array $arguments,
     ): array {
         $isIntegerIndexed = $this->isIntegerIndexed($arguments);
         $dependencyIndex = 0;
@@ -209,7 +208,7 @@ private function resolveFunctionArguments(
                     $arguments[$variadicKey] = DefinitionResolver::resolve(
                         $container,
                         $this->referenceContainer,
-                        $arguments[$variadicKey]
+                        $arguments[$variadicKey],
                     );
                 }
 
@@ -220,8 +219,8 @@ private function resolveFunctionArguments(
                     throw new InvalidArgumentException(
                         sprintf(
                             'Named argument for a variadic parameter should be an array, "%s" given.',
-                            gettype($arguments[$variadicKey])
-                        )
+                            gettype($arguments[$variadicKey]),
+                        ),
                     );
                 }
             } else {
@@ -262,7 +261,7 @@ private function isIntegerIndexed(array $arguments): bool
         }
         if ($hasIntegerIndex && $hasStringIndex) {
             throw new InvalidConfigException(
-                'Arguments indexed both by name and by position are not allowed in the same array.'
+                'Arguments indexed both by name and by position are not allowed in the same array.',
             );
         }
 

docs/internals.md

@@ -45,11 +45,11 @@ public function resolve(ContainerInterface $container): mixed
     {
         try {
             $reflection = new ReflectionFunction(
-                $this->prepareClosure($this->callable, $container)
+                $this->prepareClosure($this->callable, $container),
             );
         } catch (ReflectionException) {
             throw new NotInstantiableException(
-                'Can not instantiate callable definition. Got ' . var_export($this->callable, true)
+                'Can not instantiate callable definition. Got ' . var_export($this->callable, true),
             );
         }
 

src/ArrayDefinition.php

@@ -32,9 +32,8 @@ final class DefinitionStorage
      */
     public function __construct(
         private array $definitions = [],
-        private readonly bool $useStrictMode = false
-    ) {
-    }
+        private readonly bool $useStrictMode = false,
+    ) {}
 
     /**
      * @param ContainerInterface $delegateContainer Container to fall back to when dependency is not found.
@@ -113,7 +112,7 @@ private function isResolvable(string $id, array $building): bool
             throw new CircularReferenceException(sprintf(
                 'Circular reference to "%s" detected while building: %s.',
                 $id,
-                implode(', ', array_keys($building))
+                implode(', ', array_keys($building)),
             ));
         }
 
@@ -212,8 +211,8 @@ private function isResolvable(string $id, array $building): bool
                             sprintf(
                                 'Circular reference to "%s" detected while building: %s.',
                                 $id,
-                                implode(', ', array_keys($building))
-                            )
+                                implode(', ', array_keys($building)),
+                            ),
                         );
                     }