Fixed flat file writing on multiple sheets

yann-eugone · yann-eugone · commit 98b8365ec762 · 2022-02-27T09:59:59.000+01:00
diff --git a/src/batch-box-spout/src/Writer/FlatFileWriter.php b/src/batch-box-spout/src/Writer/FlatFileWriter.php
@@ -8,6 +8,7 @@
 use Box\Spout\Writer\Common\Creator\WriterEntityFactory;
 use Box\Spout\Writer\Common\Creator\WriterFactory;
 use Box\Spout\Writer\WriterInterface;
+use Box\Spout\Writer\WriterMultiSheetsAbstract;
 use Yokai\Batch\Bridge\Box\Spout\Writer\Options\OptionsInterface;
 use Yokai\Batch\Exception\BadMethodCallException;
 use Yokai\Batch\Exception\RuntimeException;
@@ -40,6 +41,7 @@ final class FlatFileWriter implements
     private ?array $headers;
     private ?WriterInterface $writer = null;
     private bool $headersAdded = false;
+    private ?string $defaultSheet = null;
 
     /**
      * @phpstan-param list<string>|null $headers
@@ -70,6 +72,10 @@ public function initialize(): void
         $this->writer = WriterFactory::createFromFile($path);
         $this->writer->openToFile($path);
         $this->options->configure($this->writer);
+
+        if ($this->writer instanceof WriterMultiSheetsAbstract) {
+            $this->defaultSheet = $this->writer->getCurrentSheet()->getName();
+        }
     }
 
     /**
@@ -89,6 +95,12 @@ public function write(iterable $items): void
         }
 
         foreach ($items as $row) {
+            if ($row instanceof WriteToSheetItem) {
+                $this->changeSheet($row->getSheet());
+                $row = $row->getItem();
+            } elseif ($this->defaultSheet !== null) {
+                $this->changeSheet($this->defaultSheet);
+            }
             if (\is_array($row)) {
                 $row = WriterEntityFactory::createRowFromArray($row);
             }
@@ -113,4 +125,21 @@ public function flush(): void
         $this->writer = null;
         $this->headersAdded = false;
     }
+
+    private function changeSheet(string $name): void
+    {
+        if (!$this->writer instanceof WriterMultiSheetsAbstract) {
+            return;
+        }
+
+        foreach ($this->writer->getSheets() as $sheet) {
+            if ($sheet->getName() === $name) {
+                $this->writer->setCurrentSheet($sheet);
+                return;
+            }
+        }
+
+        $sheet = $this->writer->addNewSheetAndMakeItCurrent();
+        $sheet->setName($name);
+    }
 }
diff --git a/src/batch-box-spout/src/Writer/WriteToSheetItem.php b/src/batch-box-spout/src/Writer/WriteToSheetItem.php
@@ -0,0 +1,39 @@
+<?php
+
+namespace Yokai\Batch\Bridge\Box\Spout\Writer;
+
+use Box\Spout\Common\Entity\Row;
+use Box\Spout\Common\Entity\Style\Style;
+use Box\Spout\Writer\Common\Creator\WriterEntityFactory;
+
+final class WriteToSheetItem
+{
+    private string $sheet;
+    private Row $item;
+
+    private function __construct(string $sheet, Row $item)
+    {
+        $this->sheet = $sheet;
+        $this->item = $item;
+    }
+
+    public static function array(string $sheet, array $item, Style $style = null): self
+    {
+        return new self($sheet, WriterEntityFactory::createRowFromArray($item, $style));
+    }
+
+    public static function row(string $sheet, Row $item): self
+    {
+        return new self($sheet, $item);
+    }
+
+    public function getSheet(): string
+    {
+        return $this->sheet;
+    }
+
+    public function getItem(): Row
+    {
+        return $this->item;
+    }
+}
diff --git a/src/batch-box-spout/tests/Writer/FlatFileWriterTest.php b/src/batch-box-spout/tests/Writer/FlatFileWriterTest.php
@@ -6,14 +6,14 @@
 
 use Box\Spout\Common\Entity\Style\CellAlignment;
 use Box\Spout\Common\Entity\Style\Color;
-use Box\Spout\Reader\Wrapper\XMLReader;
 use Box\Spout\Writer\Common\Creator\Style\StyleBuilder;
 use Box\Spout\Writer\Common\Creator\WriterEntityFactory;
 use PHPUnit\Framework\TestCase;
 use Yokai\Batch\Bridge\Box\Spout\Writer\FlatFileWriter;
 use Yokai\Batch\Bridge\Box\Spout\Writer\Options\CSVOptions;
 use Yokai\Batch\Bridge\Box\Spout\Writer\Options\ODSOptions;
 use Yokai\Batch\Bridge\Box\Spout\Writer\Options\XLSXOptions;
+use Yokai\Batch\Bridge\Box\Spout\Writer\WriteToSheetItem;
 use Yokai\Batch\Exception\BadMethodCallException;
 use Yokai\Batch\Exception\RuntimeException;
 use Yokai\Batch\Exception\UnexpectedValueException;
@@ -35,7 +35,6 @@ public function testWrite(
         string $expectedContent
     ): void {
         $file = self::WRITE_DIR . '/' . $filename;
-
         self::assertFileDoesNotExist($file);
 
         $writer = new FlatFileWriter(new StaticValueParameterAccessor($file), $options(), $headers);
@@ -219,6 +218,58 @@ public function types(): \Generator
             yield [$type, $options];
         }
     }
+
+    /**
+     * @dataProvider multipleSheetsOptions
+     */
+    public function testWriteMultipleSheets(string $type, callable $options): void
+    {
+        $file = self::WRITE_DIR . '/multiple-sheets.' . $type;
+        self::assertFileDoesNotExist($file);
+
+        $writer = new FlatFileWriter(new StaticValueParameterAccessor($file), $options());
+        $writer->setJobExecution(JobExecution::createRoot('123456789', 'export'));
+
+        $writer->initialize();
+        $writer->write([
+            WriteToSheetItem::array('English', ['John', 'Doe']),
+            WriteToSheetItem::array('Français', ['Jean', 'Aimar']),
+            WriteToSheetItem::row('English', WriterEntityFactory::createRowFromArray(['Jack', 'Doe'])),
+            WriteToSheetItem::row('Français', WriterEntityFactory::createRowFromArray(['Jacques', 'Ouzi'])),
+        ]);
+        $writer->flush();
+
+        if ($type === 'csv') {
+            self::assertFileContents($file, <<<CSV
+            John,Doe
+            Jean,Aimar
+            Jack,Doe
+            Jacques,Ouzi
+            CSV);
+        } else {
+            self::assertSheetContents($file, 'English', <<<CSV
+            John,Doe
+            Jack,Doe
+            CSV);
+            self::assertSheetContents($file, 'Français', <<<CSV
+            Jean,Aimar
+            Jacques,Ouzi
+            CSV);
+        }
+    }
+
+    public function multipleSheetsOptions(): \Generator
+    {
+        $types = [
+            'csv' => fn() => new CSVOptions(),
+            'xlsx' => fn() => new XLSXOptions('English'),
+            'ods' => fn() => new ODSOptions('English'),
+        ];
+        foreach ($types as $type => $options) {
+            yield [$type, $options];
+        }
+    }
+
     /**
      * @dataProvider wrongOptions
      */
