Set $escapeFormulas to false by default

welcoMattic · welcoMattic · commit 527dc6aecc3d · 2017-10-11T10:35:25.000+02:00
diff --git a/src/Symfony/Component/Serializer/CHANGELOG.md b/src/Symfony/Component/Serializer/CHANGELOG.md
@@ -11,7 +11,7 @@ CHANGELOG
  * added an optional `string $format = null` argument to `AbstractNormalizer::instantiateObject`
  * added an optional `array $context = array()` to `Serializer::supportsNormalization`, `Serializer::supportsDenormalization`,
    `Serializer::supportsEncoding` and `Serializer::supportsDecoding`
- * added optional `bool $escapeFormulas = true` argument to `CsvEncoder::__construct`
+ * added optional `bool $escapeFormulas = false` argument to `CsvEncoder::__construct`
 
 3.4.0
 -----
diff --git a/src/Symfony/Component/Serializer/Encoder/CsvEncoder.php b/src/Symfony/Component/Serializer/Encoder/CsvEncoder.php
@@ -27,13 +27,13 @@ class CsvEncoder implements EncoderInterface, DecoderInterface
     const ESCAPE_CHAR_KEY = 'csv_escape_char';
     const KEY_SEPARATOR_KEY = 'csv_key_separator';
     const HEADERS_KEY = 'csv_headers';
-    const FORMULAS_START_CHARACTERS = array('=', '-', '+', '@');
 
     private $delimiter;
     private $enclosure;
     private $escapeChar;
     private $keySeparator;
     private $escapeFormulas;
+    private $formulasStartCharacters = array('=', '-', '+', '@');
 
     /**
      * @param string $delimiter
@@ -42,7 +42,7 @@ class CsvEncoder implements EncoderInterface, DecoderInterface
      * @param string $keySeparator
      * @param bool   $escapeFormulas
      */
