Make static ParsedFile.Queue<IParsedLine> ParseFile() private (#169)

eduherminio · web-flow · commit 3ac2aacf5cbb · 2023-12-02T19:55:26.000+01:00
diff --git a/src/FileParser/Implementations/ParsedFile.cs b/src/FileParser/Implementations/ParsedFile.cs
@@ -44,9 +44,7 @@ public ParsedFile(string path, char[] existingSeparator, bool ignoreEmptyItems =
         /// <param name="existingSeparator">Word separator (space by default)</param>
         /// <param name="ignoreEmptyItems"></param>
         public ParsedFile(string path, string? existingSeparator = null, bool ignoreEmptyItems = true)
-#pragma warning disable CS0618 // Type or member is obsolete - will keep it as private
-            : base(ParseFile(path, existingSeparator, ignoreEmptyItems))
-#pragma warning restore CS0618 // Type or member is obsolete
+            : base(ParseFile(path, ignoreEmptyItems, existingSeparator))
         {
         }
 
@@ -76,7 +74,7 @@ public IParsedLine LastLine()
 
         public List<T> ToList<T>(string? lineSeparatorToAdd = null)
         {
-            List<T> list = new();
+            List<T> list = [];
 
             if (!string.IsNullOrEmpty(lineSeparatorToAdd))
             {
@@ -132,7 +130,7 @@ public static List<List<string>> ReadAllGroupsOfLines(string path)
                     {
                         if (currentGroup.Count != 0)
                         {
-                            currentGroup = new List<string>();
+                            currentGroup = [];
                             result.Add(currentGroup);
                         }
                     }
@@ -182,7 +180,7 @@ public static List<List<T>> ReadAllGroupsOfLines<T>(string path)
                     {
                         if (currentGroup.Count != 0)
                         {
-                            currentGroup = new List<T>();
+                            currentGroup = [];
                             result.Add(currentGroup);
                         }
                     }
@@ -208,16 +206,15 @@ public static List<List<T>> ReadAllGroupsOfLines<T>(string path)
         /// Queue&lt;IParsedLine&gt; ~~ Queues of 'words' inside of a queue of lines
         /// </summary>
         /// <param name="path"></param>
-        /// <param name="existingSeparator">Word separator</param>
         /// <param name="ignoreEmptyItems"></param>
+        /// <param name="existingSeparator">Word separator</param>
         /// <exception cref="FileNotFoundException"></exception>
         /// <exception cref="DirectoryNotFoundException"></exception>
         /// <exception cref="IOException"></exception>
         /// <exception cref="ArgumentException"></exception>
         /// <exception cref="ArgumentNullException"></exception>
         /// <returns></returns>
-        [Obsolete("This method exposes internal functionality and was made public accidentally. It will be removed in next major release, please used ParsedFile constructor instead.")]
-        public static Queue<IParsedLine> ParseFile(string path, string? existingSeparator = null, bool ignoreEmptyItems = true)
+        private static Queue<IParsedLine> ParseFile(string path, bool ignoreEmptyItems, string? existingSeparator = null)
         {
             Queue<IParsedLine> parsedFile = new();
 
diff --git a/src/FileParser/Implementations/ParsedLine.cs b/src/FileParser/Implementations/ParsedLine.cs
@@ -62,7 +62,7 @@ public T LastElement<T>()
 
         public List<T> ToList<T>()
         {
-            List<T> list = new();
+            List<T> list = [];
 
             while (!Empty)
             {
diff --git a/src/FileParser/Utils/TypeValidator.cs b/src/FileParser/Utils/TypeValidator.cs
@@ -5,8 +5,8 @@ internal static class TypeValidator
     /// <summary>
     /// Supported parsing conversions
     /// </summary>
-    private static HashSet<Type> SupportedTypes { get; } = new HashSet<Type>()
-    {
+    private static HashSet<Type> SupportedTypes { get; } =
+    [
         typeof(bool),
         typeof(char),
         typeof(string),
@@ -18,13 +18,13 @@ internal static class TypeValidator
         typeof(long),
         typeof(double),
         typeof(object)
-    };
+    ];
 
     internal static void ValidateSupportedType<T>()
     {
         if (!SupportedTypes.Contains(typeof(T)))
         {
-            throw new NotSupportedException("Parsing to " + typeof(T).ToString() + "is not supported yet");
+            throw new NotSupportedException("Parsing to " + typeof(T) + "is not supported yet");
         }
     }
 }
diff --git a/tests/FileParser.Test/ParsedFileTest/ExtractTests.cs b/tests/FileParser.Test/ParsedFileTest/ExtractTests.cs
@@ -11,7 +11,7 @@ public void CustomLineParse()
             const string fileName = "CustomLineParse.txt";
             const string sampleContent = "  3  1154 508 100    vegetable ";
 
-            List<long> expectedList = new() { 1154, 508, 100 };
+            List<long> expectedList = [1154, 508, 100];
             const string expectedString = "vegetable";
 
             using (StreamWriter writer = new(fileName))
@@ -54,8 +54,8 @@ public void ExtractChar()
                 writer.WriteLine(line2);
             }
 
-            IParsedFile file = new ParsedFile(fileName);
-            IParsedLine firstParsedLine = file.NextLine();
+            var file = new ParsedFile(fileName);
+            var firstParsedLine = file.NextLine();
             int nLines = Convert.ToInt32(Math.Floor(firstParsedLine.NextElement<double>())) - 1;
             for (int iLine = 0; iLine < nLines; ++iLine)
             {
@@ -89,7 +89,7 @@ public void MultipleCharWordSeparator()
                 writer.WriteLine(line2);
             }
 
-            IParsedFile file = new ParsedFile(fileName, "||");
+            var file = new ParsedFile(fileName, "||");
 
             int index = 0;
             var line = file.NextLine();
@@ -122,7 +122,7 @@ public void ParseCsvFileIntoStrings()
                 writer.WriteLine(line4);
             }
 
-            IParsedFile file = new ParsedFile(fileName, ",", ignoreEmptyItems: false);
+            var file = new ParsedFile(fileName, ",", ignoreEmptyItems: false);
 
             var headerLine = file.NextLine();
             var buckets = new List<List<string>>(headerLine.ToList<string>().Select(header => new List<string>(1000) { ModifyString(header) }));
@@ -138,10 +138,17 @@ public void ParseCsvFileIntoStrings()
 
             static string ModifyString(string str) => str.ToLowerInvariant();
 
-            Assert.Equal(new[] { "firstname", "john", "cthulhu", "bugs" }, buckets[0]);
-            Assert.Equal(new[] { "lastname", "doe", "", "bunny" }, buckets[1]);
-            Assert.Equal(new[] { "age", "66", "1000", "33" }, buckets[2]);
-            Assert.Equal(new[] { "eyecolor", "brown", "black", "white" }, buckets[3]);
+            string[] expected = ["firstname", "john", "cthulhu", "bugs"];
+            Assert.Equal(expected, buckets[0]);
+
+            string[] expected1 = ["lastname", "doe", "", "bunny"];
+            Assert.Equal(expected1, buckets[1]);
+
+            string[] expected2 = ["age", "66", "1000", "33"];
+            Assert.Equal(expected2, buckets[2]);
+
+            string[] expected3 = ["eyecolor", "brown", "black", "white"];
+            Assert.Equal(expected3, buckets[3]);
         }
 
         [Fact]
@@ -161,7 +168,7 @@ public void ParseCsvFile()
                 writer.WriteLine(line4);
             }
 
-            IParsedFile file = new ParsedFile(fileName, ",", ignoreEmptyItems: false);
+            var file = new ParsedFile(fileName, ",", ignoreEmptyItems: false);
 
             file.NextLine();
 

Original file line number	Diff line number	Diff line change
`@@ -44,9 +44,7 @@ public ParsedFile(string path, char[] existingSeparator, bool ignoreEmptyItems =`
`44`	`44`	`/// <param name="existingSeparator">Word separator (space by default)</param>`
`45`	`45`	`/// <param name="ignoreEmptyItems"></param>`
`46`	`46`	`public ParsedFile(string path, string? existingSeparator = null, bool ignoreEmptyItems = true)`
`47`		`-#pragma warning disable CS0618 // Type or member is obsolete - will keep it as private`
`48`		`- : base(ParseFile(path, existingSeparator, ignoreEmptyItems))`
`49`		`-#pragma warning restore CS0618 // Type or member is obsolete`
	`47`	`+ : base(ParseFile(path, ignoreEmptyItems, existingSeparator))`
`50`	`48`	`{`
`51`	`49`	`}`
`52`	`50`
`@@ -76,7 +74,7 @@ public IParsedLine LastLine()`
`76`	`74`
`77`	`75`	`public List<T> ToList<T>(string? lineSeparatorToAdd = null)`
`78`	`76`	`{`
`79`		`- List<T> list = new();`
	`77`	`+ List<T> list = [];`
`80`	`78`
`81`	`79`	`if (!string.IsNullOrEmpty(lineSeparatorToAdd))`
`82`	`80`	`{`
`@@ -132,7 +130,7 @@ public static List<List<string>> ReadAllGroupsOfLines(string path)`
`132`	`130`	`{`
`133`	`131`	`if (currentGroup.Count != 0)`
`134`	`132`	`{`
`135`		`- currentGroup = new List<string>();`
	`133`	`+ currentGroup = [];`
`136`	`134`	`result.Add(currentGroup);`
`137`	`135`	`}`
`138`	`136`	`}`
`@@ -182,7 +180,7 @@ public static List<List<T>> ReadAllGroupsOfLines<T>(string path)`
`182`	`180`	`{`
`183`	`181`	`if (currentGroup.Count != 0)`
`184`	`182`	`{`
`185`		`- currentGroup = new List<T>();`
	`183`	`+ currentGroup = [];`
`186`	`184`	`result.Add(currentGroup);`
`187`	`185`	`}`
`188`	`186`	`}`
`@@ -208,16 +206,15 @@ public static List<List<T>> ReadAllGroupsOfLines<T>(string path)`
`208`	`206`	`/// Queue<IParsedLine> ~~ Queues of 'words' inside of a queue of lines`
`209`	`207`	`/// </summary>`
`210`	`208`	`/// <param name="path"></param>`
`211`		`- /// <param name="existingSeparator">Word separator</param>`
`212`	`209`	`/// <param name="ignoreEmptyItems"></param>`
	`210`	`+ /// <param name="existingSeparator">Word separator</param>`
`213`	`211`	`/// <exception cref="FileNotFoundException"></exception>`
`214`	`212`	`/// <exception cref="DirectoryNotFoundException"></exception>`
`215`	`213`	`/// <exception cref="IOException"></exception>`
`216`	`214`	`/// <exception cref="ArgumentException"></exception>`
`217`	`215`	`/// <exception cref="ArgumentNullException"></exception>`
`218`	`216`	`/// <returns></returns>`
`219`		`- [Obsolete("This method exposes internal functionality and was made public accidentally. It will be removed in next major release, please used ParsedFile constructor instead.")]`
`220`		`- public static Queue<IParsedLine> ParseFile(string path, string? existingSeparator = null, bool ignoreEmptyItems = true)`
	`217`	`+ private static Queue<IParsedLine> ParseFile(string path, bool ignoreEmptyItems, string? existingSeparator = null)`
`221`	`218`	`{`
`222`	`219`	`Queue<IParsedLine> parsedFile = new();`
`223`	`220`
Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ public T LastElement<T>()`
`62`	`62`
`63`	`63`	`public List<T> ToList<T>()`
`64`	`64`	`{`
`65`		`- List<T> list = new();`
	`65`	`+ List<T> list = [];`
`66`	`66`
`67`	`67`	`while (!Empty)`
`68`	`68`	`{`
Original file line number	Diff line number	Diff line change
`@@ -5,8 +5,8 @@ internal static class TypeValidator`
`5`	`5`	`/// <summary>`
`6`	`6`	`/// Supported parsing conversions`
`7`	`7`	`/// </summary>`
`8`		`- private static HashSet<Type> SupportedTypes { get; } = new HashSet<Type>()`
`9`		`- {`
	`8`	`+ private static HashSet<Type> SupportedTypes { get; } =`
	`9`	`+ [`
`10`	`10`	`typeof(bool),`
`11`	`11`	`typeof(char),`
`12`	`12`	`typeof(string),`
`@@ -18,13 +18,13 @@ internal static class TypeValidator`
`18`	`18`	`typeof(long),`
`19`	`19`	`typeof(double),`
`20`	`20`	`typeof(object)`
`21`		`- };`
	`21`	`+ ];`
`22`	`22`
`23`	`23`	`internal static void ValidateSupportedType<T>()`
`24`	`24`	`{`
`25`	`25`	`if (!SupportedTypes.Contains(typeof(T)))`
`26`	`26`	`{`
`27`		`- throw new NotSupportedException("Parsing to " + typeof(T).ToString() + "is not supported yet");`
	`27`	`+ throw new NotSupportedException("Parsing to " + typeof(T) + "is not supported yet");`
`28`	`28`	`}`
`29`	`29`	`}`
`30`	`30`	`}`