Add Rector

contao · Mar 27, 2024 · e740353 · e740353
1 parent c20dfe4
commit e740353
Show file tree

Hide file tree

Showing 17 changed files with 120 additions and 208 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -8,7 +8,7 @@ on:
         tags:
             - '*'
     schedule:
-        - cron: 0 13 * * MON,TUE
+        - cron: 0 13 * * MON,THU
 
 jobs:
     coding-style:
@@ -30,10 +30,13 @@ jobs:
             - name: Install the dependencies
               run: composer install --no-interaction --no-suggest
 
-            - name: Check the coding style
+            - name: Run Rector
+              run: vendor/bin/rector --dry-run --no-progress-bar --ansi
+
+            - name: Run ECS
               run: vendor/bin/ecs check --no-progress-bar --ansi
 
-            - name: Analyze the code
+            - name: Run PHPStan
               run: vendor/bin/phpstan analyse --no-progress
 
     tests:

diff --git a/.gitignore b/.gitignore
@@ -4,6 +4,7 @@
 
 # Monorepo Tools
 /.monorepo-split-cache/
+/.monorepo-merge-cache/
 
 # PhpUnit
 /.phpunit.result.cache

diff --git a/composer.json b/composer.json
@@ -50,12 +50,14 @@
     },
     "scripts": {
         "all": [
+            "@rector",
             "@ecs",
             "@unit-tests",
             "@phpstan"
         ],
         "ecs": "@php vendor/bin/ecs check --fix --ansi",
         "phpstan": "@php vendor/bin/phpstan analyze  --ansi",
+        "rector": "@php vendor/bin/rector --ansi",
         "unit-tests": "@php vendor/bin/phpunit --colors=always"
     }
 }
diff --git a/ecs.php b/ecs.php
@@ -33,5 +33,5 @@
     ->withParallel()
     ->withSpacing(Option::INDENTATION_SPACES, "\n")
     ->withConfiguredRule(HeaderCommentFixer::class, ['header' => "This file is part of Contao.\n\n(c) Leo Feyer\n\n@license LGPL-3.0-or-later"])
-    ->withCache(sys_get_temp_dir().'/monorepo_cache')
+    ->withCache(sys_get_temp_dir().'/ecs_monorepo_cache')
 ;
