[4.6] Added Rector downgradesets (#3107)

* Added downgrade sets for Rector, targetting PHP 7.4 and Symfony 5

* Downgrades code samples

* Added README

* Apply suggestion from @mnocon

* Apply suggestions from code review

Co-authored-by: Tomasz Dąbrowski <64841871+dabrt@users.noreply.github.com>

---------

Co-authored-by: Tomasz Dąbrowski <64841871+dabrt@users.noreply.github.com>

Author: mnocon

.github/workflows/code_samples.yaml

@@ -12,6 +12,7 @@ jobs:
         name: Validate code samples
         runs-on: "ubuntu-22.04"
         strategy:
+            fail-fast: false
             matrix:
                 php:
                     - "8.4" # Upper supported version
@@ -56,6 +57,12 @@ jobs:
 
             - name: Run PHPStan analysis
               run: composer phpstan
+  
+            - if: matrix.php == '8.4' # ibexa/rector supports PHP 8.3 and higher
+              name: Run Rector check
+              run: |
+                composer require --dev ibexa/rector:~4.6.x-dev
+                composer check-rector
 
     code-samples-inclusion-check:
         name: Check code samples inclusion

README.md

@@ -83,6 +83,23 @@ composer update
 composer phpstan
 ```
 
+## Downgrading code samples with Rector
+
+Code samples must be compatible with PHP 7.4.
+Rector is used to check and downgrade PHP 8.x syntax and functions to PHP 7.4-compatible equivalents.
+
+To check which files need downgrading (dry-run, no changes applied), run:
+```bash
+composer require --dev ibexa/rector:~4.6.x-dev
+composer check-rector
+```
+
+To refactor the code samples, run:
+
+``` bash
+vendor/bin/rector
+```
+
 ## Where to View
 
 https://doc.ibexa.co

code_samples/api/commerce/src/Command/PaymentCommand.php

@@ -37,7 +37,7 @@ public function __construct(
         UserService $userService,
         PaymentServiceInterface $paymentService,
         OrderServiceInterface $orderService,
-        PaymentMethodServiceInterface $paymentMethodService,
+        PaymentMethodServiceInterface $paymentMethodService
     ) {
         $this->paymentService = $paymentService;
         $this->permissionResolver = $permissionResolver;

code_samples/back_office/search/src/EventSubscriber/MySuggestionEventSubscriber.php

@@ -18,7 +18,7 @@ class MySuggestionEventSubscriber implements EventSubscriberInterface, LoggerAwa
     private ProductServiceInterface $productService;
 
     public function __construct(
-        ProductServiceInterface $productService,
+        ProductServiceInterface $productService
     ) {
         $this->productService = $productService;
     }

code_samples/data_migration/src/Migrations/Step/ReplaceNameStepExecutor.php

@@ -38,7 +38,7 @@ protected function doHandle(StepInterface $step)
                     continue;
                 }
 
-                if (str_contains($field->value, 'Company Name')) {
+                if (strpos($field->value, 'Company Name') !== false) {
                     $newValue = str_replace('Company Name', $step->getReplacement(), $field->value);
                     $struct->setField($field->fieldDefIdentifier, new Value($newValue));
                 }

composer.json

@@ -11,6 +11,9 @@
             "url": "https://updates.ibexa.co"
         }
     ],
+    "require": {
+        "php": "^7.4 || ^8.0"
+    },
     "require-dev": {
         "ibexa/automated-translation": "4.6.x-dev",
         "ibexa/code-style": "^1.0",
@@ -83,7 +86,14 @@
     "scripts": {
         "fix-cs": "php-cs-fixer fix --config=.php-cs-fixer.php -v --show-progress=dots",
         "check-cs": "@fix-cs --dry-run",
-        "phpstan": "phpstan analyse"
+        "phpstan": "phpstan analyse",
+        "check-rector": "rector process --dry-run --ansi"
+    },
+    "suggest": {
+        "ibexa/rector": "Add Rector to check for code refactoring opportunities"
+    },
+    "scripts-descriptions": {
+         "check-rector": "Check for code refactoring opportunities"
     },
     "config": {
         "allow-plugins": false

rector.php

@@ -0,0 +1,27 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Ibexa\Contracts\Rector\Sets\IbexaSetList;
+use Rector\Symfony\DowngradeSymfony70\Rector\Class_\DowngradeSymfonyCommandAttributeRector;
+use Rector\DowngradePhp82\Rector\FuncCall\DowngradeIteratorCountToArrayRector;
+
+return RectorConfig::configure()
+    ->withPaths([
+        __DIR__ . '/code_samples',
+    ])
+    ->withSkip([
+        DowngradeIteratorCountToArrayRector::class,
+    ])
+    ->withSets([
+        IbexaSetList::IBEXA_46->value,
+    ])
+    ->withDowngradeSets(php74: true)
+    ->withRules([
+        DowngradeSymfonyCommandAttributeRector::class,
+    ]);