IO Enhancement

CommonsLibrary/CommonsLibrary.csproj

@@ -5,7 +5,7 @@
     <ImplicitUsings>disable</ImplicitUsings>
     <Nullable>enable</Nullable>
     <Title>C# Commons Library</Title>
-    <Version>5.0.0</Version>
+    <Version>6.0.0</Version>
     <Authors>Alex O'Brien</Authors>
     <PackageProjectUrl>https://github.com/alex8obrien/CommonsLibrary</PackageProjectUrl>
     <PackageReadmeFile>README.md</PackageReadmeFile>

CommonsLibrary/FileIO.cs

@@ -85,5 +85,30 @@ public static string LineAt(string filePath, int lineNumber) =>
         /// <exception cref="System.Security.SecurityException">The caller does not have the required permission.</exception>
         public static int TotalChars(string filePath) =>
             File.ReadAllLines(FilePath + filePath).Sum(line => line.Length);
+
+        /// <summary>This method will write a set of data to a file using delimiters</summary>
+        /// <param name="data">The data to be written to the file</param>
+        /// <param name="delimiter">A delimiter used to separate data in the file.</param>
+        /// <param name="path">The path of the CSV file.</param>
+        public static void SaveCSV(string[,] data, string delimiter, string path)
+        {
+            if (!File.Exists(path))
+                throw new FileNotFoundException();
+
+            using (StreamWriter writer = new(path))
+            {
+                for (int i = 0; i < data.GetLength(0); i++)
+                {
+                    for (int j = 0; j < data.GetLength(1); j++)
+                    {
+                        writer.Write(data[i, j]);
+
+                        if (j != data.GetLength(1) - 1)
+                            writer.Write(delimiter);
+                    }
+                    writer.WriteLine();
+                }
+            }
+        }
     }
 }

CommonsLibrary/README.md

