V3.1.0

CommonsLibrary/CommonsLibrary.csproj

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

CommonsLibrary/FileIO.cs

@@ -1,38 +1,89 @@
-using System;
-using System.IO;
+using System.IO;
 using System.Linq;
 
 namespace CommonsLibrary
 {
-    public class FileIO
+    public static class FileIO
     {
-        /// <summary>This methods returns the number of lines in a file.</summary>
-        /// <param name="filePath">It's the path of the file from the solution folder including the file extension</param>
-        /// <returns>An integer of the number of lines in a file</returns>
-        public static int TotalLines(string filePath)
-        {
-            filePath = Directory.GetParent(Directory.GetCurrentDirectory().Split("\\bin")[0]) + "\\" + filePath;
-            return File.ReadAllLines(filePath).Length;
-        }
+        /// <summary>Returns a string of the solution folder</summary>
+        public static string FilePath { get; } =
+            Directory.GetParent(Directory.GetCurrentDirectory().Split(@"\bin")[0]) + @"\";
+
+        /// <summary>Calculates the number of lines in a file.</summary>
+        /// <param name="filePath">It's the path of the file from the solution folder including the file extension.</param>
+        /// <returns>An integer of the number of lines in a file.</returns>
+        /// <exception cref="System.ArgumentException">
+        /// <paramref name="filePath" /> is a zero-length string, contains only white space, or contains one or more invalid characters as defined by <see cref="F:System.IO.Path.InvalidPathChars" />.</exception>
+        /// <exception cref="System.ArgumentNullException">
+        /// <paramref name="filePath" /> is <see langword="null" />.</exception>
+        /// <exception cref="System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
+        /// <exception cref="System.IO.DirectoryNotFoundException">The specified path is invalid (for example, it is on an unmapped drive).</exception>
+        /// <exception cref="System.IO.IOException">An I/O error occurred while opening the file.</exception>
+        /// <exception cref="System.UnauthorizedAccessException">
+        ///         <paramref name="filePath" /> specified a file that is read-only.
+        /// -or-
+        /// This operation is not supported on the current platform.
+        /// -or-
+        /// <paramref name="filePath" /> specified a directory.
+        /// -or-
+        /// The caller does not have the required permission.</exception>
+        /// <exception cref="System.IO.FileNotFoundException">The file specified in <paramref name="filePath" /> was not found.</exception>
+        /// <exception cref="System.NotSupportedException">
+        /// <paramref name="filePath" /> is in an invalid format.</exception>
+        /// <exception cref="System.Security.SecurityException">The caller does not have the required permission.</exception>
+        public static int TotalLines(string filePath) =>
+            File.ReadAllLines(FilePath + filePath).Length;
 
         /// <summary>It returns a string of a specific line in a file from a 0 based index</summary>
         /// <param name="filePath">It's the path of the file from the solution folder including the file extension</param>
         /// <param name="lineNumber">The specific line you want returned</param>
         /// <returns>A line in a file as a string</returns>
-        /// <exception cref="Exception">New exception - "Line not found"</exception>
-        public static string LineAt(string filePath, int lineNumber)
-        {
-            filePath = Directory.GetParent(Directory.GetCurrentDirectory().Split("\\bin")[0]) + "\\" + filePath;
-            return File.ReadLines(filePath).ElementAt(lineNumber) ?? throw new Exception("Line not found");
-        }
+        /// <exception cref="System.ArgumentException">
+        /// <paramref name="filePath" /> is a zero-length string, contains only white space, or contains one or more invalid characters as defined by <see cref="F:System.IO.Path.InvalidPathChars" />.</exception>
+        /// <exception cref="System.ArgumentNullException">
+        /// <paramref name="filePath" /> is <see langword="null" />.</exception>
+        /// <exception cref="System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
+        /// <exception cref="System.IO.DirectoryNotFoundException">The specified path is invalid (for example, it is on an unmapped drive).</exception>
+        /// <exception cref="System.IO.IOException">An I/O error occurred while opening the file.</exception>
+        /// <exception cref="System.UnauthorizedAccessException">
+        ///         <paramref name="filePath" /> specified a file that is read-only.
+        /// -or-
+        /// This operation is not supported on the current platform.
+        /// -or-
+        /// <paramref name="filePath" /> specified a directory.
+        /// -or-
+        /// The caller does not have the required permission.</exception>
+        /// <exception cref="System.IO.FileNotFoundException">The file specified in <paramref name="filePath" /> was not found.</exception>
+        /// <exception cref="System.NotSupportedException">
+        /// <paramref name="filePath" /> is in an invalid format.</exception>
+        /// <exception cref="System.Security.SecurityException">The caller does not have the required permission.</exception>
+        /// <exception cref="System.IndexOutOfRangeException">The line you selected is not valid</exception>
+        public static string LineAt(string filePath, int lineNumber) =>
+            File.ReadLines(FilePath + filePath).ElementAt(lineNumber);
 
         /// <summary>It returns an integer of all the characters in a file</summary>
         /// <param name="filePath">It's the path of the file from the solution folder including the file extension</param>
         /// <returns>An integer of all the characters in a file</returns>
-        public static int TotalChars(string filePath)
-        {
-            filePath = Directory.GetParent(Directory.GetCurrentDirectory().Split("\\bin")[0]) + "\\" + filePath;
-            return File.ReadAllLines(filePath).Sum(line => line.Length);
-        }
+        ///         /// <exception cref="System.ArgumentException">
+        /// <paramref name="filePath" /> is a zero-length string, contains only white space, or contains one or more invalid characters as defined by <see cref="F:System.IO.Path.InvalidPathChars" />.</exception>
+        /// <exception cref="System.ArgumentNullException">
+        /// <paramref name="filePath" /> is <see langword="null" />.</exception>
+        /// <exception cref="System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
+        /// <exception cref="System.IO.DirectoryNotFoundException">The specified path is invalid (for example, it is on an unmapped drive).</exception>
+        /// <exception cref="System.IO.IOException">An I/O error occurred while opening the file.</exception>
+        /// <exception cref="System.UnauthorizedAccessException">
+        ///         <paramref name="filePath" /> specified a file that is read-only.
+        /// -or-
+        /// This operation is not supported on the current platform.
+        /// -or-
+        /// <paramref name="filePath" /> specified a directory.
+        /// -or-
+        /// The caller does not have the required permission.</exception>
+        /// <exception cref="System.IO.FileNotFoundException">The file specified in <paramref name="filePath" /> was not found.</exception>
+        /// <exception cref="System.NotSupportedException">
+        /// <paramref name="filePath" /> is in an invalid format.</exception>
+        /// <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);
     }
 }