-    public function __construct($delimiter = ',', $enclosure = '"', $escapeChar = '\\', $keySeparator = '.', $escapeFormulas = true)
+    public function __construct($delimiter = ',', $enclosure = '"', $escapeChar = '\\', $keySeparator = '.', $escapeFormulas = false)
     {
         $this->delimiter = $delimiter;
         $this->enclosure = $enclosure;
@@ -190,7 +190,7 @@ private function flatten(array $array, array &$result, $keySeparator, $parentKey
             if (is_array($value)) {
                 $this->flatten($value, $result, $keySeparator, $parentKey.$key.$keySeparator);
             } else {
-                if ($this->escapeFormulas && \in_array(mb_substr($value, 0, 1), self::FORMULAS_START_CHARACTERS, true)) {
+                if ($this->escapeFormulas && \in_array(mb_substr($value, 0, 1), $this->formulasStartCharacters, true)) {
                     $result[$parentKey.$key] = "\t".$value;
                 } else {
                     $result[$parentKey.$key] = $value;
diff --git a/src/Symfony/Component/Serializer/Tests/Encoder/CsvEncoderTest.php b/src/Symfony/Component/Serializer/Tests/Encoder/CsvEncoderTest.php
@@ -175,28 +175,30 @@ public function testEncodeCustomHeaders()
 
     public function testEncodeFormulaValues()
     {
-        $this->assertEquals(<<<'CSV'
+        $this->encoder = new CsvEncoder(',', '"', '\\', '.', true);
+        
+        $this->assertSame(<<<'CSV'
 0
 "	=2+3"
 
 CSV
             , $this->encoder->encode(array('=2+3'), 'csv'));
 
-        $this->assertEquals(<<<'CSV'
+        $this->assertSame(<<<'CSV'
 0
 "	-2+3"
 
 CSV
             , $this->encoder->encode(array('-2+3'), 'csv'));
 
-        $this->assertEquals(<<<'CSV'
+        $this->assertSame(<<<'CSV'
 0
 "	+2+3"
 
 CSV
             , $this->encoder->encode(array('+2+3'), 'csv'));
 
-        $this->assertEquals(<<<'CSV'
+        $this->assertSame(<<<'CSV'
 0
 "	@MyDataColumn"
 
@@ -206,30 +208,28 @@ public function testEncodeFormulaValues()
 
     public function testDoNotEncodeFormulaValues()
     {
-        $this->encoder = new CsvEncoder(',', '"', '\\', '.', false);
-
-        $this->assertEquals(<<<'CSV'
+        $this->assertSame(<<<'CSV'
 0
 =2+3
 
 CSV
             , $this->encoder->encode(array('=2+3'), 'csv'));
 
-        $this->assertEquals(<<<'CSV'
+        $this->assertSame(<<<'CSV'
 0
 -2+3
 
 CSV
             , $this->encoder->encode(array('-2+3'), 'csv'));
 
-        $this->assertEquals(<<<'CSV'
+        $this->assertSame(<<<'CSV'
 0
 +2+3
 
 CSV
             , $this->encoder->encode(array('+2+3'), 'csv'));
 
-        $this->assertEquals(<<<'CSV'
+        $this->assertSame(<<<'CSV'
 0
 @MyDataColumn
 

Original file line number	Diff line number	Diff line change
`@@ -175,28 +175,30 @@ public function testEncodeCustomHeaders()`
`175`	`175`
`176`	`176`	`public function testEncodeFormulaValues()`
`177`	`177`	`{`
`178`		`- $this->assertEquals(<<<'CSV'`
	`178`	`+ $this->encoder = new CsvEncoder(',', '"', '\\', '.', true);`
	`179`	`+`
	`180`	`+ $this->assertSame(<<<'CSV'`
`179`	`181`	`0`
`180`	`182`	`" =2+3"`
`181`	`183`
`182`	`184`	`CSV`
`183`	`185`	`, $this->encoder->encode(array('=2+3'), 'csv'));`
`184`	`186`
`185`		`- $this->assertEquals(<<<'CSV'`
	`187`	`+ $this->assertSame(<<<'CSV'`
`186`	`188`	`0`
`187`	`189`	`" -2+3"`
`188`	`190`
`189`	`191`	`CSV`
`190`	`192`	`, $this->encoder->encode(array('-2+3'), 'csv'));`
`191`	`193`
`192`		`- $this->assertEquals(<<<'CSV'`
	`194`	`+ $this->assertSame(<<<'CSV'`
`193`	`195`	`0`
`194`	`196`	`" +2+3"`
`195`	`197`
`196`	`198`	`CSV`
`197`	`199`	`, $this->encoder->encode(array('+2+3'), 'csv'));`
`198`	`200`
`199`		`- $this->assertEquals(<<<'CSV'`
	`201`	`+ $this->assertSame(<<<'CSV'`
`200`	`202`	`0`
`201`	`203`	`" @MyDataColumn"`
`202`	`204`
`@@ -206,30 +208,28 @@ public function testEncodeFormulaValues()`
`206`	`208`
`207`	`209`	`public function testDoNotEncodeFormulaValues()`
`208`	`210`	`{`
`209`		`- $this->encoder = new CsvEncoder(',', '"', '\\', '.', false);`
`210`		`-`
`211`		`- $this->assertEquals(<<<'CSV'`
	`211`	`+ $this->assertSame(<<<'CSV'`
`212`	`212`	`0`
`213`	`213`	`=2+3`
`214`	`214`
`215`	`215`	`CSV`
`216`	`216`	`, $this->encoder->encode(array('=2+3'), 'csv'));`
`217`	`217`
`218`		`- $this->assertEquals(<<<'CSV'`
	`218`	`+ $this->assertSame(<<<'CSV'`
`219`	`219`	`0`
`220`	`220`	`-2+3`
`221`	`221`
`222`	`222`	`CSV`
`223`	`223`	`, $this->encoder->encode(array('-2+3'), 'csv'));`
`224`	`224`
`225`		`- $this->assertEquals(<<<'CSV'`
	`225`	`+ $this->assertSame(<<<'CSV'`
`226`	`226`	`0`
`227`	`227`	`+2+3`
`228`	`228`
`229`	`229`	`CSV`
`230`	`230`	`, $this->encoder->encode(array('+2+3'), 'csv'));`
`231`	`231`
`232`		`- $this->assertEquals(<<<'CSV'`
	`232`	`+ $this->assertSame(<<<'CSV'`
`233`	`233`	`0`
`234`	`234`	`@MyDataColumn`
`235`	`235`