Merge branch '4.x' into 5.x

Author: mbabker

.github/workflows/run-tests.yml

@@ -9,23 +9,32 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        php: ['8.4']
-        symfony: ['6.4.*', '7.3.*']
+        php: ['8.4', '8.5']
+        symfony: ['6.4.*', '7.3.*', '7.4.*@rc']
         pagerfanta: ['']
         composer-flags: ['--prefer-stable']
         can-fail: [false]
+        with-jms: [true]
         with-twig: [true]
         include:
           # Run "no Twig" build on latest PHP and Symfony LTS
           - php: '8.4'
             symfony: '6.4.*'
             composer-flags: '--prefer-stable'
             can-fail: false
+            with-jms: true
             with-twig: false
           - php: '8.4'
             symfony: '6.4.*'
             composer-flags: '--prefer-stable --prefer-lowest'
             can-fail: false
+            with-jms: true
+            with-twig: true
+          - php: '8.5'
+            symfony: '8.0.*@rc'
+            composer-flags: '--prefer-stable'
+            can-fail: true
+            with-jms: false
             with-twig: true
 
     name: "PHP ${{ matrix.php }}${{ matrix.pagerfanta != '' && format(' - Pagerfanta {0}', matrix.pagerfanta) || '' }}${{ matrix.with-twig == false && ' - Without Twig' || '' }} - Symfony ${{ matrix.symfony }}${{ matrix.composer-flags != '' && format(' - Composer {0}', matrix.composer-flags) || '' }}"
@@ -54,6 +63,10 @@ jobs:
           composer require --no-update pagerfanta/core:${{ matrix.pagerfanta }}
           composer require --dev --no-update pagerfanta/twig:${{ matrix.pagerfanta }}
 
+      - name: Remove JMS Serializer
+        if: matrix.with-jms == false
+        run: composer remove --dev --no-update jms/serializer jms/serializer-bundle
+
       - name: Remove Twig
         if: matrix.with-twig == false
         run: composer remove --dev --no-update pagerfanta/twig symfony/twig-bridge symfony/twig-bundle twig/twig

composer.json

@@ -4,33 +4,38 @@
     "description": "Bundle integrating Pagerfanta with Symfony",
     "keywords": ["pagerfanta", "pagination", "symfony"],
     "license": "MIT",
