TwigExtensionTest.php in Components! 8.2

Namespace

Drupal\Tests\components\Kernel

File

tests/src/Kernel/TwigExtensionTest.php

<?php

namespace Drupal\Tests\components\Kernel;


/**
 * @coversDefaultClass \Drupal\components\Template\TwigExtension
 * @group components
 */
class TwigExtensionTest extends ComponentsKernelTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  protected static $modules = [
    'system',
    'components',
    'components_twig_extension_test',
  ];

  /**
   * Ensures the Twig template() function works inside a Drupal instance.
   *
   * @covers ::template
   *
   * @throws \Exception
   */
  public function testTemplateFunction() {
    $result = NULL;
    try {
      $element = [
        '#theme' => 'components_twig_extension_test_template_function',
        '#items' => [
          'first item',
          'second item',
        ],
      ];
      $result = $this
        ->render($element);
    } catch (\Exception $e) {
      $this
        ->fail('No Exception expected; "' . $e
        ->getMessage() . '" thrown during: ' . $this
        ->getName());
    }
    $expected = '<ul><li>first item</li><li>second item</li></ul>';
    if (method_exists($this, 'assertStringContainsString')) {
      $this
        ->assertStringContainsString($expected, $result);
    }
    else {
      $this
        ->assertContains($expected, $result);
    }
  }

  /**
   * Ensures the Twig "recursive_merge" filter works inside a Drupal instance.
   *
   * @covers ::recursiveMergeFilter
   *
   * @dataProvider providerTestRecursiveMergeFilter
   */
  public function testRecursiveMergeFilter(string $theme_hook, string $expected) {
    try {
      $element = [
        '#theme' => $theme_hook,
        'list' => [
          '#theme' => 'item_list',
          '#items' => [
            [
              '#type' => 'container',
              '#attributes' => [
                'id' => 'the_element_id',
                'class' => [
                  'original-container-class',
                ],
              ],
            ],
          ],
        ],
      ];
      $result = $this
        ->render($element);
    } catch (\Exception $e) {
      $this
        ->fail('No Exception expected; "' . $e
        ->getMessage() . '" thrown during: ' . $this
        ->getName());
    }
    $this
      ->assertStringContainsString($expected, $result);
  }

  /**
   * Data provider for testRecursiveMergeFilter().
   *
   * @see testRecursiveMergeFilter()
   */
  public function providerTestRecursiveMergeFilter() : array {
    return [
      'Uses positional arguments' => [
        'theme_hook' => 'components_twig_extension_test_recursive_merge_filter',
        'expected' => '<div id="the_element_id" class="new-class"></div>',
      ],
      'Uses named arguments' => [
        'theme_hook' => 'components_twig_extension_test_recursive_merge_filter_named_arguments',
        'expected' => '<div id="the_element_id" class="new-class"></div>',
      ],
    ];
  }

  /**
   * Ensures the Twig "set" filter works inside a Drupal instance.
   *
   * @covers ::setFilter
   *
   * @dataProvider providerTestSetFilter
   */
  public function testSetFilter(string $theme_hook, string $expected) {
    $result = NULL;
    try {
      $element = [
        '#theme' => $theme_hook,
        'list' => [
          '#theme' => 'item_list',
          '#items' => [
            [
              '#type' => 'container',
              '#attributes' => [
                'id' => 'the_element_id',
                'class' => [
                  'original-container-class',
                ],
              ],
            ],
          ],
        ],
      ];
      $result = $this
        ->render($element);
    } catch (\Exception $e) {
      $this
        ->fail('No Exception expected; "' . $e
        ->getMessage() . '" thrown during: ' . $this
        ->getName());
    }
    if (method_exists($this, 'assertStringContainsString')) {
      $this
        ->assertStringContainsString($expected, $result);
    }
    else {
      $this
        ->assertContains($expected, $result);
    }
  }

  /**
   * Data provider for testSetFilter().
   *
   * @see testSetFilter()
   */
  public function providerTestSetFilter() : array {
    return [
      'Uses positional arguments' => [
        'theme_hook' => 'components_twig_extension_test_set_filter',
        'expected' => '<div class="new-class"></div>',
      ],
      'Uses named arguments' => [
        'theme_hook' => 'components_twig_extension_test_set_filter_named_arguments',
        'expected' => '<div class="new-class"></div>',
      ],
      'Uses deprecated "path" named argument' => [
        'theme_hook' => 'components_twig_extension_test_set_filter_deprecated_named_arguments',
        'expected' => '<div class="new-class"></div>',
      ],
      'Uses deprecated "array" named argument' => [
        'theme_hook' => 'components_twig_extension_test_set_filter_deprecated_named_argument',
        'expected' => '<div id="the_element_id" class="new-class"></div>',
      ],
    ];
  }

  /**
   * Ensures the Twig "add" filter works inside a Drupal instance.
   *
   * @covers ::addFilter
   *
   * @dataProvider providerTestAddFilter
   */
  public function testAddFilter(string $theme_hook, string $expected) {
    $result = NULL;
    try {
      $element = [
        '#theme' => $theme_hook,
        'list' => [
          '#theme' => 'item_list',
          '#items' => [
            [
              '#type' => 'container',
              '#attributes' => [
                'class' => [
                  'original-container-class',
                ],
              ],
            ],
          ],
        ],
      ];
      $result = $this
        ->render($element);
    } catch (\Exception $e) {
      $this
        ->fail('No Exception expected; "' . $e
        ->getMessage() . '" thrown during: ' . $this
        ->getName());
    }
    if (method_exists($this, 'assertStringContainsString')) {
      $this
        ->assertStringContainsString($expected, $result);
    }
    else {
      $this
        ->assertContains($expected, $result);
    }
    if (method_exists($this, 'assertStringContainsString')) {
      $this
        ->assertStringContainsString($expected, $result);
    }
    else {
      $this
        ->assertContains($expected, $result);
    }
  }

  /**
   * Data provider for testAddFilter().
   *
   * @see testAddFilter()
   */
  public function providerTestAddFilter() : array {
    return [
      'Uses positional arguments' => [
        'theme_hook' => 'components_twig_extension_test_add_filter',
        'expected' => '<div class="original-container-class new-class"></div>',
      ],
      'Uses named arguments' => [
        'theme_hook' => 'components_twig_extension_test_add_filter_named_arguments',
        'expected' => '<div class="original-container-class new-class"></div>',
      ],
      'Uses "values" named argument' => [
        'theme_hook' => 'components_twig_extension_test_add_filter_plural_named_arguments',
        'expected' => '<div class="original-container-class new-class-1 new-class-2"></div>',
      ],
      'Uses deprecated "path" named argument' => [
        'theme_hook' => 'components_twig_extension_test_add_filter_deprecated_named_arguments',
        'expected' => '<div class="original-container-class new-class"></div>',
      ],
    ];
  }

}

Classes

Name	Description
TwigExtensionTest	@coversDefaultClass \Drupal\components\Template\TwigExtension @group components