40 not all required fields in result model using read validation are be considered (#44)

* Add all missing field in error file.

* Handling Enums

* even if the result is filled with lots of data but the result model only have a few properties it still should map it.

* Always skip validation, only validate when beeing asked to.

---------

Co-authored-by: Tino Klijn <tino@dotnet2web.nl>

Author: DotNet2Web

CsvCore.Specs/CsvCoreReaderSpecs.cs

@@ -547,6 +547,7 @@ public void
         var result = csvCoreReader
             .UseDelimiter(';')
             .WithoutHeader()
+            .Validate()
             .Read<ZeroBasedNotMatchingPersonModel>(filePath);
 
         // Assert
@@ -615,6 +616,7 @@ public void Should_Validate_The_Input_When_Reading_The_Csv_File()
 
         // Act
         var result = csvCoreReader
+            .Validate()
             .Read<PersonModel>(filePath).ToList();
 
         // Assert
@@ -669,6 +671,7 @@ public void Should_Write_An_ErrorFile_Without_Using_The_WriteErrorsAt_Method()
 
         // Act
         var result = csvCoreReader
+            .Validate()
             .Read<PersonModel>(filePath).ToList();
 
         // Assert
@@ -732,6 +735,7 @@ public void Should_Validate_The_Input_When_Reading_The_Csv_File_And_Write_An_Err
         // Act
         var result = csvCoreReader
             .SetErrorPath(errorLocation)
+            .Validate()
             .Read<PersonModel>(filePath).ToList();
 
         // Assert
@@ -877,7 +881,6 @@ public void Should_Generate_A_Full_Model_With_Invalid_Records_When_Reading_The_C
 
         // Act
         var result = csvCoreReader
-            .SkipValidation()
             .Read<PersonModel>(filePath).ToList();
 
         // Assert
@@ -1063,6 +1066,7 @@ public void Should_Add_All_Missing_Required_Fields_Into_Error_File_When_Data_Is_
         // Act
         var result = csvCoreReader
             .UseDelimiter(';')
+            .Validate()
             .Read<CarResultModel>(filePath);
 
         // Assert
@@ -1094,4 +1098,48 @@ public void Should_Add_All_Missing_Required_Fields_Into_Error_File_When_Data_Is_
         // Cleanup
         FileHelper.DeleteTestFile(filePath);
     }
+
+    [Fact]
+    public void Should_Read_Provided_Csv_File_When_The_Result_Model_Contains_Only_A_Set_Of_Properties()
+    {
+        // Arrange
+        var csvCoreReader = new CsvCoreReader();
+        var directory = Directory.GetCurrentDirectory();
+
+        var filePath = Path.Combine(directory, new Faker().System.FileName(CsvExtension));
+
+        File.Create(filePath).Dispose();
+
+        var cars = new Faker<CsvCarContentModel>()
+            .RuleFor(c => c.Id, faker => faker.Vehicle.Random.Guid().ToString())
+            .RuleFor(c => c.Manufacturer, faker => faker.Vehicle.Manufacturer().ToString())
+            .RuleFor(c => c.Model, faker => faker.Vehicle.Model().ToString())
+            .RuleFor(c => c.Vin, faker => faker.Vehicle.Vin().ToString())
+            .RuleFor(c => c.YearOfConstruction, faker => faker.Date.Past().Year.ToString())
+            .RuleFor(c => c.Mileage, faker => faker.Vehicle.Random.Int(0, 100_000).ToString())
+            .RuleFor(c => c.Fuel, faker => faker.Random.Int(0, 3).ToString())
+            .Generate(1);
+
+        var csvCoreWriter = new CsvCoreWriter();
+        csvCoreWriter
+            .UseDelimiter(';')
+            .Write(filePath, cars);
+
+        // Act
+        var result = csvCoreReader
+            .UseDelimiter(';')
+            .Read<CarWithOnlyAFewColumnsSelectedModel>(filePath);
+
+        // Assert
+        var convertedCar = result.ToList();
+        convertedCar.Count.Should().Be(1);
+
+        convertedCar.First().Id.Should().Be(cars[0].Id);
+        convertedCar.First().Manufacturer.Should().Be(cars[0].Manufacturer);
+        convertedCar.First().Model.Should().Be(cars[0].Model);
+        convertedCar.First().Mileage.Should().Be(int.Parse(cars[0].Mileage));
+
+        // Cleanup
+        FileHelper.DeleteTestFile(filePath);
+    }
 }

CsvCore.Specs/Models/CarWithOnlyAFewColumnsSelectedModel.cs

