Skip to content

[EditInPlace] Fix bad HTML generation when there is HTML in the translation #259

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 3 commits into from
Feb 25, 2019
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
106 changes: 106 additions & 0 deletions Tests/Unit/Translator/EditInPlaceTranslatorTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
<?php

/*
* This file is part of the PHP Translation package.
*
* (c) PHP Translation team <tobias.nyholm@gmail.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Translation\Bundle\Tests\Unit\Translator;

use PHPUnit\Framework\TestCase;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\Translation\Loader\ArrayLoader;
use Symfony\Component\Translation\TranslatorInterface;
use Translation\Bundle\EditInPlace\ActivatorInterface;
use Translation\Bundle\Translator\EditInPlaceTranslator;

/**
* @author Damien Alexandre <dalexandre@jolicode.com>
*/
final class EditInPlaceTranslatorTest extends TestCase
{
public function testEnabled()
{
$symfonyTranslator = $this->getMockBuilder(TranslatorInterface::class)->getMock();

$request = new Request();
$requestStack = new RequestStack();
$requestStack->push($request);

$activator = new FakeActivator(true);
$service = new EditInPlaceTranslator($symfonyTranslator, $activator, $requestStack);

$this->assertSame(
'<x-trans data-key="messages|key" data-value="" data-plain="" data-domain="messages" data-locale=""></x-trans>',
$service->trans('key', [])
);
}

public function testDisabled()
{
$symfonyTranslator = $this->getMockBuilder(TranslatorInterface::class)->getMock();

$request = new Request();
$requestStack = new RequestStack();
$requestStack->push($request);

$activator = new FakeActivator(false);
$service = new EditInPlaceTranslator($symfonyTranslator, $activator, $requestStack);

$this->assertSame(
null,
$service->trans('key', [])
);
}

public function testHtmlTranslation()
{
$symfonyTranslator = new \Symfony\Component\Translation\Translator('en', null, null, true);
$symfonyTranslator->addLoader('array', new ArrayLoader());
$symfonyTranslator->addResource('array', ['foo' => 'Normal content.'], 'en');
$symfonyTranslator->addResource('array', ['bar' => 'Content with <b>HTML</b> in it.'], 'en');
$symfonyTranslator->addResource('array', ['bar.attr' => 'Content with <b class="alert">HTML</b> in it.'], 'en');

$request = new Request();
$requestStack = new RequestStack();
$requestStack->push($request);

$activator = new FakeActivator(true);
$service = new EditInPlaceTranslator($symfonyTranslator, $activator, $requestStack);

$this->assertSame(
'<x-trans data-key="messages|foo" data-value="Normal content." data-plain="Normal content." data-domain="messages" data-locale="en">Normal content.</x-trans>',
$service->trans('foo', [])
);

$this->assertSame(
'<x-trans data-key="messages|bar" data-value="Content with &lt;b&gt;HTML&lt;/b&gt; in it." data-plain="Content with &lt;b&gt;HTML&lt;/b&gt; in it." data-domain="messages" data-locale="en">Content with <b>HTML</b> in it.</x-trans>',
$service->trans('bar', [])
);

$this->assertSame(
'<x-trans data-key="messages|bar.attr" data-value="Content with &lt;b class=&quot;alert&quot;&gt;HTML&lt;/b&gt; in it." data-plain="Content with &lt;b class=&quot;alert&quot;&gt;HTML&lt;/b&gt; in it." data-domain="messages" data-locale="en">Content with <b class="alert">HTML</b> in it.</x-trans>',
$service->trans('bar.attr', [])
);
}
}

class FakeActivator implements ActivatorInterface
{
private $enabled;

public function __construct($enabled = true)
{
$this->enabled = $enabled;
}

public function checkRequest(Request $request = null)
{
return $this->enabled;
}
}
4 changes: 2 additions & 2 deletions Translator/EditInPlaceTranslator.php
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,8 @@ public function trans($id, array $parameters = [], $domain = null, $locale = nul
return sprintf('<x-trans data-key="%s|%s" data-value="%s" data-plain="%s" data-domain="%s" data-locale="%s">%s</x-trans>',
$domain,
$id,
$original,
$plain,
htmlspecialchars($original),
htmlspecialchars($plain),
$domain,
$locale,
$original
Expand Down