PreprocessPagerTest.php

<?php

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

use Drupal\Core\DependencyInjection\ContainerBuilder;
use Drupal\Core\Template\AttributeString;
use Drupal\Tests\UnitTestCase;

/**
 * Tests pager preprocessing.
 *
 * @group system
 */
class PreprocessPagerTest extends UnitTestCase {
    
    /**
     * {@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('');
        $container = new ContainerBuilder();
        $container->set('pager.manager', $pager_manager);
        $container->set('url_generator', $url_generator);
        // template_preprocess_pager() renders translatable attribute values.
        $container->set('string_translation', $this->getStringTranslationStub());
        \Drupal::setContainer($container);
    }
    
    /**
     * Tests template_preprocess_pager() when an empty #quantity is passed.
     *
     * @covers ::template_preprocess_pager
     */
    public function testQuantityNotSet() : void {
        require_once $this->root . '/core/includes/theme.inc';
        $variables = [
            'pager' => [
                '#element' => '',
                '#parameters' => [],
                '#quantity' => '',
                '#route_name' => '',
                '#tags' => '',
            ],
        ];
        template_preprocess_pager($variables);
        $this->assertEquals([
            'first',
            'previous',
        ], array_keys($variables['items']));
    }
    
    /**
     * Tests template_preprocess_pager() when a #quantity value is passed.
     *
     * @covers ::template_preprocess_pager
     */
    public function testQuantitySet() : void {
        require_once $this->root . '/core/includes/theme.inc';
        $variables = [
            'pager' => [
                '#element' => '2',
                '#parameters' => [],
                '#quantity' => '2',
                '#route_name' => '',
                '#tags' => '',
            ],
        ];
        template_preprocess_pager($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 template_preprocess_pager() when an empty #pagination_heading_level value is passed.
     *
     * @covers ::template_preprocess_pager
     */
    public function testEmptyPaginationHeadingLevelSet() : void {
        require_once $this->root . '/core/includes/theme.inc';
        $variables = [
            'pager' => [
                '#element' => '2',
                '#pagination_heading_level' => '',
                '#parameters' => [],
                '#quantity' => '2',
                '#route_name' => '',
                '#tags' => '',
            ],
        ];
        template_preprocess_pager($variables);
        $this->assertEquals('h4', $variables['pagination_heading_level']);
    }
    
    /**
     * Tests template_preprocess_pager() when no #pagination_heading_level is passed.
     *
     * @covers ::template_preprocess_pager
     */
    public function testPaginationHeadingLevelNotSet() : void {
        require_once $this->root . '/core/includes/theme.inc';
        $variables = [
            'pager' => [
                '#element' => '',
                '#parameters' => [],
                '#quantity' => '',
                '#route_name' => '',
                '#tags' => '',
            ],
        ];
        template_preprocess_pager($variables);
        $this->assertEquals('h4', $variables['pagination_heading_level']);
    }
    
    /**
     * Tests template_preprocess_pager() when a #pagination_heading_level value is passed.
     *
     * @covers ::template_preprocess_pager
     */
    public function testPaginationHeadingLevelSet() : void {
        require_once $this->root . '/core/includes/theme.inc';
        $variables = [
            'pager' => [
                '#element' => '2',
                '#pagination_heading_level' => 'h5',
                '#parameters' => [],
                '#quantity' => '2',
                '#route_name' => '',
                '#tags' => '',
            ],
        ];
        template_preprocess_pager($variables);
        $this->assertEquals('h5', $variables['pagination_heading_level']);
    }
    
    /**
     * Test template_preprocess_pager() with an invalid #pagination_heading_level.
     *
     * @covers ::template_preprocess_pager
     */
    public function testPaginationHeadingLevelInvalid() : void {
        require_once $this->root . '/core/includes/theme.inc';
        $variables = [
            'pager' => [
                '#element' => '2',
                '#pagination_heading_level' => 'not-a-heading-element',
                '#parameters' => [],
                '#quantity' => '2',
                '#route_name' => '',
                '#tags' => '',
            ],
        ];
        template_preprocess_pager($variables);
        $this->assertEquals('h4', $variables['pagination_heading_level']);
    }

}