FieldWebTest.php

<?php

namespace Drupal\Tests\views\Functional\Handler;

use Drupal\Component\Render\FormattableMarkup;
use Drupal\Component\Utility\Html;
use Drupal\Component\Utility\UrlHelper;
use Drupal\Core\Render\RenderContext;
use Drupal\Core\Url;
use Drupal\language\Entity\ConfigurableLanguage;
use Drupal\Tests\system\Functional\Cache\AssertPageCacheContextsAndTagsTrait;
use Drupal\Tests\views\Functional\ViewTestBase;
use Drupal\views\Views;

/**
 * Tests fields from within a UI.
 *
 * @group views
 * @see \Drupal\views\Plugin\views\field\FieldPluginBase
 */
class FieldWebTest extends ViewTestBase {
    use AssertPageCacheContextsAndTagsTrait;
    
    /**
     * Views used by this test.
     *
     * @var array
     */
    public static $testViews = [
        'test_view',
        'test_field_classes',
        'test_field_output',
        'test_click_sort',
        'test_distinct_click_sorting',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'node',
        'language',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * Maps between the key in the expected result and the query result.
     *
     * @var array
     */
    protected $columnMap = [
        'views_test_data_name' => 'name',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp($import_test_views = TRUE, $modules = [
        'views_test_config',
    ]) : void {
        parent::setUp($import_test_views, $modules);
        $this->enableViewsTestModule();
    }
    
    /**
     * {@inheritdoc}
     */
    protected function viewsData() {
        $data = parent::viewsData();
        $data['views_test_data']['job']['field']['id'] = 'test_field';
        return $data;
    }
    
    /**
     * Tests the click sorting functionality.
     */
    public function testClickSorting() {
        $this->drupalGet('test_click_sort');
        $this->assertSession()
            ->statusCodeEquals(200);
        // Only the id and name should be click sortable, but not the name.
        $this->assertSession()
            ->linkByHrefExists(Url::fromRoute('<none>', [], [
            'query' => [
                'order' => 'id',
                'sort' => 'asc',
            ],
        ])->toString());
        $this->assertSession()
            ->linkByHrefExists(Url::fromRoute('<none>', [], [
            'query' => [
                'order' => 'name',
                'sort' => 'desc',
            ],
        ])->toString());
        $this->assertSession()
            ->linkByHrefNotExists(Url::fromRoute('<none>', [], [
            'query' => [
                'order' => 'created',
            ],
        ])->toString());
        // Check that the view returns the click sorting cache contexts.
        $expected_contexts = [
            'languages:language_interface',
            'theme',
            'url.query_args',
        ];
        $this->assertCacheContexts($expected_contexts);
        // Clicking a click sort should change the order.
        $this->clickLink('ID');
        $href = Url::fromRoute('<none>', [], [
            'query' => [
                'order' => 'id',
                'sort' => 'desc',
            ],
        ])->toString();
        $this->assertSession()
            ->linkByHrefExists($href);
        // Check that the output has the expected order (asc).
        $ids = $this->clickSortLoadIdsFromOutput();
        $this->assertEquals(range(1, 5), $ids);
        // Check that the rel attribute has the correct value.
        $this->assertSession()
            ->elementAttributeContains('xpath', "//a[@href='{$href}']", 'rel', 'nofollow');
        $this->clickLink('ID Sort descending');
        // Check that the output has the expected order (desc).
        $ids = $this->clickSortLoadIdsFromOutput();
        $this->assertEquals(range(5, 1, -1), $ids);
    }
    
    /**
     * Tests the default click sorting functionality with distinct.
     */
    public function testClickSortingDistinct() {
        ConfigurableLanguage::createFromLangcode('es')->save();
        $node = $this->drupalCreateNode();
        $this->drupalGet('test_distinct_click_sorting');
        $this->assertSession()
            ->statusCodeEquals(200);
        // Check that the results are ordered by id in ascending order and that the
        // title click filter is for descending.
        $this->assertSession()
            ->linkByHrefExists(Url::fromRoute('<none>', [], [
            'query' => [
                'order' => 'changed',
                'sort' => 'desc',
            ],
        ])->toString());
        $this->assertSession()
            ->pageTextContains($node->getTitle());
        $this->clickLink('Changed');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->pageTextContains($node->getTitle());
    }
    
    /**
     * Small helper function to get all ids in the output.
     *
     * @return array
     *   A list of beatle ids.
     */
    protected function clickSortLoadIdsFromOutput() {
        $fields = $this->xpath("//td[contains(@class, 'views-field-id')]");
        $ids = [];
        foreach ($fields as $field) {
            $ids[] = (int) $field->getText();
        }
        return $ids;
    }
    
    /**
     * Assertion helper which checks whether a string is part of another string.
     *
     * @param string $haystack
     *   The value to search in.
     * @param string $needle
     *   The value to search for.
     * @param string $message
     *   The message to display along with the assertion.
     *
     * @internal
     */
    protected function assertSubString(string $haystack, string $needle, string $message = '') : void {
        $this->assertStringContainsString($needle, $haystack, $message);
    }
    
    /**
     * Assertion helper which checks whether a string is not part of another string.
     *
     * @param string $haystack
     *   The value to search in.
     * @param string $needle
     *   The value to search for.
     * @param string $message
     *   The message to display along with the assertion.
     *
     * @internal
     */
    protected function assertNotSubString(string $haystack, string $needle, string $message = '') : void {
        $this->assertStringNotContainsString($needle, $haystack, $message);
    }
    
    /**
     * Parse a content and return the html element.
     *
     * @param string $content
     *   The html to parse.
     *
     * @return array
     *   An array containing simplexml objects.
     */
    protected function parseContent($content) {
        $htmlDom = new \DOMDocument();
        @$htmlDom->loadHTML('<?xml encoding="UTF-8">' . $content);
        $elements = simplexml_import_dom($htmlDom);
        return $elements;
    }
    
    /**
     * Performs an xpath search on a certain content.
     *
     * The search is relative to the root element of the $content variable.
     *
     * @param string $content
     *   The html to parse.
     * @param string $xpath
     *   The xpath string to use in the search.
     * @param array $arguments
     *   Some arguments for the xpath.
     *
     * @return array|false
     *   The return value of the xpath search. For details on the xpath string
     *   format and return values see the SimpleXML documentation,
     *   http://php.net/manual/function.simplexml-element-xpath.php.
     */
    protected function xpathContent($content, $xpath, array $arguments = []) {
        if ($elements = $this->parseContent($content)) {
            $xpath = $this->assertSession()
                ->buildXPathQuery($xpath, $arguments);
            $result = $elements->xpath($xpath);
            // Some combinations of PHP / libxml versions return an empty array
            // instead of the documented FALSE. Forcefully convert any falsish values
            // to an empty array to allow foreach(...) constructions.
            return $result ? $result : [];
        }
        else {
            return FALSE;
        }
    }
    
    /**
     * Tests rewriting the output to a link.
     */
    public function testAlterUrl() {
        
        /** @var \Drupal\Core\Render\RendererInterface $renderer */
        $renderer = \Drupal::service('renderer');
        $view = Views::getView('test_view');
        $view->setDisplay();
        $view->initHandlers();
        $this->executeView($view);
        $row = $view->result[0];
        $id_field = $view->field['id'];
        // Setup the general settings required to build a link.
        $id_field->options['alter']['make_link'] = TRUE;
        $id_field->options['alter']['path'] = $path = $this->randomMachineName();
        // Tests that the suffix/prefix appears on the output.
        $id_field->options['alter']['prefix'] = $prefix = $this->randomMachineName();
        $id_field->options['alter']['suffix'] = $suffix = $this->randomMachineName();
        $output = $renderer->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
            return $id_field->theme($row);
        });
        $this->assertSubString($output, $prefix);
        $this->assertSubString($output, $suffix);
        unset($id_field->options['alter']['prefix']);
        unset($id_field->options['alter']['suffix']);
        $output = $renderer->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
            return $id_field->theme($row);
        });
        $this->assertSubString($output, $path, 'Make sure that the path is part of the output');
        // Some generic test code adapted from the UrlTest class, which tests
        // mostly the different options for the path.
        foreach ([
            FALSE,
            TRUE,
        ] as $absolute) {
            $alter =& $id_field->options['alter'];
            $alter['path'] = 'node/123';
            $expected_result = Url::fromRoute('entity.node.canonical', [
                'node' => '123',
            ], [
                'absolute' => $absolute,
            ])->toString();
            $alter['absolute'] = $absolute;
            $result = $renderer->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
                return $id_field->theme($row);
            });
            $this->assertSubString($result, $expected_result);
            $expected_result = Url::fromRoute('entity.node.canonical', [
                'node' => '123',
            ], [
                'fragment' => 'foo',
                'absolute' => $absolute,
            ])->toString();
            $alter['path'] = 'node/123#foo';
            $result = $renderer->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
                return $id_field->theme($row);
            });
            $this->assertSubString($result, $expected_result);
            $expected_result = Url::fromRoute('entity.node.canonical', [
                'node' => '123',
            ], [
                'query' => [
                    'foo' => NULL,
                ],
                'absolute' => $absolute,
            ])->toString();
            $alter['path'] = 'node/123?foo';
            $result = $renderer->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
                return $id_field->theme($row);
            });
            $this->assertSubString($result, $expected_result);
            $expected_result = Url::fromRoute('entity.node.canonical', [
                'node' => '123',
            ], [
                'query' => [
                    'foo' => 'bar',
                    'bar' => 'baz',
                ],
                'absolute' => $absolute,
            ])->toString();
            $alter['path'] = 'node/123?foo=bar&bar=baz';
            $result = $renderer->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
                return $id_field->theme($row);
            });
            $this->assertSubString(Html::decodeEntities($result), Html::decodeEntities($expected_result));
            // @todo The route-based URL generator strips out NULL attributes.
            // $expected_result = Url::fromRoute('entity.node.canonical', ['node' => '123'], ['query' => ['foo' => NULL], 'fragment' => 'bar', 'absolute' => $absolute])->toString();
            $expected_result = Url::fromUserInput('/node/123', [
                'query' => [
                    'foo' => NULL,
                ],
                'fragment' => 'bar',
                'absolute' => $absolute,
            ])->toString();
            $alter['path'] = 'node/123?foo#bar';
            $result = $renderer->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
                return $id_field->theme($row);
            });
            $this->assertSubString(Html::decodeEntities($result), Html::decodeEntities($expected_result));
            $expected_result = Url::fromRoute('<front>', [], [
                'absolute' => $absolute,
            ])->toString();
            $alter['path'] = '<front>';
            $result = $renderer->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
                return $id_field->theme($row);
            });
            $this->assertSubString($result, $expected_result);
        }
        // Tests the replace spaces with dashes feature.
        $id_field->options['alter']['replace_spaces'] = TRUE;
        $id_field->options['alter']['path'] = $path = $this->randomMachineName() . ' ' . $this->randomMachineName();
        $output = $renderer->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
            return $id_field->theme($row);
        });
        $this->assertSubString($output, str_replace(' ', '-', $path));
        $id_field->options['alter']['replace_spaces'] = FALSE;
        $output = $renderer->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
            return $id_field->theme($row);
        });
        // The URL has a space in it, so to check we have to decode the URL output.
        $this->assertSubString(urldecode($output), $path);
        // Tests the external flag.
        // Switch on the external flag should output an external URL as well.
        $id_field->options['alter']['external'] = TRUE;
        $id_field->options['alter']['path'] = $path = 'www.drupal.org';
        $output = $renderer->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
            return $id_field->theme($row);
        });
        $this->assertSubString($output, 'http://www.drupal.org');
        // Setup a not external URL, which shouldn't lead to an external URL.
        $id_field->options['alter']['external'] = FALSE;
        $id_field->options['alter']['path'] = $path = 'www.drupal.org';
        $output = $renderer->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
            return $id_field->theme($row);
        });
        $this->assertNotSubString($output, 'http://www.drupal.org');
        // Tests the transforming of the case setting.
        $id_field->options['alter']['path'] = $path = $this->randomMachineName();
        $id_field->options['alter']['path_case'] = 'none';
        $output = $renderer->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
            return $id_field->theme($row);
        });
        $this->assertSubString($output, $path);
        // Switch to uppercase and lowercase.
        $id_field->options['alter']['path_case'] = 'upper';
        $output = $renderer->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
            return $id_field->theme($row);
        });
        $this->assertSubString($output, strtoupper($path));
        $id_field->options['alter']['path_case'] = 'lower';
        $output = $renderer->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
            return $id_field->theme($row);
        });
        $this->assertSubString($output, strtolower($path));
        // Switch to ucfirst and ucwords.
        $id_field->options['alter']['path_case'] = 'ucfirst';
        $id_field->options['alter']['path'] = 'drupal has a great community';
        $output = $renderer->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
            return $id_field->theme($row);
        });
        $this->assertSubString($output, UrlHelper::encodePath('Drupal has a great community'));
        $id_field->options['alter']['path_case'] = 'ucwords';
        $output = $renderer->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
            return $id_field->theme($row);
        });
        $this->assertSubString($output, UrlHelper::encodePath('Drupal Has A Great Community'));
        unset($id_field->options['alter']['path_case']);
        // Tests the link_class setting and see whether it actually exists in the
        // output.
        $id_field->options['alter']['link_class'] = $class = $this->randomMachineName();
        $output = $renderer->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
            return $id_field->theme($row);
        });
        $elements = $this->xpathContent($output, '//a[contains(@class, :class)]', [
            ':class' => $class,
        ]);
        $this->assertNotEmpty($elements);
        // @fixme link_class, alt, rel cannot be unset, which should be fixed.
        $id_field->options['alter']['link_class'] = '';
        // Tests the alt setting.
        $id_field->options['alter']['alt'] = $rel = $this->randomMachineName();
        $output = $renderer->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
            return $id_field->theme($row);
        });
        $elements = $this->xpathContent($output, '//a[contains(@title, :alt)]', [
            ':alt' => $rel,
        ]);
        $this->assertNotEmpty($elements);
        $id_field->options['alter']['alt'] = '';
        // Tests the rel setting.
        $id_field->options['alter']['rel'] = $rel = $this->randomMachineName();
        $output = $renderer->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
            return $id_field->theme($row);
        });
        $elements = $this->xpathContent($output, '//a[contains(@rel, :rel)]', [
            ':rel' => $rel,
        ]);
        $this->assertNotEmpty($elements);
        $id_field->options['alter']['rel'] = '';
        // Tests the target setting.
        $id_field->options['alter']['target'] = $target = $this->randomMachineName();
        $output = $renderer->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
            return $id_field->theme($row);
        });
        $elements = $this->xpathContent($output, '//a[contains(@target, :target)]', [
            ':target' => $target,
        ]);
        $this->assertNotEmpty($elements);
        unset($id_field->options['alter']['target']);
    }
    
    /**
     * Tests the field/label/wrapper classes.
     */
    public function testFieldClasses() {
        
        /** @var \Drupal\Core\Render\RendererInterface $renderer */
        $renderer = $this->container
            ->get('renderer');
        $view = Views::getView('test_field_classes');
        $view->initHandlers();
        // Tests whether the default field classes are added.
        $id_field = $view->field['id'];
        $id_field->options['element_default_classes'] = FALSE;
        // Setup some kind of label by default.
        $id_field->options['label'] = $this->randomMachineName();
        $output = $view->preview();
        $output = $renderer->renderRoot($output);
        $this->assertEmpty($this->xpathContent($output, '//div[contains(@class, :class)]', [
            ':class' => 'field-content',
        ]));
        $this->assertEmpty($this->xpathContent($output, '//div[contains(@class, :class)]', [
            ':class' => 'field__label',
        ]));
        $id_field->options['element_default_classes'] = TRUE;
        $output = $view->preview();
        $output = $renderer->renderRoot($output);
        // Per default the label and the element of the field are spans.
        $this->assertNotEmpty($this->xpathContent($output, '//span[contains(@class, :class)]', [
            ':class' => 'field-content',
        ]));
        $this->assertNotEmpty($this->xpathContent($output, '//span[contains(@class, :class)]', [
            ':class' => 'views-label',
        ]));
        $this->assertNotEmpty($this->xpathContent($output, '//div[contains(@class, :class)]', [
            ':class' => 'views-field',
        ]));
        // Tests the element wrapper classes/element.
        $random_class = $this->randomMachineName();
        // Set some common wrapper element types and see whether they appear with and without a custom class set.
        foreach ([
            'h1',
            'span',
            'p',
            'div',
        ] as $element_type) {
            $id_field->options['element_wrapper_type'] = $element_type;
            // Set a custom wrapper element css class.
            $id_field->options['element_wrapper_class'] = $random_class;
            $output = $view->preview();
            $output = $renderer->renderRoot($output);
            $this->assertNotEmpty($this->xpathContent($output, "//{$element_type}[contains(@class, :class)]", [
                ':class' => $random_class,
            ]));
            // Set no custom css class.
            $id_field->options['element_wrapper_class'] = '';
            $output = $view->preview();
            $output = $renderer->renderRoot($output);
            $this->assertEmpty($this->xpathContent($output, "//{$element_type}[contains(@class, :class)]", [
                ':class' => $random_class,
            ]));
            $this->assertNotEmpty($this->xpathContent($output, "//li[contains(@class, views-row)]/{$element_type}"));
        }
        // Tests the label class/element.
        // Set some common label element types and see whether they appear with and without a custom class set.
        foreach ([
            'h1',
            'span',
            'p',
            'div',
        ] as $element_type) {
            $id_field->options['element_label_type'] = $element_type;
            // Set a custom label element css class.
            $id_field->options['element_label_class'] = $random_class;
            $output = $view->preview();
            $output = $renderer->renderRoot($output);
            $this->assertNotEmpty($this->xpathContent($output, "//li[contains(@class, views-row)]//{$element_type}[contains(@class, :class)]", [
                ':class' => $random_class,
            ]));
            // Set no custom css class.
            $id_field->options['element_label_class'] = '';
            $output = $view->preview();
            $output = $renderer->renderRoot($output);
            $this->assertEmpty($this->xpathContent($output, "//li[contains(@class, views-row)]//{$element_type}[contains(@class, :class)]", [
                ':class' => $random_class,
            ]));
            $this->assertNotEmpty($this->xpathContent($output, "//li[contains(@class, views-row)]//{$element_type}"));
        }
        // Tests the element classes/element.
        // Set some common element types and see whether they appear with and without a custom class set.
        foreach ([
            'h1',
            'span',
            'p',
            'div',
        ] as $element_type) {
            $id_field->options['element_type'] = $element_type;
            // Set a custom label element css class.
            $id_field->options['element_class'] = $random_class;
            $output = $view->preview();
            $output = $renderer->renderRoot($output);
            $this->assertNotEmpty($this->xpathContent($output, "//li[contains(@class, views-row)]//div[contains(@class, views-field)]//{$element_type}[contains(@class, :class)]", [
                ':class' => $random_class,
            ]));
            // Set no custom css class.
            $id_field->options['element_class'] = '';
            $output = $view->preview();
            $output = $renderer->renderRoot($output);
            $this->assertEmpty($this->xpathContent($output, "//li[contains(@class, views-row)]//div[contains(@class, views-field)]//{$element_type}[contains(@class, :class)]", [
                ':class' => $random_class,
            ]));
            $this->assertNotEmpty($this->xpathContent($output, "//li[contains(@class, views-row)]//div[contains(@class, views-field)]//{$element_type}"));
        }
        // Tests the available html elements.
        $element_types = $id_field->getElements();
        $expected_elements = [
            '',
            0,
            'div',
            'span',
            'h1',
            'h2',
            'h3',
            'h4',
            'h5',
            'h6',
            'p',
            'strong',
            'em',
            'marquee',
        ];
        $this->assertEquals($expected_elements, array_keys($element_types));
    }
    
    /**
     * Tests trimming/read-more/ellipses.
     */
    public function testTextRendering() {
        
        /** @var \Drupal\Core\Render\RendererInterface $renderer */
        $renderer = \Drupal::service('renderer');
        $view = Views::getView('test_field_output');
        $view->initHandlers();
        $name_field = $view->field['name'];
        // Tests stripping of html elements.
        $this->executeView($view);
        $random_text = $this->randomMachineName();
        $name_field->options['alter']['alter_text'] = TRUE;
        $name_field->options['alter']['text'] = $html_text = '<div class="views-test">' . $random_text . '</div>';
        $row = $view->result[0];
        $name_field->options['alter']['strip_tags'] = TRUE;
        $output = $renderer->executeInRenderContext(new RenderContext(), function () use ($name_field, $row) {
            return $name_field->advancedRender($row);
        });
        $this->assertSubString($output, $random_text, 'Find text without html if stripping of views field output is enabled.');
        $this->assertNotSubString($output, $html_text, 'Find no text with the html if stripping of views field output is enabled.');
        // Tests preserving of html tags.
        $name_field->options['alter']['preserve_tags'] = '<div>';
        $output = $renderer->executeInRenderContext(new RenderContext(), function () use ($name_field, $row) {
            return $name_field->advancedRender($row);
        });
        $this->assertSubString($output, $random_text, 'Find text without html if stripping of views field output is enabled but a div is allowed.');
        $this->assertSubString($output, $html_text, 'Find text with the html if stripping of views field output is enabled but a div is allowed.');
        $name_field->options['alter']['strip_tags'] = FALSE;
        $output = $renderer->executeInRenderContext(new RenderContext(), function () use ($name_field, $row) {
            return $name_field->advancedRender($row);
        });
        $this->assertSubString($output, $random_text, 'Find text without html if stripping of views field output is disabled.');
        $this->assertSubString($output, $html_text, 'Find text with the html if stripping of views field output is disabled.');
        // Tests for removing whitespace and the beginning and the end.
        $name_field->options['alter']['alter_text'] = FALSE;
        $views_test_data_name = $row->views_test_data_name;
        $row->views_test_data_name = '  ' . $views_test_data_name . '     ';
        $name_field->options['alter']['trim_whitespace'] = TRUE;
        $output = $renderer->executeInRenderContext(new RenderContext(), function () use ($name_field, $row) {
            return $name_field->advancedRender($row);
        });
        $this->assertSubString($output, $views_test_data_name, 'Make sure the trimmed text can be found if trimming is enabled.');
        $this->assertNotSubString($output, $row->views_test_data_name, 'Make sure the untrimmed text can be found if trimming is enabled.');
        $name_field->options['alter']['trim_whitespace'] = FALSE;
        $output = $renderer->executeInRenderContext(new RenderContext(), function () use ($name_field, $row) {
            return $name_field->advancedRender($row);
        });
        $this->assertSubString($output, $views_test_data_name, 'Make sure the trimmed text can be found if trimming is disabled.');
        $this->assertSubString($output, $row->views_test_data_name, 'Make sure the untrimmed text can be found  if trimming is disabled.');
        // Tests for trimming to a maximum length.
        $name_field->options['alter']['trim'] = TRUE;
        $name_field->options['alter']['word_boundary'] = FALSE;
        // Tests for simple trimming by string length.
        $row->views_test_data_name = $this->randomMachineName(8);
        $name_field->options['alter']['max_length'] = 5;
        $trimmed_name = mb_substr($row->views_test_data_name, 0, 5);
        $output = $renderer->executeInRenderContext(new RenderContext(), function () use ($name_field, $row) {
            return $name_field->advancedRender($row);
        });
        $this->assertSubString($output, $trimmed_name, new FormattableMarkup('Make sure the trimmed output (@trimmed) appears in the rendered output (@output).', [
            '@trimmed' => $trimmed_name,
            '@output' => $output,
        ]));
        $this->assertNotSubString($output, $row->views_test_data_name, new FormattableMarkup("Make sure the untrimmed value (@untrimmed) shouldn't appear in the rendered output (@output).", [
            '@untrimmed' => $row->views_test_data_name,
            '@output' => $output,
        ]));
        $name_field->options['alter']['max_length'] = 9;
        $output = $renderer->executeInRenderContext(new RenderContext(), function () use ($name_field, $row) {
            return $name_field->advancedRender($row);
        });
        $this->assertSubString($output, $trimmed_name, new FormattableMarkup('Make sure the untrimmed (@untrimmed) output appears in the rendered output  (@output).', [
            '@trimmed' => $trimmed_name,
            '@output' => $output,
        ]));
        // Take word_boundary into account for the tests.
        $name_field->options['alter']['max_length'] = 5;
        $name_field->options['alter']['word_boundary'] = TRUE;
        $random_text_2 = $this->randomMachineName(2);
        $random_text_4 = $this->randomMachineName(4);
        $random_text_8 = $this->randomMachineName(8);
        $tuples = [
            // Create one string which doesn't fit at all into the limit.
[
                'value' => $random_text_8,
                'trimmed_value' => '',
                'trimmed' => TRUE,
            ],
            // Create one string with two words which doesn't fit both into the limit.
[
                'value' => $random_text_8 . ' ' . $random_text_8,
                'trimmed_value' => '',
                'trimmed' => TRUE,
            ],
            // Create one string which contains of two words, of which only the first
            // fits into the limit.
[
                'value' => $random_text_4 . ' ' . $random_text_8,
                'trimmed_value' => $random_text_4,
                'trimmed' => TRUE,
            ],
            // Create one string which contains of two words, of which both fits into
            // the limit.
[
                'value' => $random_text_2 . ' ' . $random_text_2,
                'trimmed_value' => $random_text_2 . ' ' . $random_text_2,
                'trimmed' => FALSE,
            ],
        ];
        foreach ($tuples as $tuple) {
            $row->views_test_data_name = $tuple['value'];
            $output = $renderer->executeInRenderContext(new RenderContext(), function () use ($name_field, $row) {
                return $name_field->advancedRender($row);
            });
            if ($tuple['trimmed']) {
                $this->assertNotSubString($output, $tuple['value'], new FormattableMarkup('The untrimmed value (@untrimmed) should not appear in the trimmed output (@output).', [
                    '@untrimmed' => $tuple['value'],
                    '@output' => $output,
                ]));
            }
            if (!empty($tuple['trimmed_value'])) {
                $this->assertSubString($output, $tuple['trimmed_value'], new FormattableMarkup('The trimmed value (@trimmed) should appear in the trimmed output (@output).', [
                    '@trimmed' => $tuple['trimmed_value'],
                    '@output' => $output,
                ]));
            }
        }
        // Tests for displaying a readmore link when the output got trimmed.
        $row->views_test_data_name = $this->randomMachineName(8);
        $name_field->options['alter']['max_length'] = 5;
        $name_field->options['alter']['more_link'] = TRUE;
        $name_field->options['alter']['more_link_text'] = $more_text = $this->randomMachineName();
        $name_field->options['alter']['more_link_path'] = $more_path = $this->randomMachineName();
        $output = $renderer->executeInRenderContext(new RenderContext(), function () use ($name_field, $row) {
            return $name_field->advancedRender($row);
        });
        $this->assertSubString($output, $more_text, 'Make sure a read more text is displayed if the output got trimmed');
        $this->assertNotEmpty($this->xpathContent($output, '//a[contains(@href, :path)]', [
            ':path' => $more_path,
        ]), 'Make sure the read more link points to the right destination.');
        $name_field->options['alter']['more_link'] = FALSE;
        $output = $renderer->executeInRenderContext(new RenderContext(), function () use ($name_field, $row) {
            return $name_field->advancedRender($row);
        });
        $this->assertNotSubString($output, $more_text, 'Make sure no read more text appears.');
        $this->assertEmpty($this->xpathContent($output, '//a[contains(@href, :path)]', [
            ':path' => $more_path,
        ]), 'Make sure no read more link appears.');
        // Check for the ellipses.
        $row->views_test_data_name = $this->randomMachineName(8);
        $name_field->options['alter']['max_length'] = 5;
        $output = $renderer->executeInRenderContext(new RenderContext(), function () use ($name_field, $row) {
            return $name_field->advancedRender($row);
        });
        $this->assertSubString($output, '…', 'An ellipsis should appear if the output is trimmed');
        $name_field->options['alter']['max_length'] = 10;
        $output = $renderer->executeInRenderContext(new RenderContext(), function () use ($name_field, $row) {
            return $name_field->advancedRender($row);
        });
        $this->assertNotSubString($output, '…', 'No ellipsis should appear if the output is not trimmed');
    }

}