Merge branch 'rector'

Author: codedmonkey

.github/workflows/linting.yaml

@@ -63,6 +63,38 @@ jobs:
       #  if: always() && steps.composer-install.outcome == 'success'
       #  run: bin/console lint:xliff translations --ansi
 
+  rector:
+    name: Rector
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install PHP with extensions
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.3
+          tools: composer:v2
+
+      - name: Set Composer cache directory
+        id: composer-cache
+        run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+
+      - name: Cache Composer output
+        uses: actions/cache@v4
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('composer.lock') }}
+          restore-keys: ${{ runner.os }}-composer-
+
+      - name: Install Composer dependencies
+        run: composer install --ansi --no-interaction --no-progress
+
+      - name: Run Rector
+        run: vendor/bin/rector process --dry-run --ansi --no-progress-bar
+
   php-cs-fixer:
     name: PHP-CS-Fixer
 

composer.json

@@ -64,6 +64,7 @@
         "friendsofphp/php-cs-fixer": "^3.75",
         "phpstan/phpstan": "^2.1",
         "phpunit/phpunit": "^12.4",
+        "rector/rector": "^2.3",
         "symfony/browser-kit": "^7.3",
         "symfony/css-selector": "^7.3",
         "symfony/debug-bundle": "^7.3",
@@ -110,6 +111,7 @@
         ],
         "build:standalone": "docker build . -t dirigent-standalone",
         "lint": [
+            "@lint:refactor",
             "@lint:coding-style",
             "@lint:static-analysis",
             "@lint:composer",
@@ -121,6 +123,7 @@
         "lint:coding-style": "vendor/bin/php-cs-fixer fix --diff",
         "lint:composer": "composer validate",
         "lint:container": "bin/console lint:container",
+        "lint:refactor": "vendor/bin/rector process",
         "lint:static-analysis": "vendor/bin/phpstan analyze",
         "lint:templates": "bin/console lint:twig templates",
         "lint:translations": "bin/console lint:translations",
@@ -146,10 +149,11 @@
     "scripts-descriptions": {
         "build:standalone": "Build the standalone image",
         "lint": "Perform all linting validations",
-        "lint:coding-style": "Validate the code style of the PHP code",
+        "lint:coding-style": "Validate the code style of the PHP code (using PHP-CS-Fixer)",
         "lint:composer": "Validate the Composer configuration",
         "lint:container": "Validate the Symfony container configuration",
-        "lint:static-analysis": "Run static analysis on the PHP code",
+        "lint:refactor": "Run automated code refactoring (using Rector)",
+        "lint:static-analysis": "Run static analysis on the PHP code (using PHPStan)",
         "lint:templates": "Validate the Twig templates",
         "lint:translations": "Validate the translations",
         "lint:yaml": "Validate YAML files",

composer.lock

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\Php80\Rector\Class_\ClassPropertyAssignToConstructorPromotionRector;
+
+return RectorConfig::configure()
+    ->withCache(__DIR__ . '/var/cache/rector')
+    ->withRootFiles()
+    ->withPaths([
+        __DIR__ . '/bin',
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+    ])
+    ->withImportNames(importShortClasses: false)
+    ->withPhpSets()
+    ->withComposerBased(
+        twig: true,
+        doctrine: true,
+        phpunit: true,
+        symfony: true,
+    )
+    ->withAttributesSets(
+        symfony: true,
+        doctrine: true,
+        phpunit: true,
+    )
+    ->withSkip([
+        // Exclude promotion of properties to the constructor for Doctrine entities
+        ClassPropertyAssignToConstructorPromotionRector::class => [__DIR__ . '/src/Doctrine/Entity'],
+    ]);

rector.php

@@ -12,11 +12,12 @@ class ConsoleApplication extends Application
     private bool $commandsRegistered = false;
 
     public function __construct(
-        private KernelInterface $kernel,
+        private readonly KernelInterface $kernel,
     ) {
         parent::__construct('Dirigent', Kernel::VERSION);
     }
 
+    #[\Override]
     public function doRun(InputInterface $input, OutputInterface $output): int
     {
         $this->registerCommands();

src/ConsoleApplication.php

@@ -152,9 +152,7 @@ public function packageDistribution(Request $request, string $reference, string
     public function trackInstallations(Request $request): Response
     {
         $contents = json_decode($request->getContent(), true);
-        $invalidInputs = static function ($item) {
-            return !isset($item['name'], $item['version']);
-        };
+        $invalidInputs = static fn ($item) => !isset($item['name'], $item['version']);
 
         if (!is_array($contents) || !isset($contents['downloads']) || !is_array($contents['downloads']) || array_filter($contents['downloads'], $invalidInputs)) {
             return new JsonResponse(['status' => 'error', 'message' => 'Invalid request format, must be a json object containing a downloads key filled with an array of name/version objects'], 200);

src/Controller/ApiController.php

@@ -35,6 +35,7 @@ public static function getSubscribedEvents(): array
         ];
     }
 
+    #[\Override]
     public function configureCrud(Crud $crud): Crud
     {
         return $crud
@@ -43,19 +44,22 @@ public function configureCrud(Crud $crud): Crud
             ->overrideTemplate('crud/index', 'dashboard/access_token/index.html.twig');
     }
 
+    #[\Override]
     public function configureActions(Actions $actions): Actions
     {
         return $actions
             ->remove(Crud::PAGE_INDEX, Action::EDIT)
             ->remove(Crud::PAGE_NEW, Action::SAVE_AND_ADD_ANOTHER);
     }
 
+    #[\Override]
     public function configureFields(string $pageName): iterable
     {
         yield TextField::new('name');
         yield DateTimeField::new('expiresAt');
     }
 
+    #[\Override]
     public function createIndexQueryBuilder(SearchDto $searchDto, EntityDto $entityDto, FieldCollection $fields, FilterCollection $filters): QueryBuilder
     {
         /** @var User $user */

src/Controller/Dashboard/DashboardAccessTokenController.php

@@ -19,6 +19,7 @@ public static function getEntityFqcn(): string
         return Credentials::class;
     }
 
+    #[\Override]
     public function configureCrud(Crud $crud): Crud
     {
         return parent::configureCrud($crud)
@@ -27,6 +28,7 @@ public function configureCrud(Crud $crud): Crud
             ->overrideTemplate('layout', 'dashboard/credentials/layout.html.twig');
     }
 
+    #[\Override]
     public function configureFields(string $pageName): iterable
     {
         yield TextField::new('name');
@@ -36,9 +38,7 @@ public function configureFields(string $pageName): iterable
             ->setTemplatePath('dashboard/fields/credentials_type.html.twig')
             ->setRequired(true)
             ->setChoices(CredentialsType::cases())
-            ->setFormTypeOption('choice_label', static function (CredentialsType $choice): string {
-                return "credentials.type.{$choice->value}";
-            })
+            ->setFormTypeOption('choice_label', static fn (CredentialsType $choice): string => "credentials.type.{$choice->value}")
             ->renderExpanded();
         yield TextField::new('username')
             ->setFormTypeOption('row_attr', ['data-credentials-field' => 'username'])

src/Controller/Dashboard/DashboardCredentialsController.php

@@ -64,7 +64,7 @@ public function addMirroring(Request $request): Response
         if ($form->isSubmitted() && $form->isValid()) {
             $registry = $form->get('registry')->getData();
 
-            $packageNamesInput = $form->get('packages')->getData();
+            $packageNamesInput = (string) $form->get('packages')->getData();
             $packageNames = preg_split('#(\s|,)+#', $packageNamesInput);
 
             $results = [];

src/Controller/Dashboard/DashboardPackagesController.php

@@ -28,6 +28,7 @@ public static function getEntityFqcn(): string
         return Registry::class;
     }
 
+    #[\Override]
     public function configureCrud(Crud $crud): Crud
     {
         return $crud
@@ -36,6 +37,7 @@ public function configureCrud(Crud $crud): Crud
             ->setEntityPermission('ROLE_ADMIN');
     }
 
+    #[\Override]
     public function configureActions(Actions $actions): Actions
     {
         $upAction = Action::new('moveUp', icon: 'fa fa-arrow-up')
@@ -48,6 +50,7 @@ public function configureActions(Actions $actions): Actions
             ->add(Crud::PAGE_INDEX, $upAction);
     }
 
+    #[\Override]
     public function configureFields(string $pageName): iterable
     {
         yield TextField::new('name')
@@ -69,9 +72,7 @@ public function configureFields(string $pageName): iterable
             ->setTemplatePath('dashboard/fields/registry_package_mirroring.html.twig')
             ->setRequired(true)
             ->setChoices(RegistryPackageMirroring::cases())
-            ->setFormTypeOption('choice_label', static function (RegistryPackageMirroring $choice): string {
-                return "registry.package-mirroring.{$choice->value}";
-            })
+            ->setFormTypeOption('choice_label', static fn (RegistryPackageMirroring $choice): string => "registry.package-mirroring.{$choice->value}")
             ->renderExpanded();
 
         yield DateIntervalField::new('dynamicUpdateDelay')