+    "repositories": [
+        {
+            "type": "vcs",
+            "url": "https://github.com/mbabker/SymfonyDependencyInjectionTest"
+        }
+    ],
     "require": {
         "php": "^8.4",
         "pagerfanta/core": "^4.7 || ^5.0",
         "psr/container": "^1.0 || ^2.0",
-        "symfony/config": "^6.4 || ^7.3",
-        "symfony/dependency-injection": "^6.4 || ^7.3",
-        "symfony/http-foundation": "^6.4 || ^7.3",
-        "symfony/http-kernel": "^6.4 || ^7.3",
-        "symfony/property-access": "^6.4 || ^7.3",
-        "symfony/routing": "^6.4 || ^7.3"
+        "symfony/config": "^6.4 || ^7.3 || ^8.0",
+        "symfony/dependency-injection": "^6.4 || ^7.3 || ^8.0",
+        "symfony/http-foundation": "^6.4 || ^7.3 || ^8.0",
+        "symfony/http-kernel": "^6.4 || ^7.3 || ^8.0",
+        "symfony/property-access": "^6.4 || ^7.3 || ^8.0",
+        "symfony/routing": "^6.4 || ^7.3 || ^8.0"
     },
     "require-dev": {
         "jms/serializer": "^3.32",
         "jms/serializer-bundle": "^5.4",
-        "matthiasnoback/symfony-dependency-injection-test": "^5.0",
+        "matthiasnoback/symfony-dependency-injection-test": "dev-ci-updates as 6.1.0.1",
         "pagerfanta/twig": "^4.7 || ^5.0",
         "phpstan/extension-installer": "^1.3",
-        "phpstan/phpstan": "2.1.31",
-        "phpstan/phpstan-phpunit": "2.0.7",
+        "phpstan/phpstan": "2.1.32",
+        "phpstan/phpstan-phpunit": "2.0.8",
         "phpstan/phpstan-symfony": "2.0.8",
-        "phpunit/phpunit": "9.6.29",
-        "rector/rector": "2.2.3",
-        "symfony/phpunit-bridge": "^6.4 || ^7.3",
-        "symfony/serializer": "^6.4 || ^7.3",
-        "symfony/twig-bridge": "^6.4 || ^7.3",
-        "symfony/twig-bundle": "^6.4 || ^7.3",
-        "symfony/translation": "^6.4 || ^7.3",
+        "phpunit/phpunit": "10.5.58 || 11.5.44",
+        "rector/rector": "2.2.8",
+        "symfony/serializer": "^6.4 || ^7.3 || ^8.0",
+        "symfony/twig-bridge": "^6.4 || ^7.3 || ^8.0",
+        "symfony/twig-bundle": "^6.4 || ^7.3 || ^8.0",
+        "symfony/translation": "^6.4 || ^7.3 || ^8.0",
         "twig/twig": "^3.12"
     },
     "conflict": {

phpstan-baseline.neon

@@ -61,7 +61,7 @@ parameters:
 			path: src/View/ContainerBackedImmutableViewFactory.php
 
 		-
-			message: '#^Parameter \#2 \$array of static method PHPUnit\\Framework\\Assert\:\:assertArrayHasKey\(\) expects array\|ArrayAccess, mixed given\.$#'
+			message: '#^Parameter \#2 \$array of static method PHPUnit\\Framework\\Assert\:\:assertArrayHasKey\(\) expects array\<mixed\>\|ArrayAccess\<\(int\|string\), mixed\>, mixed given\.$#'
 			identifier: argument.type
 			count: 1
 			path: tests/DependencyInjection/BabDevPagerfantaExtensionTest.php

phpstan.neon

@@ -7,6 +7,8 @@ parameters:
     - %currentWorkingDirectory%/config
     - %currentWorkingDirectory%/src
     - %currentWorkingDirectory%/tests
+  excludePaths:
+    - %currentWorkingDirectory%/src/DependencyInjection/Configuration.php
   treatPhpDocTypesAsCertain: false
   ignoreErrors:
     -

phpunit.xml.dist

@@ -11,18 +11,9 @@
         </testsuite>
     </testsuites>
 
-    <coverage processUncoveredFiles="true">
+    <source>
         <include>
-            <directory suffix=".php">./src</directory>
+            <directory>./src</directory>
         </include>
-    </coverage>
-
-    <listeners>
-        <listener class="Symfony\Bridge\PhpUnit\SymfonyTestsListener"/>
-    </listeners>
-
-    <php>
-        <!-- Ignore deprecations from lowest stable and symfony/serializer:^6.3 -->
-        <env name="SYMFONY_DEPRECATIONS_HELPER" value="max[indirect]=1&amp;max[indirect]=10&amp;max[direct]=18"/>
-    </php>
+    </source>
 </phpunit>

tests/DependencyInjection/BabDevPagerfantaExtensionTest.php

@@ -88,6 +88,8 @@ public function testContainerIsLoadedWithDefaultConfigurationWhenTwigBundleIsIns
             ],
         );
 
+        $this->container->setParameter('kernel.build_dir', __DIR__);
+        $this->container->setParameter('kernel.cache_dir', __DIR__);
         $this->container->setParameter('kernel.debug', false);
         $this->container->setParameter('kernel.build_dir', __DIR__);
         $this->container->setParameter('kernel.cache_dir', __DIR__);
