Refactor and enhance FlowSynx CSV Plugin

- Added support for a new `read` operation to convert structured data into CSV format.
- Refactored `CsvPlugin` to use `IPluginOperation` for modular operation handling.
- Introduced `FilterOperation`, `MapOperation`, and `ReadOperation` classes.
- Added parameter classes (`FilterParameters`, `MapParameters`, `ReadParameters`) with metadata annotations.
- Centralized CSV handling logic in the new `ParseDataHelper` class.
- Updated `README.md` with new examples, descriptions, and parameter details.
- Removed legacy classes (`InputParameter`, `ICsvOperationHandler`, and its implementations).
- Upgraded target framework to `net10.0` and updated dependencies.
- Improved code maintainability, extensibility, and usability.

#18

Author: ziagham

README.md

@@ -1,4 +1,4 @@
-# FlowSynx CSV Plugin
+## FlowSynx CSV Plugin
 
 The CSV Plugin is a pre-packaged, plug-and-play integration component for the FlowSynx engine. It enables reading from and writing to CSV files with configurable parameters such as file path, delimiter, headers, and encoding. Designed for FlowSynx’s no-code/low-code automation workflows, this plugin simplifies data extraction and transformation tasks.
 
@@ -15,18 +15,20 @@ The CSV Plugin allows FlowSynx users to:
 
 ## Supported Operations
 
+- **read**: Converts a structured object (e.g., rows from a database, in-memory objects) into CSV output using the provided parameters (e.g., delimiter, headers).  
 - **filter**: Filters rows in the CSV using defined `Filter` conditions. Supports logical operations (`and`, `or`) and common operators like `equals`, `contains`, `startsWith`, `endsWith`, `greaterThan`, and `lessThan`.  
 - **map**: Maps existing fields in the CSV to a new subset of keys or column arrangement for simplified output.
-- **read**: Reads the structured object (e.g., from database) and returns it as a CSV data.
+
+Minimum FlowSynx version: 1.3.0.
 
 ## Input Parameters
 
 The plugin accepts the following parameters:
 
-- `Operation` (string): **Required.** The type of operation to perform. Supported values are `filter` and `map`.  
-- `Data` (string/object): **Required.** The raw CSV string to process.  
+- `Operation` (string): Required. The type of operation to perform. Supported values are `read`, `filter`, and `map`.  
+- `Data` (string/object): Required. The input to process. For `filter` and `map`, provide a raw CSV string. For `read`, provide a structured object or rows to convert to CSV.  
 - `Delimiter` (string): Optional. Defaults to `,`. The character used to separate fields in the CSV.  
-- `Mappings` (list): **Required for `map` operation.** Defines which fields to include in the output.  
+- `Mappings` (list): Required for `map` operation. Defines which fields to include in the output.  
 - `IgnoreBlankLines` (bool): Optional. Specifies whether blank lines in the CSV should be ignored (`true`) or treated as data rows (`false`). Defaults to `true`.  
 - `HasHeader` (bool): Optional. Indicates if the first row of the CSV contains headers (`true`) or data (`false`). Defaults to `true`.  
 - `Filters` (object): Optional. Used with the `filter` operation to define filtering criteria.  
