Nomenclature improvements

Author: codeconscious

UniqueFileGenerator/ArgParser.cs

@@ -1,13 +1,19 @@
 namespace UniqueFileGenerator;
 
-public record Arguments(uint Count, Dictionary<string, string> argDict);
+public sealed record ParsedArguments(uint FileCount, Dictionary<string, string> FlagValueMap);
 
 public static class ArgParser
 {
     private static readonly IReadOnlyList<string> SupportedFlags =
-        new List<string>() { "-p", "-e", "-o", "-s", "-d" };
+        new List<string>() {
+            "-p", // Prefix
+            "-e", // Extension
+            "-o", // Output directory
+            "-s", // Size
+            "-d"  // Delay
+        };
 
-    public static Arguments ParseArgs(string[] args)
+    public static ParsedArguments ParseArgs(string[] args)
     {
         if (args.Length == 0)
             throw new ArgumentException(Resources.FileCountMissing, nameof(args));
@@ -17,12 +23,12 @@ public static Arguments ParseArgs(string[] args)
         var fileCountText = argQueue.Dequeue().Replace(",", "");
         if (!uint.TryParse(fileCountText, out var fileCount))
         {
-            // If all characters are digits, then a number that was too high was provided.
+            // Parsing failed. If all characters are digits,
+            // then a number that was too large was provided.
             if (fileCountText.All(char.IsDigit))
                 throw new InvalidOperationException(Resources.FileCountTooHigh);
 
-            // Otherwise, some invalid string was provided --
-            // e.g., negative number, letters, symbols, etc.
+            // Otherwise, some invalid characters were provided.
             throw new InvalidOperationException(Resources.FileCountInvalidRange);
         }
 
@@ -41,7 +47,6 @@ public static Arguments ParseArgs(string[] args)
         {
             var thisArg = argQueue.Dequeue();
 
-            // If this is a supported flag.
             if (SupportedFlags.Contains(thisArg))
             {
                 // Flags cannot be used twice.
@@ -50,7 +55,7 @@ public static Arguments ParseArgs(string[] args)
 
                 currentFlag = thisArg;
             }
-            // Otherwise, consider this a value for the current flag.
+            // Treat the arg as a value for the current flag.
             else
             {
                 if (string.IsNullOrWhiteSpace(currentFlag))
@@ -67,6 +72,6 @@ public static Arguments ParseArgs(string[] args)
             }
         }
 
-        return new Arguments(fileCount, argDict);
+        return new ParsedArguments(fileCount, argDict);
     }
 }

UniqueFileGenerator/Settings.cs

@@ -48,30 +48,30 @@ public sealed class Settings
     public bool IsLargeSize => SizeInBytes > 100_000_000;
     public bool IsLongDelay => FileCreationDelayMs > 60_000; // 1m
 
-    public Settings(Arguments args)
+    public Settings(ParsedArguments parsedArgs)
     {
-        FileCount = args.Count;
+        FileCount = parsedArgs.FileCount;
 
-        var argDict = args.argDict;
+        var args = parsedArgs.FlagValueMap;
 
         // Only add a post-prefix space when the last character is not alphanumeric.
-        Prefix = argDict.ContainsKey("-p")
-            ? argDict["-p"] + (IsLastCharAlphanumeric(argDict["-p"]) ? " " : string.Empty)
+        Prefix = args.ContainsKey("-p")
+            ? args["-p"] + (IsLastCharAlphanumeric(args["-p"]) ? " " : string.Empty)
             : string.Empty;
 
-        Extension = argDict.ContainsKey("-e")
-            ? EnforceStartingPeriod(argDict["-e"])
+        Extension = args.ContainsKey("-e")
+            ? EnforceStartingPeriod(args["-e"])
             : string.Empty;
 
-        OutputDirectory = (argDict.ContainsKey("-o") ? Path.Combine(".", argDict["-o"])
-                                                     : Path.Combine(".", "output"))
+        OutputDirectory = (args.ContainsKey("-o") ? Path.Combine(".", args["-o"])
+                                                  : Path.Combine(".", "output"))
                           + Path.DirectorySeparatorChar;
 
         // Parse the requested file size, if provided.
         // TODO: Accept sizes in formats like "30KB" or "10.4MB"
-        if (argDict.ContainsKey("-s"))
+        if (args.ContainsKey("-s"))
         {
-            if (int.TryParse(argDict["-s"], out var parsedSize))
+            if (int.TryParse(args["-s"], out var parsedSize))
             {
                 SizeInBytes = parsedSize switch
                 {
@@ -90,8 +90,8 @@ public Settings(Arguments args)
         }
 
         // Parse the file creation delay, if provided.
-        if (argDict.ContainsKey("-d") &&
-            int.TryParse(argDict["-d"], out var parsedDelay))
+        if (args.ContainsKey("-d") &&
+            int.TryParse(args["-d"], out var parsedDelay))
         {
             FileCreationDelayMs = parsedDelay switch
             {