{{ this.pagination.currentPage }}
+ + {{ ux_pagination( + this.pagination, + linkAttributes: this.paginationLinkAttributes, + ) }} +1
', $initialHtml); + self::assertStringContainsString('href="/products?page=2"', $initialHtml); + self::assertStringContainsString('data-live-page-param="2"', $initialHtml); + + $component->call('goToPage', ['page' => 2]); + $updatedHtml = (string) $component->render(); + + self::assertTrue($component->response()->isSuccessful()); + self::assertStringContainsString('2
', $updatedHtml); + self::assertStringContainsString('href="/products"', $updatedHtml); + self::assertStringContainsString('aria-current="page">', $updatedHtml); + self::assertSame(2, $component->component()->page); + } + + public function testBundleTemplateOverrideAppliesToTheDefaultTheme() + { + self::bootKernel(); + + /** @var PaginatorInterface $paginator */ + $paginator = self::getContainer()->get(PaginatorInterface::class); + /** @var Environment $twig */ + $twig = self::getContainer()->get(Environment::class); + + $pagination = $paginator->query(range(1, 100)) + ->perPage(10) + ->path('/items') + ->paginate(page: 3); + + $html = $twig->getRuntime(PaginationExtension::class)->renderPagination($pagination); + + self::assertStringContainsString('', $html); + self::assertStringContainsString('Previous', $html); + } + + public function testCapturedRouteKeepsLinkUrlsStableAcrossLiveRerenders() + { + self::bootKernel(); + + $component = $this->createLiveComponent('live_pagination_auto', [ + 'paginationRoute' => 'ux_pagination_test_products', + ]); + + $initialHtml = (string) $component->render(); + self::assertStringContainsString('href="/products?page=2"', $initialHtml); + + $component->call('goToPage', ['page' => 2]); + $updatedHtml = (string) $component->render(); + + self::assertTrue($component->response()->isSuccessful()); + self::assertStringContainsString('href="/products?page=3"', $updatedHtml); + self::assertStringContainsString('href="/products"', $updatedHtml); + self::assertStringNotContainsString('href="/_components', $updatedHtml); + } +} + +final class UXPaginationTestKernel extends Kernel +{ + use MicroKernelTrait; + + public function registerBundles(): iterable + { + yield new FrameworkBundle(); + yield new TwigBundle(); + yield new StimulusBundle(); + yield new TwigComponentBundle(); + yield new LiveComponentBundle(); + yield new UXPaginationBundle(); + } + + public function registerContainerConfiguration(LoaderInterface $loader): void + { + $loader->load(function (ContainerBuilder $container) { + if (!$container->hasDefinition('kernel')) { + $container->register('kernel', static::class) + ->addTag('controller.service_arguments') + ->setAutoconfigured(true) + ->setSynthetic(true) + ->setPublic(true); + } + $container->getDefinition('kernel')->addTag('routing.route_loader'); + $container->loadFromExtension('framework', [ + 'secret' => 'test-secret', + 'test' => true, + 'http_method_override' => false, + 'handle_all_throwables' => true, + 'php_errors' => ['log' => true], + 'router' => [ + 'resource' => 'kernel::loadRoutes', + 'type' => 'service', + ], + 'translator' => 'no_translator' === $this->environment + ? ['enabled' => false] + : ['fallbacks' => ['en']], + ]); + $container->loadFromExtension('twig_component', [ + 'defaults' => [], + 'anonymous_template_directory' => 'components/', + ]); + $container->loadFromExtension('twig', [ + 'default_path' => __DIR__.'/../Fixtures/templates', + ]); + $paginationConfig = [ + 'items_per_page' => 30, + 'page_parameter' => 'page', + 'paginators' => [ + 'blog' => [ + 'items_per_page' => 12, + 'page_parameter' => 'p', + 'navigation' => [ + 'mode' => 'fixed', + 'size' => 2, + ], + ], + ], + ]; + if ('bootstrap_theme' === $this->environment) { + $paginationConfig['theme'] = + '@UXPagination/theme/bootstrap.html.twig'; + } + $container->loadFromExtension( + 'ux_pagination', + $paginationConfig, + ); + $container->register(TestPaginationController::class) + ->setAutoconfigured(true) + ->setAutowired(true) + ->setPublic(true) + ->addTag('controller.service_arguments'); + $container->register(NamedPaginatorConsumer::class) + ->setAutowired(true) + ->setPublic(true); + $container->register(LivePaginationComponent::class) + ->setAutoconfigured(true) + ->setAutowired(true); + $container->register(LiveAutoRoutePaginationComponent::class) + ->setAutoconfigured(true) + ->setAutowired(true); + }); + } + + protected function configureRoutes(RoutingConfigurator $routes): void + { + $routes->add('ux_pagination_test_controller', '/_ux-pagination/controller') + ->controller(TestPaginationController::class.'::__invoke'); + $routes->add('ux_pagination_test_products', '/products'); + $routes->import('@LiveComponentBundle/config/routes.php') + ->prefix('/_components'); + } + + public function getCacheDir(): string + { + return sys_get_temp_dir().'/ux_pagination_tests/cache/'.Kernel::VERSION_ID.'/'.$this->environment; + } + + public function getLogDir(): string + { + return sys_get_temp_dir().'/ux_pagination_tests/log/'.Kernel::VERSION_ID; + } +} + +final class TestPaginationController +{ + public function __invoke(PaginatorInterface $paginator): Response + { + return new Response($paginator::class); + } +} + +final class NamedPaginatorConsumer +{ + public function __construct( + public readonly PaginatorInterface $blogPaginator, + #[Target('blog')] + public readonly PaginatorInterface $targetedPaginator, + #[Autowire(service: 'ux_pagination.paginator.blog')] + public readonly PaginatorInterface $explicitPaginator, + ) { + } +} diff --git a/src/Pagination/tests/LiveComponent/ComponentWithPaginationTraitTest.php b/src/Pagination/tests/LiveComponent/ComponentWithPaginationTraitTest.php new file mode 100644 index 00000000000..03a66bebd69 --- /dev/null +++ b/src/Pagination/tests/LiveComponent/ComponentWithPaginationTraitTest.php @@ -0,0 +1,319 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Symfony\UX\Pagination\Tests\LiveComponent; + +use PHPUnit\Framework\Attributes\CoversTrait; +use PHPUnit\Framework\Attributes\DataProvider; +use PHPUnit\Framework\TestCase; +use Symfony\Component\HttpFoundation\Request; +use Symfony\Component\HttpFoundation\RequestStack; +use Symfony\Component\Routing\Generator\UrlGenerator; +use Symfony\Component\Routing\RequestContext; +use Symfony\Component\Routing\Route; +use Symfony\Component\Routing\RouteCollection; +use Symfony\UX\LiveComponent\Attribute\LiveAction; +use Symfony\UX\LiveComponent\Attribute\LiveArg; +use Symfony\UX\LiveComponent\Attribute\LiveProp; +use Symfony\UX\LiveComponent\Metadata\UrlMapping; +use Symfony\UX\Pagination\Adapter\ArrayPaginationAdapter; +use Symfony\UX\Pagination\Exception\InvalidArgumentException; +use Symfony\UX\Pagination\LiveComponent\ComponentWithPaginationTrait; +use Symfony\UX\Pagination\PaginationBuilder; +use Symfony\UX\Pagination\Paginator; + +#[CoversTrait(ComponentWithPaginationTrait::class)] +final class ComponentWithPaginationTraitTest extends TestCase +{ + public function testDefaultState() + { + self::assertSame(1, $this->createComponent([1, 2, 3])->page); + } + + public function testPageIsWritableAndSynchronizedWithTheUrl() + { + $property = new \ReflectionProperty(ComponentWithPaginationTrait::class, 'page'); + $attributes = $property->getAttributes(LiveProp::class); + + self::assertCount(1, $attributes); + + $liveProp = $attributes[0]->newInstance(); + + self::assertTrue($liveProp->isIdentityWritable()); + self::assertInstanceOf(UrlMapping::class, $liveProp->url()); + } + + #[DataProvider('liveActions')] + public function testNavigationMethodsAreLiveActions(string $method) + { + $attributes = new \ReflectionMethod(ComponentWithPaginationTrait::class, $method) + ->getAttributes(LiveAction::class); + + self::assertCount(1, $attributes); + } + + /** + * @return iterable{{ pagination.info }}
', + 'pagination/_page.html.twig' => <<<'TWIG' + {% if link.isGap %} + + {% elseif link.isCurrent %} + {{ link.page }} + {% else %} + {{ link.page }} + {% endif %} + TWIG, + ])); + + $pagination = new Pagination( + source: range(1, 30), + adapter: new ArrayPaginationAdapter(), + currentPage: 2, + perPage: 10, + paginationUrlGenerator: new PaginationUrlGenerator(basePath: '/products'), + ); + + $html = new PaginationRenderer($twig) + ->renderPagination($pagination, theme: 'pagination/product.html.twig'); + + self::assertStringContainsString('class="product-summary"', $html); + self::assertStringContainsString('class="product-page"', $html); + self::assertStringContainsString('aria-current="page"', $html); + self::assertStringContainsString('rel="next"', $html); + } + + public function testApplicationTemplateCanExtendTheDefaultBlocks() + { + $bundleLoader = new FilesystemLoader(); + $bundleLoader->addPath(\dirname(__DIR__, 2).'/templates', 'UXPagination'); + $twig = new Environment(new ChainLoader([ + new ArrayLoader([ + 'pagination/product.html.twig' => <<<'TWIG' + {% extends '@UXPagination/theme/default.html.twig' %} + + {% block info %} +Product catalogue
+ {% endblock %} + TWIG, + ]), + $bundleLoader, + ])); + $twig->addExtension(new class extends AbstractExtension { + public function getFilters(): array + { + return [ + new TwigFilter('trans', static fn (string $key) => $key), + ]; + } + }); + + $pagination = new Pagination( + source: range(1, 30), + adapter: new ArrayPaginationAdapter(), + currentPage: 2, + perPage: 10, + paginationUrlGenerator: new PaginationUrlGenerator(basePath: '/products'), + ); + + $html = new PaginationRenderer($twig) + ->renderPagination($pagination, theme: 'pagination/product.html.twig'); + + self::assertStringContainsString('Product catalogue
', $html); + self::assertStringContainsString('class="ux-pagination__list"', $html); + self::assertStringContainsString('aria-current="page"', $html); + } + + public function testExtendedThemeOverridesTheLabelBlocks() + { + $twig = $this->createExtendingEnvironment(<<<'TWIG' + {% extends '@!UXPagination/theme/default.html.twig' %} + + {% block previous_label %}‹ {{ 'Previous'|trans({}, 'UXPaginationBundle') }}{% endblock %} + {% block next_label %}{{ 'Next'|trans({}, 'UXPaginationBundle') }} ›{% endblock %} + TWIG); + $renderer = new PaginationRenderer($twig); + + $middlePage = new Pagination( + source: range(1, 30), + adapter: new ArrayPaginationAdapter(), + currentPage: 2, + perPage: 10, + paginationUrlGenerator: new PaginationUrlGenerator(basePath: '/products'), + ); + $html = $renderer->renderPagination($middlePage, theme: 'pagination/application.html.twig'); + + self::assertStringContainsString('‹ Previous', $html); + self::assertStringContainsString('Next ›', $html); + self::assertStringNotContainsString('←', $html); + + $firstPage = new Pagination( + source: range(1, 30), + adapter: new ArrayPaginationAdapter(), + currentPage: 1, + perPage: 10, + paginationUrlGenerator: new PaginationUrlGenerator(basePath: '/products'), + ); + $html = $renderer->renderPagination($firstPage, theme: 'pagination/application.html.twig'); + + // The disabled previous control uses the same overridden label + self::assertStringContainsString('ux-pagination__link--disabled', $html); + self::assertStringContainsString('‹ Previous', $html); + } + + public function testExtendedThemeOverridesThePageLabelWithLinkContext() + { + $twig = $this->createExtendingEnvironment(<<<'TWIG' + {% extends '@!UXPagination/theme/default.html.twig' %} + + {% block page_label %}p{{ link.page }}{% endblock %} + TWIG); + + $pagination = new Pagination( + source: range(1, 30), + adapter: new ArrayPaginationAdapter(), + currentPage: 2, + perPage: 10, + paginationUrlGenerator: new PaginationUrlGenerator(basePath: '/products'), + ); + $html = new PaginationRenderer($twig) + ->renderPagination($pagination, theme: 'pagination/application.html.twig'); + + self::assertStringContainsString('aria-current="page">p2<', $html); + self::assertStringContainsString('>p1', $html); + self::assertStringContainsString('>p3', $html); + } + + private function createExtendingEnvironment(string $applicationTheme): Environment + { + $bundleLoader = new FilesystemLoader(); + $bundleLoader->addPath(\dirname(__DIR__, 2).'/templates', 'UXPagination'); + $bundleLoader->addPath(\dirname(__DIR__, 2).'/templates', '!UXPagination'); + + $twig = new Environment(new ChainLoader([ + new ArrayLoader([ + 'pagination/application.html.twig' => $applicationTheme, + ]), + $bundleLoader, + ])); + $twig->addExtension(new class extends AbstractExtension { + public function getFilters(): array + { + return [ + new TwigFilter('trans', static fn (string $key) => $key), + ]; + } + }); + + return $twig; + } + + #[DataProvider('themes')] + public function testEveryThemeExposesTheDocumentedBlocks( + string $theme, + ): void { + $bundleLoader = new FilesystemLoader(); + $bundleLoader->addPath( + \dirname(__DIR__, 2).'/templates', + 'UXPagination', + ); + $applicationTheme = str_replace( + '__PARENT_THEME__', + $theme, + <<<'TWIG' + {% extends '__PARENT_THEME__' %} + + {% block pagination %} +