EditorManagerTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\editor\Kernel;

use Drupal\editor\Entity\Editor;
use Drupal\filter\Entity\FilterFormat;
use Drupal\KernelTests\KernelTestBase;

/**
 * Tests detection of text editors and correct generation of attachments.
 *
 * @group editor
 */
class EditorManagerTest extends KernelTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'system',
        'user',
        'filter',
        'editor',
    ];
    
    /**
     * The manager for text editor plugins.
     *
     * @var \Drupal\Component\Plugin\PluginManagerInterface
     */
    protected $editorManager;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Install the Filter module.
        // Add text formats.
        $filtered_html_format = FilterFormat::create([
            'format' => 'filtered_html',
            'name' => 'Filtered HTML',
            'weight' => 0,
            'filters' => [],
        ]);
        $filtered_html_format->save();
        $full_html_format = FilterFormat::create([
            'format' => 'full_html',
            'name' => 'Full HTML',
            'weight' => 1,
            'filters' => [],
        ]);
        $full_html_format->save();
    }
    
    /**
     * Tests the configurable text editor manager.
     */
    public function testManager() : void {
        $this->editorManager = $this->container
            ->get('plugin.manager.editor');
        // Case 1: no text editor available:
        // - listOptions() should return an empty list of options
        // - getAttachments() should return an empty #attachments array (and not
        //   a JS settings structure that is empty)
        $this->assertSame([], $this->editorManager
            ->listOptions(), 'When no text editor is enabled, the manager works correctly.');
        $this->assertSame([], $this->editorManager
            ->getAttachments([]), 'No attachments when no text editor is enabled and retrieving attachments for zero text formats.');
        $this->assertSame([], $this->editorManager
            ->getAttachments([
            'filtered_html',
            'full_html',
        ]), 'No attachments when no text editor is enabled and retrieving attachments for multiple text formats.');
        // Enable the Text Editor Test module, which has the Unicorn Editor and
        // clear the editor manager's cache so it is picked up.
        $this->enableModules([
            'editor_test',
        ]);
        $this->editorManager = $this->container
            ->get('plugin.manager.editor');
        $this->editorManager
            ->clearCachedDefinitions();
        // Case 2: a text editor available.
        $this->assertSame('Unicorn Editor', (string) $this->editorManager
            ->listOptions()['unicorn'], 'When some text editor is enabled, the manager works correctly.');
        // Case 3: a text editor available & associated (but associated only with
        // the 'Full HTML' text format).
        $unicorn_plugin = $this->editorManager
            ->createInstance('unicorn');
        $editor = Editor::create([
            'format' => 'full_html',
            'editor' => 'unicorn',
        ]);
        $editor->save();
        $this->assertSame([], $this->editorManager
            ->getAttachments([]), 'No attachments when one text editor is enabled and retrieving attachments for zero text formats.');
        $expected = [
            'library' => [
                0 => 'editor_test/unicorn',
            ],
            'drupalSettings' => [
                'editor' => [
                    'formats' => [
                        'full_html' => [
                            'format' => 'full_html',
                            'editor' => 'unicorn',
                            'editorSettings' => $unicorn_plugin->getJSSettings($editor),
                            'editorSupportsContentFiltering' => TRUE,
                            'isXssSafe' => FALSE,
                        ],
                    ],
                ],
            ],
        ];
        $this->assertSame($expected, $this->editorManager
            ->getAttachments([
            'filtered_html',
            'full_html',
        ]), 'Correct attachments when one text editor is enabled and retrieving attachments for multiple text formats.');
        // Case 4: a text editor available associated, but now with its JS settings
        // being altered via hook_editor_js_settings_alter().
        \Drupal::state()->set('editor_test_js_settings_alter_enabled', TRUE);
        $expected['drupalSettings']['editor']['formats']['full_html']['editorSettings']['ponyModeEnabled'] = FALSE;
        $this->assertSame($expected, $this->editorManager
            ->getAttachments([
            'filtered_html',
            'full_html',
        ]), 'hook_editor_js_settings_alter() works correctly.');
    }

}