Chamilo/vendor/sonata-project/core-bundle/Test/AbstractWidgetTestCase.php

<?php

/*
 * This file is part of the Sonata Project package.
 *
 * (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Sonata\CoreBundle\Test;

use Symfony\Bridge\Twig\Extension\FormExtension;
use Symfony\Bridge\Twig\Extension\TranslationExtension;
use Symfony\Bridge\Twig\Form\TwigRenderer;
use Symfony\Bridge\Twig\Form\TwigRendererEngine;
use Symfony\Bridge\Twig\Form\TwigRendererEngineInterface;
use Symfony\Bridge\Twig\Tests\Extension\Fixtures\StubFilesystemLoader;
use Symfony\Bundle\FrameworkBundle\Tests\Templating\Helper\Fixtures\StubTranslator;
use Symfony\Component\Form\FormExtensionInterface;
use Symfony\Component\Form\FormView;
use Symfony\Component\Form\Test\TypeTestCase;

/**
 * Base class for tests checking rendering of form widgets.
 *
 * @author Christian Gripp <mail@core23.de>
 */
abstract class AbstractWidgetTestCase extends TypeTestCase
{
    /**
     * @var FormExtensionInterface
     */
    private $extension;

    /**
     * @var TwigRenderer
     */
    private $renderer;

    /**
     * {@inheritdoc}
     */
    protected function setUp()
    {
        // NEXT_MAJOR: remove this block when dropping symfony < 2.7 support
        if (!class_exists('Symfony\Bridge\Twig\Extension\AssetExtension')) {
            $this->markTestSkipped();
        }
        parent::setUp();

        // NEXT_MAJOR: Remove BC hack when dropping symfony 2.4 support
        $csrfProviderClasses = array_filter(array(
            // symfony <=2.4
            'Symfony\Component\Security\Csrf\CsrfTokenManagerInterface',
            // symfony >=2.4
            'Symfony\Component\Form\Extension\Csrf\CsrfProvider\CsrfProviderInterface',
        ), 'interface_exists');

        // TODO: remove the condition when dropping symfony/twig-bundle < 3.2
        if (method_exists('Symfony\Bridge\Twig\AppVariable', 'getToken')) {
            $this->extension = new FormExtension();
            $environment = $this->getEnvironment();
            $this->renderer = new TwigRenderer(
                $this->getRenderingEngine($environment),
                $this->createMock(current($csrfProviderClasses))
            );
            $runtimeLoader = $this
                ->getMockBuilder('Twig_RuntimeLoaderInterface')
                ->getMock();

            $runtimeLoader->expects($this->any())
                ->method('load')
                ->with($this->equalTo('Symfony\Bridge\Twig\Form\TwigRenderer'))
                ->will($this->returnValue($this->renderer));

            $environment->addRuntimeLoader($runtimeLoader);
        } else {
            $this->renderer = new TwigRenderer(
                $this->getRenderingEngine(),
                $this->createMock(current($csrfProviderClasses))
            );
            $this->extension = new FormExtension($this->renderer);
            $environment = $this->getEnvironment();
        }

        $this->extension->initRuntime($environment);
    }

    /**
     * @return \Twig_Environment
     */
    protected function getEnvironment()
    {
        $loader = new StubFilesystemLoader($this->getTemplatePaths());

        $environment = new \Twig_Environment($loader, array(
            'strict_variables' => true,
        ));
        $environment->addExtension(new TranslationExtension(new StubTranslator()));
        $environment->addExtension($this->extension);

        return $environment;
    }

    /**
     * Returns a list of template paths.
     *
     * @return string[]
     */
    protected function getTemplatePaths()
    {
        // this is an workaround for different composer requirements and different TwigBridge installation directories
        $twigPaths = array_filter(array(
            // symfony/twig-bridge (running from this bundle)
            __DIR__.'/../vendor/symfony/twig-bridge/Resources/views/Form',
            // symfony/twig-bridge (running from other bundles)
            __DIR__.'/../../../symfony/twig-bridge/Resources/views/Form',
            // NEXT_MAJOR: Remove BC hacks when dropping symfony 2.3 support
            // symfony/twig-bridge 2.3 (running from this bundle)
            __DIR__.'/../vendor/symfony/twig-bridge/Symfony/Bridge/Twig/Resources/views/Form',
            // symfony/twig-bridge 2.3 (running from other bundles)
            __DIR__.'/../../../symfony/twig-bridge/Symfony/Bridge/Twig/Resources/views/Form',
            // symfony/symfony (running from this bundle)
            __DIR__.'/../vendor/symfony/symfony/src/Symfony/Bridge/Twig/Resources/views/Form',
            // symfony/symfony (running from other bundles)
            __DIR__.'/../../../symfony/symfony/src/Symfony/Bridge/Twig/Resources/views/Form',
        ), 'is_dir');

        $twigPaths[] = __DIR__.'/../Resources/views/Form';

        return $twigPaths;
    }

    /**
     * NEXT_MAJOR: uncomment and use the $environment argument.
     *
     * @return TwigRendererEngineInterface
     */
    protected function getRenderingEngine(/* \Twig_Environment $environment = null */)
    {
        $environment = current(func_get_args());
        if (is_null($environment) && method_exists('Symfony\Bridge\Twig\AppVariable', 'getToken')) {
            @trigger_error(
                'Not passing a \Twig_Environment instance to '.__METHOD__.
                ' is deprecated since 3.3 and will not be possible in 4.0',
                E_USER_DEPRECATED
            );
        }

        return new TwigRendererEngine(array('form_div_layout.html.twig'), $environment);
    }

    /**
     * Renders widget from FormView, in SonataAdmin context, with optional view variables $vars. Returns plain HTML.
     *
     * @param FormView $view
     * @param array    $vars
     *
     * @return string
     */
    final protected function renderWidget(FormView $view, array $vars = array())
    {
        return (string) $this->renderer->searchAndRenderBlock($view, 'widget', $vars);
    }

    /**
     * Helper method to strip newline and space characters from html string to make comparing easier.
     *
     * @param string $html
     *
     * @return string
     */
    final protected function cleanHtmlWhitespace($html)
    {
        return preg_replace_callback('/\s*>([^<]+)</', function ($value) {
            return '>'.trim($value[1]).'<';
        }, $html);
    }

    /**
     * @param string $html
     *
     * @return string
     */
    final protected function cleanHtmlAttributeWhitespace($html)
    {
        return preg_replace_callback('~<([A-Z0-9]+) \K(.*?)>~i', function ($m) {
            return preg_replace('~\s*~', '', $m[0]);
        }, $html);
    }

    /**
     * NEXT_MAJOR: Remove this method when dropping support for < PHPUnit 5.4.
     *
     * @param string $class
     *
     * @return \PHPUnit_Framework_MockObject_MockObject
     */
    protected function createMock($class)
    {
        if (is_callable('parent::createMock')) {
            return parent::createMock($class);
        }

        return $this->getMock($class);
    }
}