- Version 5.0.0 check-in

Author: NinjaRocks

DeveloperGuide.md

@@ -110,7 +110,7 @@ public class File<T> where T: FileLine
 -------------
 
 
-**Case 2:** Let us see how we can parse a delimiter separted file with header and footer rows.
+**Case 2:** Let us see how we can parse a delimiter separted file with prefixed header, data and footer rows.
 ------------------------------------------------------------------------
 
 **Note:** This file will have rows with line head to determine each row type. By default, the line heads are 'H' for header, 'D' for data and 'F' for footer respectively. all these line heads are configurable via the config. 
@@ -131,13 +131,7 @@ The configuration is the same as before. We can override the default line heads
 ```
 {
     "configSettings":{
-        "parserSettings":{ "delimiter": { "value":"|"} ,
-                           "lineHeaders": { 
-                                "header":"H", 
-                                "footer":"F", 
-                                "data":"D" 
-                            }
-        },
+        "parserSettings":{ "delimiter": { "value":"|"} },
         "providerSettings":{
                         "folderPath":"C:work",
                         "fileNameFormat":"File*.txt",
@@ -154,21 +148,49 @@ The configuration is the same as before. We can override the default line heads
 Like before we need a line class to map to each type of the row in the file
 ie one for the header, footer and data line respectively.
 
+However, this time we derive from `PrefixedFileLine` class instead of `FileLine` class.
+The `PrefixedFileLine` class has an extra property called `Prefix` which is used to determine the type of the line.
+The prefix is set to the first column of the row by default.
+
 We continue by creating two extra classes HeaderLine and FooterLine as follows.
 
-     public class Header : FileLine
-        {
-            [Column(0)]
-            public string Name { get; set; }
-            [Column(1)]
-            public DateTime Date { get; set; }
-        } 
+    public class Header : PrefixedFileLine
+    {
+        public override string Prefix => "H";
+
+        [Column(0)]
+        public LineType Type { get; set; }
+        [Column(1)]
+        public string Name { get; set; }
+        [Column(2)]
+        public DateTime Date { get; set; }
+    }
 
-     public class Footer : FileLine
-        {
-            [Column(0)]
-            public string FileRemarks { get; set; }
-        } 
+    public class Employee : PrefixedFileLine
+    {
+        public override string Prefix => "D";
+
+        [Column(0)]
+        public LineType Type { get; set; }
+        [Column(1)]
+        public string Title { get; set; }
+        [Column(2)]
+        public string Name { get; set; }
+        [Column(3)]
+        public string Sex { get; set; }
+        [Column(4, "London")]
+        public string Location { get; set; }
+    } 
+
+    public class Footer : FileLine
+    {
+        public override string Prefix => "F";
+
+        [Column(0)]
+        public LineType Type { get; set; }
+        [Column(1)]
+        public string FileRemarks { get; set; }
+    } 
 
 
 To parse the file you call the GetFiles() Method as follows -

FileUtil.Core.sln

@@ -11,8 +11,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "FileUtil.Tests", "test\File
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".github", ".github", "{D549CC35-5318-45B0-ACCD-F28C543E482C}"
 	ProjectSection(SolutionItems) = preProject
-		.github\workflows\Master-Build.yml = .github\workflows\Master-Build.yml
 		.github\workflows\CI-Package-Release.yml = .github\workflows\CI-Package-Release.yml
+		.github\workflows\Master-Build.yml = .github\workflows\Master-Build.yml
 		.github\workflows\Master-CodeQL.yml = .github\workflows\Master-CodeQL.yml
 		.github\workflows\PR-CodeQL.yml = .github\workflows\PR-CodeQL.yml
 	EndProjectSection
@@ -25,6 +25,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".misc", ".misc", "{8EDBC8F3
 	ProjectSection(SolutionItems) = preProject
 		.gitattributes = .gitattributes
 		.gitignore = .gitignore
+		DeveloperGuide.md = DeveloperGuide.md
 		GitVersion.yml = GitVersion.yml
 		License.md = License.md
 		nuget.config = nuget.config

src/FileUtil/ColumnAttribute.cs

@@ -3,6 +3,5 @@ namespace FileUtil.Configuration
     public interface IParserSettings
     {
         IDelimiter Delimiter { get; set; }
-        ILineHeaders LineHeaders { get; set; }
     }
 }

src/FileUtil/Configuration/IParserSettings.cs

@@ -1,21 +1,21 @@
+using System.Collections.Generic;
 using System.Linq;
 using FileUtil.Configuration;
-using FileUtil.Parser;
-using FileUtil.Parser.Impl;
 using FileUtil.Provider;
 using FileUtil.Provider.Impl;
+using parsley;
 
 namespace FileUtil
 {
     public class Engine
     {
         private readonly IFileProvider fileProvider;
-        private readonly ILineParser lineParser;
+        private readonly IParser parser;
 
-        internal Engine(ILineParser lineParser, IFileProvider fileProvider)
+        internal Engine(IParser parser, IFileProvider fileProvider)
         {
             this.fileProvider = fileProvider;
-            this.lineParser = lineParser;
+            this.parser = parser;
         }
 
         /// <summary>
@@ -26,7 +26,7 @@ internal Engine(ILineParser lineParser, IFileProvider fileProvider)
         /// </remarks>
         /// <param name="settings">Configuration settings for default file provider and parser</param>
         public Engine(IConfigSettings settings)
-            : this(new LineParser(settings.ParserSettings), new DefaulProvider(settings.ProviderSettings, new FileHelper()))
+            : this(new Parser((settings?.ParserSettings?.Delimiter?.Value).GetValueOrDefault(',')), new DefaulProvider(settings.ProviderSettings, new FileHelper()))
         {
         }
 
@@ -36,7 +36,7 @@ public Engine(IConfigSettings settings)
         /// <param name="parserSettings">Parser settings.</param>
         /// <param name="fileProvider">Custom file provider instance.</param>
         public Engine(IParserSettings parserSettings, IFileProvider fileProvider)
-            : this(new LineParser(parserSettings), fileProvider)
+            : this(new Parser((parserSettings?.Delimiter?.Value).GetValueOrDefault(',')), fileProvider)
         {
         }
 
@@ -64,9 +64,8 @@ public Engine(IParserSettings parserSettings, IFileProvider fileProvider)
                     Lines = file.Lines,
                 },
 
-                Data = lineParser.Parse<T>(file.Lines)
-            })
-                .ToArray();
+                Data = parser.Parse<T>(file.Lines)
+            }).ToArray();
         }
 
         /// <summary>
@@ -88,14 +87,18 @@ public Engine(IParserSettings parserSettings, IFileProvider fileProvider)
         /// Collection of Files each parsed with header, footer and data typed arrays
         /// </returns>
         public File<TH, TD, TF>[] GetFiles<TH, TD, TF>()
-            where TH : FileLine, new()
-            where TD : FileLine, new()
-            where TF : FileLine, new()
+            where TH : PrefixedFileLine, new()
+            where TD : PrefixedFileLine, new()
+            where TF : PrefixedFileLine, new()
         {
             var files = fileProvider.GetFiles();
 
             return files.Select(file =>
             {
+                var headerLines = file.Lines.Where(line => line.StartsWith(new TH().Prefix)).ToArray();
+                var footerLines = file.Lines.Where(line => line.StartsWith(new TF().Prefix)).ToArray();
+                var dataLines = file.Lines.Where(line => line.StartsWith(new TD().Prefix)).ToArray();
+
                 var parsed = new File<TH, TD, TF>
                 {
                     FileMeta = new FileMeta
@@ -106,9 +109,9 @@ public File<TH, TD, TF>[] GetFiles<TH, TD, TF>()
                         Lines = file.Lines,
                     },
 
-                    Header = lineParser.Parse<TH>(file.Lines, LineType.Header).FirstOrDefault(),
-                    Footer = lineParser.Parse<TF>(file.Lines, LineType.Footer).FirstOrDefault(),
-                    Data = lineParser.Parse<TD>(file.Lines, LineType.Data)
+                    Header = parser.Parse<TH>(headerLines).FirstOrDefault(),
+                    Data = parser.Parse<TD>(dataLines).ToArray(),
+                    Footer = parser.Parse<TF>(footerLines).FirstOrDefault()
                 };
 
                 return parsed;

src/FileUtil/Engine.cs

@@ -1,34 +1,37 @@
-namespace FileUtil
+namespace FileUtil
 {
     public class File<T> where T : FileLine
     {
         /// <summary>
         /// File meta data.
         /// </summary>
         public FileMeta FileMeta { get; set; }
+
         /// <summary>
         /// Strongly typed parsed lines.
         /// </summary>
         public T[] Data { get; set; }
-
     }
 
-    public class File<TH, TD, TF> where TH : FileLine, new()
-                                  where TD : FileLine, new()
-                                  where TF : FileLine, new()
+    public class File<TH, TD, TF> where TH : PrefixedFileLine, new()
+                                  where TD : PrefixedFileLine, new()
+                                  where TF : PrefixedFileLine, new()
     {
         /// <summary>
         /// File meta data.
         /// </summary>
         public FileMeta FileMeta { get; set; }
+
         /// <summary>
         /// Parsed header line.
         /// </summary>
         public TH Header { get; set; }
+
         /// <summary>
         /// Parsed data lines.
         /// </summary>
         public TD[] Data { get; set; }
+
         /// <summary>
         /// Parsed footer line.
         /// </summary>
@@ -41,14 +44,17 @@ public class FileMeta
         /// File Path
         /// </summary>
         public string FilePath { get; set; }
+
         /// <summary>
         /// File Name
         /// </summary>
         public string FileName { get; set; }
+
         /// <summary>
         /// File Size
         /// </summary>
         public long FileSize { get; set; }
+
         /// <summary>
         /// Raw lines in the file (not parsed).
         /// </summary>

src/FileUtil/File.cs

@@ -1,4 +1,5 @@
 using System.Collections.Generic;
+using parsley;
 
 namespace FileUtil
 {
@@ -10,7 +11,6 @@ protected FileLine()
         }
 
         public int Index { get; set; }
-        public LineType Type { get; set; }
         public IList<string> Errors { get; set; }
     }
 }

src/FileUtil/FileLine.cs

@@ -41,4 +41,7 @@ Example: pipe delimited, csv, tsv, etc.</Description>
       <PackagePath>\</PackagePath>
     </None>
   </ItemGroup>
+  <ItemGroup>
+    <PackageReference Include="Parsley.Net" Version="1.0.0" />
+  </ItemGroup>
 </Project>