api: setup rector again to keep our codebase up to date

Exclude some controversial rules for now.

This documents the rules which were used for the last run.
No enforcement right now, just enablement.

It also helped with fixing phpunit deprecations.

Author: BacLuc

api/composer.json

@@ -141,7 +141,8 @@
         ],
         "psalm": [
             "psalm.phar"
-        ]
+        ],
+        "rector": "vendor/bin/rector"
     },
     "conflict": {
         "symfony/dependency-injection": "5.3.7",

api/rector.php

@@ -2,34 +2,57 @@
 
 declare(strict_types=1);
 
-use Rector\Core\Configuration\Option;
-use Rector\Doctrine\Set\DoctrineSetList;
-use Rector\Php74\Rector\Property\TypedPropertyRector;
-use Rector\Set\ValueObject\SetList;
-use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+use Rector\CodeQuality\Rector\Catch_\ThrowWithPreviousExceptionRector;
+use Rector\CodeQuality\Rector\ClassMethod\LocallyCalledStaticMethodToNonStaticRector;
+use Rector\CodeQuality\Rector\Equal\UseIdenticalOverEqualWithSameTypeRector;
+use Rector\CodeQuality\Rector\Identical\FlipTypeControlToUseExclusiveTypeRector;
+use Rector\CodeQuality\Rector\If_\CombineIfRector;
+use Rector\CodeQuality\Rector\If_\ExplicitBoolCompareRector;
+use Rector\CodeQuality\Rector\If_\SimplifyIfElseToTernaryRector;
+use Rector\CodeQuality\Rector\If_\SimplifyIfReturnBoolRector;
+use Rector\Config\RectorConfig;
+use Rector\DeadCode\Rector\If_\RemoveDeadInstanceOfRector;
+use Rector\Doctrine\Bundle230\Rector\Class_\AddAnnotationToRepositoryRector;
+use Rector\PHPUnit\CodeQuality\Rector\Class_\PreferPHPUnitThisCallRector;
+use Rector\PHPUnit\CodeQuality\Rector\ClassMethod\AddInstanceofAssertForNullableInstanceRector;
+use Rector\PHPUnit\CodeQuality\Rector\MethodCall\AssertEmptyNullableObjectToAssertInstanceofRector;
+use Rector\Privatization\Rector\Class_\FinalizeTestCaseClassRector;
+use Rector\Renaming\Rector\FuncCall\RenameFunctionRector;
+use Rector\Strict\Rector\Empty_\DisallowedEmptyRuleFixerRector;
+use Rector\TypeDeclaration\Rector\StmtsAwareInterface\DeclareStrictTypesRector;
 
-return static function (ContainerConfigurator $containerConfigurator): void {
-    // get parameters
-    $parameters = $containerConfigurator->parameters();
-    $parameters->set(Option::PATHS, [
+// @noinspection PhpUnhandledExceptionInspection
+return RectorConfig::configure()
+    ->withPaths([
+        __DIR__.'/public',
+        __DIR__.'/config',
+        __DIR__.'/migrations',
         __DIR__.'/src',
         __DIR__.'/tests',
-    ]);
-    $parameters->set(Option::AUTO_IMPORT_NAMES, true);
-    $parameters->set(Option::IMPORT_SHORT_CLASSES, false);
-    $parameters->set(Option::APPLY_AUTO_IMPORT_NAMES_ON_CHANGED_FILES_ONLY, true);
-
-    // Define what rule sets will be applied
-    $containerConfigurator->import(DoctrineSetList::ANNOTATIONS_TO_ATTRIBUTES);
-
-    // $containerConfigurator->import(SetList::DEAD_CODE);
-    // $containerConfigurator->import(SetList::CODE_QUALITY);
-    // $containerConfigurator->import(SetList::CODING_STYLE);
-    // $containerConfigurator->import(SetList::PHP_80);
-
-    // get services (needed for register a single rule)
-    // $services = $containerConfigurator->services();
-
-    // register a single rule
-    // $services->set(TypedPropertyRector::class);
-};
+    ])
+    ->withComposerBased(doctrine: true, phpunit: true, symfony: true)
+    ->withPreparedSets(deadCode: true, codeQuality: true, privatization: true, rectorPreset: true, phpunitCodeQuality: true, symfonyCodeQuality: true)
+    ->withAttributesSets(all: true)
+    ->withConfiguredRule(RenameFunctionRector::class, [
+        'implode' => 'join',
+        'join' => 'join',
+    ])
+    ->withSkip([
+        AddAnnotationToRepositoryRector::class,
+        AddInstanceofAssertForNullableInstanceRector::class,
+        AssertEmptyNullableObjectToAssertInstanceofRector::class,
+        CombineIfRector::class,
+        DeclareStrictTypesRector::class,
+        DisallowedEmptyRuleFixerRector::class,
+        ExplicitBoolCompareRector::class,
+        FinalizeTestCaseClassRector::class,
+        FlipTypeControlToUseExclusiveTypeRector::class,
+        LocallyCalledStaticMethodToNonStaticRector::class,
+        PreferPHPUnitThisCallRector::class,
+        RemoveDeadInstanceOfRector::class,
+        SimplifyIfElseToTernaryRector::class,
+        SimplifyIfReturnBoolRector::class,
+        ThrowWithPreviousExceptionRector::class,
+        UseIdenticalOverEqualWithSameTypeRector::class,
+    ])
+;

api/src/Controller/CevidbController.php

@@ -12,7 +12,7 @@ class CevidbController extends AbstractController {
      * Link to this controller to start the "connect" process.
      */
     #[Route('/auth/cevidb', name: 'connect_cevidb_start')]
-    public function connectAction(Request $request, ClientRegistry $clientRegistry) {
+    public function connect(Request $request, ClientRegistry $clientRegistry) {
         return $clientRegistry
             ->getClient('cevidb') // key used in config/packages/knpu_oauth2_client.yaml
             ->redirect([], ['additionalData' => ['callback' => $request->get('callback')]])
@@ -25,7 +25,7 @@ public function connectAction(Request $request, ClientRegistry $clientRegistry)
      * in config/packages/knpu_oauth2_client.yaml.
      */
     #[Route('/auth/cevidb/callback', name: 'connect_cevidb_check')]
-    public function connectCheckAction(Request $request, ClientRegistry $clientRegistry) {
+    public function connectCheck(ClientRegistry $clientRegistry) {
         // ** if you want to *authenticate* the user, then
         // leave this method blank and create a custom authenticator
     }

api/src/Controller/GoogleController.php

@@ -12,7 +12,7 @@ class GoogleController extends AbstractController {
      * Link to this controller to start the "connect" process.
      */
     #[Route('/auth/google', name: 'connect_google_start')]
-    public function connectAction(Request $request, ClientRegistry $clientRegistry) {
+    public function connect(Request $request, ClientRegistry $clientRegistry) {
         return $clientRegistry
             ->getClient('google') // key used in config/packages/knpu_oauth2_client.yaml
             ->redirect([], ['additionalData' => ['callback' => $request->get('callback')]])
@@ -25,7 +25,7 @@ public function connectAction(Request $request, ClientRegistry $clientRegistry)
      * in config/packages/knpu_oauth2_client.yaml.
      */
     #[Route('/auth/google/callback', name: 'connect_google_check')]
-    public function connectCheckAction(Request $request, ClientRegistry $clientRegistry) {
+    public function connectCheck(ClientRegistry $clientRegistry) {
         // ** if you want to *authenticate* the user, then
         // leave this method blank and create a custom authenticator
     }

api/src/Controller/JubladbController.php

@@ -12,7 +12,7 @@ class JubladbController extends AbstractController {
      * Link to this controller to start the "connect" process.
      */
     #[Route('/auth/jubladb', name: 'connect_jubladb_start')]
-    public function connectAction(Request $request, ClientRegistry $clientRegistry) {
+    public function connect(Request $request, ClientRegistry $clientRegistry) {
         return $clientRegistry
             ->getClient('jubladb') // key used in config/packages/knpu_oauth2_client.yaml
             ->redirect([], ['additionalData' => ['callback' => $request->get('callback')]])
@@ -25,7 +25,7 @@ public function connectAction(Request $request, ClientRegistry $clientRegistry)
      * in config/packages/knpu_oauth2_client.yaml.
      */
     #[Route('/auth/jubladb/callback', name: 'connect_jubladb_check')]
-    public function connectCheckAction(Request $request, ClientRegistry $clientRegistry) {
+    public function connectCheck(ClientRegistry $clientRegistry) {
         // ** if you want to *authenticate* the user, then
         // leave this method blank and create a custom authenticator
     }

api/src/Controller/PbsmidataController.php

@@ -12,7 +12,7 @@ class PbsmidataController extends AbstractController {
      * Link to this controller to start the "connect" process.
      */
     #[Route('/auth/pbsmidata', name: 'connect_pbsmidata_start')]
-    public function connectAction(Request $request, ClientRegistry $clientRegistry) {
+    public function connect(Request $request, ClientRegistry $clientRegistry) {
         return $clientRegistry
             ->getClient('pbsmidata') // key used in config/packages/knpu_oauth2_client.yaml
             ->redirect([], ['additionalData' => ['callback' => $request->get('callback')]])
@@ -25,7 +25,7 @@ public function connectAction(Request $request, ClientRegistry $clientRegistry)
      * in config/packages/knpu_oauth2_client.yaml.
      */
     #[Route('/auth/pbsmidata/callback', name: 'connect_pbsmidata_check')]
-    public function connectCheckAction(Request $request, ClientRegistry $clientRegistry) {
+    public function connectCheck(ClientRegistry $clientRegistry) {
         // ** if you want to *authenticate* the user, then
         // leave this method blank and create a custom authenticator
     }

api/src/Doctrine/Filter/ContentNodeCampFilter.php

@@ -32,14 +32,11 @@ public function __construct(
 
     // This function is only used to hook in documentation generators (supported by Swagger and Hydra)
     public function getDescription(string $resourceClass): array {
-        $description = [];
-        $description['camp'] = [
+        return ['camp' => [
             'property' => self::CAMP_QUERY_NAME,
             'type' => Type::BUILTIN_TYPE_STRING,
             'required' => false,
-        ];
-
-        return $description;
+        ]];
     }
 
     protected function filterProperty(

api/src/Doctrine/Filter/ContentNodeIsRootFilter.php

@@ -26,14 +26,11 @@ public function __construct(
 
     // This function is only used to hook in documentation generators (supported by Swagger and Hydra)
     public function getDescription(string $resourceClass): array {
-        $description = [];
-        $description['isRoot'] = [
+        return ['isRoot' => [
             'property' => self::IS_ROOT_QUERY_NAME,
             'type' => Type::BUILTIN_TYPE_BOOL,
             'required' => false,
-        ];
-
-        return $description;
+        ]];
     }
 
     protected function filterProperty(

api/src/Doctrine/Filter/ContentNodePeriodFilter.php

@@ -33,14 +33,11 @@ public function __construct(
 
     // This function is only used to hook in documentation generators (supported by Swagger and Hydra)
     public function getDescription(string $resourceClass): array {
-        $description = [];
-        $description['period'] = [
+        return ['period' => [
             'property' => self::PERIOD_QUERY_NAME,
             'type' => Type::BUILTIN_TYPE_STRING,
             'required' => false,
-        ];
-
-        return $description;
+        ]];
     }
 
     protected function filterProperty(

api/src/Doctrine/Filter/MaterialItemPeriodFilter.php

@@ -29,14 +29,11 @@ public function __construct(
 
     // This function is only used to hook in documentation generators (supported by Swagger and Hydra)
     public function getDescription(string $resourceClass): array {
-        $description = [];
-        $description['period'] = [
+        return ['period' => [
             'property' => self::PERIOD_QUERY_NAME,
             'type' => Type::BUILTIN_TYPE_STRING,
             'required' => false,
-        ];
-
-        return $description;
+        ]];
     }
 
     protected function filterProperty(