test: install and run Rector to upgrade to PHP 8.4

Author: vincentchalamon

.github/workflows/ci.yml

@@ -94,6 +94,9 @@ jobs:
       -
         name: Run PHPStan
         run: docker compose exec -T php vendor/bin/phpstan --memory-limit=256M
+      -
+        name: Run Rector
+        run: docker compose exec -T php vendor/bin/rector --dry-run
       -
         name: Check OpenAPI
         run: docker compose exec -T php bin/console api:openapi:export --yaml | docker run --rm -i -v $(pwd)/redocly.yaml:/spec/redocly.yaml redocly/cli lint /dev/stdin
@@ -207,34 +210,35 @@ jobs:
           recursive: true
 
       # Lint API
-      -
-        name: PHP CS Fixer Cache
-        uses: actions/cache@v4
-        with:
-          path: api/.php-cs-fixer.cache
-          key: ${{ runner.OS }}-phpcsfixer-${{ github.sha }}
-          restore-keys: |
-            ${{ runner.OS }}-phpcsfixer-
-      -
-        name: Get API changed files
-        id: api-changed-files
-        uses: tj-actions/changed-files@v46
-        with:
-          files: api/**/*.php
-      -
-        name: Get Extra Arguments for PHP-CS-Fixer
-        id: phpcs-intersection
-        run: |
-          CHANGED_FILES=$(echo "${{ steps.api-changed-files.outputs.all_changed_and_modified_files }}" | tr ' ' '\n')
-          if ! echo "${CHANGED_FILES}" | grep -qE "^api\/(\\.php-cs-fixer(\\.dist)?\\.php|composer\\.lock)$"; then EXTRA_ARGS=$(printf -- '--path-mode=intersection\n--\n%s' "${CHANGED_FILES}"); else EXTRA_ARGS=''; fi
-          echo "PHPCS_EXTRA_ARGS<<EOF" >> $GITHUB_ENV
-          echo "$EXTRA_ARGS" >> $GITHUB_ENV
-          echo "EOF" >> $GITHUB_ENV
-      -
-        name: Lint API
-        uses: docker://oskarstark/php-cs-fixer-ga
-        with:
-          args: --config=api/.php-cs-fixer.dist.php -v --dry-run --stop-on-violation --using-cache=no ${{ env.PHPCS_EXTRA_ARGS }}"
+      # todo Waiting for PHP CS Fixer to support PHP 8.4
+#      -
+#        name: PHP CS Fixer Cache
+#        uses: actions/cache@v4
+#        with:
+#          path: api/.php-cs-fixer.cache
+#          key: ${{ runner.OS }}-phpcsfixer-${{ github.sha }}
+#          restore-keys: |
+#            ${{ runner.OS }}-phpcsfixer-
+#      -
+#        name: Get API changed files
+#        id: api-changed-files
+#        uses: tj-actions/changed-files@v46
+#        with:
+#          files: api/**/*.php
+#      -
+#        name: Get Extra Arguments for PHP-CS-Fixer
+#        id: phpcs-intersection
+#        run: |
+#          CHANGED_FILES=$(echo "${{ steps.api-changed-files.outputs.all_changed_and_modified_files }}" | tr ' ' '\n')
+#          if ! echo "${CHANGED_FILES}" | grep -qE "^api\/(\\.php-cs-fixer(\\.dist)?\\.php|composer\\.lock)$"; then EXTRA_ARGS=$(printf -- '--path-mode=intersection\n--\n%s' "${CHANGED_FILES}"); else EXTRA_ARGS=''; fi
+#          echo "PHPCS_EXTRA_ARGS<<EOF" >> $GITHUB_ENV
+#          echo "$EXTRA_ARGS" >> $GITHUB_ENV
+#          echo "EOF" >> $GITHUB_ENV
+#      -
+#        name: Lint API
+#        uses: docker://oskarstark/php-cs-fixer-ga
+#        with:
+#          args: --config=api/.php-cs-fixer.dist.php -v --dry-run --stop-on-violation --using-cache=no ${{ env.PHPCS_EXTRA_ARGS }}"
 
       # Lint PWA
       -