@@ -0,0 +1,14 @@
+using System;
+
+namespace CsvCore.Specs.Models;
+
+public class CarWithOnlyAFewColumnsSelectedModel
+{
+    public Guid Id { get; set; }
+
+    public string Manufacturer { get; set; }
+
+    public string Model { get; set; }
+
+    public int Mileage { get; set; }
+}

CsvCore/Documentation/CsvCoreReader.md

@@ -84,11 +84,27 @@ When you have the model all setup use the `CsvCoreReader` to read the csv file,
 
 ### Validations
 
-Ofcourse you will receive csv files that are not valid, so we added some validations to the reader.
+Ofcourse you will receive csv files that are not valid.
 
-We will validate the data before adding them to the result models, any record that cant be parsed correctly will be added to errors.csv file.
+By default `CsvCoreReader` won't validate the data, it just reads the csv file and maps the data to your model.
+If you want `CsvCoreReader` to validate the data, you can use the `Validate` method.
 
-The file will be stored at the location your application will be run. The filename will be the same as the original file, but we just add `_errors` to it.
+### Example
+
+```csharp
+   var result = csvCoreReader
+       .Validate()
+       .Read<ResultModel>(Path.Combine("AnyPath", "YourFile.csv"));
+```
+
+This will validate the data before it adds the line into the result model. If the data is not valid, it will be added to the errors.csv file.
+The reader will return a list with valid objects and the errors will be written to the errors.csv file as described in the next section.
+
+**A little note:**
+- _If you have a non-nullable dateonly / datetime property in your model, and the csv file contains a null value, the reader will set these properties to their MinValues._
+
+When using the `Validate` method, the reader will create a file called `<originalfilename>_errors.csv` in the same location as your application is run.
+The filename will be the same as the original file, but we just add `_errors.csv` to it.
 
 If you need those error files to be written somewhere else simply use the `.SetErrorPath("AnyPath")` method on the reader
 
@@ -126,20 +142,3 @@ The `IsValid` method will return a `List<ValidationModel>` containing:
 - The reason why the data could not be parsed stored in the error message property
 
 This could be handy in numerous ways.
-
-And how about skipping the validation. If you want to skip the validation, you can use the `SkipValidation` method.
-### Example
-
-```csharp
-   var result = csvCoreReader
-       .SkipValidation()
-       .Read<ResultModel>(Path.Combine("AnyPath", "YourFile.csv"));
-```
-
-This will skip the validation and read the csv file without validating the data.
-The result will be a list of `ResultModel` objects, but the data will not be validated.
-
-**A little note about the validation:**
-- _If you have a non-nullable dateonly / datetime property in your model, and the csv file contains a null value, the reader will set these properties to their MinValues._
-
-This way you can do whatever you want with the result.

CsvCore/Documentation/CsvCoreWriter.md

@@ -21,6 +21,7 @@ public class PersonModel
 
     public string Email { get; set; }
 }
+```
 
 ```csharp
 public class Foo(ICsvCoreWriter csvCoreWriter)

CsvCore/Reader/CsvCoreReader.cs

@@ -14,7 +14,7 @@ public class CsvCoreReader : ICsvCoreReader
     private string? delimiter;
     private bool hasHeaderRecord = true;
     private string errorFolderPath = Path.Combine(Directory.GetCurrentDirectory(), "Errors");
-    private bool skipValidation;
+    private bool validate;
     private string? dateTimeFormat;
 
     /// <summary>
@@ -69,9 +69,9 @@ public CsvCoreReader SetDateTimeFormat(string format)
     /// Use this method to tell us that the CSV file does not have a header record.
     /// </summary>
     /// <returns></returns>
-    public CsvCoreReader SkipValidation()
+    public CsvCoreReader Validate()
     {
-        skipValidation = true;
+        validate = true;
         return this;
     }
 
@@ -232,7 +232,7 @@ private IEnumerable<ValidationModel> GenerateModelBasedOnHeader<T>(List<string>
                 continue;
             }
 
-            if (!skipValidation)
+            if (validate)
             {
                 var validationResult = validationHelper.Validate(record[i], property, rowNumber, dateTimeFormat);
 
@@ -279,7 +279,7 @@ private IEnumerable<ValidationModel> GenerateModel<T>(string[] record, T target,
 
             var index = DetermineIndex(property, startPosition, i);
 
-            if (!skipValidation)
+            if (validate)
             {
                 var validationResult = validationHelper.Validate(record[index], property, rowNumber, dateTimeFormat);
 

CsvCore/Reader/ICsvCoreReader.cs

@@ -10,7 +10,7 @@ public interface ICsvCoreReader
 
     CsvCoreReader SetDateTimeFormat(string format);
 
-    CsvCoreReader SkipValidation();
+    CsvCoreReader Validate();
 
     IEnumerable<T> Read<T>(string filePath) where T : class;
 }