kimai/tests/Twig/PaginationExtensionTest.php

<?php

/*
 * This file is part of the Kimai time-tracking app.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace App\Tests\Twig;

use App\Twig\PaginationExtension;
use App\Utils\Pagination;
use Pagerfanta\Adapter\ArrayAdapter;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\TestCase;
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
use Twig\TwigFunction;

#[CoversClass(PaginationExtension::class)]
class PaginationExtensionTest extends TestCase
{
    private function getUrlGenerator(): UrlGeneratorInterface
    {
        $urlGenerator = $this->getMockBuilder(UrlGeneratorInterface::class)->getMock();
        $urlGenerator
            ->expects($this->any())
            ->method('generate')
            ->willReturnCallback(function ($name, $parameters = []) {
                $params = [];
                foreach ($parameters as $k => $v) {
                    $params[] = $k . '=' . $v;
                }

                return (string) $name . '?' . implode('&', $params);
            })
        ;

        return $urlGenerator;
    }

    protected function getSut(): PaginationExtension
    {
        return new PaginationExtension($this->getUrlGenerator());
    }

    public function testGetFunctions(): void
    {
        $functions = ['pagination'];
        $sut = $this->getSut();
        $twigFunctions = $sut->getFunctions();
        self::assertCount(\count($functions), $twigFunctions);
        $i = 0;
        /** @var TwigFunction $filter */
        foreach ($twigFunctions as $filter) {
            self::assertInstanceOf(TwigFunction::class, $filter);
            self::assertEquals($functions[$i++], $filter->getName());
        }
    }

    public function testRenderPaginationWithoutTemplateName(): void
    {
        $sut = $this->getSut();

        $values = array_fill(0, 151, 'blub');
        $pagination = new Pagination(new ArrayAdapter($values));
        $pagination->setMaxPerPage(10);
        $result = $sut->renderPagination($pagination, [
            'css_container_class' => 'pagination pagination-sm inline',
            'routeName' => 'project_activities',
            'routeParams' => ['id' => 137]
        ]);
        $this->assertPaginationHtml($result);
    }

    public function assertPaginationHtml($result): void
    {
        // this makes sure that we show the correct amount of pagination links!
        $expected =
            '<ul class="pagination pagination-sm inline">' .
            '<li class="page-item  disabled"><span class="page-link pagination-link"><i class="fas fa-chevron-left"></i></span></li>' .
            '<li class="page-item active"><a class="page-link pagination-link" href="project_activities?id=137&page=1">1</a></li>' .
            '<li class="page-item"><a class="page-link pagination-link" href="project_activities?id=137&page=2">2</a></li>' .
            '<li class="page-item"><a class="page-link pagination-link" href="project_activities?id=137&page=3">3</a></li>' .
            '<li class="page-item"><a class="page-link pagination-link" href="project_activities?id=137&page=4">4</a></li>' .
            '<li class="page-item"><a class="page-link pagination-link" href="project_activities?id=137&page=5">5</a></li>' .
            '<li class="page-item disabled"><span class="page-link pagination-link">&hellip;</span></li>' .
            '<li class="page-item"><a class="page-link pagination-link" href="project_activities?id=137&page=16">16</a></li>' .
            '<li class="page-item"><a class="page-link pagination-link" href="project_activities?id=137&page=2" rel="next"><i class="fas fa-chevron-right"></i></a></li>' .
            '</ul>';

        self::assertEquals($expected, $result);
    }

    public function testRenderPagination(): void
    {
        $sut = $this->getSut();

        $values = array_fill(0, 151, 'blub');
        $pagination = new Pagination(new ArrayAdapter($values));
        $pagination->setMaxPerPage(10);
        $result = $sut->renderPagination($pagination, [
            'css_container_class' => 'pagination pagination-sm inline',
            'routeName' => 'project_activities',
            'routeParams' => ['id' => 137]
        ]);
        $this->assertPaginationHtml($result);
    }

    public function testRenderPaginationWithoutPageSize(): void
    {
        $sut = $this->getSut();

        $values = array_fill(0, 151, 'blub');
        $pagination = new Pagination(new ArrayAdapter($values));
        $result = $sut->renderPagination($pagination, [
            'css_container_class' => 'pagination pagination-sm inline',
            'routeName' => 'project_activities',
            'routeParams' => ['id' => 137]
        ]);

        $expected =
            '<ul class="pagination pagination-sm inline"><li class="page-item  disabled"><span class="page-link pagination-link"><i class="fas fa-chevron-left"></i></span></li>' .
            '<li class="page-item active"><a class="page-link pagination-link" href="project_activities?id=137&page=1">1</a></li>' .
            '<li class="page-item  disabled"><span class="page-link pagination-link"><i class="fas fa-chevron-right"></i></span></li></ul>';

        self::assertEquals($expected, $result);
    }

    public function testRenderPaginationWithoutRouteName(): void
    {
        $this->expectException(\Exception::class);
        $this->expectExceptionMessage('Pagination is missing the "routeName" option');

        $sut = $this->getSut();

        $values = array_fill(0, 151, 'blub');
        $pagination = new Pagination(new ArrayAdapter($values));
        $result = $sut->renderPagination($pagination, [
            'css_container_class' => 'pagination pagination-sm inline',
            'routeParams' => ['id' => 137]
        ]);
        $this->assertPaginationHtml($result);
    }
}