@@ -283,15 +334,55 @@ private static function assertFileContents(string $filePath, string $inlineData)
                 $pathToSheetFile = $filePath . '#xl/worksheets/sheet1.xml';
                 $xmlContents = file_get_contents('zip://' . $pathToSheetFile);
                 foreach ($strings as $string) {
-                    self::assertStringContainsString($string, $xmlContents);
+                    self::assertStringContainsString("<t>$string</t>", $xmlContents);
                 }
                 break;
 
             case 'ods':
-                $xmlReader = new XMLReader();
-                $xmlReader->openFileInZip($filePath, 'content.xml');
-                $xmlReader->readUntilNodeFound('table:table');
-                $sheetXmlAsString = $xmlReader->readOuterXml();
+                $sheetContent = file_get_contents('zip://' . $filePath . '#content.xml');
+                if (!preg_match('#<table:table[^>]+>[\s\S]*?<\/table:table>#', $sheetContent, $matches)) {
+                    self::fail('No sheet found in file "' . $filePath . '".');
+                }
+                $sheetXmlAsString = $matches[0];
+                foreach ($strings as $string) {
+                    self::assertStringContainsString("<text:p>$string</text:p>", $sheetXmlAsString);
+                }
+                break;
+        }
+    }
+
+    private static function assertSheetContents(string $filePath, string $sheet, string $inlineData): void
+    {
+        $type = \strtolower(\pathinfo($filePath, PATHINFO_EXTENSION));
+        $strings = array_merge(...array_map('str_getcsv', explode(PHP_EOL, $inlineData)));
+
+        switch ($type) {
+            case 'csv':
+                $fileContents = file_get_contents($filePath);
+                foreach ($strings as $string) {
+                    self::assertStringContainsString($string, $fileContents);
+                }
+                break;
+
+            case 'xlsx':
+                $workbookContent = file_get_contents('zip://' . $filePath . '#xl/workbook.xml');
+                if (!preg_match('#<sheet name="' . $sheet . '" sheetId="([0-9]+)"#', $workbookContent, $matches)) {
+                    self::fail('Sheet ' . $sheet . ' was not found in file "' . $filePath . '".');
+                }
+                $sheetFilename = 'sheet' . $matches[1];
+                $sheetContent = file_get_contents('zip://' . $filePath . '#xl/worksheets/' . $sheetFilename . '.xml');
+                foreach ($strings as $string) {
+                    self::assertStringContainsString("<t>$string</t>", $sheetContent);
+                }
+                break;
+
+            case 'ods':
+                $sheetContent = file_get_contents('zip://' . $filePath . '#content.xml');
+                $regex = '#<table:table.+table:name="' . $sheet . '">[\s\S]*?<\/table:table>#';
+                if (!preg_match($regex, $sheetContent, $matches)) {
+                    self::fail('Sheet ' . $sheet . ' was not found in file "' . $filePath . '".');
+                }
+                $sheetXmlAsString = $matches[0];
                 foreach ($strings as $string) {
                     self::assertStringContainsString("<text:p>$string</text:p>", $sheetXmlAsString);
                 }