CommonsLibrary/Logs.cs

@@ -5,7 +5,7 @@
 
 namespace CommonsLibrary
 {
-    public class Logs
+    public static class Logs
     {
         /// <summary>This method will create a log file if it doesn't exist and then it will write the log to the file.
         /// It can also be called manually to write a custom log to the log file</summary>

CommonsLibrary/Maths.cs

@@ -3,13 +3,15 @@
 
 namespace CommonsLibrary
 {
-    public class Maths
+    /// <summary>This class contains frequently used math functions.</summary>
+    public static class Maths
     {
-        /// <summary>
-        /// This method checks if the number is prime or not
-        /// </summary>
+        /// <summary>Checks if the number is prime or not.</summary>
         /// <param name="number">Any positive integer with a value greater than 0</param>
-        /// <returns>A boolean based on if the number is prime or not</returns>
+        /// <returns>A boolean based on if the number is prime or not.</returns>
+        /// <exception cref="System.ArgumentException">A non-integer based value has been entered.</exception>
+        /// <exception cref="System.ArgumentNullException">
+        /// <paramref name="number" /> is <see langword="null" />.</exception>
         public static bool IsPrime(int number)
         {
             switch (number)
@@ -34,13 +36,16 @@ public static bool IsPrime(int number)
             return true;
         }
 
-        /// <summary>
-        /// This method returns all of the divisors of a number
-        /// </summary>
-        /// <param name="number">The number that you want to check</param>
-        /// <returns>Every divisor of the number</returns>
+        /// <summary>Returns all of the divisors of a number.</summary>
+        /// <param name="number">The number that you want to check.</param>
+        /// <returns>Every divisor of the number.</returns>
+        /// <Exception cref="ArgumentNullException">
+        /// <paramref name="number" /> is <see langword="null" />.</exception>
         public static IEnumerable<int> GetDivisors(int number)
         {
+            if (number < 0) number = -number;
+            if (number == 0) yield return 0;
+
             for (int i = 1; i * i <= number; i++)
             {
                 if (number % i != 0) continue;
@@ -51,15 +56,15 @@ public static IEnumerable<int> GetDivisors(int number)
             }
         }
 
-        /// <summary>
-        /// This method returns all of the prime factors of a given number
-        /// </summary>
+        /// <summary>Returns all of the prime factors of a given number.</summary>
         /// <param name="number">This is the signed integer that you want the prime factors of</param>
         /// <returns>An array of the prime factors</returns>
+        /// <exception cref="ArgumentNullException">
+        /// <paramref name="number" /> is <see langword="null" />.</exception>
         public static int[] GetPrimeFactors(int number)
         {
             List<int> factors = new();
-            if (number < 0) number *= -1;
+            if (number < 0) number = -number;
 
             while (number % 2 == 0)
             {

CommonsLibrary/StdInp.cs

@@ -2,22 +2,27 @@
 
 namespace CommonsLibrary
 {
+    /// <summary>This class can return input from the console.</summary>
     public static class StdInp
     {
-        /// <summary>This method can be used to retrieve a string input from the console</summary>
-        /// <param name="msg">The message to be displayed to the user</param>
-        /// <returns>The string input by the user</returns>
+        /// <summary>Used to retrieve a string input from the console.</summary>
+        /// <param name="msg">The message to be displayed to the user.</param>
+        /// <returns>The string input by the user.</returns>
+        /// <exception cref="ArgumentNullException">
+        /// <paramref name="msg" /> is <see langword="null" />.</exception>
         public static string Input(string msg)
         {
             Console.Write($"{msg}: ");
             return Console.ReadLine() ?? string.Empty;
         }
 
-        /// <summary>This method can be used to retrieve an integer based input from the console that is between a range of values</summary>
-        /// <param name="msg">The message to be displayed to the user</param>
-        /// <param name="lowerBound">The lower bound of the range</param>
-        /// <param name="upperBound">The upper bound of the range</param>
-        /// <returns>The integer input by the user</returns>
+        /// <summary>Used to retrieve an integer based input from the console that is between a range of values.</summary>
+        /// <param name="msg">The message to be displayed to the user.</param>
+        /// <param name="lowerBound">The lower bound of the range.</param>
+        /// <param name="upperBound">The upper bound of the range.</param>
+        /// <returns>The integer input by the user.</returns>
+        /// <exception cref="ArgumentNullException">
+        /// <paramref name="msg" /> is <see langword="null" />.</exception>
         public static int InputIntInBound(string msg, int lowerBound, int upperBound)
         {
             int output;
@@ -29,9 +34,11 @@ public static int InputIntInBound(string msg, int lowerBound, int upperBound)
             return output;
         }
 
-        /// <summary>This method can be used to retrieve an integer based input from the console</summary>
-        /// <param name="msg">The message to be displayed to the user</param>
-        /// <returns>The integer input by the user</returns>
+        /// <summary>This method can be used to retrieve an integer based input from the console.</summary>
+        /// <param name="msg">The message to be displayed to the user.</param>
+        /// <returns>The integer input by the user.</returns>
+        /// <exception cref="ArgumentNullException">
+        /// <paramref name="msg" /> is <see langword="null" />.</exception>
         public static int InputInt(string msg)
         {
             int output;
@@ -43,9 +50,11 @@ public static int InputInt(string msg)
             return output;
         }
 
-        /// <summary>This method can be used to retrieve a bool input from the console from Yes or No</summary>
-        /// <param name="msg">The message to be displayed to the user</param>
-        /// <returns>The bool input by the user</returns>
+        /// <summary>This method can be used to retrieve a bool input from the console from Yes or No.</summary>
+        /// <param name="msg">The message to be displayed to the user.</param>
+        /// <returns>The bool input by the user.</returns>
+        /// <exception cref="ArgumentNullException">
+        /// <paramref name="msg" /> is <see langword="null" />.</exception>
         // ReSharper disable once InconsistentNaming
         public static bool InputYNAsBool(string msg)
         {
@@ -56,17 +65,7 @@ public static bool InputYNAsBool(string msg)
                 inp = Input($"{msg} (y/n)").ToUpper();
             } while (inp != "Y" && inp != "N" && inp != "YES" && inp != "NO");
 
-            switch (inp)
-            {
-                case "Y":
-                case "YES":
-                    return true;
-                case "N":
-                case "NO":
-                    return false;
-                default:
-                    return false;
-            }
+            return inp is "Y" or "YES";
         }
     }
 }

CommonsLibrary/StdOut.cs

@@ -3,6 +3,7 @@
 
 namespace CommonsLibrary
 {
+    /// <summary>Contains methods for standard output data.</summary>
     public static class StdOut
     {
         /// <summary>