refactor: remove redundant options

Author: norberttech

documentation/components/adapters/excel.md

@@ -204,3 +204,45 @@ data_frame()
     ->write(to_excel('path/to/output.xlsx')->withWriterOptions($options))
     ->run();
 ```
+
+For ODS format:
+
+```php
+<?php
+
+use OpenSpout\Writer\ODS\Options as OdsOptions;
+
+$options = new OdsOptions(
+    DEFAULT_COLUMN_WIDTH: 15.0,
+    DEFAULT_ROW_HEIGHT: 20.0,
+);
+
+data_frame()
+    ->read($extractor)
+    ->write(to_excel('path/to/output.ods')->withWriterOptions($options))
+    ->run();
+```
+
+### Custom Date/Time Formats
+
+Control how date, datetime, and time values are formatted in the output:
+
+```php
+<?php
+
+data_frame()
+    ->read($extractor)
+    ->write(
+        to_excel('path/to/output.xlsx')
+            ->withDateFormat('d/m/Y')
+            ->withDateTimeFormat('d/m/Y H:i')
+            ->withTimeFormat('%H:%I')
+    )
+    ->run();
+```
+
+Default formats:
+- Date: `Y-m-d`
+- DateTime: `Y-m-d H:i:s`
+- Time: `H:i:s`
+

src/adapter/etl-adapter-excel/src/Flow/ETL/Adapter/Excel/ExcelLoader.php

@@ -32,8 +32,6 @@ final class ExcelLoader implements Closure, FileLoader, Loader
 
     private string $timeFormat = 'H:i:s';
 
-    private bool $useInlineStrings = true;
-
     private bool $withHeader = true;
 
     private ?WorkbookManager $workbookManager = null;
@@ -145,15 +143,12 @@ public function withHeaderStyle(Style $style) : self
         return $this;
     }
 
-    public function withInlineStrings(bool $useInlineStrings) : self
-    {
-        $this->useInlineStrings = $useInlineStrings;
-
-        return $this;
-    }
-
     public function withSheetName(?string $sheetName) : self
     {
+        if ($sheetName !== null && $this->sheetNameEntryName !== null) {
+            throw new InvalidArgumentException('Cannot set both sheetName and sheetNameFromEntry. These options are mutually exclusive.');
+        }
+
         if ($sheetName !== null) {
             SheetNameAssertion::assert($sheetName);
         }
@@ -165,6 +160,10 @@ public function withSheetName(?string $sheetName) : self
 
     public function withSheetNameFromEntry(string $entryName) : self
     {
+        if ($this->sheetName !== null) {
+            throw new InvalidArgumentException('Cannot set both sheetName and sheetNameFromEntry. These options are mutually exclusive.');
+        }
+
         $this->sheetNameEntryName = $entryName;
 
         return $this;
@@ -196,8 +195,7 @@ private function getWorkbookManager() : WorkbookManager
         if ($this->workbookManager === null) {
             $this->workbookManager = new WorkbookManager(
                 writerType: $this->resolveWriterType(),
-                xlsxOptions: $this->resolveXlsxOptions(),
-                odsOptions: $this->resolveOdsOptions(),
+                options: $this->writerOptions,
             );
         }
 
@@ -224,15 +222,6 @@ private function resolveCellStyles(Row $row, int $rowIndex, string $sheetName) :
         return $styles;
     }
 
-    private function resolveOdsOptions() : ?OdsOptions
-    {
-        if ($this->writerOptions instanceof OdsOptions) {
-            return $this->writerOptions;
-        }
-
-        return null;
-    }
-
     private function resolveSheetName(Row $row) : string
     {
         if ($this->sheetNameEntryName !== null && $row->has($this->sheetNameEntryName)) {
@@ -261,15 +250,4 @@ private function resolveWriterType() : ExcelWriter
             default => ExcelWriter::XLSX,
         };
     }
-
-    private function resolveXlsxOptions() : ?XlsxOptions
-    {
-        if ($this->writerOptions instanceof XlsxOptions) {
-            return $this->writerOptions;
-        }
-
-        return $this->resolveWriterType() === ExcelWriter::XLSX
-            ? new XlsxOptions(SHOULD_USE_INLINE_STRINGS: $this->useInlineStrings)
-            : null;
-    }
 }

src/adapter/etl-adapter-excel/src/Flow/ETL/Adapter/Excel/WorkbookManager.php

@@ -32,8 +32,7 @@ final class WorkbookManager
 
     public function __construct(
         private readonly ExcelWriter $writerType = ExcelWriter::XLSX,
-        private readonly ?XlsxOptions $xlsxOptions = null,
-        private readonly ?OdsOptions $odsOptions = null,
+        private readonly OdsOptions|XlsxOptions|null $options = null,
     ) {
     }
 
@@ -131,12 +130,16 @@ private function countSheetsForCurrentFile() : int
 
     private function createOdsWriter() : OdsWriter
     {
-        return new OdsWriter($this->odsOptions ?? new OdsOptions());
+        $options = $this->options instanceof OdsOptions ? $this->options : new OdsOptions();
+
+        return new OdsWriter($options);
     }
 
     private function createXlsxWriter() : XlsxWriter
     {
-        return new XlsxWriter($this->xlsxOptions ?? new XlsxOptions());
+        $options = $this->options instanceof XlsxOptions ? $this->options : new XlsxOptions();
+
+        return new XlsxWriter($options);
     }
 
     private function getOrCreateSheet(string $sheetName) : Sheet

src/adapter/etl-adapter-excel/tests/Flow/ETL/Adapter/Excel/Tests/Integration/ExcelLoaderTest.php

@@ -7,6 +7,7 @@
 use function Flow\ETL\Adapter\Excel\DSL\{from_excel, to_excel};
 use function Flow\ETL\DSL\{bool_entry, date_entry, datetime_entry, df, float_entry, from_rows, int_entry, json_entry, row, rows, string_entry, time_entry, uuid_entry};
 use Flow\ETL\Adapter\Excel\{CellStyler, ExcelWriter};
+use Flow\ETL\Exception\InvalidArgumentException;
 use Flow\ETL\Row\Entry;
 use Flow\ETL\Tests\FlowIntegrationTestCase;
 use OpenSpout\Common\Entity\Style\Style;
@@ -345,6 +346,26 @@ public function test_round_trip_without_header(ExcelWriter $writer, string $exte
         self::assertSame(['e00', 'e01'], \array_keys($rows[0]));
     }
 
+    public function test_sheet_name_and_sheet_name_from_entry_are_mutually_exclusive() : void
+    {
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('Cannot set both sheetName and sheetNameFromEntry');
+
+        to_excel('/tmp/test.xlsx')
+            ->withSheetName('MySheet')
+            ->withSheetNameFromEntry('category');
+    }
+
+    public function test_sheet_name_from_entry_and_sheet_name_are_mutually_exclusive() : void
+    {
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('Cannot set both sheetName and sheetNameFromEntry');
+
+        to_excel('/tmp/test.xlsx')
+            ->withSheetNameFromEntry('category')
+            ->withSheetName('MySheet');
+    }
+
     public function test_with_cell_styler() : void
     {
         $outputPath = $this->cacheDir->suffix('output_cell_styler.xlsx')->path();
@@ -408,28 +429,6 @@ public function test_with_header_style() : void
         self::assertSame([1, 'Test'], [$rows[0]['id'], $rows[0]['name']]);
     }
 
-    public function test_with_inline_strings_disabled() : void
-    {
-        $outputPath = $this->cacheDir->suffix('output_no_inline_strings.xlsx')->path();
-
-        df()
-            ->read(from_rows(
-                rows(
-                    row(int_entry('id', 1), string_entry('name', 'Test')),
-                )
-            ))
-            ->write(to_excel($outputPath)->withInlineStrings(false))
-            ->run();
-
-        $rows = df()
-            ->read(from_excel($outputPath))
-            ->fetch()
-            ->toArray();
-
-        self::assertCount(1, $rows);
-        self::assertSame([1, 'Test'], [$rows[0]['id'], $rows[0]['name']]);
-    }
-
     public function test_with_ods_options() : void
     {
         $outputPath = $this->cacheDir->suffix('output_with_ods_options.ods')->path();