Added an ability to specify CSV ouput encoding

CHANGELOG.md

@@ -7,6 +7,8 @@ All notable changes to this project will be documented in this file.
 - Fix return type of `FromQuery::query()`
 - Support Laravel 9
 - Added a config setting to specify DB connection
+- Added a config setting to specify CSV output encoding
+- Added an ability to specify CSV ouput encoding through csvSettings
 
 ## [3.1.35] - 2022-01-04
 

config/excel.php

@@ -48,6 +48,7 @@
             'use_bom'                => false,
             'include_separator_line' => false,
             'excel_compatibility'    => false,
+            'output_encoding'        => '',
         ],
 
         /*

src/Concerns/MapsCsvSettings.php

@@ -51,6 +51,11 @@ trait MapsCsvSettings
      */
     protected static $inputEncoding = 'UTF-8';
 
+    /**
+     * @var string
+     */
+    protected static $outputEncoding = '';
+
     /**
      * @param  array  $config
      */
@@ -65,5 +70,6 @@ public static function applyCsvSettings(array $config)
         static::$escapeCharacter      = Arr::get($config, 'escape_character', static::$escapeCharacter);
         static::$contiguous           = Arr::get($config, 'contiguous', static::$contiguous);
         static::$inputEncoding        = Arr::get($config, 'input_encoding', static::$inputEncoding);
+        static::$outputEncoding       = Arr::get($config, 'output_encoding', static::$outputEncoding);
     }
 }

src/Factories/WriterFactory.php

@@ -56,6 +56,7 @@ public static function make(string $writerType, Spreadsheet $spreadsheet, $expor
             $writer->setUseBOM(static::$useBom);
             $writer->setIncludeSeparatorLine(static::$includeSeparatorLine);
             $writer->setExcelCompatibility(static::$excelCompatibility);
+            $writer->setOutputEncoding(static::$outputEncoding);
         }
 
         // Calculation settings

tests/Concerns/WithCustomCsvSettingsTest.php

@@ -54,6 +54,7 @@ public function getCsvSettings(): array
                     'use_bom'                => true,
                     'include_separator_line' => true,
                     'excel_compatibility'    => false,
+                    'output_encoding'        => '',
                 ];
             }
         };
@@ -67,6 +68,55 @@ public function getCsvSettings(): array
         $this->assertStringContains('A2;B2', $contents);
     }
 
+    /**
+     * @test
+     */
+    public function can_store_csv_export_with_custom_encoding()
+    {
+        $export = new class implements FromCollection, WithCustomCsvSettings
+        {
+            /**
+             * @return Collection
+             */
+            public function collection()
+            {
+                return collect([
+                    ['A1', '€ŠšŽžŒœŸ'],
+                    ['A2', 'åßàèòìù'],
+                ]);
+            }
+
+            /**
+             * @return array
+             */
+            public function getCsvSettings(): array
+            {
+                return [
+                    'delimiter'              => ';',
+                    'enclosure'              => '',
+                    'line_ending'            => PHP_EOL,
+                    'use_bom'                => false,
+                    'include_separator_line' => true,
+                    'excel_compatibility'    => false,
+                    'output_encoding'        => 'ISO-8859-15',
+                ];
+            }
+        };
+
+        $this->SUT->store($export, 'custom-csv-iso.csv');
+
+        $contents = file_get_contents(__DIR__ . '/../Data/Disks/Local/custom-csv-iso.csv');
+
+        Assert::assertEquals('ISO-8859-15', mb_detect_encoding($contents, 'ISO-8859-15', true));
+        Assert::assertFalse(mb_detect_encoding($contents, 'UTF-8', true));
+
+        $contents = mb_convert_encoding($contents, 'UTF-8', 'ISO-8859-15');
+
+        $this->assertStringContains('sep=;', $contents);
+        $this->assertStringContains('A1;€ŠšŽžŒœŸ', $contents);
+        $this->assertStringContains('A2;åßàèòìù', $contents);
+    }
+
     /**
      * @test
      */