feat: file reader add option delimiter and defaultData

FileReader use array for options
ems-project · Oct 29, 2024 · 6e27cc1 · 6e27cc1
1 parent 1bbe7d5
commit 6e27cc1
Show file tree

Hide file tree

Showing 5 changed files with 44 additions and 16 deletions.
diff --git a/EMS/common-bundle/src/Common/File/FileReader.php b/EMS/common-bundle/src/Common/File/FileReader.php
@@ -15,13 +15,20 @@ final class FileReader implements FileReaderInterface
     /**
      * {@inheritDoc}
      */
-    public function getData(string $filename, bool $skipFirstRow = false, string $encoding = null): array
+    public function getData(string $filename, array $options = []): array
     {
+        $skipFirstRow = true === ($options['skipFirstRow'] ?? false);
+        $encoding = $options['encoding'] ?? null;
+
         $reader = IOFactory::createReaderForFile($filename);
         if (($reader instanceof Csv || $reader instanceof Html || $reader instanceof Slk) && null !== $encoding) {
             $reader->setInputEncoding($encoding);
         }
 
+        if ($reader instanceof Csv && isset($options['delimiter'])) {
+            $reader->setDelimiter($options['delimiter']);
+        }
+
         $data = $reader->load($filename)->getActiveSheet()->toArray();
 
         if ($skipFirstRow) {

diff --git a/EMS/common-bundle/src/Contracts/File/FileReaderInterface.php b/EMS/common-bundle/src/Contracts/File/FileReaderInterface.php
@@ -7,7 +7,13 @@
 interface FileReaderInterface
 {
     /**
+     * @param array{
+     *     skipFirstRow?: bool,
+     *     encoding?: ?string,
+     *     delimiter?: ?string,
+     * } $options
+     *
      * @return array<mixed>
      */
-    public function getData(string $filename, bool $skipFirstRow = false, string $encoding = null): array;
+    public function getData(string $filename, array $options = []): array;
 }
diff --git a/elasticms-cli/src/Client/File/FileReaderImportConfig.php b/elasticms-cli/src/Client/File/FileReaderImportConfig.php
@@ -8,11 +8,16 @@
 
 class FileReaderImportConfig
 {
+    /**
+     * @param array<string, mixed> $defaultData
+     */
     private function __construct(
         public bool $generateHash = false,
         public bool $deleteMissingDocuments = false,
+        public ?string $delimiter = null,
+        public array $defaultData = [],
         public ?string $ouuidExpression = "row['ouuid']",
-        public ?string $encoding = null
+        public ?string $encoding = null,
     ) {
     }
 
@@ -24,23 +29,27 @@ public static function createFromArray(array $config): self
         $optionsResolver = new OptionsResolver();
         $optionsResolver
             ->setDefaults([
-                'generateHash' => false,
-                'deleteMissingDocuments' => false,
-                'ouuidExpression' => 'row[\'ouuid\']',
+                'delimiter' => null,
+                'default_data' => [],
+                'delete_missing_documents' => false,
                 'encoding' => null,
+                'generate_hash' => false,
+                'ouuid_expression' => 'row[\'ouuid\']',
             ])
-            ->setAllowedTypes('generateHash', 'bool')
-            ->setAllowedTypes('deleteMissingDocuments', 'bool')
-            ->setAllowedTypes('ouuidExpression', ['string', 'null'])
+            ->setAllowedTypes('delete_missing_documents', 'bool')
+            ->setAllowedTypes('generate_hash', 'bool')
+            ->setAllowedTypes('ouuid_expression', ['string', 'null'])
         ;
 
-        $config = $optionsResolver->resolve($config);
+        $options = $optionsResolver->resolve($config);
 
         return new self(
-            generateHash: $config['generateHash'],
-            deleteMissingDocuments: $config['deleteMissingDocuments'],
-            ouuidExpression: $config['ouuidExpression'],
-            encoding: $config['encoding'],
+            generateHash: $options['generate_hash'],
+            deleteMissingDocuments: $options['delete_missing_documents'],
+            delimiter: $options['delimiter'],
+            defaultData: $options['default_data'],
+            ouuidExpression: $options['ouuid_expression'],
+            encoding: $options['encoding'],
         );
     }
 }
diff --git a/elasticms-cli/src/Command/Document/DocumentUpdateCommand.php b/elasticms-cli/src/Command/Document/DocumentUpdateCommand.php
@@ -79,7 +79,10 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $config = DocumentUpdateConfig::fromFile($this->configFile);
 
         $this->io->section('Reading data');
-        $dataArray = $this->fileReader->getData($this->dataFilePath, $this->dataSkipFirstRow);
+        $dataArray = $this->fileReader->getData(
+            filename: $this->dataFilePath,
+            options: ['skipFirstRow' => $this->dataSkipFirstRow]
+        );
 
         $data = new Data($dataArray);
         $this->io->writeln(\sprintf('Loaded data in memory: %d rows', \count($data)));

diff --git a/elasticms-cli/src/Command/FileReader/FileReaderImportCommand.php b/elasticms-cli/src/Command/FileReader/FileReaderImportCommand.php
@@ -80,7 +80,10 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         }
 
         $expressionLanguage = new ExpressionLanguage();
-        $rows = $this->fileReader->getData($file->getFilename(), false, $config->encoding);
+        $rows = $this->fileReader->getData($file->getFilename(), [
+            'delimiter' => $config->delimiter,
+            'encoding' => $config->encoding,
+        ]);
         $header = \array_map('trim', $rows[0] ?? []);
 
         $ouuids = [];