8000 [Templating|FrameworkBundle] Made DelegatingEngine::getEngine() public by jakzal · Pull Request #8280 · symfony/symfony · GitHub
[go: up one dir, main page]

Skip to content

[Templating|FrameworkBundle] Made DelegatingEngine::getEngine() public #8280

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 17, 2013
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ public function supports($name)
/**
* {@inheritdoc}
*/
protected function getEngine($name)
public function getEngine($name)
{
foreach ($this->engines as $i => $engine) {
if (is_string($engine)) {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
<?php

/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Symfony\Bundle\FrameworkBundle\Tests\Templating;

use Symfony\Bundle\FrameworkBundle\Templating\DelegatingEngine;

class DelegatingEngineTest extends \PHPUnit_Framework_TestCase
{
public function testSupportsRetrievesEngineFromTheContainer()
{
$container = $this->getContainerMock(array(
'engine.first' => $this->getEngineMock('template.php', false),
'engine.second' => $this->getEngineMock('template.php', true)
));

$delegatingEngine = new DelegatingEngine($container, array('engine.first', 'engine.second'));

$this->assertTrue($delegatingEngine->supports('template.php'));
}

public function testGetExistingEngine()
{
$firstEngine = $this->getEngineMock('template.php', false);
$secondEngine = $this->getEngineMock('template.php', true);
$container = $this->getContainerMock(array(
'engine.first' => $firstEngine,
'engine.second' => $secondEngine
));

$delegatingEngine = new DelegatingEngine($container, array('engine.first', 'engine.second'));

$this->assertSame($secondEngine, $delegatingEngine->getEngine('template.php', array('foo' => 'bar')));
}

/**
* @expectedException \RuntimeException
* @expectedExceptionMessage No engine is able to work with the template "template.php"
*/
public function testGetInvalidEngine()
{
$firstEngine = $this->getEngineMock('template.php', false);
$secondEngine = $this->getEngineMock('template.php', false);
$container = $this->getContainerMock(array(
'engine.first' => $firstEngine,
'engine.second' => $secondEngine
));

$delegatingEngine = new DelegatingEngine($container, array('engine.first', 'engine.second'));
$delegatingEngine->getEngine('template.php', array('foo' => 'bar'));
}

public function testRenderResponse()
{
$response = $this->getMock('Symfony\Component\HttpFoundation\Response');
$engine = $this->getFrameworkEngineMock('template.php', true);
$engine->expects($this->once())
->method('renderResponse')
->with('template.php', array('foo' => 'bar'))
->will($this->returnValue($response));
$container = $this->getContainerMock(array('engine' => $engine));

$delegatingEngine = new DelegatingEngine($container, array('engine'));

$this->assertSame($response, $delegatingEngine->renderResponse('template.php', array('foo' => 'bar')));
}

private function getEngineMock($template, $supports)
{
$engine = $this->getMock('Symfony\Component\Templating\EngineInterface');

$engine->expects($this->once())
->method('supports')
->with($template)
->will($this->returnValue($supports));

return $engine;
}

private function getFrameworkEngineMock($template, $supports)
{
$engine = $this->getMock('Symfony\Bundle\FrameworkBundle\Templating\EngineInterface');

$engine->expects($this->once())
->method('supports')
->with($template)
->will($this->returnValue($supports));

return $engine;
}

private function getContainerMock($services)
{
$container = $this->getMock('Symfony\Component\DependencyInjection\ContainerInterface');

$i = 0;
foreach ($services as $id => $service) {
$container->expects($this->at($i++))
->method('get')
->with($id)
->will($this->returnValue($service));
}

return $container;
}
}
2 changes: 1 addition & 1 deletion src/Symfony/Component/Templating/DelegatingEngine.php
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ public function supports($name)
*
* @api
*/
protected function getEngine($name)
public function getEngine($name)
{
foreach ($this->engines as $engine) {
if ($engine->supports($name)) {
Expand Down
157 changes: 157 additions & 0 deletions src/Symfony/Component/Templating/Tests/DelegatingEngineTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,157 @@
<?php

/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Symfony\Component\Templating\Tests;

use Symfony\Component\Templating\DelegatingEngine;
use Symfony\Component\Templating\StreamingEngineInterface;
use Symfony\Component\Templating\EngineInterface;

class DelegatingEngineTest extends \PHPUnit_Framework_TestCase
{
public function testRenderDelegatesToSupportedEngine()
{
$firstEngine = $this->getEngineMock('template.php', false);
$secondEngine = $this->getEngineMock('template.php', true);

$secondEngine->expects($this->once())
->method('render')
->with('template.php', array('foo' => 'bar'))
->will($this->returnValue('<html />'));

$delegatingEngine = new DelegatingEngine(array($firstEngine, $secondEngine));
$result = $delegatingEngine->render('template.php', array('foo' => 'bar'));

$this->assertSame('<html />', $result);
}

/**
* @expectedException \RuntimeException
* @expectedExceptionMessage No engine is able to work with the template "template.php"
*/
public function testRenderWithNoSupportedEngine()
{
$firstEngine = $this->getEngineMock('template.php', false);
$secondEngine = $this->getEngineMock('template.php', false);

$delegatingEngine = new DelegatingEngine(array($firstEngine, $secondEngine));
$delegatingEngine->render('template.php', array('foo' => 'bar'));
}

public function testStreamDelegatesToSupportedEngine()
{
$streamingEngine = $this->getStreamingEngineMock('template.php', true);
$streamingEngine->expects($this->once())
->method('stream')
->with('template.php', array('foo' => 'bar'))
->will($this->returnValue('<html />'));

$delegatingEngine = new DelegatingEngine(array($streamingEngine));
$result = $delegatingEngine->stream('template.php', array('foo' => 'bar'));

$this->assertNull($result);
}

/**
* @expectedException \LogicException
* @expectedExceptionMessage Template "template.php" cannot be streamed as the engine supporting it does not implement StreamingEngineInterface
*/
public function testStreamRequiresStreamingEngine()
{
$engine = $this->getEngineMock('template.php', true);
$engine->expects($this->never())->method('stream');

$delegatingEngine = new DelegatingEngine(array($engine));
$delegatingEngine->stream('template.php', array('foo' => 'bar'));
}

public function testExists()
{
$engine = $this->getEngineMock('template.php', true);
$engine->expects($this->once())
->method('exists')
->with('template.php')
->will($this->returnValue(true));

$delegatingEngine = new DelegatingEngine(array($engine));

$this->assertTrue($delegatingEngine->exists('template.php'));
}

public function testSupports()
{
$engine = $this->getEngineMock('template.php', true);

$delegatingEngine = new DelegatingEngine(array($engine));

$this->assertTrue($delegatingEngine->supports('template.php'));
67ED }

public function testSupportsWithNoSupportedEngine()
{
$engine = $this->getEngineMock('template.php', false);

$delegatingEngine = new DelegatingEngine(array($engine));

$this->assertFalse($delegatingEngine->supports('template.php'));
}

public function testGetExistingEngine()
{
$firstEngine = $this->getEngineMock('template.php', false);
$secondEngine = $this->getEngineMock('template.php', true);

$delegatingEngine = new DelegatingEngine(array($firstEngine, $secondEngine));

$this->assertSame($secondEngine, $delegatingEngine->getEngine('template.php', array('foo' => 'bar')));
}

/**
* @expectedException \RuntimeException
* @expectedExceptionMessage No engine is able to work with the template "template.php"
*/
public function testGetInvalidEngine()
{
$firstEngine = $this->getEngineMock('template.php', false);
$secondEngine = $this->getEngineMock('template.php', false);

$delegatingEngine = new DelegatingEngine(array($firstEngine, $secondEngine));
$delegatingEngine->getEngine('template.php', array('foo' => 'bar'));
}

private function getEngineMock($template, $supports)
{
$engine = $this->getMock('Symfony\Component\Templating\EngineInterface');

$engine->expects($this->once())
->method('supports')
->with($template)
->will($this->returnValue($supports));

return $engine;
}

private function getStreamingEngineMock($template, $supports)
{
$engine = $this->getMockForAbstractClass('Symfony\Component\Templating\Tests\MyStreamingEngine');

$engine->expects($this->once())
->method('supports')
->with($template)
->will($this->returnValue($supports));

return $engine;
}
}

interface MyStreamingEngine extends StreamingEngineInterface, EngineInterface
{
}
0