ListFormatterTest.php in Facebook Instant Articles 3.x

Namespace

Drupal\Tests\fb_instant_articles\Kernel\Plugin\Field\FieldFormatter

File

tests/src/Kernel/Plugin/Field/FieldFormatter/ListFormatterTest.php

<?php

namespace Drupal\Tests\fb_instant_articles\Kernel\Plugin\Field\FieldFormatter;

use Drupal\entity_test\Entity\EntityTest;
use Drupal\fb_instant_articles\Regions;
use Facebook\InstantArticles\Elements\InstantArticle;
use Facebook\InstantArticles\Elements\ListElement;

/**
 * Tests the instant article list field formatter.
 *
 * @group fb_instant_articles
 */
class ListFormatterTest extends FormatterTestBase {

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();

    // Setup entity view display with default settings.
    $this->display
      ->setComponent($this->fieldName, [
      'type' => 'fbia_list',
      'settings' => [],
    ]);
    $this->display
      ->save();
  }

  /**
   * Test the instant article list formatter.
   */
  public function testListFormatter() {
    $value_alpha = 'I am a random value.';
    $value_beta = 'I am another random value.';
    $entity = EntityTest::create([]);
    $entity->{$this->fieldName}[] = [
      'value' => $value_alpha,
    ];
    $entity->{$this->fieldName}[] = [
      'value' => $value_beta,
    ];

    /** @var \Drupal\fb_instant_articles\Plugin\Field\InstantArticleFormatterInterface $formatter */
    $formatter = $this->display
      ->getRenderer($this->fieldName);
    $article = InstantArticle::create();
    $formatter
      ->viewInstantArticle($entity->{$this->fieldName}, $article, Regions::REGION_CONTENT, $this->normalizerMock);
    $children = $article
      ->getChildren();

    /** @var \Facebook\InstantArticles\Elements\ListElement $list */
    $list = $children[0];
    $this
      ->assertEquals(1, count($children));
    $this
      ->assertTrue($list instanceof ListElement);
    $this
      ->assertFalse($list
      ->isOrdered());
    $list_items = $list
      ->getItems();
    $this
      ->assertEquals(2, count($list_items));
    $this
      ->assertEquals($value_alpha, $list_items[0]
      ->getPlainText());

    // Test an ordered list configuration.
    $this->display
      ->setComponent($this->fieldName, [
      'type' => 'fbia_list',
      'settings' => [
        'is_ordered' => TRUE,
      ],
    ]);
    $this->display
      ->save();

    /** @var \Drupal\fb_instant_articles\Plugin\Field\InstantArticleFormatterInterface $formatter */
    $formatter = $this->display
      ->getRenderer($this->fieldName);
    $article = InstantArticle::create();
    $formatter
      ->viewInstantArticle($entity->{$this->fieldName}, $article, Regions::REGION_CONTENT, $this->normalizerMock);
    $children = $article
      ->getChildren();

    /** @var \Facebook\InstantArticles\Elements\ListElement $list */
    $list = $children[0];
    $this
      ->assertTrue($list
      ->isOrdered());
  }

}

Classes

Name	Description
ListFormatterTest	Tests the instant article list field formatter.