8000 [Serializer] Xml encoder throws exception for valid data by gr1ev0us · Pull Request #21671 · symfony/symfony · GitHub
[go: up one dir, main page]
Skip to content

[Serializer] Xml encoder throws exception for valid data #21671

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.

Sign up for GitHub

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

Closed
wants to merge 3 commits into from
Closed

[Serializer] Xml encoder throws exception for valid data #21671

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3fd7f53
Issue-21617 Xml encoder throws exception for valid data
gr1ev0us Feb 19, 2017
175bc90
Issue-21617 Review fix
gr1ev0us Feb 21, 2017
88bfde5
Issue-21617 Review fix
gr1ev0us Feb 27, 2017
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
7 changes: 5 additions & 2 deletions src/Symfony/Component/Serializer/Encoder/XmlEncoder.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -369,7 +369,10 @@ private function buildXml(\DOMNode $parentNode, $data, $xmlRootNodeName = null)
if (is_array($data) || ($data instanceof \Traversable && !$this->serializer->supportsNormalization($data, $this->format))) {
foreach ($data as $key => $data) {
//Ah this is the magic @ attribute types.
if (0 === strpos($key, '@') && is_scalar($data) && $this->isElementNameValid($attributeName = substr($key, 1))) {
if (0 === strpos($key, '@') && $this->isElementNameValid($attributeName = substr($key, 1))) {
if (!is_scalar($data)) {
$data = $this->serializer->normalize($data, $this->format, $this->context);
}
$parentNode->setAttribute($attributeName, $data);
} elseif ($key === '#') {
$append = $this->selectNodeType($parentNode, $data);
Expand Down Expand Up @@ -474,7 +477,7 @@ private function selectNodeType(\DOMNode $node, $val)
} elseif ($val instanceof \Traversable) {
$this->buildXml($node, $val);
} elseif (is_object($val)) {
return $this->buildXml($node, $this->serializer->normalize($val, $this->format, $this-> 8000 context));
return $this->selectNodeType($node, $this->serializer->normalize($val, $this->format, $this->context));
} elseif (is_numeric($val)) {
return $this->appendText($node, (string) $val);
} elseif (is_string($val) && $this->needsCdataWrapping($val)) {
Expand Down
110 changes: 106 additions & 4 deletions src/Symfony/Component/Serializer/Tests/Encoder/XmlEncoderTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,29 @@

namespace Symfony\Component\Serializer\Tests\Encoder;

use DateTime;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For classes in the global namespace, we don't import them (use \DateTime directly).

use PHPUnit\Framework\TestCase;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please revert any change related to ordering: our policy is to add new lines in alpha order, but keep old ones as is - to help for merges between branches.

use Symfony\Component\Serializer\Tests\Fixtures\Dummy;
use Symfony\Component\Serializer\Tests\Fixtures\NormalizableTraversableDummy;
use Symfony\Component\Serializer\Tests\Fixtures\ScalarDummy;
use Symfony\Component\Serializer\Encoder\XmlEncoder;
use Symfony\Component\Serializer\Serializer;
use Symfony\Component\Serializer\Exception\UnexpectedValueException;
use Symfony\Component\Serializer\Normalizer\CustomNormalizer;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
use Symfony\Component\Serializer\Serializer;
use Symfony\Component\Serializer\Tests\Fixtures\Dummy;
use Symfony\Component\Serializer\Tests\Fixtures\NormalizableTraversableDummy;
use Symfony\Component\Serializer\Tests\Fixtures\ScalarDummy;

class XmlEncoderTest extends TestCase
{
/**
* @var XmlEncoder
*/
private $encoder;

/**
Copy link
< 8000 /div>
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This comment is useless (the IDE will be able to infer the type using the default value).

* @var string
*/
private $exampleDateTimeString = '2017-02-19T15:16:08+0300';

protected function setUp()
{
$this->encoder = new XmlEncoder();
Expand Down Expand Up @@ -524,4 +534,96 @@ protected function getObject()

return $obj;
}

/**
* @test
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This block is useless (same below).

*/
public function testEncodeXmlWithBoolValue()
{
$expectedXml = '<?xml version="1.0"?>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You may use the heredoc syntax (the IDE will be able to highlight the snippet). (Just suggestion, not mandatory).

<response><foo>1</foo><bar>0</bar></response>
';

$actualXml = $this->encoder->encode(array('foo' => true, 'bar' => false), 'xml');
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't get why this is expected? IMO it should be array('foo' => '1', 'bar' => '0') unless explicitly defined as bool in a XML schema.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is an actual behavior of XmlEncode, to cast bool to int. I am not sure that i should fix this non explicit behaviour, so i am just cover that with test.


$this->assertEquals($expectedXml, $actualXml);
}

/**
* @test
*/
public function testEncodeXmlWithDateTimeObjectValue()
{
$xmlEncoder = $this->createXmlEncoderWithDateTimeNormalizer();

$actualXml = $xmlEncoder->encode(array('dateTime' => new DateTime($this->exampleDateTimeString)), 'xml');

$this->assertEquals($this->createXmlWithDateTime(), $actualXml);
}

/**
* @test
*/
public function testEncodeXmlWithDateTimeObjectField()
{
$xmlEncoder = $this->createXmlEncoderWithDateTimeNormalizer();

$actualXml = $xmlEncoder->encode(array('foo' => array('@dateTime' => new DateTime($this->exampleDateTimeString))), 'xml');

$this->assertEquals($this->createXmlWithDateTimeField(), $actualXml);
}

/**
* @return XmlEncoder
*/
private function createXmlEncoderWithDateTimeNormalizer()
{
$encoder = new XmlEncoder();
$serializer = new Serializer(array($this->createMockDateTimeNormalizer()), array('xml' => new XmlEncoder()));
$encoder->setSerializer($serializer);

return $encoder;
}

/**
* @return \PHPUnit_Framework_MockObject_MockObject|NormalizerInterface
*/
private function createMockDateTimeNormalizer()
{
$mock = $this->getMockBuilder('\Symfony\Component\Serializer\Normalizer\CustomNormalizer')->getMock();

$mock
->expects($this->once())
->method('normalize')
->with(new DateTime($this->exampleDateTimeString), 'xml', array())
->willReturn($this->exampleDateTimeString);

$mock
->expects($this->once())
->method('supportsNormalization')
->with(new DateTime($this->exampleDateTimeString), 'xml')
->willReturn(true);

return $mock;
}

/**
* @return string
*/
private function createXmlWithDateTime()
{
return sprintf('<?xml version="1.0"?>
<response><dateTime>%s</dateTime></response>
', $this->exampleDateTimeString);
}

/**
* @return string
*/
private function createXmlWithDateTimeField()
{
return sprintf('<?xml version="1.0"?>
<response><foo dateTime="%s"/></response>
', $this->exampleDateTimeString);
}
}
0