class HeadingPluginTest

Same name in other branches
  1. 9 core/modules/ckeditor5/tests/src/Unit/HeadingPluginTest.php \Drupal\Tests\ckeditor5\Unit\HeadingPluginTest
  2. 10 core/modules/ckeditor5/tests/src/Unit/HeadingPluginTest.php \Drupal\Tests\ckeditor5\Unit\HeadingPluginTest

@coversDefaultClass \Drupal\ckeditor5\Plugin\CKEditor5Plugin\Language @group ckeditor5 @internal

Hierarchy

  • class \Drupal\Tests\ckeditor5\Unit\HeadingPluginTest extends \Drupal\Tests\UnitTestCase

Expanded class hierarchy of HeadingPluginTest

File

core/modules/ckeditor5/tests/src/Unit/HeadingPluginTest.php, line 17

Namespace

Drupal\Tests\ckeditor5\Unit
View source 
class HeadingPluginTest extends UnitTestCase {
    
    /**
     * Provides a list of configs to test.
     */
    public static function providerGetDynamicPluginConfig() : array {
        // Prepare headings matching ckeditor5.ckeditor5.yml to also protect
        // against unexpected changes to the YAML file given the YAML file is used
        // to generate the dynamic plugin configuration.
        $paragraph = [
            'model' => 'paragraph',
            'title' => 'Paragraph',
            'class' => 'ck-heading_paragraph',
        ];
        $headings = [];
        foreach (range(2, 6) as $number) {
            $headings[$number] = [
                'model' => 'heading' . $number,
                'view' => 'h' . $number,
                'title' => 'Heading ' . $number,
                'class' => 'ck-heading_heading' . $number,
            ];
        }
        return [
            'All headings' => [
                Heading::DEFAULT_CONFIGURATION,
                [
                    'heading' => [
                        'options' => [
                            $paragraph,
                            $headings[2],
                            $headings[3],
                            $headings[4],
                            $headings[5],
                            $headings[6],
                        ],
                    ],
                ],
            ],
            'Only required headings' => [
                [
                    'enabled_headings' => [],
                ],
                [
                    'heading' => [
                        'options' => [
                            $paragraph,
                        ],
                    ],
                ],
            ],
            'Heading 2 only' => [
                [
                    'enabled_headings' => [
                        'heading2',
                    ],
                ],
                [
                    'heading' => [
                        'options' => [
                            $paragraph,
                            $headings[2],
                        ],
                    ],
                ],
            ],
            'Heading 2 and 3 only' => [
                [
                    'enabled_headings' => [
                        'heading2',
                        'heading3',
                    ],
                ],
                [
                    'heading' => [
                        'options' => [
                            $paragraph,
                            $headings[2],
                            $headings[3],
                        ],
                    ],
                ],
            ],
        ];
    }
    
    /**
     * @covers ::getDynamicPluginConfig
     * @dataProvider providerGetDynamicPluginConfig
     */
    public function testGetDynamicPluginConfig(array $configuration, array $expected_dynamic_config) : void {
        // Read the CKEditor 5 plugin's static configuration from YAML.
        $ckeditor5_plugin_definitions = Yaml::parseFile(__DIR__ . '/../../../ckeditor5.ckeditor5.yml');
        $static_plugin_config = $ckeditor5_plugin_definitions['ckeditor5_heading']['ckeditor5']['config'];
        $plugin = new Heading($configuration, 'ckeditor5_heading', NULL);
        $dynamic_plugin_config = $plugin->getDynamicPluginConfig($static_plugin_config, $this->prophesize(EditorInterface::class)
            ->reveal());
        $this->assertSame($expected_dynamic_config, $dynamic_plugin_config);
    }

}

Members

Title Modifiers Object type Summary Overrides
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::getCallableName private static function Returns a callable as a string suitable for inclusion in a message.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
HeadingPluginTest::providerGetDynamicPluginConfig public static function Provides a list of configs to test.
HeadingPluginTest::testGetDynamicPluginConfig public function @covers ::getDynamicPluginConfig
@dataProvider providerGetDynamicPluginConfig
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
UnitTestCase::$root protected property The app root.
UnitTestCase::getClassResolverStub protected function Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub public function Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getConfigStorageStub public function Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator protected function Sets up a container with a cache tags invalidator.
UnitTestCase::getStringTranslationStub public function Returns a stub translation manager that just returns the passed string.
UnitTestCase::setUp protected function 358
UnitTestCase::setUpBeforeClass public static function

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.