@@ -141,6 +143,10 @@ public function testContainerIsLoadedWithDefaultConfigurationWhenTwigBundleIsIns
 
     public function testContainerIsLoadedWithDefaultConfigurationWhenJMSSerializerBundleIsInstalled(): void
     {
+        if (!class_exists(JMSSerializerBundle::class)) {
+            self::markTestSkipped('Test requires JMSSerializerBundle');
+        }
+
         $this->container->setParameter(
             'kernel.bundles',
             [

tests/RouteGenerator/RequestAwareRouteGeneratorFactoryTest.php

@@ -4,6 +4,7 @@
 
 use BabDev\PagerfantaBundle\RouteGenerator\RequestAwareRouteGeneratorFactory;
 use Pagerfanta\Exception\RuntimeException;
+use PHPUnit\Framework\Attributes\DoesNotPerformAssertions;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\HttpFoundation\Request;
@@ -36,6 +37,7 @@ protected function tearDown(): void
     /**
      * @doesNotPerformAssertions
      */
+    #[DoesNotPerformAssertions]
     public function testTheGeneratorIsCreatedWhenResolvingTheRouteNameFromTheRequest(): void
     {
         $request = Request::create('/');
@@ -50,6 +52,7 @@ public function testTheGeneratorIsCreatedWhenResolvingTheRouteNameFromTheRequest
     /**
      * @doesNotPerformAssertions
      */
+    #[DoesNotPerformAssertions]
     public function testTheGeneratorIsCreatedWhenGivenARouteNameDuringASubrequest(): void
     {
         $masterRequest = Request::create('/');

tests/Serializer/Handler/PagerfantaHandlerTest.php

@@ -11,10 +11,21 @@
 use JMS\Serializer\SerializerInterface;
 use Pagerfanta\Adapter\FixedAdapter;
 use Pagerfanta\Pagerfanta;
+use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
 
+/**
+ * @note The {@see PagerfantaHandler::PRESERVE_KEYS_KEY} constant value is inlined to avoid autoloader issues when the JMS packages are not installed
+ */
 final class PagerfantaHandlerTest extends TestCase
 {
+    public static function setUpBeforeClass(): void
+    {
+        if (!class_exists(SerializerBuilder::class)) {
+            self::markTestSkipped('Test requires JMS Serializer');
+        }
+    }
+
     public function testSerializeToJson(): void
     {
         $pager = new Pagerfanta(new FixedAdapter(100, range(1, 5)));
@@ -33,14 +44,15 @@ public static function dataSerializeWithPreserveKeysContext(): \Generator
     {
         yield 'Context not set' => [[0 => 'item1', 2 => 'item2', 4 => 'item3'], [], '{"items":{"0":"item1","2":"item2","4":"item3"},"pagination":{"current_page":1,"has_previous_page":false,"has_next_page":false,"per_page":10,"total_items":3,"total_pages":1}}'];
 
-        yield 'Context with preserve keys disabled' => [[0 => 'item1', 2 => 'item2', 4 => 'item3'], [PagerfantaHandler::PRESERVE_KEYS_KEY => false], '{"items":["item1","item2","item3"],"pagination":{"current_page":1,"has_previous_page":false,"has_next_page":false,"per_page":10,"total_items":3,"total_pages":1}}'];
+        yield 'Context with preserve keys disabled' => [[0 => 'item1', 2 => 'item2', 4 => 'item3'], ['pagerfanta_preserve_keys' => false], '{"items":["item1","item2","item3"],"pagination":{"current_page":1,"has_previous_page":false,"has_next_page":false,"per_page":10,"total_items":3,"total_pages":1}}'];
 
-        yield 'Context with preserve keys enabled' => [[0 => 'item1', 2 => 'item2', 4 => 'item3'], [PagerfantaHandler::PRESERVE_KEYS_KEY => true], '{"items":{"0":"item1","2":"item2","4":"item3"},"pagination":{"current_page":1,"has_previous_page":false,"has_next_page":false,"per_page":10,"total_items":3,"total_pages":1}}'];
+        yield 'Context with preserve keys enabled' => [[0 => 'item1', 2 => 'item2', 4 => 'item3'], ['pagerfanta_preserve_keys' => true], '{"items":{"0":"item1","2":"item2","4":"item3"},"pagination":{"current_page":1,"has_previous_page":false,"has_next_page":false,"per_page":10,"total_items":3,"total_pages":1}}'];
     }
 
     /**
      * @dataProvider dataSerializeWithPreserveKeysContext
      */
+    #[DataProvider('dataSerializeWithPreserveKeysContext')]
     public function testSerializeToJsonWithPreserveKeysContext(array $data, array $context, string $expectedJson): void
     {
         $pager = new Pagerfanta(new FixedAdapter(\count($data), $data));
@@ -66,7 +78,7 @@ public function testNormalizeRejectsInvalidPreserveKeysContext(): void
         $pager->setMaxPerPage(5);
 
         $serializationContext = new SerializationContext();
-        $serializationContext->setAttribute(PagerfantaHandler::PRESERVE_KEYS_KEY, 'invalid');
+        $serializationContext->setAttribute('pagerfanta_preserve_keys', 'invalid');
 
         $this->createSerializer()->serialize($pager, 'json', $serializationContext);
     }

tests/Serializer/Normalizer/PagerfantaNormalizerTest.php

@@ -7,6 +7,7 @@
 use Pagerfanta\Adapter\NullAdapter;
 use Pagerfanta\Pagerfanta;
 use Pagerfanta\PagerfantaInterface;
+use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Serializer\Exception\InvalidArgumentException;
 use Symfony\Component\Serializer\Exception\LogicException;
@@ -50,6 +51,7 @@ public static function dataNormalizeWithPreserveKeysContext(): \Generator
     /**
      * @dataProvider dataNormalizeWithPreserveKeysContext
      */
+    #[DataProvider('dataNormalizeWithPreserveKeysContext')]
     public function testNormalizeWithPreserveKeysContext(array $data, array $context, array $expectedItems): void
     {
         $pager = new Pagerfanta(new FixedAdapter(\count($data), $data));
@@ -87,7 +89,7 @@ public function testNormalizeOnlyAcceptsPagerfantaInstances(): void
         new PagerfantaNormalizer()->normalize(new \stdClass());
     }
 
-    public function dataSupportsNormalization(): \Generator
+    public static function dataSupportsNormalization(): \Generator
     {
         yield 'Supported' => [new Pagerfanta(new NullAdapter(25)), true];
         yield 'Not Supported' => [new \stdClass(), false];
@@ -96,6 +98,7 @@ public function dataSupportsNormalization(): \Generator
     /**
      * @dataProvider dataSupportsNormalization
      */
+    #[DataProvider('dataSupportsNormalization')]
     public function testSupportsNormalization(mixed $data, bool $supported): void
     {
         self::assertSame($supported, new PagerfantaNormalizer()->supportsNormalization($data));

tests/Twig/TwigUndefinedCallableHandlerTest.php

@@ -3,6 +3,7 @@
 namespace BabDev\PagerfantaBundle\Tests\Twig;
 
 use BabDev\PagerfantaBundle\Twig\UndefinedCallableHandler;
+use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
 use Twig\Error\SyntaxError;
 
@@ -15,7 +16,7 @@ public static function setUpBeforeClass(): void
         }
     }
 
-    public function dataSupportedFunctions(): \Generator
+    public static function dataSupportedFunctions(): \Generator
     {
         yield '"pagerfanta" function' => ['pagerfanta'];
         yield '"pagerfanta_page_url" function' => ['pagerfanta_page_url'];
@@ -24,6 +25,7 @@ public function dataSupportedFunctions(): \Generator
     /**
      * @dataProvider dataSupportedFunctions
      */
+    #[DataProvider('dataSupportedFunctions')]
     public function testThrowsASyntaxErrorForSupportedTwigFunctionsWhenNotDefined(string $function): void
     {
         $this->expectException(SyntaxError::class);