Webfactory\ShortcodeBundle\Tests\Functional\EmbeddedShortcodeHandlerTest

Complexity

Total Complexity

8

Size/Duplication

Total Lines	59
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	processShortcodes()	0	9	2
A	provideEsiShortcodes()	0	4	1
A	processing_with_esi_fragments()	0	6	1
A	paragraphs_wrapping_shortcodes_get_removed()	0	3	1
A	content_without_shortcodes_wont_be_changed()	0	3	1
A	provideShortcodeNames()	0	6	1
A	expand_shortcodes_registered_in_different_ways()	0	4	1

<?php

namespace Webfactory\ShortcodeBundle\Tests\Functional;

use Generator;
use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestStack;
use Webfactory\ShortcodeBundle\Test\EndToEndTestHelper;

/**
 * Test shortcode processing using EmbeddedShortcodeHandler and a fixture ShortodeTestController,
 * to make sure shortcodes defined in various places (DI config, bundle config) work as expected.
 */
class EmbeddedShortcodeHandlerTest extends KernelTestCase
{
    /** @test */
    public function paragraphs_wrapping_shortcodes_get_removed(): void
    {
        self::assertSame('test', $this->processShortcodes('<p>[test-config-inline]</p>'));
    }

    /** @test */
    public function content_without_shortcodes_wont_be_changed(): void
    {
        self::assertSame('<p>Content without shortcode</p>', $this->processShortcodes('<p>Content without shortcode</p>'));
    }

    /**
     * @test
     * @dataProvider provideShortcodeNames
     */
    public function expand_shortcodes_registered_in_different_ways(string $shortcodeName): void
    {
        // All shortcodes are set up as fixtures and use ShortcodeTestController
        self::assertSame('test foo=bar', $this->processShortcodes("[$shortcodeName foo=bar]"));
    }

    public function provideShortcodeNames(): Generator
    {
        yield 'Inline shortcode defined in bundle config' => ['test-config-inline'];
        yield 'ESI-based shortcode defined in bundle config' => ['test-config-esi'];
        yield 'Inline shortcode defined in service definitions' => ['test-service-inline'];
        yield 'ESI-based shortcode defined in service definitions' => ['test-service-esi'];
    }

    /**
     * @test
     * @dataProvider provideEsiShortcodes
     */
    public function processing_with_esi_fragments(string $shortcodeName): void
    {
        $request = new Request([], [], [], [], [], ['SCRIPT_URL' => '/', 'HTTP_HOST' => 'localhost']);
        $request->headers->set('Surrogate-Capability', 'ESI/1.0');

        self::assertStringContainsString('<esi:include ', $this->processShortcodes("[$shortcodeName foo=bar]", $request));
    }

    public function provideEsiShortcodes(): Generator
    {
        yield 'ESI-based shortcode defined in bundle configuration' => ['test-config-esi'];
        yield 'ESI-based shortcode defined in service configuration' => ['test-service-esi'];
    }

    private function processShortcodes(string $content, Request $request = null): string
    {
        self::bootKernel();

        if ($request) {
            static::$container->get(RequestStack::class)->push($request);
        }

        return EndToEndTestHelper::createFromContainer(static::$container)->processShortcode($content);
    }
}