Webfactory\ShortcodeBundle\Tests\Functional\ShortcodeTest

Complexity

Total Complexity

13

Size/Duplication

Total Lines	105
Duplicated Lines	0 %

Importance

Changes	5
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	setUp()	0	12	3
A	getRenderedExampleHtml()	0	3	1
A	assertHttpStatusCodeWhenCrawlingRenderedExample()	0	8	1
A	crawlRenderedExample()	0	15	2
A	getCustomParametersAsString()	0	16	4
A	getUrlWithRenderedExample()	0	10	2

<?php

namespace Webfactory\ShortcodeBundle\Tests\Functional;

use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
use Symfony\Component\BrowserKit\Client;

The type Symfony\Component\BrowserKit\Client was not found. Maybe you did not declare it correctly or list all dependencies?

use Symfony\Component\DomCrawler\Crawler;

The type Symfony\Component\DomCrawler\Crawler was not found. Maybe you did not declare it correctly or list all dependencies?

/**
 * Abstract template for common shortcode tests.
 */
abstract class ShortcodeTest extends WebTestCase
{
    /** @var Client */
    protected $client;

    /**
     * @return string name of the shortcode to test.
     */
    abstract protected function getShortcodeToTest(): string;

    protected function setUp(): void
    {
        parent::setUp();

        if ('' === $this->getShortcodeToTest() || null === $this->getShortcodeToTest()) {
            throw new \PHPUnit_Framework_IncompleteTestError(

The type PHPUnit_Framework_IncompleteTestError was not found. Maybe you did not declare it correctly or list all dependencies?

                'Albeit being a '.__CLASS__.', '.\get_called_class().' does not define a shortcode to test.'
            );
        }

        static::bootKernel();
        $this->client = static::createClient();
    }

    /**
     * @param array|string|null $customParameters use of strings is deprecated, use array instead.
     *
     * @return Crawler
     */
    protected function getRenderedExampleHtml(?array $customParameters = null): string
    {
        return $this->crawlRenderedExample($customParameters)->html();
    }

    /**
     * @param array|string|null $customParameters use of strings is deprecated, use array instead.
     *
     * @return Crawler
     */
    protected function crawlRenderedExample(/*array*/ $customParameters = null): Crawler
    {
        $urlWithRenderedExample = $this->getUrlWithRenderedExample($customParameters);

        $crawlerOnRenderedExamplePage = $this->client->request('GET', $urlWithRenderedExample);
        $this->assertEquals(200, $this->client->getResponse()->getStatusCode());

        $crawlerOnRenderedExample = $crawlerOnRenderedExamplePage->filter('#rendered-example');
        if (0 === $crawlerOnRenderedExample->count()) {
            throw new \PHPUnit_Framework_ExpectationFailedException(

The type PHPUnit_Framework_ExpectationFailedException was not found. Maybe you did not declare it correctly or list all dependencies?

                'No rendered example found for shortcode "'.$this->shortcode.'"'

The property shortcode does not exist on Webfactory\ShortcodeBundle\Tests\Functional\ShortcodeTest. Did you maybe forget to declare it?

            );
        }

        return $crawlerOnRenderedExample;
    }

    /**
     * @param int               $expectedStatusCode
     * @param array|string|null $customParameters   use of strings is deprecated, use array instead.
     *
     * @return Crawler
     */
    protected function assertHttpStatusCodeWhenCrawlingRenderedExample(
        int $expectedStatusCode,
        /*array*/ $customParameters = null
    ): Crawler {
        $urlWithRenderedExample = $this->getUrlWithRenderedExample($customParameters);

        $crawlerOnRenderedExamplePage = $this->client->request('GET', $urlWithRenderedExample);

The assignment to $crawlerOnRenderedExamplePage is dead and can be removed.

        $this->assertEquals($expectedStatusCode, $this->client->getResponse()->getStatusCode());

In this branch, the function will implicitly return null which is incompatible with the type-hinted return Symfony\Component\DomCrawler\Crawler. Consider adding a return statement or allowing null as return value.

    }

    /**
     * @param array|string|null $customParameters use of strings is deprecated, use array instead.
     *
     * @return Crawler
     */
    private function getUrlWithRenderedExample(/*array*/ $customParameters = null): string
    {
        $urlParameters = ['shortcode' => $this->getShortcodeToTest()];

        $customParametersAsString = $this->getCustomParametersAsString($customParameters);
        if ($customParametersAsString) {
            $urlParameters['customParameters'] = $customParametersAsString;
        }

        return static::$container->get('router')->generate('webfactory.shortcode.guide-detail', $urlParameters);
    }

    private function getCustomParametersAsString($customParametersAsMixed): ?string
    {
        if (\is_string($customParametersAsMixed)) {
            return $customParametersAsMixed;
        }

        if (\is_array($customParametersAsMixed)) {
            $customParametersAsString = '';
            foreach ($customParametersAsMixed as $name => $value) {
                $customParametersAsString .= $name.'='.$value.' ';
            }

            return $customParametersAsString;
        }

        return null;
    }
}