Refactor Docopt argument parsing

NeilJustice · NeilJustice · commit 436a97c16f5f · 2025-07-07T11:38:45.000-05:00
diff --git a/DocoptPlusDLL/DocoptPlus.dll b/DocoptPlusDLL/DocoptPlus.dll
diff --git a/QuickVsix/Components/Args/InstallVsixArgsParser.cs b/QuickVsix/Components/Args/InstallVsixArgsParser.cs
@@ -3,10 +3,10 @@
 
 public class InstallVsixArgsParser : ProgramModeSpecificArgsParser
 {
-   public override QuickVsixArgs ParseDocoptDictionary(ReadOnlyDictionary<string, DocoptValueObject> docoptDictionary, ProgramMode programMode)
+   public override QuickVsixArgs ParseDocoptDictionary(ReadOnlyDictionary<string, DocoptValueObject> docoptDictionary)
    {
       var args = new QuickVsixArgs();
-      args.programMode = programMode;
+      args.programMode = ProgramMode.InstallVsix;
       args.vsixFilePath = p_docoptParser.GetRequiredFilePathWhichMustExist(docoptDictionary, "--vsix-file");
       args.waitForAnyKey = p_docoptParser.GetOptionalBool(docoptDictionary, "--wait-for-any-key");
       return args;
diff --git a/QuickVsix/Components/Args/ProgramModeSpecificArgsParser.cs b/QuickVsix/Components/Args/ProgramModeSpecificArgsParser.cs
@@ -9,7 +9,7 @@ public class ProgramModeSpecificArgsParser
    protected readonly DocoptParser p_docoptParser = new DocoptParser();
    protected readonly FileSystem p_fileSystem = new FileSystem();
 
-   public virtual QuickVsixArgs ParseDocoptDictionary(ReadOnlyDictionary<string, DocoptValueObject> docoptDictionary, ProgramMode programMode)
+   public virtual QuickVsixArgs ParseDocoptDictionary(ReadOnlyDictionary<string, DocoptValueObject> docoptDictionary)
    {
       throw new NotSupportedException();
    }
diff --git a/QuickVsix/Components/Args/QuickVsixArgsParser.cs b/QuickVsix/Components/Args/QuickVsixArgsParser.cs
@@ -1,7 +1,6 @@
-﻿using CSharpUtils;
+﻿using System.Collections.ObjectModel;
+using CSharpUtils;
 using DocoptPlus;
-using System.Collections.Generic;
-using System.Collections.ObjectModel;
 
 public class QuickVsixArgsParser
 {
@@ -20,7 +19,7 @@ public virtual QuickVsixArgs ParseStringArgs(string[] stringArgs)
       ReadOnlyDictionary<string, DocoptValueObject> docoptDictionary = _docoptParser.ParseStringArgsForDocoptDictionary<QuickVsixArgs>(stringArgs);
       ProgramMode programMode = _docoptParser.GetProgramMode(docoptDictionary, QuickVsixArgs.programModesDictionary);
       ProgramModeSpecificArgsParser programModeSpecificArgsParser = _programModeSpecificArgsParserFactory.New(programMode);
-      QuickVsixArgs args = programModeSpecificArgsParser.ParseDocoptDictionary(docoptDictionary, programMode);
+      QuickVsixArgs args = programModeSpecificArgsParser.ParseDocoptDictionary(docoptDictionary);
       return args;
    }
 }
diff --git a/QuickVsix/Components/Args/ReinstallVsixArgsParser.cs b/QuickVsix/Components/Args/ReinstallVsixArgsParser.cs
@@ -3,10 +3,10 @@
 
 public class ReinstallVsixArgsParser : ProgramModeSpecificArgsParser
 {
-   public override QuickVsixArgs ParseDocoptDictionary(ReadOnlyDictionary<string, DocoptValueObject> docoptDictionary, ProgramMode programMode)
+   public override QuickVsixArgs ParseDocoptDictionary(ReadOnlyDictionary<string, DocoptValueObject> docoptDictionary)
    {
       var args = new QuickVsixArgs();
-      args.programMode = programMode;
+      args.programMode = ProgramMode.ReinstallVsix;
       args.vsixFilePath = p_docoptParser.GetRequiredString(docoptDictionary, "--vsix-file");
       args.waitForAnyKey = p_docoptParser.GetOptionalBool(docoptDictionary, "--wait-for-any-key");
       return args;
diff --git a/QuickVsix/Components/Args/UninstallVsixArgsParser.cs b/QuickVsix/Components/Args/UninstallVsixArgsParser.cs
@@ -3,10 +3,10 @@
 
 public class UninstallVsixArgsParser : ProgramModeSpecificArgsParser
 {
-   public override QuickVsixArgs ParseDocoptDictionary(ReadOnlyDictionary<string, DocoptValueObject> docoptDictionary, ProgramMode programMode)
+   public override QuickVsixArgs ParseDocoptDictionary(ReadOnlyDictionary<string, DocoptValueObject> docoptDictionary)
    {
       var args = new QuickVsixArgs();
-      args.programMode = programMode;
+      args.programMode = ProgramMode.UninstallVsix;
       args.vsixFilePath = p_docoptParser.GetRequiredString(docoptDictionary, "--vsix-file");
       args.waitForAnyKey = p_docoptParser.GetOptionalBool(docoptDictionary, "--wait-for-any-key");
       return args;
diff --git a/QuickVsixTests/Components/Args/InstallVsixArgsParserTests.cs b/QuickVsixTests/Components/Args/InstallVsixArgsParserTests.cs
@@ -22,16 +22,15 @@ public void ParseDocoptDictionary_ParsesArgs_ReturnsQuickVsixArgs()
 
       bool waitForAnyKey = Mock.ReturnRandomBool(() => p_docoptParserMock.GetOptionalBool(null, null));
 
-      var docoptDictionary = new Dictionary<string, DocoptValueObject>().ToReadOnlyDictionary();
-      ProgramMode programMode = TestRandom.Enum<ProgramMode>();
+      var docoptDictionary = DocoptPlusTestRandom.DocoptDictionary();
       //
-      QuickVsixArgs args = _installVsixArgsParser.ParseDocoptDictionary(docoptDictionary, programMode);
+      QuickVsixArgs args = _installVsixArgsParser.ParseDocoptDictionary(docoptDictionary);
       //
       Called.Once(() => p_docoptParserMock.GetRequiredFilePathWhichMustExist(docoptDictionary, "--vsix-file")).Then(
       Called.Once(() => p_docoptParserMock.GetOptionalBool(docoptDictionary, "--wait-for-any-key")));
       var expectedArgs = new QuickVsixArgs
       {
-         programMode = programMode,
+         programMode = ProgramMode.InstallVsix,
          vsixFilePath = vsixFilePath,
          waitForAnyKey = waitForAnyKey
       };
diff --git a/QuickVsixTests/Components/Args/ProgramModeSpecificArgsParserTests.cs b/QuickVsixTests/Components/Args/ProgramModeSpecificArgsParserTests.cs
@@ -19,6 +19,6 @@ public static void DefaultConstructor_NewsDocoptParser()
    public static void ParseStringArgs_ThrowsNotSupportedException()
    {
       var programModeSpecificArgsParser = new ProgramModeSpecificArgsParser();
-      Assert2.ThrowsNotSupportedException(() => programModeSpecificArgsParser.ParseDocoptDictionary(null, ProgramMode.Unset));
+      Assert2.ThrowsNotSupportedException(() => programModeSpecificArgsParser.ParseDocoptDictionary(null));
    }
 }
diff --git a/QuickVsixTests/Components/Args/QuickVsixArgsParserTests.cs b/QuickVsixTests/Components/Args/QuickVsixArgsParserTests.cs
@@ -31,9 +31,9 @@ public static void ProgramModesDictionary_IsExpectedReadOnlyDictionary()
    }
 
    [Test]
-   public void ParseStringArgs_ParsesStringArgsForDocoptDictionary_GetsProgramMode_NewsProgramModeSpecificArgsParser_ParsesArgs_ReturnsArg()
+   public void ParseStringArgs_DoesSo()
    {
-      ReadOnlyDictionary<string, DocoptValueObject> docoptDictionary = new Dictionary<string, DocoptValueObject>().ToReadOnlyDictionary();
+      var docoptDictionary = DocoptPlusTestRandom.DocoptDictionary();
       Mock.Return(() => _docoptParserMock.ParseStringArgsForDocoptDictionary<QuickVsixArgs>(null), docoptDictionary);
 
       ProgramMode programMode = Mock.ReturnRandomEnum(() => _docoptParserMock.GetProgramMode<ProgramMode>(null, null));
@@ -42,7 +42,7 @@ public void ParseStringArgs_ParsesStringArgsForDocoptDictionary_GetsProgramMode_
       Mock.Return(() => _programModeSpecificArgsParserFactoryMock.New(default), programModeSpecificArgsParserMock);
 
       QuickVsixArgs args = QuickVsixTestRandom.Args();
-      Mock.Return(() => programModeSpecificArgsParserMock.ParseDocoptDictionary(null, default), args);
+      Mock.Return(() => programModeSpecificArgsParserMock.ParseDocoptDictionary(null), args);
 
       string[] stringArgs = TestRandom.StringArray();
       //
@@ -51,7 +51,7 @@ public void ParseStringArgs_ParsesStringArgsForDocoptDictionary_GetsProgramMode_
       Called.Once(() => _docoptParserMock.ParseStringArgsForDocoptDictionary<QuickVsixArgs>(stringArgs)).Then(
       Called.Once(() => _docoptParserMock.GetProgramMode(docoptDictionary, QuickVsixArgs.programModesDictionary))).Then(
       Called.Once(() => _programModeSpecificArgsParserFactoryMock.New(programMode))).Then(
-      Called.Once(() => programModeSpecificArgsParserMock.ParseDocoptDictionary(docoptDictionary, programMode)));
+      Called.Once(() => programModeSpecificArgsParserMock.ParseDocoptDictionary(docoptDictionary)));
       Assert.AreEqual(args, returnedArgs);
    }
 }
diff --git a/QuickVsixTests/Components/Args/ReinstallVsixArgsParserTests.cs b/QuickVsixTests/Components/Args/ReinstallVsixArgsParserTests.cs
@@ -19,19 +19,16 @@ public void SetUp()
    public void ParseDocoptDictionary_ParsesArgs_ReturnsQuickVsixArgs()
    {
       string vsixFilePath = Mock.ReturnRandomString(() => p_docoptParserMock.GetRequiredString(null, null));
-
       bool waitForAnyKey = Mock.ReturnRandomBool(() => p_docoptParserMock.GetOptionalBool(null, null));
-
-      var docoptDictionary = new Dictionary<string, DocoptValueObject>().ToReadOnlyDictionary();
-      ProgramMode programMode = TestRandom.Enum<ProgramMode>();
+      var docoptDictionary = DocoptPlusTestRandom.DocoptDictionary();
       //
-      QuickVsixArgs args = _reinstallVsixArgsParser.ParseDocoptDictionary(docoptDictionary, programMode);
+      QuickVsixArgs args = _reinstallVsixArgsParser.ParseDocoptDictionary(docoptDictionary);
       //
       Called.Once(() => p_docoptParserMock.GetRequiredString(docoptDictionary, "--vsix-file")).Then(
       Called.Once(() => p_docoptParserMock.GetOptionalBool(docoptDictionary, "--wait-for-any-key")));
       var expectedArgs = new QuickVsixArgs
       {
-         programMode = programMode,
+         programMode = ProgramMode.ReinstallVsix,
          vsixFilePath = vsixFilePath,
          waitForAnyKey = waitForAnyKey
       };
diff --git a/QuickVsixTests/Components/Args/UninstallVsixArgsParserTests.cs b/QuickVsixTests/Components/Args/UninstallVsixArgsParserTests.cs
@@ -22,16 +22,15 @@ public void ParseDocoptDictionary_ParsesArgs_ReturnsQuickVsixArgs()
 
       bool waitForAnyKey = Mock.ReturnRandomBool(() => p_docoptParserMock.GetOptionalBool(null, null));
 
-      var docoptDictionary = new Dictionary<string, DocoptValueObject>().ToReadOnlyDictionary();
-      ProgramMode programMode = TestRandom.Enum<ProgramMode>();
+      var docoptDictionary = DocoptPlusTestRandom.DocoptDictionary();
       //
-      QuickVsixArgs args = _uninstallVsixArgsParser.ParseDocoptDictionary(docoptDictionary, programMode);
+      QuickVsixArgs args = _uninstallVsixArgsParser.ParseDocoptDictionary(docoptDictionary);
       //
       Called.Once(() => p_docoptParserMock.GetRequiredString(docoptDictionary, "--vsix-file")).Then(
       Called.Once(() => p_docoptParserMock.GetOptionalBool(docoptDictionary, "--wait-for-any-key")));
       var expectedArgs = new QuickVsixArgs
       {
-         programMode = programMode,
+         programMode = ProgramMode.UninstallVsix,
          vsixFilePath = vsixFilePath,
          waitForAnyKey = waitForAnyKey
       };
diff --git a/QuickVsixTests/ValueTypes/QuickVsixArgsTests.cs b/QuickVsixTests/ValueTypes/QuickVsixArgsTests.cs
@@ -57,9 +57,9 @@ public static void ProgramModesDictionary_IsExpectedDictionary()
    [Test]
    public void Populate_ThrowsNotSupportedException()
    {
-      var docoptArguments = new Dictionary<string, DocoptValueObject>().ToReadOnlyDictionary();
+      var docoptDictionary = DocoptPlusTestRandom.DocoptDictionary();
       //
-      Assert2.ThrowsNotSupportedException(() => _quickVsixArgs.Populate(docoptArguments));
+      Assert2.ThrowsNotSupportedException(() => _quickVsixArgs.Populate(docoptDictionary));
    }
 
    [Test]

Original file line number	Diff line number	Diff line change
`@@ -3,10 +3,10 @@`
`3`	`3`
`4`	`4`	`public class InstallVsixArgsParser : ProgramModeSpecificArgsParser`
`5`	`5`	`{`
`6`		`- public override QuickVsixArgs ParseDocoptDictionary(ReadOnlyDictionary<string, DocoptValueObject> docoptDictionary, ProgramMode programMode)`
	`6`	`+ public override QuickVsixArgs ParseDocoptDictionary(ReadOnlyDictionary<string, DocoptValueObject> docoptDictionary)`
`7`	`7`	`{`
`8`	`8`	`var args = new QuickVsixArgs();`
`9`		`- args.programMode = programMode;`
	`9`	`+ args.programMode = ProgramMode.InstallVsix;`
`10`	`10`	`args.vsixFilePath = p_docoptParser.GetRequiredFilePathWhichMustExist(docoptDictionary, "--vsix-file");`
`11`	`11`	`args.waitForAnyKey = p_docoptParser.GetOptionalBool(docoptDictionary, "--wait-for-any-key");`
`12`	`12`	`return args;`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ public class ProgramModeSpecificArgsParser`
`9`	`9`	`protected readonly DocoptParser p_docoptParser = new DocoptParser();`
`10`	`10`	`protected readonly FileSystem p_fileSystem = new FileSystem();`
`11`	`11`
`12`		`- public virtual QuickVsixArgs ParseDocoptDictionary(ReadOnlyDictionary<string, DocoptValueObject> docoptDictionary, ProgramMode programMode)`
	`12`	`+ public virtual QuickVsixArgs ParseDocoptDictionary(ReadOnlyDictionary<string, DocoptValueObject> docoptDictionary)`
`13`	`13`	`{`
`14`	`14`	`throw new NotSupportedException();`
`15`	`15`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,6 @@`
`1`		`-using CSharpUtils;`
	`1`	`+using System.Collections.ObjectModel;`
	`2`	`+using CSharpUtils;`
`2`	`3`	`using DocoptPlus;`
`3`		`-using System.Collections.Generic;`
`4`		`-using System.Collections.ObjectModel;`
`5`	`4`
`6`	`5`	`public class QuickVsixArgsParser`
`7`	`6`	`{`
`@@ -20,7 +19,7 @@ public virtual QuickVsixArgs ParseStringArgs(string[] stringArgs)`
`20`	`19`	`ReadOnlyDictionary<string, DocoptValueObject> docoptDictionary = _docoptParser.ParseStringArgsForDocoptDictionary<QuickVsixArgs>(stringArgs);`
`21`	`20`	`ProgramMode programMode = _docoptParser.GetProgramMode(docoptDictionary, QuickVsixArgs.programModesDictionary);`
`22`	`21`	`ProgramModeSpecificArgsParser programModeSpecificArgsParser = _programModeSpecificArgsParserFactory.New(programMode);`
`23`		`- QuickVsixArgs args = programModeSpecificArgsParser.ParseDocoptDictionary(docoptDictionary, programMode);`
	`22`	`+ QuickVsixArgs args = programModeSpecificArgsParser.ParseDocoptDictionary(docoptDictionary);`
`24`	`23`	`return args;`
`25`	`24`	`}`
`26`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,10 +3,10 @@`
`3`	`3`
`4`	`4`	`public class ReinstallVsixArgsParser : ProgramModeSpecificArgsParser`
`5`	`5`	`{`
`6`		`- public override QuickVsixArgs ParseDocoptDictionary(ReadOnlyDictionary<string, DocoptValueObject> docoptDictionary, ProgramMode programMode)`
	`6`	`+ public override QuickVsixArgs ParseDocoptDictionary(ReadOnlyDictionary<string, DocoptValueObject> docoptDictionary)`
`7`	`7`	`{`
`8`	`8`	`var args = new QuickVsixArgs();`
`9`		`- args.programMode = programMode;`
	`9`	`+ args.programMode = ProgramMode.ReinstallVsix;`
`10`	`10`	`args.vsixFilePath = p_docoptParser.GetRequiredString(docoptDictionary, "--vsix-file");`
`11`	`11`	`args.waitForAnyKey = p_docoptParser.GetOptionalBool(docoptDictionary, "--wait-for-any-key");`
`12`	`12`	`return args;`
Original file line number	Diff line number	Diff line change
`@@ -3,10 +3,10 @@`
`3`	`3`
`4`	`4`	`public class UninstallVsixArgsParser : ProgramModeSpecificArgsParser`
`5`	`5`	`{`
`6`		`- public override QuickVsixArgs ParseDocoptDictionary(ReadOnlyDictionary<string, DocoptValueObject> docoptDictionary, ProgramMode programMode)`
	`6`	`+ public override QuickVsixArgs ParseDocoptDictionary(ReadOnlyDictionary<string, DocoptValueObject> docoptDictionary)`
`7`	`7`	`{`
`8`	`8`	`var args = new QuickVsixArgs();`
`9`		`- args.programMode = programMode;`
	`9`	`+ args.programMode = ProgramMode.UninstallVsix;`
`10`	`10`	`args.vsixFilePath = p_docoptParser.GetRequiredString(docoptDictionary, "--vsix-file");`
`11`	`11`	`args.waitForAnyKey = p_docoptParser.GetOptionalBool(docoptDictionary, "--wait-for-any-key");`
`12`	`12`	`return args;`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,6 @@ public static void DefaultConstructor_NewsDocoptParser()`
`19`	`19`	`public static void ParseStringArgs_ThrowsNotSupportedException()`
`20`	`20`	`{`
`21`	`21`	`var programModeSpecificArgsParser = new ProgramModeSpecificArgsParser();`
`22`		`- Assert2.ThrowsNotSupportedException(() => programModeSpecificArgsParser.ParseDocoptDictionary(null, ProgramMode.Unset));`
	`22`	`+ Assert2.ThrowsNotSupportedException(() => programModeSpecificArgsParser.ParseDocoptDictionary(null));`
`23`	`23`	`}`
`24`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,9 +31,9 @@ public static void ProgramModesDictionary_IsExpectedReadOnlyDictionary()`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`[Test]`
`34`		`- public void ParseStringArgs_ParsesStringArgsForDocoptDictionary_GetsProgramMode_NewsProgramModeSpecificArgsParser_ParsesArgs_ReturnsArg()`
	`34`	`+ public void ParseStringArgs_DoesSo()`
`35`	`35`	`{`
`36`		`- ReadOnlyDictionary<string, DocoptValueObject> docoptDictionary = new Dictionary<string, DocoptValueObject>().ToReadOnlyDictionary();`
	`36`	`+ var docoptDictionary = DocoptPlusTestRandom.DocoptDictionary();`
`37`	`37`	`Mock.Return(() => _docoptParserMock.ParseStringArgsForDocoptDictionary<QuickVsixArgs>(null), docoptDictionary);`
`38`	`38`
`39`	`39`	`ProgramMode programMode = Mock.ReturnRandomEnum(() => _docoptParserMock.GetProgramMode<ProgramMode>(null, null));`
`@@ -42,7 +42,7 @@ public void ParseStringArgs_ParsesStringArgsForDocoptDictionary_GetsProgramMode_`
`42`	`42`	`Mock.Return(() => _programModeSpecificArgsParserFactoryMock.New(default), programModeSpecificArgsParserMock);`
`43`	`43`
`44`	`44`	`QuickVsixArgs args = QuickVsixTestRandom.Args();`
`45`		`- Mock.Return(() => programModeSpecificArgsParserMock.ParseDocoptDictionary(null, default), args);`
	`45`	`+ Mock.Return(() => programModeSpecificArgsParserMock.ParseDocoptDictionary(null), args);`
`46`	`46`
`47`	`47`	`string[] stringArgs = TestRandom.StringArray();`
`48`	`48`	`//`
`@@ -51,7 +51,7 @@ public void ParseStringArgs_ParsesStringArgsForDocoptDictionary_GetsProgramMode_`
`51`	`51`	`Called.Once(() => _docoptParserMock.ParseStringArgsForDocoptDictionary<QuickVsixArgs>(stringArgs)).Then(`
`52`	`52`	`Called.Once(() => _docoptParserMock.GetProgramMode(docoptDictionary, QuickVsixArgs.programModesDictionary))).Then(`
`53`	`53`	`Called.Once(() => _programModeSpecificArgsParserFactoryMock.New(programMode))).Then(`
`54`		`- Called.Once(() => programModeSpecificArgsParserMock.ParseDocoptDictionary(docoptDictionary, programMode)));`
	`54`	`+ Called.Once(() => programModeSpecificArgsParserMock.ParseDocoptDictionary(docoptDictionary)));`
`55`	`55`	`Assert.AreEqual(args, returnedArgs);`
`56`	`56`	`}`
`57`	`57`	`}`