symfony/src/Symfony/Component/Serializer/Tests/Encoder/CsvEncoderTest.php

<?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\Serializer\Tests\Encoder;

use PHPUnit\Framework\TestCase;
use Symfony\Component\Serializer\Encoder\CsvEncoder;

/**
 * @author Kévin Dunglas <dunglas@gmail.com>
 */
class CsvEncoderTest extends TestCase
{
    /**
     * @var CsvEncoder
     */
    private $encoder;

    protected function setUp()
    {
        $this->encoder = new CsvEncoder();
    }

    public function testSupportEncoding()
    {
        $this->assertTrue($this->encoder->supportsEncoding('csv'));
        $this->assertFalse($this->encoder->supportsEncoding('foo'));
    }

    public function testEncode()
    {
        $value = array('foo' => 'hello', 'bar' => 'hey ho');

        $this->assertEquals(<<<'CSV'
foo,bar
hello,"hey ho"

CSV
    , $this->encoder->encode($value, 'csv'));
    }

    public function testEncodeCollection()
    {
        $value = array(
            array('foo' => 'hello', 'bar' => 'hey ho'),
            array('foo' => 'hi', 'bar' => 'let\'s go'),
        );

        $this->assertEquals(<<<'CSV'
foo,bar
hello,"hey ho"
hi,"let's go"

CSV
    , $this->encoder->encode($value, 'csv'));
    }

    public function testEncodePlainIndexedArray()
    {
        $this->assertEquals(<<<'CSV'
0,1,2
a,b,c

CSV
            , $this->encoder->encode(array('a', 'b', 'c'), 'csv'));
    }

    public function testEncodeNonArray()
    {
        $this->assertEquals(<<<'CSV'
0
foo

CSV
            , $this->encoder->encode('foo', 'csv'));
    }

    public function testEncodeNestedArrays()
    {
        $value = array('foo' => 'hello', 'bar' => array(
            array('id' => 'yo', 1 => 'wesh'),
            array('baz' => 'Halo', 'foo' => 'olá'),
        ));

        $this->assertEquals(<<<'CSV'
foo,bar.0.id,bar.0.1,bar.1.baz,bar.1.foo
hello,yo,wesh,Halo,olá

CSV
    , $this->encoder->encode($value, 'csv'));
    }

    public function testEncodeCustomSettings()
    {
        $this->encoder = new CsvEncoder(';', "'", '|', '-');

        $value = array('a' => 'he\'llo', 'c' => array('d' => 'foo'));

        $this->assertEquals(<<<'CSV'
a;c-d
'he''llo';foo

CSV
    , $this->encoder->encode($value, 'csv'));
    }

    public function testEncodeCustomSettingsPassedInContext()
    {
        $value = array('a' => 'he\'llo', 'c' => array('d' => 'foo'));

        $this->assertSame(<<<'CSV'
a;c-d
'he''llo';foo

CSV
        , $this->encoder->encode($value, 'csv', array(
            CsvEncoder::DELIMITER_KEY => ';',
            CsvEncoder::ENCLOSURE_KEY => "'",
            CsvEncoder::ESCAPE_CHAR_KEY => '|',
            CsvEncoder::KEY_SEPARATOR_KEY => '-',
        )));
    }

    public function testEncodeEmptyArray()
    {
        $this->assertEquals("\n\n", $this->encoder->encode(array(), 'csv'));
        $this->assertEquals("\n\n", $this->encoder->encode(array(array()), 'csv'));
    }

    public function testEncodeVariableStructure()
    {
        $value = array(
            array('a' => array('foo', 'bar')),
            array('a' => array(), 'b' => 'baz'),
            array('a' => array('bar', 'foo'), 'c' => 'pong'),
        );
        $csv = <<<CSV
a.0,a.1,c,b
foo,bar,,
,,,baz
bar,foo,pong,

CSV;

        $this->assertEquals($csv, $this->encoder->encode($value, 'csv'));
    }

    public function testEncodeCustomHeaders()
    {
        $context = array(
            CsvEncoder::HEADERS_KEY => array(
                'b',
                'c',
            ),
        );
        $value = array(
            array('a' => 'foo', 'b' => 'bar'),
        );
        $csv = <<<CSV
b,c,a
bar,,foo

CSV;

        $this->assertEquals($csv, $this->encoder->encode($value, 'csv', $context));
    }

    public function testEncodeFormulas()
    {
        $this->encoder = new CsvEncoder(',', '"', '\\', '.', true);

        $this->assertSame(<<<'CSV'
0
"	=2+3"

CSV
            , $this->encoder->encode(array('=2+3'), 'csv'));

        $this->assertSame(<<<'CSV'
0
"	-2+3"

CSV
            , $this->encoder->encode(array('-2+3'), 'csv'));

        $this->assertSame(<<<'CSV'
0
"	+2+3"

CSV
            , $this->encoder->encode(array('+2+3'), 'csv'));

        $this->assertSame(<<<'CSV'
0
"	@MyDataColumn"

CSV
            , $this->encoder->encode(array('@MyDataColumn'), 'csv'));
    }

    public function testDoNotEncodeFormulas()
    {
        $this->assertSame(<<<'CSV'
0
=2+3

CSV
            , $this->encoder->encode(array('=2+3'), 'csv'));

        $this->assertSame(<<<'CSV'
0
-2+3

CSV
            , $this->encoder->encode(array('-2+3'), 'csv'));

        $this->assertSame(<<<'CSV'
0
+2+3

CSV
            , $this->encoder->encode(array('+2+3'), 'csv'));

        $this->assertSame(<<<'CSV'
0
@MyDataColumn

CSV
            , $this->encoder->encode(array('@MyDataColumn'), 'csv'));
    }