diff --git a/rector.php b/rector.php
@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\CodingStyle\Rector\FuncCall\ArraySpreadInsteadOfArrayMergeRector;
+use Rector\Config\RectorConfig;
+use Rector\Php73\Rector\FuncCall\JsonThrowOnErrorRector;
+use Rector\Php81\Rector\FuncCall\NullToStrictStringFuncCallArgRector;
+
+return RectorConfig::configure()
+    ->withSets([__DIR__.'/vendor/contao/code-quality/config/rector.php'])
+    ->withPaths([
+        __DIR__.'/src',
+        __DIR__.'/tests',
+    ])
+    ->withSkip([
+        ArraySpreadInsteadOfArrayMergeRector::class,
+        JsonThrowOnErrorRector::class,
+        NullToStrictStringFuncCallArgRector::class,
+    ])
+    ->withParallel()
+    ->withCache(sys_get_temp_dir().'/rector_monorepo_cache')
+;
diff --git a/src/Command/ComposerJsonCommand.php b/src/Command/ComposerJsonCommand.php
@@ -27,30 +27,20 @@
 
 class ComposerJsonCommand extends Command
 {
-    /**
-     * @var string
-     */
-    private $rootDir;
-
-    /**
-     * @var array
-     */
-    private $config;
+    private array $config;
 
     /**
      * @var array<string, array<string, string>>
      */
-    private $replacedPackages = [];
+    private array $replacedPackages = [];
 
     /**
      * @var array<string, string>
      */
-    private $prettyVersionConstraints = [];
+    private array $prettyVersionConstraints = [];
 
-    public function __construct(string $rootDir)
+    public function __construct(private readonly string $rootDir)
     {
-        $this->rootDir = $rootDir;
-
         parent::__construct();
     }
 
@@ -83,7 +73,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         if ($input->getOption('validate')) {
             $invalid = $this->validateJsons($rootJson, $splitJsons);
 
-            if (0 === \count($invalid)) {
+            if ([] === $invalid) {
                 $io->success('All composer.json files are up to date.');
 
                 return 0;
@@ -108,7 +98,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         $updated = $this->updateJsons($rootJson, $splitJsons);
 
-        if (0 === \count($updated)) {
+        if ([] === $updated) {
             $io->success('All composer.json files are up to date.');
 
             return 0;
@@ -224,13 +214,11 @@ function ($folder) {
             array_values($rootJson['require-dev'] ?? []),
             array_values($rootJson['conflict'] ?? []),
             array_merge(...array_values(array_map(
-                static function ($json) {
-                    return array_merge(
-                        array_values($json['require'] ?? []),
-                        array_values($json['require-dev'] ?? []),
-                        array_values($json['conflict'] ?? []),
-                    );
-                },
+                static fn ($json) => array_merge(
+                    array_values($json['require'] ?? []),
+                    array_values($json['require-dev'] ?? []),
+                    array_values($json['conflict'] ?? []),
+                ),
                 $jsons,
             ))),
         ));
@@ -277,7 +265,6 @@ static function ($json) {
                         $rootJson['require-dev'][$packageName],
                         $versionConstraint,
                     ],
-                    $packageName,
                 );
 
                 unset($rootJson['require-dev'][$packageName]);
@@ -329,7 +316,7 @@ static function ($json) {
 
         // Remove empty arrays
         foreach ($rootJson as $key => $value) {
-            if (\is_array($value) && 0 === \count($value)) {
+            if (\is_array($value) && [] === $value) {
                 unset($rootJson[$key]);
             }
         }
@@ -366,7 +353,7 @@ private function combineDependecies(array $requireArrays, array $ignorePackages
         }
 
         foreach ($requires as $packageName => $constraints) {
-            $requires[$packageName] = $this->combineConstraints($constraints, $packageName, $conjunctive);
+            $requires[$packageName] = $this->combineConstraints($constraints, $conjunctive);
         }
 
         uksort(
@@ -381,15 +368,15 @@ static function ($a, $b) {
                 }
 
                 if (
-                    (0 === strncmp($a, 'ext-', 4) && 0 !== strncmp($b, 'ext-', 4))
-                    || (0 === strncmp($a, 'lib-', 4) && 0 !== strncmp($b, 'lib-', 4))
+                    (str_starts_with($a, 'ext-') && !str_starts_with($b, 'ext-'))
+                    || (str_starts_with($a, 'lib-') && !str_starts_with($b, 'lib-'))
                 ) {
                     return -1;
                 }
 
                 if (
-                    (0 !== strncmp($a, 'ext-', 4) && 0 === strncmp($b, 'ext-', 4))
-                    || (0 !== strncmp($a, 'lib-', 4) && 0 === strncmp($b, 'lib-', 4))
+                    (!str_starts_with($a, 'ext-') && str_starts_with($b, 'ext-'))
+                    || (!str_starts_with($a, 'lib-') && str_starts_with($b, 'lib-'))
                 ) {
                     return 1;
                 }
@@ -409,7 +396,7 @@ static function ($a, $b) {
         return $requires;
     }
 
-    private function combineConstraints(array $constraints, string $name, bool $conjunctive = true): string
+    private function combineConstraints(array $constraints, bool $conjunctive = true): string
     {
         $parsedConstraints = [];
         $versionParser = new VersionParser();
@@ -420,11 +407,7 @@ private function combineConstraints(array $constraints, string $name, bool $conj
 
         $compact = (string) Intervals::compactConstraint(MultiConstraint::create($parsedConstraints, $conjunctive));
 
-        if (isset($this->prettyVersionConstraints[$compact])) {
-            return $this->prettyVersionConstraints[$compact];
-        }
-
-        return str_replace(['[', ']'], '', $compact);
+        return $this->prettyVersionConstraints[$compact] ?? str_replace(['[', ']'], '', $compact);
     }
 
     /**

diff --git a/src/Command/MergeCommand.php b/src/Command/MergeCommand.php
@@ -19,15 +19,8 @@
 
 class MergeCommand extends Command
 {
-    /**
-     * @var string
-     */
-    private $rootDir;
-
-    public function __construct(string $rootDir)
+    public function __construct(private readonly string $rootDir)
     {
-        $this->rootDir = $rootDir;
-
         parent::__construct();
     }
 

diff --git a/src/Command/SplitCommand.php b/src/Command/SplitCommand.php
@@ -24,15 +24,8 @@
 
 class SplitCommand extends Command
 {
-    /**
-     * @var string
-     */
-    private $rootDir;
-
-    public function __construct(string $rootDir)
+    public function __construct(private readonly string $rootDir)
     {
-        $this->rootDir = $rootDir;
-
         parent::__construct();
     }
 
@@ -81,7 +74,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
     private function addAuthToken($repoUrl): string
     {
-        if (($token = getenv('GITHUB_TOKEN')) && 0 === strncmp($repoUrl, 'https://github.com/', 19)) {
+        if (($token = getenv('GITHUB_TOKEN')) && str_starts_with($repoUrl, 'https://github.com/')) {
             return 'https://'.$token.'@github.com/'.substr($repoUrl, 19);
         }
 

diff --git a/src/Git/Commit.php b/src/Git/Commit.php
@@ -14,15 +14,9 @@
 
 class Commit extends GitObject
 {
-    /**
-     * @var string
-     */
-    private $tree;
+    private string $tree;
 
-    /**
-     * @var array
-     */
-    private $parents = [];
+    private array $parents = [];
 
     public function __construct(string $rawCommit)
     {
@@ -33,9 +27,9 @@ public function __construct(string $rawCommit)
                 break;
             }
 
-            if (0 === strncmp($line, 'tree ', 5)) {
+            if (str_starts_with($line, 'tree ')) {
                 $this->tree = substr($line, 5, 40);
-            } elseif (0 === strncmp($line, 'parent ', 7)) {
+            } elseif (str_starts_with($line, 'parent ')) {
                 $this->parents[] = substr($line, 7, 40);
             }
         }
@@ -61,7 +55,7 @@ public function getCommitterDate(): \DateTime
                 break;
             }
 
-            if (0 === strncmp($line, 'committer ', 10)) {
+            if (str_starts_with($line, 'committer ')) {
                 $parts = explode(' ', $line);
 
                 $date = \DateTime::createFromFormat(
@@ -99,7 +93,7 @@ public function hasGpgSignature(): bool
                 break;
             }
 
-            if (0 === strncmp($line, 'gpgsig ', 7)) {
+            if (str_starts_with($line, 'gpgsig ')) {
                 return true;
             }
         }
@@ -128,7 +122,7 @@ public function withTree(string $hash): self
                 break;
             }
 
-            if (0 === strncmp($line, 'tree ', 5)) {
+            if (str_starts_with($line, 'tree ')) {
                 $raw[$num] = 'tree '.$hash;
                 break;
             }
@@ -146,11 +140,11 @@ public function withParents(array $hashes): self
                 break;
             }
 
-            if (0 === strncmp($line, 'tree ', 5)) {
-                if (\count($hashes)) {
+            if (str_starts_with($line, 'tree ')) {
+                if ([] !== $hashes) {
                     $raw[$num] .= "\nparent ".implode("\nparent ", $hashes);
                 }
-            } elseif (0 === strncmp($line, 'parent ', 7)) {
+            } elseif (str_starts_with($line, 'parent ')) {
                 unset($raw[$num]);
             }
         }
@@ -179,7 +173,7 @@ public function withoutGpgSignature(): self
 
             $signatureStartFound = false;
 
-            if (0 === strncmp($line, 'gpgsig ', 7)) {
+            if (str_starts_with($line, 'gpgsig ')) {
                 $signatureStartFound = true;
                 unset($raw[$num]);
             }

diff --git a/src/Git/GitObject.php b/src/Git/GitObject.php
@@ -14,14 +14,8 @@
 
 abstract class GitObject
 {
-    /**
-     * @var string
-     */
-    private $raw;
-
-    public function __construct(string $rawData)
+    public function __construct(private readonly string $raw)
     {
-        $this->raw = $rawData;
     }
 
     public function getHash(): string