IBX-8138: [Rector] Applied rules from Symfony 5 Rector set lists (#118)

For more details see https://issues.ibexa.co/browse/IBX-8138 and #118 Key changes: * [Rector] Applied all Symfony 5.x rectors to the production codebase * Changed `Command::SUCCESS` to `self::SUCCESS` in Symfony commands * Added missing return statement for WarmableInterface::warmUp implementation * [PHPStan] Aligned baseline with the changes * [Behat] Excluded addLocation and subtreeEditor
ibexa · Jul 24, 2024 · de05f28 · de05f28
1 parent 87601ef
commit de05f28
Show file tree

Hide file tree

Showing 20 changed files with 30 additions and 33 deletions.
diff --git a/.github/workflows/browser-tests.yaml b/.github/workflows/browser-tests.yaml
@@ -13,7 +13,7 @@ jobs:
         uses: ibexa/gh-workflows/.github/workflows/browser-tests.yml@main
         with:
             project-edition: 'oss'
-            test-suite:  '--profile=browser --suite=admin-ui-full'
+            test-suite:  '--profile=browser --suite=admin-ui-full --tags=~@broken'
             test-setup-phase-1: '--profile=regression --suite=setup-oss --mode=standard'
             multirepository: true
             timeout: 40

diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -1,10 +1,5 @@
 parameters:
 	ignoreErrors:
-		-
-			message: "#^Method Ibexa\\\\Bundle\\\\Behat\\\\Cache\\\\JsRoutingDirectoryCacheDirectoryCreator\\:\\:warmUp\\(\\) should return array\\<string\\> but return statement is missing\\.$#"
-			count: 1
-			path: src/bundle/Cache/JsRoutingDirectoryCacheDirectoryCreator.php
-
 		-
 			message: "#^Method Ibexa\\\\Bundle\\\\Behat\\\\Command\\\\CreateExampleDataCommand\\:\\:configure\\(\\) has no return type specified\\.$#"
 			count: 1

diff --git a/src/bundle/Cache/JsRoutingDirectoryCacheDirectoryCreator.php b/src/bundle/Cache/JsRoutingDirectoryCacheDirectoryCreator.php
@@ -12,19 +12,21 @@
 
 class JsRoutingDirectoryCacheDirectoryCreator implements CacheWarmerInterface
 {
-    private const FOS_JS_ROUTING_CACHE_DIR = 'fosJsRouting';
+    private const string FOS_JS_ROUTING_CACHE_DIR = 'fosJsRouting';
 
-    public function isOptional()
+    public function isOptional(): bool
     {
         return true;
     }
 
-    public function warmUp(string $cacheDir)
+    public function warmUp(string $cacheDir): array
     {
         // Workaround for https://github.com/FriendsOfSymfony/FOSJsRoutingBundle/pull/434
         $cachePath = $cacheDir . \DIRECTORY_SEPARATOR . self::FOS_JS_ROUTING_CACHE_DIR;
         if (!file_exists($cachePath) && !mkdir($cachePath) && !is_dir($cachePath)) {
             throw new \RuntimeException('Unable to create JsRoutingBundle cache directory ' . $cachePath);
         }
+
+        return [];
     }
 }
diff --git a/src/bundle/Command/CreateExampleDataCommand.php b/src/bundle/Command/CreateExampleDataCommand.php
@@ -56,7 +56,7 @@ protected function configure()
             ->addArgument('serializedTransitionData', InputArgument::REQUIRED);
     }
 
-    public function execute(InputInterface $input, OutputInterface $output)
+    public function execute(InputInterface $input, OutputInterface $output): int
     {
         $iterations = $input->getArgument('iterations');
         $initialData = $this->parseInputData($input->getArgument('serializedTransitionData'));
@@ -77,7 +77,7 @@ public function execute(InputInterface $input, OutputInterface $output)
         $this->logger->log(LogLevel::INFO, $statsEnd);
         $output->writeln($statsEnd);
 
-        return 0;
+        return self::SUCCESS;
     }
 
     private function parseInputData(string $serializedTransitionEvent): InitialEvent

diff --git a/src/bundle/Command/CreateExampleDataManagerCommand.php b/src/bundle/Command/CreateExampleDataManagerCommand.php
@@ -52,7 +52,7 @@ public function __construct(string $env, string $projectDir)
         $this->stopwatch = new Stopwatch();
     }
 
-    public function execute(InputInterface $input, OutputInterface $output)
+    public function execute(InputInterface $input, OutputInterface $output): int
     {
         $data = $this->getData();
         $this->stopwatch->start('timer');
@@ -62,7 +62,7 @@ public function execute(InputInterface $input, OutputInterface $output)
         $event = $this->stopwatch->stop('timer');
         $output->writeln(sprintf('Duration: %d s, memory: %s MB', $event->getDuration() / 1000, $event->getMemory() / 1024 / 1024));
 
-        return 0;
+        return self::SUCCESS;
     }
 
     private function executeCommand(OutputInterface $output, $cmd, float $timeout = 1200)

diff --git a/src/bundle/Command/CreateLanguageCommand.php b/src/bundle/Command/CreateLanguageCommand.php
@@ -70,6 +70,6 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         $this->languageService->createLanguage($languageCreateStruct);
 
-        return 0;
+        return self::SUCCESS;
     }
 }
diff --git a/src/bundle/Command/TestSiteaccessCommand.php b/src/bundle/Command/TestSiteaccessCommand.php
@@ -37,6 +37,6 @@ protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $output->writeln($this->siteaccess->name);
 
-        return 0;
+        return self::SUCCESS;
     }
 }
