Merge pull request #119 from TheDragonCode/1.x

Added `CSV` feeds format

Author: andrey-helldar

config/feeds.php

@@ -114,5 +114,15 @@
              */
             'options' => JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE,
         ],
+
+        'csv' => [
+            /**
+             * CSV specific options applied when exporting feeds in CSV format.
+             */
+            /**
+             * The delimiter used to separate values. Common values are "," or ";".
+             */
+            'delimiter' => ';',
+        ],
     ],
 ];

docs/labels.list

@@ -15,4 +15,8 @@
         Available for JSON Lines feeds
     </secondary-label>
 
+    <secondary-label id="format-csv" name="csv" color="blue">
+        Available for CSV feeds
+    </secondary-label>
+
 </labels>

docs/topics/elements.topic

@@ -48,6 +48,7 @@
         <secondary-label ref="format-xml" />
         <secondary-label ref="format-json" />
         <secondary-label ref="format-jsonl" />
+        <secondary-label ref="format-csv" />
 
         <p>
             To add information to the beginning of the root element (if present) or without it,

docs/topics/supported-formats.topic

@@ -22,6 +22,9 @@
         <def title="jsonl">
             Generates feeds in JSON Lines format.
         </def>
+        <def title="csv">
+            Generates feeds in CSV format.
+        </def>
     </deflist>
 
     <p>

src/Converters/CsvConverter.php

@@ -0,0 +1,73 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DragonCode\LaravelFeed\Converters;
+
+use DragonCode\LaravelFeed\Feeds\Feed;
+use DragonCode\LaravelFeed\Feeds\Items\FeedItem;
+use DragonCode\LaravelFeed\Services\TransformerService;
+use Illuminate\Container\Attributes\Config;
+
+use function implode;
+use function is_array;
+
+class CsvConverter extends Converter
+{
+    public function __construct(
+        #[Config('feeds.converters.csv.delimiter')]
+        protected string $delimiter,
+        TransformerService $transformer
+    ) {
+        parent::__construct(false, $transformer);
+    }
+
+    public function header(Feed $feed): string
+    {
+        return '';
+    }
+
+    public function footer(Feed $feed): string
+    {
+        return '';
+    }
+
+    public function root(Feed $feed): string
+    {
+        return '';
+    }
+
+    public function item(FeedItem $item, bool $isLast): string
+    {
+        $data = $this->performItem($item->toArray());
+
+        return $this->toCsv($data);
+    }
+
+    public function info(array $info, bool $afterRoot): string
+    {
+        $data = $this->performItem($info);
+
+        return $this->toCsv($data);
+    }
+
+    protected function performItem(array $data): array
+    {
+        foreach ($data as &$value) {
+            if (is_array($value)) {
+                $value = $this->performItem($value);
+
+                continue;
+            }
+
+            $value = $this->transformValue($value);
+        }
+
+        return $data;
+    }
+
+    protected function toCsv(array $data): string
+    {
+        return implode($this->delimiter, $data);
+    }
+}

src/Converters/JsonLinesConverter.php

@@ -17,11 +17,9 @@ class JsonLinesConverter extends Converter
     public function __construct(
         #[Config('feeds.converters.jsonl.options')]
         protected int $options,
-        #[Config('feeds.pretty')]
-        bool $pretty,
         TransformerService $transformer
     ) {
-        parent::__construct($pretty, $transformer);
+        parent::__construct(false, $transformer);
 
         $this->options &= ~JSON_PRETTY_PRINT;
     }

src/Enums/FeedFormatEnum.php

@@ -9,4 +9,5 @@ enum FeedFormatEnum: string
     case Xml       = 'xml';
     case Json      = 'json';
     case JsonLines = 'jsonl';
+    case Csv       = 'csv';
 }

src/Feeds/Feed.php

@@ -43,10 +43,11 @@ public function chunkSize(): int
 
     public function header(): string
     {
-        return match ($this->format()) {
-            FeedFormatEnum::Xml => '<?xml version="1.0" encoding="UTF-8"?>',
-            default             => ''
-        };
+        if ($this->format() !== FeedFormatEnum::Xml) {
+            return '';
+        }
+
+        return '<?xml version="1.0" encoding="UTF-8"?>';
     }
 
     public function footer(): string

src/Helpers/ConverterHelper.php

@@ -5,6 +5,7 @@
 namespace DragonCode\LaravelFeed\Helpers;
 
 use DragonCode\LaravelFeed\Converters\Converter;
+use DragonCode\LaravelFeed\Converters\CsvConverter;
 use DragonCode\LaravelFeed\Converters\JsonConverter;
 use DragonCode\LaravelFeed\Converters\JsonLinesConverter;
 use DragonCode\LaravelFeed\Converters\XmlConverter;
@@ -20,6 +21,7 @@ public function get(FeedFormatEnum $format): Converter
             FeedFormatEnum::Xml       => app(XmlConverter::class),
             FeedFormatEnum::Json      => app(JsonConverter::class),
             FeedFormatEnum::JsonLines => app(JsonLinesConverter::class),
+            FeedFormatEnum::Csv       => app(CsvConverter::class),
         };
     }
 }

tests/.pest/snapshots/Feature/Feeds/Formats/Csv/DefaultTest/export_with_data_set____false__.snap

@@ -0,0 +1,3 @@
+1;Some 1;Some content 1;2025-09-04T04:08:12.000000Z;2025-09-04T04:08:12.000000Z
+2;Some 2;Some content 2;2025-09-04T04:08:12.000000Z;2025-09-04T04:08:12.000000Z
+3;Some 3;Some content 3;2025-09-04T04:08:12.000000Z;2025-09-04T04:08:12.000000Z