DateTimeTimeAgoFormatterTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\datetime\Functional;

use Drupal\Core\Entity\Entity\EntityFormDisplay;
use Drupal\Core\Entity\Entity\EntityViewDisplay;
use Drupal\field\Entity\FieldConfig;
use Drupal\field\Entity\FieldStorageConfig;
use Drupal\Tests\BrowserTestBase;

/**
 * Tests the functionality of DateTimeTimeAgoFormatter field formatter.
 *
 * @group field
 */
class DateTimeTimeAgoFormatterTest extends BrowserTestBase {
    
    /**
     * An array of field formatter display options.
     *
     * @var array
     */
    protected $displayOptions;
    
    /**
     * A field storage to use in this test class.
     *
     * @var \Drupal\field\Entity\FieldStorageConfig
     */
    protected $fieldStorage;
    
    /**
     * The field used in this test class.
     *
     * @var \Drupal\field\Entity\FieldConfig
     */
    protected $field;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'datetime',
        'entity_test',
        'field_ui',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $web_user = $this->drupalCreateUser([
            'access administration pages',
            'view test entity',
            'administer entity_test content',
            'administer entity_test fields',
            'administer entity_test display',
            'administer entity_test form display',
            'view the administration theme',
        ]);
        $this->drupalLogin($web_user);
        $field_name = 'field_datetime';
        $type = 'datetime';
        $widget_type = 'datetime_default';
        $formatter_type = 'datetime_time_ago';
        $this->fieldStorage = FieldStorageConfig::create([
            'field_name' => $field_name,
            'entity_type' => 'entity_test',
            'type' => $type,
        ]);
        $this->fieldStorage
            ->save();
        $this->field = FieldConfig::create([
            'field_storage' => $this->fieldStorage,
            'bundle' => 'entity_test',
            'required' => TRUE,
        ]);
        $this->field
            ->save();
        EntityFormDisplay::load('entity_test.entity_test.default')->setComponent($field_name, [
            'type' => $widget_type,
        ])
            ->save();
        $this->displayOptions = [
            'type' => $formatter_type,
            'label' => 'hidden',
        ];
        EntityViewDisplay::create([
            'targetEntityType' => $this->field
                ->getTargetEntityTypeId(),
            'bundle' => $this->field
                ->getTargetBundle(),
            'mode' => 'full',
            'status' => TRUE,
        ])
            ->setComponent($field_name, $this->displayOptions)
            ->save();
    }
    
    /**
     * Tests the formatter settings.
     */
    public function testSettings() : void {
        $this->drupalGet('entity_test/structure/entity_test/display');
        $edit = [
            'fields[field_datetime][region]' => 'content',
            'fields[field_datetime][type]' => 'datetime_time_ago',
        ];
        $this->submitForm($edit, 'Save');
        $this->submitForm([], 'field_datetime_settings_edit');
        $edit = [
            'fields[field_datetime][settings_edit_form][settings][future_format]' => 'ends in @interval',
            'fields[field_datetime][settings_edit_form][settings][past_format]' => 'started @interval ago',
            'fields[field_datetime][settings_edit_form][settings][granularity]' => 1,
        ];
        $this->submitForm($edit, 'Update');
        $this->submitForm([], 'Save');
        $this->assertSession()
            ->pageTextContains('ends in 1 year');
        $this->assertSession()
            ->pageTextContains('started 1 year ago');
    }

}