DevKit updates for 3.x branch

.github/workflows/test.yaml

@@ -42,10 +42,6 @@ jobs:
                       dependencies: lowest
                       allowed-to-fail: false
                       variant: normal
-                    - php-version: '8.2'
-                      dependencies: highest
-                      allowed-to-fail: false
-                      variant: sonata-project/block-bundle:"5.0.0-alpha-1"
                     - php-version: '8.2'
                       dependencies: highest
                       allowed-to-fail: false
@@ -54,13 +50,13 @@ jobs:
                     - php-version: '8.2'
                       dependencies: highest
                       allowed-to-fail: false
-                      symfony-require: 6.2.*
-                      variant: symfony/symfony:"6.2.*"
+                      symfony-require: 6.3.*
+                      variant: symfony/symfony:"6.3.*"
                     - php-version: '8.2'
                       dependencies: highest
                       allowed-to-fail: false
-                      symfony-require: 6.3.*
-                      variant: symfony/symfony:"6.3.*"
+                      symfony-require: 6.4.*
+                      variant: symfony/symfony:"6.4.*"
 
         steps:
             - name: Checkout

.php-cs-fixer.dist.php

@@ -56,6 +56,8 @@
     ]],
     'php_unit_strict' => true,
     'php_unit_test_case_static_method_calls' => true,
+    'php_unit_data_provider_name' => true,
+    'php_unit_data_provider_return_type' => true,
     'phpdoc_to_comment' => ['ignored_tags' => ['psalm-suppress', 'phpstan-var']],
     'single_line_throw' => false,
     'static_lambda' => true,

composer.json

@@ -52,7 +52,7 @@
         "phpunit/phpunit": "^9.5",
         "psalm/plugin-phpunit": "^0.18",
         "psalm/plugin-symfony": "^5.0",
-        "rector/rector": "^0.17",
+        "rector/rector": "^0.18",
         "sonata-project/doctrine-orm-admin-bundle": "^4.0",
         "symfony/browser-kit": "^5.4 || ^6.2",
         "symfony/css-selector": "^5.4 || ^6.2",

rector.php

@@ -19,7 +19,10 @@
 
 use Rector\Config\RectorConfig;
 use Rector\Php70\Rector\FunctionLike\ExceptionHandlerTypehintRector;
-use Rector\Php71\Rector\FuncCall\CountOnNullRector;
+use Rector\PHPUnit\CodeQuality\Rector\Class_\AddSeeTestAnnotationRector;
+use Rector\PHPUnit\CodeQuality\Rector\Class_\PreferPHPUnitThisCallRector;
+use Rector\PHPUnit\Set\PHPUnitLevelSetList;
+use Rector\PHPUnit\Set\PHPUnitSetList;
 use Rector\Set\ValueObject\LevelSetList;
 
 return static function (RectorConfig $rectorConfig): void {
@@ -30,12 +33,15 @@
 
     $rectorConfig->sets([
         LevelSetList::UP_TO_PHP_80,
+        PHPUnitLevelSetList::UP_TO_PHPUNIT_90,
+        PHPUnitSetList::PHPUNIT_CODE_QUALITY,
     ]);
 
     $rectorConfig->importNames();
     $rectorConfig->importShortClasses(false);
     $rectorConfig->skip([
-        CountOnNullRector::class,
         ExceptionHandlerTypehintRector::class,
+        AddSeeTestAnnotationRector::class,
+        PreferPHPUnitThisCallRector::class,
     ]);
 };

src/Admin/Extension/Gedmo/TranslatableAdminExtension.php

@@ -79,6 +79,7 @@ private function setLocale(object $object): void
         \assert($objectManager instanceof ObjectManager);
 
         $configuration = $this->translatableListener->getConfiguration($objectManager, $objectClassName);
