PreprocessPagerTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\system\Unit\Pager;

use Drupal\Core\DependencyInjection\ContainerBuilder;
use Drupal\Core\EventSubscriber\MainContentViewSubscriber;
use Drupal\Core\Pager\PagerPreprocess;
use Drupal\Core\Template\AttributeString;
use Drupal\Tests\UnitTestCase;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\Group;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestStack;

/**
 * Tests pager preprocessing.
 */
class PreprocessPagerTest extends UnitTestCase {
  
  /**
   * Pager preprocess instance.
   */
  protected PagerPreprocess $pagerPreprocess;
  
  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $pager_manager = $this->getMockBuilder('Drupal\\Core\\Pager\\PagerManager')
      ->disableOriginalConstructor()
      ->getMock();
    $pager = $this->getMockBuilder('Drupal\\Core\\Pager\\Pager')
      ->disableOriginalConstructor()
      ->getMock();
    $url_generator = $this->getMockBuilder('Drupal\\Core\\Routing\\UrlGenerator')
      ->disableOriginalConstructor()
      ->getMock();
    $pager->method('getTotalPages')
      ->willReturn(2);
    $pager->method('getCurrentPage')
      ->willReturn(1);
    $url_generator->method('generateFromRoute')
      ->willReturn('');
    $pager_manager->method('getPager')
      ->willReturn($pager);
    $pager_manager->method('getUpdatedParameters')
      ->willReturn('');
    $request_stack = $this->createMock(RequestStack::class);
    $request = Request::createFromGlobals();
    $request->query
      ->set(MainContentViewSubscriber::WRAPPER_FORMAT, 'drupal_modal');
    // Mocks the request stack getting the current request.
    $request_stack->expects($this->any())
      ->method('getCurrentRequest')
      ->willReturn($request);
    $this->pagerPreprocess = new PagerPreprocess($pager_manager, $request_stack);
    $container = new ContainerBuilder();
    $container->set('url_generator', $url_generator);
    \Drupal::setContainer($container);
  }
  
  /**
   * Tests when an empty #quantity is passed.
   *
   * @legacy-covers ::preprocessPager
   */
  public function testQuantityNotSet() : void {
    $variables = [
      'pager' => [
        '#element' => '',
        '#parameters' => [],
        '#quantity' => '',
        '#route_name' => '',
        '#tags' => '',
      ],
    ];
    $this->pagerPreprocess
      ->preprocessPager($variables);
    $this->assertEquals([
      'first',
      'previous',
    ], array_keys($variables['items']));
  }
  
  /**
   * Tests when a #quantity value is passed.
   *
   * @legacy-covers ::preprocessPager
   */
  public function testQuantitySet() : void {
    $variables = [
      'pager' => [
        '#element' => '2',
        '#parameters' => [],
        '#quantity' => '2',
        '#route_name' => '',
        '#tags' => '',
      ],
    ];
    $this->pagerPreprocess
      ->preprocessPager($variables);
    $this->assertEquals([
      'first',
      'previous',
      'pages',
    ], array_keys($variables['items']));
    /** @var \Drupal\Core\Template\AttributeString $attribute */
    $attribute = $variables['items']['pages']['2']['attributes']->offsetGet('aria-current');
    $this->assertInstanceOf(AttributeString::class, $attribute);
    $this->assertEquals('page', $attribute->value());
  }
  
  /**
   * Tests when an empty #pagination_heading_level value is passed.
   *
   * @legacy-covers ::preprocessPager
   */
  public function testEmptyPaginationHeadingLevelSet() : void {
    $variables = [
      'pager' => [
        '#element' => '2',
        '#pagination_heading_level' => '',
        '#parameters' => [],
        '#quantity' => '2',
        '#route_name' => '',
        '#tags' => '',
      ],
    ];
    $this->pagerPreprocess
      ->preprocessPager($variables);
    $this->assertEquals('h4', $variables['pagination_heading_level']);
  }
  
  /**
   * Tests when no #pagination_heading_level is passed.
   *
   * @legacy-covers ::preprocessPager
   */
  public function testPaginationHeadingLevelNotSet() : void {
    $variables = [
      'pager' => [
        '#element' => '',
        '#parameters' => [],
        '#quantity' => '',
        '#route_name' => '',
        '#tags' => '',
      ],
    ];
    $this->pagerPreprocess
      ->preprocessPager($variables);
    $this->assertEquals('h4', $variables['pagination_heading_level']);
  }
  
  /**
   * Tests when a #pagination_heading_level value is passed.
   *
   * @legacy-covers ::preprocessPager
   */
  public function testPaginationHeadingLevelSet() : void {
    $variables = [
      'pager' => [
        '#element' => '2',
        '#pagination_heading_level' => 'h5',
        '#parameters' => [],
        '#quantity' => '2',
        '#route_name' => '',
        '#tags' => '',
      ],
    ];
    $this->pagerPreprocess
      ->preprocessPager($variables);
    $this->assertEquals('h5', $variables['pagination_heading_level']);
  }
  
  /**
   * Test with an invalid #pagination_heading_level.
   *
   * @legacy-covers ::preprocessPager
   */
  public function testPaginationHeadingLevelInvalid() : void {
    $variables = [
      'pager' => [
        '#element' => '2',
        '#pagination_heading_level' => 'not-a-heading-element',
        '#parameters' => [],
        '#quantity' => '2',
        '#route_name' => '',
        '#tags' => '',
      ],
    ];
    $this->pagerPreprocess
      ->preprocessPager($variables);
    $this->assertEquals('h4', $variables['pagination_heading_level']);
  }
  
  /**
   * Tests pager links get modal attributes when request is in a modal.
   */
  public function testPagerModalAttributes() : void {
    $variables = [
      'pager' => [
        '#element' => '',
        '#parameters' => [],
        '#quantity' => '',
        '#route_name' => '',
        '#tags' => '',
      ],
    ];
    $this->pagerPreprocess
      ->preprocessPager($variables);
    foreach ([
      'first',
      'previous',
    ] as $key) {
      $attributes = $variables['items'][$key]['attributes']->toArray();
      $this->assertEquals([
        'use-ajax',
      ], $attributes['class']);
    }
  }

}