api/.php-cs-fixer.dist.php

@@ -1,11 +1,11 @@
 <?php
 
-$finder = (new PhpCsFixer\Finder())
+$finder = new PhpCsFixer\Finder()
     ->in(__DIR__)
     ->exclude('var')
 ;
 
-return (new PhpCsFixer\Config())
+return new PhpCsFixer\Config()
     ->setRiskyAllowed(true)
     ->setRules([
         '@PhpCsFixer' => true,

api/Dockerfile

@@ -4,7 +4,7 @@
 
 
 # Versions
-FROM dunglas/frankenphp:1-php8.3 AS frankenphp_upstream
+FROM dunglas/frankenphp:1-php8.4 AS frankenphp_upstream
 
 
 # The different stages of this Dockerfile are meant to be built into separate images

api/composer.json

@@ -2,7 +2,7 @@
     "type": "project",
     "license": "MIT",
     "require": {
-        "php": ">=8.3",
+        "php": ">=8.4",
         "ext-ctype": "*",
         "ext-iconv": "*",
         "api-platform/doctrine-orm": "^4.1.18",
@@ -51,6 +51,7 @@
         "phpstan/phpstan-phpunit": "^2.0.6",
         "phpstan/phpstan-symfony": "^2.0.6",
         "phpunit/phpunit": "^12.2.5",
+        "rector/rector": "^2.1",
         "symfony/browser-kit": "7.3.*",
         "symfony/css-selector": "7.3.*",
         "symfony/debug-bundle": "7.3.*",

api/composer.lock

@@ -13,13 +13,13 @@
 // Load cached env vars if the .env.local.php file exists
 // Run "composer dump-env prod" to create it (requires symfony/flex >=1.2)
 if (is_array($env = @include dirname(__DIR__) . '/.env.local.php') && (!isset($env['APP_ENV']) || ($_SERVER['APP_ENV'] ?? $_ENV['APP_ENV'] ?? $env['APP_ENV']) === $env['APP_ENV'])) {
-    (new Dotenv())->usePutenv(false)->populate($env);
+    new Dotenv()->usePutenv(false)->populate($env);
 } else {
     // load all the .env files
-    (new Dotenv())->usePutenv(false)->loadEnv(dirname(__DIR__) . '/.env');
+    new Dotenv()->usePutenv(false)->loadEnv(dirname(__DIR__) . '/.env');
 }
 
 $_SERVER += $_ENV;
 $_SERVER['APP_ENV'] = $_ENV['APP_ENV'] = ($_SERVER['APP_ENV'] ?? $_ENV['APP_ENV'] ?? null) ?: 'dev';
-$_SERVER['APP_DEBUG'] = $_SERVER['APP_DEBUG'] ?? $_ENV['APP_DEBUG'] ?? 'prod' !== $_SERVER['APP_ENV'];
+$_SERVER['APP_DEBUG'] ??= $_ENV['APP_DEBUG'] ?? 'prod' !== $_SERVER['APP_ENV'];
 $_SERVER['APP_DEBUG'] = $_ENV['APP_DEBUG'] = (int) $_SERVER['APP_DEBUG'] || filter_var($_SERVER['APP_DEBUG'], \FILTER_VALIDATE_BOOLEAN) ? '1' : '0';

api/config/bootstrap.php

@@ -12,6 +12,7 @@
  */
 final class Version20230906094949 extends AbstractMigration
 {
+    #[\Override]
     public function getDescription(): string
     {
         return '';
@@ -22,25 +23,25 @@ public function up(Schema $schema): void
         // this up() migration is auto-generated, please modify it to your needs
         $this->addSql('CREATE TABLE book (id UUID NOT NULL, book VARCHAR(255) NOT NULL, title TEXT NOT NULL, author VARCHAR(255) DEFAULT NULL, "condition" VARCHAR(255) NOT NULL, PRIMARY KEY(id))');
         $this->addSql('CREATE UNIQUE INDEX UNIQ_CBE5A331CBE5A331 ON book (book)');
-        $this->addSql('COMMENT ON COLUMN book.id IS \'(DC2Type:uuid)\'');
+        $this->addSql("COMMENT ON COLUMN book.id IS '(DC2Type:uuid)'");
         $this->addSql('CREATE TABLE bookmark (id UUID NOT NULL, user_id UUID NOT NULL, book_id UUID NOT NULL, bookmarked_at TIMESTAMP(0) WITHOUT TIME ZONE NOT NULL, PRIMARY KEY(id))');
         $this->addSql('CREATE INDEX IDX_DA62921DA76ED395 ON bookmark (user_id)');
         $this->addSql('CREATE INDEX IDX_DA62921D16A2B381 ON bookmark (book_id)');
         $this->addSql('CREATE UNIQUE INDEX UNIQ_DA62921DA76ED39516A2B381 ON bookmark (user_id, book_id)');
-        $this->addSql('COMMENT ON COLUMN bookmark.id IS \'(DC2Type:uuid)\'');
-        $this->addSql('COMMENT ON COLUMN bookmark.user_id IS \'(DC2Type:uuid)\'');
-        $this->addSql('COMMENT ON COLUMN bookmark.book_id IS \'(DC2Type:uuid)\'');
-        $this->addSql('COMMENT ON COLUMN bookmark.bookmarked_at IS \'(DC2Type:datetime_immutable)\'');
+        $this->addSql("COMMENT ON COLUMN bookmark.id IS '(DC2Type:uuid)'");
+        $this->addSql("COMMENT ON COLUMN bookmark.user_id IS '(DC2Type:uuid)'");
+        $this->addSql("COMMENT ON COLUMN bookmark.book_id IS '(DC2Type:uuid)'");
+        $this->addSql("COMMENT ON COLUMN bookmark.bookmarked_at IS '(DC2Type:datetime_immutable)'");
         $this->addSql('CREATE TABLE parchment (id UUID NOT NULL, title VARCHAR(255) NOT NULL, description VARCHAR(255) NOT NULL, PRIMARY KEY(id))');
-        $this->addSql('COMMENT ON COLUMN parchment.id IS \'(DC2Type:uuid)\'');
+        $this->addSql("COMMENT ON COLUMN parchment.id IS '(DC2Type:uuid)'");
         $this->addSql('CREATE TABLE review (id UUID NOT NULL, user_id UUID NOT NULL, book_id UUID NOT NULL, published_at TIMESTAMP(0) WITHOUT TIME ZONE NOT NULL, body TEXT NOT NULL, rating SMALLINT NOT NULL, letter VARCHAR(255) DEFAULT NULL, PRIMARY KEY(id))');
         $this->addSql('CREATE INDEX IDX_794381C6A76ED395 ON review (user_id)');
         $this->addSql('CREATE INDEX IDX_794381C616A2B381 ON review (book_id)');
         $this->addSql('CREATE UNIQUE INDEX UNIQ_794381C6A76ED39516A2B381 ON review (user_id, book_id)');
-        $this->addSql('COMMENT ON COLUMN review.id IS \'(DC2Type:uuid)\'');
-        $this->addSql('COMMENT ON COLUMN review.user_id IS \'(DC2Type:uuid)\'');
-        $this->addSql('COMMENT ON COLUMN review.book_id IS \'(DC2Type:uuid)\'');
-        $this->addSql('COMMENT ON COLUMN review.published_at IS \'(DC2Type:datetime_immutable)\'');
+        $this->addSql("COMMENT ON COLUMN review.id IS '(DC2Type:uuid)'");
+        $this->addSql("COMMENT ON COLUMN review.user_id IS '(DC2Type:uuid)'");
+        $this->addSql("COMMENT ON COLUMN review.book_id IS '(DC2Type:uuid)'");
+        $this->addSql("COMMENT ON COLUMN review.published_at IS '(DC2Type:datetime_immutable)'");
         $this->addSql('CREATE TABLE "user" (id UUID NOT NULL, email VARCHAR(255) NOT NULL, first_name VARCHAR(255) NOT NULL, last_name VARCHAR(255) NOT NULL, PRIMARY KEY(id))');
         $this->addSql('CREATE UNIQUE INDEX UNIQ_8D93D649E7927C74 ON "user" (email)');
         $this->addSql('COMMENT ON COLUMN "user".id IS \'(DC2Type:uuid)\'');
@@ -50,6 +51,7 @@ public function up(Schema $schema): void
         $this->addSql('ALTER TABLE review ADD CONSTRAINT FK_794381C616A2B381 FOREIGN KEY (book_id) REFERENCES book (id) ON DELETE CASCADE NOT DEFERRABLE INITIALLY IMMEDIATE');
     }
 
+    #[\Override]
     public function down(Schema $schema): void
     {
         // this down() migration is auto-generated, please modify it to your needs

api/migrations/Version20230906094949.php

@@ -9,9 +9,7 @@
 // Support CloudFlare Flexible SSL
 // https://developers.cloudflare.com/fundamentals/reference/http-request-headers/#cf-visitor
 if ($_SERVER['HTTP_CF_VISITOR'] ?? false) {
-    $_SERVER['HTTP_X_FORWARDED_PROTO'] = json_decode($_SERVER['HTTP_CF_VISITOR'], true)['scheme'];
+    $_SERVER['HTTP_X_FORWARDED_PROTO'] = json_decode((string) $_SERVER['HTTP_CF_VISITOR'], true)['scheme'];
 }
 
-return static function (array $context) {
-    return new Kernel($context['APP_ENV'], (bool) $context['APP_DEBUG']);
-};
+return static fn (array $context): Kernel => new Kernel($context['APP_ENV'], (bool) $context['APP_DEBUG']);

api/public/index.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\CodeQuality\Rector\Empty_\SimplifyEmptyCheckOnEmptyArrayRector;
+use Rector\Config\RectorConfig;
+use Rector\Set\ValueObject\SetList;
+use Rector\Strict\Rector\Empty_\DisallowedEmptyRuleFixerRector;
+
+$rector = RectorConfig::configure()
+    ->withPaths([
+        __DIR__ . '/config',
+        __DIR__ . '/migrations',
+        __DIR__ . '/public',
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+    ])
+    ->withRootFiles()
+    ->withPhpSets() // empty means use the version from composer.json
+    ->withSets([
+        SetList::CODE_QUALITY,
+        SetList::CODING_STYLE,
+        SetList::DEAD_CODE,
+        SetList::INSTANCEOF,
+        SetList::PRIVATIZATION,
+        SetList::TYPE_DECLARATION,
+        SetList::STRICT_BOOLEANS,
+    ])
+    ->withAttributesSets()
+    ->withComposerBased(doctrine: true, phpunit: true)
+    ->withSkip([
+        __DIR__ . '/config/bundles.php',
+        DisallowedEmptyRuleFixerRector::class,
+        SimplifyEmptyCheckOnEmptyArrayRector::class,
+    ])
+;
+
+$kernelFilename = __DIR__ . '/var/cache/dev/App_KernelDevDebugContainer.xml';
+if (is_file($kernelFilename)) {
+    $rector->withSymfonyContainerXml($kernelFilename);
+}
+
+return $rector;

api/rector.php

@@ -78,6 +78,7 @@ protected function defaults(): array
     /**
      * @see https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#initialization
      */
+    #[\Override]
     protected function initialize(): static
     {
         return $this
@@ -95,10 +96,8 @@ protected function initialize(): static
                 }
 
                 // An Open Library book URI has been specified: try to find it in the array of books
-                $data = array_filter($this->data, static function (array $datum) use ($book) {
-                    return $book->book === $datum['book'];
-                });
-                if ($data) {
+                $data = array_filter($this->data, static fn (array $datum): bool => $book->book === $datum['book']);
+                if ([] !== $data) {
                     $datum = current($data);
                     $book->title ??= $datum['title'];
                     // A book can have no author