@@ -35,7 +37,6 @@ The plugin accepts the following parameters:
 
 ```json
 {
-  "Operation": "map",
   "Data": { ... },
   "Mappings": ["LastName", "Email"],
   "IgnoreBlankLines": true,
@@ -46,6 +47,19 @@ The plugin accepts the following parameters:
 
 ## Operation Examples
 
+### read Operation
+
+**Input Data (object):**
+
+```json
+{ 
+    "Data": [ /* csv string or structured rows */ ], 
+    "IgnoreBlankLines": true,
+    "HasHeader": true, 
+    "Delimiter": ","
+}
+```
+
 ### map Operation
 
 **Input Data:**
@@ -61,7 +75,6 @@ CustomerID,FirstName,LastName,Email,Phone,Country
 **Input Parameters:**
 ```json
 {
-  "Operation": "map",
   "Data": { ... },
   "Mappings": ["LastName", "Email"],
   "IgnoreBlankLines": true,
@@ -95,7 +108,6 @@ CustomerID,FirstName,LastName,Email,Phone,Country
 **Input Parameters:**
 ```json
 {
-  "Operation": "filter",
   "Data": { ... },
   "Filters": {
     "Logic": "and",

src/CsvPlugin.cs

@@ -1,21 +1,18 @@
 using FlowSynx.PluginCore.Helpers;
 using FlowSynx.PluginCore;
-using FlowSynx.Plugins.Csv.Models;
 using FlowSynx.PluginCore.Extensions;
 using FlowSynx.Plugins.Csv.Services;
-using CsvHelper.Configuration;
-using CsvHelper;
-using System.Globalization;
-using System.Dynamic;
+using FlowSynx.Plugins.Csv.Operations;
+using FlowSynx.Plugins.Csv.Parameters;
 
 namespace FlowSynx.Plugins.Csv;
 
-public class CsvPlugin: IPlugin
+public class CsvPlugin : IPlugin
 {
     private IPluginLogger? _logger;
     private readonly IGuidProvider _guidProvider;
     private readonly IReflectionGuard _reflectionGuard;
-    private CsvPluginSpecifications _csvSenderSpecifications = null!;
+    private CsvPluginSpecifications? _specifications = null;
     private bool _isInitialized;
 
     public CsvPlugin() : this(new GuidProvider(), new DefaultReflectionGuard()) { }
@@ -32,7 +29,7 @@ internal CsvPlugin(IGuidProvider guidProvider, IReflectionGuard reflectionGuard)
         Name = "Csv",
         CompanyName = "FlowSynx",
         Description = Resources.PluginDescription,
-        Version = new Version(1, 2, 3),
+        Version = new Version(1, 3, 0),
         Category = PluginCategory.Data,
         Authors = new List<string> { "FlowSynx" },
         Copyright = "© FlowSynx. All rights reserved.",
@@ -41,35 +38,40 @@ internal CsvPlugin(IGuidProvider guidProvider, IReflectionGuard reflectionGuard)
         RepositoryUrl = "https://github.com/flowsynx/plugin-csv",
         ProjectUrl = "https://flowsynx.io",
         Tags = new List<string>() { "flowSynx", "csv", "comma-separated-values", "data", "data-platform" },
-        MinimumFlowSynxVersion = new Version(1, 1, 1),
+        MinimumFlowSynxVersion = new Version(1, 3, 0),
     };
 
-    public PluginSpecifications? Specifications { get; set; }
+    public IPluginSpecifications? Specifications => _specifications;
 
-    public Type SpecificationsType => typeof(CsvPluginSpecifications);
-
-    private Dictionary<string, ICsvOperationHandler> OperationMap => new(StringComparer.OrdinalIgnoreCase)
+    public IReadOnlyCollection<IPluginOperation> SupportedOperations { get; } = new IPluginOperation[]
     {
-        ["read"] = new ReadOperationHandler(),
-        ["filter"] = new FilterOperationHandler(),
-        ["map"] = new MapOperationHandler()
+        new ReadOperation(),
+        new FilterOperation(),
+        new MapOperation()
     };
 
-    public IReadOnlyCollection<string> SupportedOperations => OperationMap.Keys;
-
-    public Task Initialize(IPluginLogger logger)
+    public Task InitializeAsync(IPluginLogger logger, IDictionary<string, object?>? specifications)
     {
         if (ReflectionHelper.IsCalledViaReflection())
             throw new InvalidOperationException(Resources.ReflectionBasedAccessIsNotAllowed);
 
-        ArgumentNullException.ThrowIfNull(logger);
-        _csvSenderSpecifications = Specifications.ToObject<CsvPluginSpecifications>();
-        _logger = logger;
+        _logger = logger ?? throw new ArgumentNullException(nameof(logger));
+
+        var csvSpecifications = new CsvPluginSpecifications();
+        if (specifications != null)
+            csvSpecifications.FromDictionary(specifications);
+
+        csvSpecifications.Validate();
+        _specifications = csvSpecifications;
+
         _isInitialized = true;
         return Task.CompletedTask;
     }
 
-    public async Task<object?> ExecuteAsync(PluginParameters parameters, CancellationToken cancellationToken)
+    public async Task<object?> ExecuteAsync(
+        string? operationName,
+        PluginParameters parameters, 
+        CancellationToken cancellationToken)
     {
         cancellationToken.ThrowIfCancellationRequested();
 
@@ -79,155 +81,22 @@ public Task Initialize(IPluginLogger logger)
         if (!_isInitialized)
             throw new InvalidOperationException($"Plugin '{Metadata.Name}' v{Metadata.Version} is not initialized.");
 
-        var inputParameter = parameters.ToObject<InputParameter>();
-        if (!OperationMap.TryGetValue(inputParameter.Operation, out var handler))
-        {
-            throw new NotSupportedException($"Operation '{inputParameter.Operation}' is not supported.");
-        }
-
-        var context = ParseDataToContext(inputParameter.Data);
-        var csv = ReadDataFromPluginContext(context, inputParameter);
-
-        using var reader = new StringReader(csv);
-        using var csvReader = new CsvReader(reader, new CsvConfiguration(CultureInfo.InvariantCulture)
-        {
-            Delimiter = inputParameter.Delimiter ?? ",",
-            IgnoreBlankLines = inputParameter.IgnoreBlankLines ?? true,
-            HasHeaderRecord = inputParameter.HasHeader ?? true,
-            TrimOptions = TrimOptions.Trim,
-            DetectColumnCountChanges = true,
-            BadDataFound = null
-        });
-
-        var records = csvReader.GetRecords<dynamic>().Select(row =>
-        {
-            var expando = new ExpandoObject() as IDictionary<string, object?>;
-            foreach (var kvp in (IDictionary<string, object?>)row)
-            {
-                expando[kvp.Key] = kvp.Value;
-            }
-            return (ExpandoObject)expando;
-        }).ToList();
-
-        var result = handler.Handle(records, inputParameter);
-        var csvString = await ToCsvStringAsync(result, inputParameter);
-
-        var structuredData = result
-            .Select(expando => ((IDictionary<string, object?>)expando)
-                .ToDictionary(kvp => kvp.Key, kvp => kvp.Value as object))
-            .ToList();
-
-        string filename = $"{_guidProvider.NewGuid()}.csv";
-        return new PluginContext(filename, "Data")
-        {
-            Format = "Csv",
-            Content = csvString,
-            StructuredData = structuredData
-        };
-    }
-
-    private PluginContext ParseDataToContext(object? data)
-    {
-        if (data is null)
-            throw new ArgumentNullException(nameof(data), "Input data cannot be null.");
+        var operation = SupportedOperations
+            .FirstOrDefault(op => string.Equals(op.Name, operationName, StringComparison.OrdinalIgnoreCase))
+            ?? throw new NotSupportedException($"Operation '{operationName}' is not supported.");
 
-        return data switch
+        return operation.Name.ToLowerInvariant() switch
         {
-            PluginContext singleContext => singleContext,
-            IEnumerable<PluginContext> => throw new NotSupportedException("List of PluginContext is not supported."),
-            string strData => new PluginContext(_guidProvider.NewGuid().ToString(), "Data") { Content = strData },
-            _ => throw new NotSupportedException("Unsupported input data format.")
-        };
-    }
+            "read" => await ((ReadOperation)operation)
+                            .ExecuteAsync(parameters.ToObject<ReadParameters>(), cancellationToken),
 
-    private string ReadDataFromPluginContext(PluginContext pluginContext, InputParameter inputParameter)
-    {
-        if (pluginContext.Content is not null)
-            return pluginContext.Content;
-        else if (pluginContext.StructuredData is not null)
-            return StructuredDataToCsv(pluginContext.StructuredData, inputParameter.Delimiter, inputParameter.HasHeader);
-        else
-            throw new InvalidDataException(string.Format(Resources.TheEnteredDataIsInvalid, pluginContext.Id));
-    }
+            "filter" => await ((FilterOperation)operation)
+                            .ExecuteAsync(parameters.ToObject<FilterParameters>(), cancellationToken),
 
-    private string StructuredDataToCsv(List<Dictionary<string, object>>? data, string? delimiter = ",", bool? hasHeader = true)
-    {
-        if (data == null || data.Count == 0)
-            return string.Empty;
+            "map" => await ((MapOperation)operation)
+                            .ExecuteAsync(parameters.ToObject<MapParameters>(), cancellationToken),
 
-        using var writer = new StringWriter();
-        var config = new CsvConfiguration(CultureInfo.InvariantCulture)
-        {
-            Delimiter = delimiter ?? ",",
-            HasHeaderRecord = hasHeader ?? true,
-            TrimOptions = TrimOptions.Trim,
-            DetectColumnCountChanges = true,
-            BadDataFound = null
+            _ => throw new InvalidOperationException($"Unsupported operation: {operation.Name}")
         };
-
-        using var csv = new CsvWriter(writer, config);
-
-        // Get all unique headers
-        var headers = data.SelectMany(d => d.Keys).Distinct().ToList();
-
-        // Write headers
-        foreach (var header in headers)
-        {
-            csv.WriteField(header);
-        }
-        csv.NextRecord();
-
-        // Write rows
-        foreach (var row in data)
-        {
-            foreach (var header in headers)
-            {
-                row.TryGetValue(header, out var value);
-                csv.WriteField(value);
-            }
-            csv.NextRecord();
-        }
-
-        return writer.ToString();
-    }
-
-    private async Task<string> ToCsvStringAsync(IEnumerable<ExpandoObject> records, InputParameter inputParameter)
-    {
-        using var writer = new StringWriter();
-        using var csvWriter = new CsvWriter(writer, new CsvConfiguration(CultureInfo.InvariantCulture)
-        {
-            Delimiter = inputParameter.Delimiter ?? ",",
-            IgnoreBlankLines = inputParameter.IgnoreBlankLines ?? true,
-            HasHeaderRecord = inputParameter.HasHeader ?? true,
-            TrimOptions = TrimOptions.Trim,
-            DetectColumnCountChanges = true,
-            BadDataFound = null
-        });
-
-        // Write header
-        var firstRecord = records.FirstOrDefault();
-        if (firstRecord is not null)
-        {
-            var headerRow = ((IDictionary<string, object?>)firstRecord).Keys;
-            foreach (var header in headerRow)
-            {
-                csvWriter.WriteField(header);
-            }
-            await csvWriter.NextRecordAsync();
-
-            // Write rows
-            foreach (var record in records)
-            {
-                var values = (IDictionary<string, object?>)record;
-                foreach (var value in values.Values)
-                {
-                    csvWriter.WriteField(value);
-                }
-                await csvWriter.NextRecordAsync();
-            }
-        }
-
-        await csvWriter.FlushAsync();
-        return writer.ToString();
     }
 }

src/CsvPluginSpecifications.cs

@@ -0,0 +1,11 @@
+using FlowSynx.PluginCore;
+
+namespace FlowSynx.Plugins.Csv;
+
+public class CsvPluginSpecifications : PluginSpecifications
+{
+    public override void Validate()
+    {
+
+    }
+}

src/FlowSynx.Plugins.Csv.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
 	<PropertyGroup>
-		<TargetFramework>net9.0</TargetFramework>
+		<TargetFramework>net10.0</TargetFramework>
 		<ImplicitUsings>enable</ImplicitUsings>
 		<Nullable>enable</Nullable>
 	</PropertyGroup>
@@ -13,7 +13,7 @@
 
 	<ItemGroup>
 		<PackageReference Include="CsvHelper" Version="33.1.0" />
-		<PackageReference Include="FlowSynx.PluginCore" Version="1.3.4" />
+		<PackageReference Include="FlowSynx.PluginCore" Version="1.3.5" />
 	</ItemGroup>
 
 	<ItemGroup>