@@ -14,6 +14,7 @@ This is my commons library for all of my personal C# projects.
 - [Maths library](https://github.com/alex8obrien/CommonsLibrary/tree/master/CommonsLibrary.Maths)
 
 ## Contributors
+
 - [Alex O'Brien](https://github.com/alex8obrien)
 
-### *Licensed under the MIT License, Find it [here](https://github.com/alex8obrien/CommonsLibrary/blob/master/LICENSE.md)*
+### *Licensed under the MIT License, Find it [here](https://github.com/alex8obrien/CommonsLibrary/blob/master/LICENSE.md)*

CommonsLibrary/StdInp.cs

@@ -3,6 +3,7 @@
 namespace CommonsLibrary
 {
     /// <summary>This class can return input from the console.</summary>
+    /// <remarks>Requires the 'System.Console' package.</remarks>
     public static class StdInp
     {
         /// <summary>Used to retrieve a string input from the console.</summary>
@@ -67,5 +68,16 @@ public static bool InputYNAsBool(string msg)
 
             return inp is "Y" or "YES";
         }
+
+        /// <summary>Converts user input to a delimited string array.</summary>
+        /// <param name="msg">The input message displayed to the user.</param>
+        /// <param name="delimiter">The delimiter used to separate the string.</param>
+        /// <returns>A string array created from user input.</returns>
+        public static string[] InputDelimitedArray(string msg, string delimiter)
+        {
+            string input = Input(msg);
+            string[] array = input.Split(delimiter);
+            return array;
+        }
     }
 }

CommonsLibrary/StdOut.cs

@@ -1,178 +1,93 @@
 using System;
-using System.Collections.Generic;
 
 namespace CommonsLibrary
 {
     /// <summary>Contains methods for standard output data.</summary>
+    /// <remarks>It requires the use of the 'System.Console' package.</remarks>
     public static class StdOut
     {
-        /// <summary>
-        /// Creates a table from Headers and Data in Array format
-        /// <param name="headers">Is the headers for the table in an array</param>
-        /// <param name="data">Is the data for the table in an array</param>
-        /// </summary>
-        public static void ArrayTable(string[] headers, string[,] data)
+        /// <summary>Used to write messages to the console in colour without a new line</summary>
+        /// <param name="msg"></param>
+        /// <param name="colour"></param>
+        public static void WriteColourMessage(string msg, ConsoleColor colour)
         {
-            // Makes max width for each column
-            int[] largest = new int[headers.Length];
+            Console.ForegroundColor = colour;
+            Console.Write(msg);
+            Console.ResetColor();
+        }
+
+        /// <summary>Used to write messages to the console in colour with a new line</summary>
+        /// <param name="msg"></param>
+        /// <param name="colour"></param>
+        public static void WriteLineColourMessage(string msg, ConsoleColor colour) =>
+            WriteColourMessage($"{msg}\n", colour);
+
+        /// <summary>Used to build and display data</summary>
+        /// <param name="headers">An array of the headers</param>
+        /// <param name="data">A 2D array of the data you want displaying</param>
+        public static void PrintTable(string[] headers, string[,] data)
+        {
+            int[] maxColumnWidth = new int[headers.Length];
 
-            // Makes the maximum width equal to each header
+            // Find max column width
             for (int i = 0; i < headers.Length; i++)
-            { largest[i] = headers[i].Length; }
+            {
+                maxColumnWidth[i] = headers[i].Length;
+            }
 
-            // Makes the maximum width equal to each data if its bigger
             for (int i = 0; i < data.GetLength(0); i++)
             {
                 for (int j = 0; j < data.GetLength(1); j++)
                 {
-                    if (data[i, j].Length > largest[j])
+                    if (data[i, j].Length > maxColumnWidth[j])
                     {
-                        largest[j] = data[i, j].Length;
+                        maxColumnWidth[j] = data[i, j].Length;
                     }
                 }
             }
 
-            WriteHeaders(headers, largest);
-            Underline(largest);
-            Console.Write("\n");
-            WriteData(data, largest);
-        }
-
-        /// <summary>
-        /// Writes the headers for the table with equal spacing
-        /// </summary>
-        /// <param name="headers">The array containing the header strings</param>
-        /// <param name="maxWidth">The maximum with for each column</param>
-        private static void WriteHeaders(IReadOnlyList<string> headers, IReadOnlyList<int> maxWidth)
-        {
-            // Writes the underline
-            Console.Write("|");
-            for (int i = 0; i < maxWidth.Count; i++)
+            foreach (string header in headers)
             {
-                Console.Write(" ");
-
-                if (maxWidth[i] % 2 == 0)
+                Console.Write($"| {header} ");
+                int diff = maxColumnWidth[Array.IndexOf(headers, header)] - header.Length;
+                for (int i = 0; i < diff; i++)
                 {
-                    int width = maxWidth[i];
-                    width -= headers[i].Length;
-                    width /= 2;
-
-                    // Write first half of spaces
-                    for (int j = 0; j < width; j++)
-                    { Console.Write(" "); }
-
-                    // Write header
-                    Console.Write(headers[i]);
-
-                    if (headers[i].Length % 2 == 0)
-                    {
-                        // Write second half of spaces
-                        for (int j = 0; j < width; j++)
-                        { Console.Write(" "); }
-                    }
-                    else
-                    {
-                        // Write second half of spaces
-                        for (int j = 0; j <= width; j++)
-                        { Console.Write(" "); }
-                    }
+                    Console.Write(" ");
                 }
-                else
-                {
-                    int width = maxWidth[i];
-                    width -= headers[i].Length;
-                    width /= 2;
-
-                    // Write first half of spaces
-                    for (int j = 0; j < width; j++)
-                    { Console.Write(" "); }
-
-                    // Write header
-                    Console.Write(headers[i]);
-
-                    if (headers[i].Length % 2 == 0)
-                    {
-                        // Write second half of spaces
-                        for (int j = 0; j <= width; j++)
-                        { Console.Write(" "); }
-                    }
-                    else
-                    {
-                        // Write second half of spaces
-                        for (int j = 0; j < width; j++)
-                        { Console.Write(" "); }
-                    }
-                }
-
-                Console.Write(" |");
             }
-        }
 
-        /// <summary>
-        /// Underlines the headers in the table
-        /// </summary>
-        /// <param name="maxWidth">It's the maximum width of each column</param>
-        private static void Underline(IEnumerable<int> maxWidth)
-        {
-            // Writes the underline
-            Console.Write("\n|");
-            foreach (int value in maxWidth)
+            Console.WriteLine("|");
+
+            for (int i = 0; i < headers.Length; i++)
             {
-                for (int j = 0; j < value + 2; j++)
+                Console.Write("|-");
+                for (int j = 0; j < maxColumnWidth[i]; j++)
                 {
                     Console.Write("-");
                 }
-                Console.Write("|");
+
+                Console.Write("-");
             }
-        }
 
-        /// <summary>
-        /// It writes the data to the console
-        /// </summary>
-        /// <param name="data">It's a 2D array that contains data for the table</param>
-        /// <param name="maxWidth">It's the maximum width of each column</param>
-        private static void WriteData(string[,] data, IReadOnlyList<int> maxWidth)
-        {
+            Console.WriteLine("|");
+
             for (int i = 0; i < data.GetLength(0); i++)
             {
                 Console.Write("|");
                 for (int j = 0; j < data.GetLength(1); j++)
                 {
-                    if (data[i, j].Length == maxWidth[j])
-                    {
-                        Console.Write(" " + data[i, j]);
-                        Console.Write(" |");
-                        continue;
-                    }
+                    Console.Write($" {data[i, j]}");
 
-                    if (data[i, j].Length % 2 == 0)
+                    int diff = maxColumnWidth[j] - data[i, j].Length;
+                    for (int k = 0; k < diff; k++)
                     {
-                        int numberOfSpaces = maxWidth[j] - data[i, j].Length;
-
-                        for (int k = 0; k <= numberOfSpaces / 2; k++)
-                        { Console.Write(" "); }
-
-                        Console.Write(data[i, j]);
-
-                        for (int k = 0; k <= numberOfSpaces / 2; k++)
-                        { Console.Write(" "); }
-                    }
-                    else
-                    {
-                        int numberOfSpaces = maxWidth[j] - data[i, j].Length;
-
-                        for (int k = 0; k <= Math.Floor(numberOfSpaces / 2f); k++)
-                        { Console.Write(" "); }
-
-                        Console.Write(data[i, j]);
-
-                        for (int k = 0; k < Math.Ceiling(numberOfSpaces / 2f); k++)
-                        { Console.Write(" "); }
+                        Console.Write(" ");
                     }
 
                     Console.Write(" |");
                 }
-                Console.Write("\n");
+
+                Console.WriteLine("");
             }
         }
     }