+        /** @psalm-suppress InvalidArrayOffset */
         if (!isset($configuration['locale'])) {
             throw new \LogicException(sprintf(
                 'There is no locale or language property found on class: "%s"',

src/Block/LocaleSwitcherBlockService.php

@@ -50,8 +50,6 @@ public function execute(BlockContextInterface $blockContext, ?Response $response
     {
         $template = $blockContext->getTemplate();
 
-        \assert(\is_string($template));
-
         return $this->renderResponse($template, [
             'block_context' => $blockContext,
             'block' => $blockContext->getBlock(),

src/DependencyInjection/SonataTranslationExtension.php

@@ -19,6 +19,7 @@
 use Symfony\Component\Config\Definition\Processor;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
 use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
@@ -155,10 +156,14 @@ private function registerTranslatableListener(ContainerBuilder $container, array
         // Registration based on the documentation
         // see https://github.com/doctrine-extensions/DoctrineExtensions/blob/7c0d5aeab0f840d2a18a18c3dc10b0117c597a42/doc/symfony4.md#doctrine-extension-listener-services
         $container->register('sonata_translation.listener.translatable', TranslatableListener::class)
-            ->addMethodCall('setAnnotationReader', [new Reference('annotation_reader')])
+            ->addMethodCall('setAnnotationReader', [new Reference('annotation_reader', ContainerInterface::IGNORE_ON_INVALID_REFERENCE)])
             ->addMethodCall('setDefaultLocale', ['%locale%'])
             ->addMethodCall('setTranslatableLocale', ['%locale%'])
             ->addMethodCall('setTranslationFallback', [false])
-            ->addTag('doctrine.event_subscriber');
+            ->addTag('doctrine.event_listener', ['event' => 'postLoad'])
+            ->addTag('doctrine.event_listener', ['event' => 'postPersist'])
+            ->addTag('doctrine.event_listener', ['event' => 'preFlush'])
+            ->addTag('doctrine.event_listener', ['event' => 'onFlush'])
+            ->addTag('doctrine.event_listener', ['event' => 'loadClassMetadata']);
     }
 }

src/Twig/Extension/SonataTranslationExtension.php

@@ -64,7 +64,7 @@ public function isTranslatable($object): bool
         return $this->getTranslatableChecker()->isTranslatable($object);
     }
 
-    public function getLocaleName(string $locale, ?string $displayLocale = null): ?string
+    public function getLocaleName(string $locale, ?string $displayLocale = null): string
     {
         return Locales::getName($locale, $displayLocale);
     }

tests/App/AppKernel.php

@@ -79,9 +79,6 @@ protected function configureRoutes(RoutingConfigurator $routes): void
         $routes->import(sprintf('%s/config/routes.yaml', $this->getProjectDir()));
     }
 
-    /**
-     * @psalm-suppress DeprecatedClass
-     */
     protected function configureContainer(ContainerBuilder $container, LoaderInterface $loader): void
     {
         $container->setParameter('app.base_dir', $this->getBaseDir());

tests/App/Provider/DummyUserProvider.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Sonata Project package.
+ *
+ * (c) Thomas Rabaix <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Sonata\TranslationBundle\Tests\App\Provider;
+
+use Knp\DoctrineBehaviors\Contract\Provider\UserProviderInterface;
+
+final class DummyUserProvider implements UserProviderInterface
+{
+    /**
+     * @return object|string|null
+     */
+    public function provideUser()
+    {
+        return null;
+    }
+
+    public function provideUserEntity(): ?string
+    {
+        return null;
+    }
+}

tests/App/config/services.php

@@ -14,10 +14,12 @@
 namespace Symfony\Component\DependencyInjection\Loader\Configurator;
 
 use Gedmo\Translatable\TranslatableListener;
+use Knp\DoctrineBehaviors\Provider\UserProvider;
 use Sonata\TranslationBundle\Tests\App\Admin\GedmoCategoryAdmin;
 use Sonata\TranslationBundle\Tests\App\Admin\KnpCategoryAdmin;
 use Sonata\TranslationBundle\Tests\App\Entity\GedmoCategory;
 use Sonata\TranslationBundle\Tests\App\Entity\KnpCategory;
+use Sonata\TranslationBundle\Tests\App\Provider\DummyUserProvider;
 
 return static function (ContainerConfigurator $containerConfigurator): void {
     $containerConfigurator->services()
@@ -42,8 +44,16 @@
             ])
 
         ->set('app.gedmo.translation_listener', TranslatableListener::class)
-            ->call('setAnnotationReader', [service('annotation_reader')])
+            ->call('setAnnotationReader', [service('annotation_reader')->nullOnInvalid()])
             ->call('setDefaultLocale', [param('locale')])
             ->call('setTranslationFallback', [false])
-            ->tag('doctrine.event_subscriber');
+            ->tag('doctrine.event_listener', ['event' => 'postLoad'])
+            ->tag('doctrine.event_listener', ['event' => 'postPersist'])
+            ->tag('doctrine.event_listener', ['event' => 'preFlush'])
+            ->tag('doctrine.event_listener', ['event' => 'onFlush'])
+            ->tag('doctrine.event_listener', ['event' => 'loadClassMetadata'])
+
+        // Temporary fix to decorate User Provider from KNP (see https://github.com/KnpLabs/DoctrineBehaviors/pull/727)
+        ->set(DummyUserProvider::class)
+            ->decorate(UserProvider::class);
 };

tests/Checker/TranslatableCheckerTest.php

@@ -33,7 +33,7 @@ protected function setUp(): void
     /**
      * @return iterable<array{object|class-string, array<class-string>, array<class-string>}>
      */
-    public function provideTestIsTranslatable(): iterable
+    public function provideIsTranslatableCases(): iterable
     {
         yield 'object-by-model' => [
             new ModelCustomTranslatable(),
@@ -61,7 +61,7 @@ public function provideTestIsTranslatable(): iterable
     }
 
     /**
-     * @dataProvider provideTestIsTranslatable
+     * @dataProvider provideIsTranslatableCases
      *
      * @phpstan-param object|class-string $classOrObject
      * @phpstan-param class-string[] $supportedModels

tests/DependencyInjection/SonataTranslationExtensionTest.php

@@ -17,6 +17,7 @@
 use Matthias\SymfonyDependencyInjectionTest\PhpUnit\AbstractExtensionTestCase;
 use Sonata\TranslationBundle\DependencyInjection\SonataTranslationExtension;
 use Sonata\TranslationBundle\Filter\TranslationFieldFilter;
+use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\DependencyInjection\Reference;
 
 /**
@@ -85,7 +86,7 @@ public function testRegistersTranslatableListenerWhenUsingGedmo(): void
         $this->assertContainerBuilderHasServiceDefinitionWithMethodCall(
             'sonata_translation.listener.translatable',
             'setAnnotationReader',
-            [new Reference('annotation_reader')]
+            [new Reference('annotation_reader', ContainerInterface::IGNORE_ON_INVALID_REFERENCE)]
         );
 
         $this->assertContainerBuilderHasServiceDefinitionWithMethodCall(

tests/Functional/GedmoCRUDTest.php

@@ -28,7 +28,7 @@ protected function setUp(): void
     }
 
     /**
-     * @dataProvider provideLocales
+     * @dataProvider provideListCases
      */
     public function testList(string $locale, string $name): void
     {
@@ -42,7 +42,7 @@ public function testList(string $locale, string $name): void
     /**
      * @return iterable<array{string, string}>
      */
-    public function provideLocales(): iterable
+    public function provideListCases(): iterable
     {
         yield 'default english' => ['', 'Novel'];
         yield 'english' => ['en', 'Novel'];
@@ -51,7 +51,7 @@ public function provideLocales(): iterable
     }
 
     /**
-     * @dataProvider provideLocalesToCreate
+     * @dataProvider provideCreateCases
      */
     public function testCreate(string $locale, string $newName): void
     {
@@ -87,7 +87,7 @@ public function testCreate(string $locale, string $newName): void
     /**
      * @return iterable<array{string, string}>
      */
-    public function provideLocalesToCreate(): iterable
+    public function provideCreateCases(): iterable
     {
         yield 'default english' => ['', 'Default New Novel'];
         yield 'english' => ['en', 'New Novel'];
@@ -96,7 +96,7 @@ public function provideLocalesToCreate(): iterable
     }
 
     /**
-     * @dataProvider provideLocalesToEdit
+     * @dataProvider provideEditCases
      */
     public function testEdit(string $locale, string $editedName): void
     {
@@ -128,7 +128,7 @@ public function testEdit(string $locale, string $editedName): void
     /**
      * @return iterable<array{string, string}>
      */
-    public function provideLocalesToEdit(): iterable
+    public function provideEditCases(): iterable
     {
         yield 'default english' => ['', 'Edited Default Novel'];
         yield 'english' => ['en', 'Edited Novel'];

tests/Functional/KnpCRUDTest.php

@@ -28,7 +28,7 @@ protected function setUp(): void
     }
 
     /**
-     * @dataProvider provideLocales
+     * @dataProvider provideListCases
      */
     public function testList(string $locale, string $name): void
     {
@@ -42,7 +42,7 @@ public function testList(string $locale, string $name): void
     /**
      * @return iterable<array{string, string}>
      */
-    public function provideLocales(): iterable
+    public function provideListCases(): iterable
     {
         yield 'default english' => ['', 'Novel'];
         yield 'english' => ['en', 'Novel'];
@@ -51,7 +51,7 @@ public function provideLocales(): iterable
     }
 
     /**
-     * @dataProvider provideLocalesToCreate
+     * @dataProvider provideCreateCases
      */
     public function testCreate(string $locale, string $newName): void
     {
@@ -87,7 +87,7 @@ public function testCreate(string $locale, string $newName): void
     /**
      * @return iterable<array{string, string}>
      */
-    public function provideLocalesToCreate(): iterable
+    public function provideCreateCases(): iterable
     {
         yield 'default english' => ['', 'Default New Novel'];
         yield 'english' => ['en', 'New Novel'];
@@ -96,7 +96,7 @@ public function provideLocalesToCreate(): iterable
     }
 
     /**
-     * @dataProvider provideLocalesToEdit
+     * @dataProvider provideEditCases
      */
     public function testEdit(string $locale, string $editedName): void
     {
@@ -128,7 +128,7 @@ public function testEdit(string $locale, string $editedName): void
     /**
      * @return iterable<array{string, string}>
      */
-    public function provideLocalesToEdit(): iterable
+    public function provideEditCases(): iterable
     {
         yield 'default english' => ['', 'Edited Default Novel'];
         yield 'english' => ['en', 'Edited Novel'];

tests/Provider/Knplabs/LocaleProviderTest.php

@@ -23,7 +23,7 @@
 final class LocaleProviderTest extends TestCase
 {
     /**
-     * @dataProvider provideValues
+     * @dataProvider provideUsesTheProperProviderBasedOnRequestCases
      */
     public function testUsesTheProperProviderBasedOnRequest(
         string $expectedLocale,
@@ -53,7 +53,7 @@ public function testUsesTheProperProviderBasedOnRequest(
     /**
      * @return iterable<array{string, string, string, bool}>
      */
-    public function provideValues(): iterable
+    public function provideUsesTheProperProviderBasedOnRequestCases(): iterable
     {
         yield 'with sonata enabled it uses sonata provider' => ['en', 'es', 'en', true];
         yield 'with sonata disabled it uses knp provider' => ['es', 'es', 'en', false];
@@ -66,12 +66,12 @@ public function __construct(private string $locale)
             {
             }
 
-            public function provideCurrentLocale(): ?string
+            public function provideCurrentLocale(): string
             {
                 return $this->locale;
             }
 
-            public function provideFallbackLocale(): ?string
+            public function provideFallbackLocale(): string
             {
                 return $this->locale;
             }

tests/Traits/DoctrineOrmTestCase.php

@@ -80,7 +80,9 @@ final protected function getConfiguration(): Configuration
         return ORMSetup::createAttributeMetadataConfiguration(
             [],
             false,
-            sys_get_temp_dir().'/sonata-translation-bundle'
+            sys_get_temp_dir().'/sonata-translation-bundle',
+            null,
+            true,
         );
     }
 }