    public function testEncodeFormulasWithSettingsPassedInContext()
    {
        $this->assertSame(<<<'CSV'
0
"	=2+3"

CSV
            , $this->encoder->encode(array('=2+3'), 'csv', array(
                CsvEncoder::ESCAPE_FORMULAS_KEY => true,
            )));

        $this->assertSame(<<<'CSV'
0
"	-2+3"

CSV
            , $this->encoder->encode(array('-2+3'), 'csv', array(
                CsvEncoder::ESCAPE_FORMULAS_KEY => true,
            )));

        $this->assertSame(<<<'CSV'
0
"	+2+3"

CSV
            , $this->encoder->encode(array('+2+3'), 'csv', array(
                CsvEncoder::ESCAPE_FORMULAS_KEY => true,
            )));

        $this->assertSame(<<<'CSV'
0
"	@MyDataColumn"

CSV
            , $this->encoder->encode(array('@MyDataColumn'), 'csv', array(
                CsvEncoder::ESCAPE_FORMULAS_KEY => true,
            )));
    }

    public function testSupportsDecoding()
    {
        $this->assertTrue($this->encoder->supportsDecoding('csv'));
        $this->assertFalse($this->encoder->supportsDecoding('foo'));
    }

    /**
     * @group legacy
     * @expectedDeprecation Relying on the default value (false) of the "as_collection" option is deprecated since 4.2. You should set it to false explicitly instead as true will be the default value in 5.0.
     */
    public function testDecodeLegacy()
    {
        $expected = array('foo' => 'a', 'bar' => 'b');

        $this->assertEquals($expected, $this->encoder->decode(<<<'CSV'
foo,bar
a,b
CSV
        , 'csv'));
    }

    public function testDecodeAsSingle()
    {
        $expected = array('foo' => 'a', 'bar' => 'b');

        $this->assertEquals($expected, $this->encoder->decode(<<<'CSV'
foo,bar
a,b
CSV
        , 'csv', array(CsvEncoder::AS_COLLECTION_KEY => false)));
    }

    public function testDecodeCollection()
    {
        $expected = array(
            array('foo' => 'a', 'bar' => 'b'),
            array('foo' => 'c', 'bar' => 'd'),
            array('foo' => 'f'),
        );

        $this->assertEquals($expected, $this->encoder->decode(<<<'CSV'
foo,bar
a,b
c,d
f

CSV
        , 'csv'));
    }

    public function testDecode()
    {
        $expected = array(
            array('foo' => 'a'),
        );

        $this->assertEquals($expected, $this->encoder->decode(<<<'CSV'
foo
a

CSV
        , 'csv', array(
            CsvEncoder::AS_COLLECTION_KEY => true, // Can be removed in 5.0
        )));
    }

    public function testDecodeToManyRelation()
    {
        $expected = array(
            array('foo' => 'bar', 'relations' => array(array('a' => 'b'), array('a' => 'b'))),
            array('foo' => 'bat', 'relations' => array(array('a' => 'b'), array('a' => ''))),
            array('foo' => 'bat', 'relations' => array(array('a' => 'b'))),
            array('foo' => 'baz', 'relations' => array(array('a' => 'c'), array('a' => 'c'))),
        );

        $this->assertEquals($expected, $this->encoder->decode(<<<'CSV'
foo,relations.0.a,relations.1.a
bar,b,b
bat,b,
bat,b
baz,c,c
CSV
            , 'csv'));
    }

    public function testDecodeNestedArrays()
    {
        $expected = array(
            array('foo' => 'a', 'bar' => array('baz' => array('bat' => 'b'))),
            array('foo' => 'c', 'bar' => array('baz' => array('bat' => 'd'))),
        );

        $this->assertEquals($expected, $this->encoder->decode(<<<'CSV'
foo,bar.baz.bat
a,b
c,d
CSV
        , 'csv'));
    }

    public function testDecodeCustomSettings()
    {
        $this->encoder = new CsvEncoder(';', "'", '|', '-');

        $expected = array(array('a' => 'hell\'o', 'bar' => array('baz' => 'b')));
        $this->assertEquals($expected, $this->encoder->decode(<<<'CSV'
a;bar-baz
'hell''o';b;c
CSV
        , 'csv', array(
            CsvEncoder::AS_COLLECTION_KEY => true, // Can be removed in 5.0
        )));
    }

    public function testDecodeCustomSettingsPassedInContext()
    {
        $expected = array(array('a' => 'hell\'o', 'bar' => array('baz' => 'b')));
        $this->assertEquals($expected, $this->encoder->decode(<<<'CSV'
a;bar-baz
'hell''o';b;c
CSV
        , 'csv', array(
            CsvEncoder::DELIMITER_KEY => ';',
            CsvEncoder::ENCLOSURE_KEY => "'",
            CsvEncoder::ESCAPE_CHAR_KEY => '|',
            CsvEncoder::KEY_SEPARATOR_KEY => '-',
            CsvEncoder::AS_COLLECTION_KEY => true, // Can be removed in 5.0
        )));
    }

    public function testDecodeMalformedCollection()
    {
        $expected = array(
            array('foo' => 'a', 'bar' => 'b'),
            array('foo' => 'c', 'bar' => 'd'),
            array('foo' => 'f'),
        );

        $this->assertEquals($expected, $this->encoder->decode(<<<'CSV'
foo,bar
a,b,e
c,d,g,h
f

CSV
            , 'csv'));
    }

    public function testDecodeEmptyArray()
    {
        $this->assertEquals(array(), $this->encoder->decode('', 'csv'));
    }
}