diff --git a/src/bundle/Subscriber/EndScenarioSubscriber.php b/src/bundle/Subscriber/EndScenarioSubscriber.php
@@ -17,7 +17,7 @@ class EndScenarioSubscriber implements EventSubscriberInterface
 {
     private const PRIORITY = -1000;
 
-    public static function getSubscribedEvents()
+    public static function getSubscribedEvents(): array
     {
         return [
             ScenarioTested::AFTER => ['resetLogProvider', self::PRIORITY],

diff --git a/src/bundle/Subscriber/StartScenarioSubscriber.php b/src/bundle/Subscriber/StartScenarioSubscriber.php
@@ -34,7 +34,7 @@ public function __construct(KernelInterface $kernel, int $width, int $height)
         $this->height = $height;
     }
 
-    public static function getSubscribedEvents()
+    public static function getSubscribedEvents(): array
     {
         return [
             ScenarioTested::BEFORE => ['resizeWindow', self::PRIORITY],

diff --git a/src/lib/Core/Debug/Command/GoBackCommand.php b/src/lib/Core/Debug/Command/GoBackCommand.php
@@ -33,12 +33,12 @@ protected function configure()
             ->setHelp('');
     }
 
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $this->session->back();
 
         $output->writeln("The last page from browser's history has been visited.");
 
-        return 0;
+        return self::SUCCESS;
     }
 }
diff --git a/src/lib/Core/Debug/Command/RefreshPageCommand.php b/src/lib/Core/Debug/Command/RefreshPageCommand.php
@@ -33,12 +33,12 @@ protected function configure()
             ->setHelp('');
     }
 
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $this->session->reload();
 
         $output->writeln('Page has been refreshed.');
 
-        return 0;
+        return self::SUCCESS;
     }
 }
diff --git a/src/lib/Core/Debug/Command/ShowHTMLCommand.php b/src/lib/Core/Debug/Command/ShowHTMLCommand.php
@@ -33,10 +33,10 @@ protected function configure()
             ->setHelp('');
     }
 
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $output->writeln($this->session->getPage()->getOuterHtml());
 
-        return 0;
+        return self::SUCCESS;
     }
 }
diff --git a/src/lib/Core/Debug/Command/ShowURLCommand.php b/src/lib/Core/Debug/Command/ShowURLCommand.php
@@ -33,10 +33,10 @@ protected function configure()
             ->setHelp('');
     }
 
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $output->writeln($this->session->getCurrentUrl());
 
-        return 0;
+        return self::SUCCESS;
     }
 }
diff --git a/src/lib/Core/Debug/Command/TakeScreenshotCommand.php b/src/lib/Core/Debug/Command/TakeScreenshotCommand.php
@@ -41,7 +41,7 @@ protected function configure()
             ->setHelp('');
     }
 
-    protected function execute(InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $image = $this->session->getScreenshot();
         $filePath = sys_get_temp_dir() . \DIRECTORY_SEPARATOR . uniqid('debug') . '.png';
@@ -54,7 +54,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             $response = Uploader::unsigned_upload($filePath, self::PRESET);
             $output->writeln(sprintf('Open image at %s', $response['secure_url']));
 
-            return 0;
+            return self::SUCCESS;
         } catch (Exception $e) {
             $output->writeln(sprintf('Error while uploading image. %s', $e->getMessage()));
 

diff --git a/src/lib/Subscriber/CreateContentDraft.php b/src/lib/Subscriber/CreateContentDraft.php
@@ -27,7 +27,7 @@ class CreateContentDraft extends AbstractProcessStage implements EventSubscriber
     /** @var \Ibexa\Workflow\Behat\Facade\WorkflowFacade */
     private $workflowFacade;
 
-    public static function getSubscribedEvents()
+    public static function getSubscribedEvents(): array
     {
         return [
             Events::START_TO_DRAFT => ['execute', 0],

diff --git a/src/lib/Subscriber/EditContent.php b/src/lib/Subscriber/EditContent.php
@@ -38,7 +38,7 @@ protected function getTransitions(): array
         ];
     }
 
-    public static function getSubscribedEvents()
+    public static function getSubscribedEvents(): array
     {
         return [
             Events::PUBLISH_TO_EDIT => 'execute',

diff --git a/src/lib/Subscriber/InitialStage.php b/src/lib/Subscriber/InitialStage.php
@@ -31,7 +31,7 @@ protected function getTransitions(): array
         ];
     }
 
-    public static function getSubscribedEvents()
+    public static function getSubscribedEvents(): array
     {
         return [
             Events::START => 'onStart',

diff --git a/src/lib/Subscriber/PublishDraft.php b/src/lib/Subscriber/PublishDraft.php
@@ -35,7 +35,7 @@ protected function getTransitions(): array
         ];
     }
 
-    public static function getSubscribedEvents()
+    public static function getSubscribedEvents(): array
     {
         return [
             Events::REVIEW_TO_PUBLISH => 'execute',

diff --git a/src/lib/Subscriber/PublishInTheFuture.php b/src/lib/Subscriber/PublishInTheFuture.php
@@ -56,7 +56,7 @@ protected function doExecute(TransitionEvent $event): void
         $this->dateBasedPublisherService->schedulePublish($event->content->versionInfo, $this->randomDataGenerator->getRandomDateInTheFuture());
     }
 
-    public static function getSubscribedEvents()
+    public static function getSubscribedEvents(): array
     {
         return [
             Events::REVIEW_TO_PUBLISH_LATER => 'execute',

diff --git a/src/lib/Subscriber/Review.php b/src/lib/Subscriber/Review.php
@@ -41,7 +41,7 @@ protected function getTransitions(): array
         ];
     }
 
-    public static function getSubscribedEvents()
+    public static function getSubscribedEvents(): array
     {
         return [
             Events::DRAFT_TO_REVIEW => 'execute',