Merge branch 'Athari-disable-auto-options' into develop

Author: ericnewton76

src/CommandLine/Core/InstanceBuilder.cs

@@ -23,6 +23,8 @@ public static ParserResult<T> Build<T>(
             StringComparer nameComparer,
             bool ignoreValueCase,
             CultureInfo parsingCulture,
+            bool autoHelp,
+            bool autoVersion,
             IEnumerable<ErrorType> nonFatalErrors)
         {
             var typeInfo = factory.MapValueOrDefault(f => f().GetType(), typeof(T));
@@ -139,7 +141,7 @@ from sp in spv.DefaultIfEmpty()
 
             var preprocessorErrors = (
                     argumentsList.Any()
-                    ? argumentsList.Preprocess(PreprocessorGuards.Lookup(nameComparer))
+                    ? arguments.Preprocess(PreprocessorGuards.Lookup(nameComparer, autoHelp, autoVersion))
                     : Enumerable.Empty<Error>()
                 ).Memorize();
 

src/CommandLine/Core/InstanceChooser.cs

@@ -19,6 +19,8 @@ public static ParserResult<object> Choose(
             StringComparer nameComparer,
             bool ignoreValueCase,
             CultureInfo parsingCulture,
+            bool autoHelp,
+            bool autoVersion,
             IEnumerable<ErrorType> nonFatalErrors)
         {
             Func<ParserResult<object>> choose = () =>
@@ -31,13 +33,13 @@ public static ParserResult<object> Choose(
 
                 var verbs = Verb.SelectFromTypes(types);
 
-                return preprocCompare("help")
+                return (autoHelp && preprocCompare("help"))
                     ? MakeNotParsed(types,
                         MakeHelpVerbRequestedError(verbs,
                             arguments.Skip(1).FirstOrDefault() ?? string.Empty, nameComparer))
-                    : preprocCompare("version")
+                    : (autoVersion && preprocCompare("version"))
                         ? MakeNotParsed(types, new VersionRequestedError())
-                        : MatchVerb(tokenizer, verbs, arguments, nameComparer, ignoreValueCase, parsingCulture, nonFatalErrors);
+                        : MatchVerb(tokenizer, verbs, arguments, nameComparer, ignoreValueCase, parsingCulture, autoHelp, autoVersion, nonFatalErrors);
             };
 
             return arguments.Any()
@@ -52,6 +54,8 @@ private static ParserResult<object> MatchVerb(
             StringComparer nameComparer,
             bool ignoreValueCase,
             CultureInfo parsingCulture,
+            bool autoHelp,
+            bool autoVersion,
             IEnumerable<ErrorType> nonFatalErrors)
         {
             return verbs.Any(a => nameComparer.Equals(a.Item1.Name, arguments.First()))
@@ -64,6 +68,8 @@ private static ParserResult<object> MatchVerb(
                     nameComparer,
                     ignoreValueCase,
                     parsingCulture,
+                    autoHelp,
+                    autoVersion,
                     nonFatalErrors)
                 : MakeNotParsed(verbs.Select(v => v.Item2), new BadVerbSelectedError(arguments.First()));
         }

src/CommandLine/Core/PreprocessorGuards.cs

@@ -9,13 +9,14 @@ namespace CommandLine.Core
     static class PreprocessorGuards
     {
         public static IEnumerable<Func<IEnumerable<string>, IEnumerable<Error>>>
-            Lookup(StringComparer nameComparer)
+            Lookup(StringComparer nameComparer, bool autoHelp, bool autoVersion)
         {
-            return new List<Func<IEnumerable<string>, IEnumerable<Error>>>
-                {
-                    HelpCommand(nameComparer),
-                    VersionCommand(nameComparer)
-                };
+            var list = new List<Func<IEnumerable<string>, IEnumerable<Error>>>();
+            if (autoHelp)
+                list.Add(HelpCommand(nameComparer));
+            if (autoVersion)
+                list.Add(VersionCommand(nameComparer));
+            return list;
         }
 
         public static Func<IEnumerable<string>, IEnumerable<Error>> HelpCommand(StringComparer nameComparer)

src/CommandLine/Parser.cs

@@ -99,6 +99,8 @@ public ParserResult<T> ParseArguments<T>(IEnumerable<string> args)
                     settings.NameComparer,
                     settings.CaseInsensitiveEnumValues,
                     settings.ParsingCulture,
+                    settings.AutoHelp,
+                    settings.AutoVersion,
                     HandleUnknownArguments(settings.IgnoreUnknownArguments)),
                 settings);
         }
@@ -128,6 +130,8 @@ public ParserResult<T> ParseArguments<T>(Func<T> factory, IEnumerable<string> ar
                     settings.NameComparer,
                     settings.CaseInsensitiveEnumValues,
                     settings.ParsingCulture,
+                    settings.AutoHelp,
+                    settings.AutoVersion,
                     HandleUnknownArguments(settings.IgnoreUnknownArguments)),
                 settings);
         }
@@ -158,6 +162,8 @@ public ParserResult<object> ParseArguments(IEnumerable<string> args, params Type
                     settings.NameComparer,
                     settings.CaseInsensitiveEnumValues,
                     settings.ParsingCulture,
+                    settings.AutoHelp,
+                    settings.AutoVersion,
                     HandleUnknownArguments(settings.IgnoreUnknownArguments)),
                 settings);
         }

src/CommandLine/ParserSettings.cs

@@ -20,6 +20,8 @@ public class ParserSettings : IDisposable
         private bool caseInsensitiveEnumValues;
         private TextWriter helpWriter;
         private bool ignoreUnknownArguments;
+        private bool autoHelp;
+        private bool autoVersion;
         private CultureInfo parsingCulture;
         private bool enableDashDash;
         private int maximumDisplayWidth;
@@ -31,6 +33,8 @@ public ParserSettings()
         {
             caseSensitive = true;
             caseInsensitiveEnumValues = false;
+            autoHelp = true;
+            autoVersion = true;
             parsingCulture = CultureInfo.InvariantCulture;
             try
             {
@@ -122,6 +126,24 @@ public bool IgnoreUnknownArguments
             set { PopsicleSetter.Set(Consumed, ref ignoreUnknownArguments, value); }
         }
 
+        /// <summary>
+        /// Gets or sets a value indicating whether implicit option or verb 'help' should be supported.
+        /// </summary>
+        public bool AutoHelp
+        {
+            get { return autoHelp; }
+            set { PopsicleSetter.Set(Consumed, ref autoHelp, value); }
+        }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether implicit option or verb 'version' should be supported.
+        /// </summary>
+        public bool AutoVersion
+        {
+            get { return autoVersion; }
+            set { PopsicleSetter.Set(Consumed, ref autoVersion, value); }
+        }
+
         /// <summary>
         /// Gets or sets a value indicating whether enable double dash '--' syntax,
         /// that forces parsing of all subsequent tokens as values.

src/CommandLine/Text/HelpText.cs

@@ -31,6 +31,8 @@ public class HelpText
         private StringBuilder optionsHelp;
         private bool addDashesToOption;
         private bool addEnumValuesToHelpText;
+        private bool autoHelp;
+        private bool autoVersion;
 
         /// <summary>
         /// Initializes a new instance of the <see cref="CommandLine.Text.HelpText"/> class.
@@ -117,6 +119,8 @@ public HelpText(SentenceBuilder sentenceBuilder, string heading, string copyrigh
             this.sentenceBuilder = sentenceBuilder;
             this.heading = heading;
             this.copyright = copyright;
+            this.autoHelp = true;
+            this.autoVersion = true;
         }
 
         /// <summary>
@@ -187,6 +191,24 @@ public bool AddEnumValuesToHelpText
             set { addEnumValuesToHelpText = value; }
         }
 
+        /// <summary>
+        /// Gets or sets a value indicating whether implicit option or verb 'help' should be supported.
+        /// </summary>
+        public bool AutoHelp
+        {
+            get { return autoHelp; }
+            set { autoHelp = value; }
+        }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether implicit option or verb 'version' should be supported.
+        /// </summary>
+        public bool AutoVersion
+        {
+            get { return autoVersion; }
+            set { autoVersion = value; }
+        }
+
         /// <summary>
         /// Gets the <see cref="SentenceBuilder"/> instance specified in constructor.
         /// </summary>
@@ -680,8 +702,11 @@ private IEnumerable<Specification> GetSpecificationsFromType(Type type)
         {
             var specs = type.GetSpecifications(Specification.FromProperty);
             var optionSpecs = specs
-                .OfType<OptionSpecification>()
-                .Concat(new[] { MakeHelpEntry(), MakeVersionEntry() });
+                .OfType<OptionSpecification>();
+            if (autoHelp)
+                optionSpecs = optionSpecs.Concat(new [] { MakeHelpEntry() });
+            if (autoVersion)
+                optionSpecs = optionSpecs.Concat(new [] { MakeVersionEntry() });
             var valueSpecs = specs
                 .OfType<ValueSpecification>()
                 .OrderBy(v => v.Index);
@@ -711,15 +736,20 @@ private static Maybe<Tuple<UsageAttribute, IEnumerable<Example>>> GetUsageFromTy
 
         private IEnumerable<Specification> AdaptVerbsToSpecifications(IEnumerable<Type> types)
         {
-            return (from verbTuple in Verb.SelectFromTypes(types)
+            var optionSpecs = from verbTuple in Verb.SelectFromTypes(types)
                     select
                         OptionSpecification.NewSwitch(
                             string.Empty,
                             verbTuple.Item1.Name,
                             false,
                             verbTuple.Item1.HelpText,
                             string.Empty,
-                            verbTuple.Item1.Hidden)).Concat(new[] { MakeHelpEntry(), MakeVersionEntry() });
+                            verbTuple.Item1.Hidden);
+            if (autoHelp)
+                optionSpecs = optionSpecs.Concat(new [] { MakeHelpEntry() });
+            if (autoVersion)
+                optionSpecs = optionSpecs.Concat(new [] { MakeVersionEntry() });
+            return optionSpecs;
         }
 
         private HelpText AddOptionsImpl(

tests/CommandLine.Tests/CommandLine.Tests.csproj

@@ -59,6 +59,8 @@
     </Compile>
     <Compile Include="CultureInfoExtensions.cs" />
     <Compile Include="Fakes\Hidden_Option.cs" />
+    <Compile Include="Fakes\Options_With_Custom_Help_Option.cs" />
+    <Compile Include="Fakes\Options_With_Custom_Version_Option.cs" />
     <Compile Include="Fakes\Options_With_Default_Set_To_Sequence.cs" />
     <Compile Include="Fakes\Options_With_Guid.cs" />
     <Compile Include="Fakes\Options_With_Option_And_Value_Of_String_Type.cs" />

tests/CommandLine.Tests/Fakes/Options_With_Custom_Help_Option.cs

@@ -0,0 +1,8 @@
+namespace CommandLine.Tests.Fakes
+{
+    class Options_With_Custom_Help_Option : Simple_Options
+    {
+        [Option('h', "help")]
+        public bool Help { get; set; }
+    }
+}

tests/CommandLine.Tests/Fakes/Options_With_Custom_Version_Option.cs

@@ -0,0 +1,8 @@
+namespace CommandLine.Tests.Fakes
+{
+    class Options_With_Custom_Version_Option : Simple_Options
+    {
+        [Option('v', "version")]
+        public bool MyVersion { get; set; }
+    }
+}

tests/CommandLine.Tests/Unit/Core/InstanceBuilderTests.cs

@@ -19,7 +19,7 @@ namespace CommandLine.Tests.Unit.Core
 {
     public class InstanceBuilderTests
     {
-        private static ParserResult<T> InvokeBuild<T>(string[] arguments)
+        private static ParserResult<T> InvokeBuild<T>(string[] arguments, bool autoHelp = true, bool autoVersion = true)
             where T : new()
         {
             return InstanceBuilder.Build(
@@ -29,6 +29,8 @@ private static ParserResult<T> InvokeBuild<T>(string[] arguments)
                 StringComparer.Ordinal,
                 false,
                 CultureInfo.InvariantCulture,
+                autoHelp,
+                autoVersion,
                 Enumerable.Empty<ErrorType>());
         }
 
@@ -42,6 +44,8 @@ private static ParserResult<T> InvokeBuildEnumValuesCaseIgnore<T>(string[] argum
                 StringComparer.Ordinal,
                 true,
                 CultureInfo.InvariantCulture,
+                true,
+                true,
                 Enumerable.Empty<ErrorType>());
         }
 
@@ -54,6 +58,8 @@ private static ParserResult<T> InvokeBuildImmutable<T>(string[] arguments)
                 StringComparer.Ordinal,
                 false,
                 CultureInfo.InvariantCulture,
+                true,
+                true,
                 Enumerable.Empty<ErrorType>());
         }
 
@@ -451,6 +457,8 @@ public void Double_dash_force_subsequent_arguments_as_values()
                 StringComparer.Ordinal,
                 false,
                 CultureInfo.InvariantCulture,
+                true,
+                true,
                 Enumerable.Empty<ErrorType>());
 
             // Verify outcome
@@ -1024,6 +1032,76 @@ public void Parse_string_with_dashes_except_in_beginning(string[] arguments, str
             // Teardown
         }
 
+        [Theory]
+        [InlineData(new[] { "--help" }, ErrorType.UnknownOptionError)]
+        public void Parse_without_auto_help_should_not_recognize_help_option(string[] arguments, ErrorType errorType)
+        {
+            // Fixture setup in attributes
+
+            // Exercize system 
+            var result = InvokeBuild<Simple_Options>(arguments, autoHelp: false);
+
+            // Verify outcome
+            result.Should().BeOfType<NotParsed<Simple_Options>>()
+                .Which.Errors.Should().ContainSingle()
+                .Which.Tag.Should().Be(errorType);
+
+            // Teardown
+        }
+
+        [Theory]
+        [InlineData(new[] { "--help" }, true)]
+        [InlineData(new[] { "-h" }, true)]
+        [InlineData(new[] { "-x" }, false)]
+        public void Parse_with_custom_help_option(string[] arguments, bool isHelp)
+        {
+            // Fixture setup in attributes
+
+            // Exercize system 
+            var result = InvokeBuild<Options_With_Custom_Help_Option>(arguments, autoHelp: false);
+
+            // Verify outcome
+            result.Should().BeOfType<Parsed<Options_With_Custom_Help_Option>>()
+                .Which.Value.Help.Should().Be(isHelp);
+
+            // Teardown
+        }
+
+        [Theory]
+        [InlineData(new[] { "--version" }, ErrorType.UnknownOptionError)]
+        public void Parse_without_auto_version_should_not_recognize_version_option(string[] arguments, ErrorType errorType)
+        {
+            // Fixture setup in attributes
+
+            // Exercize system 
+            var result = InvokeBuild<Simple_Options>(arguments, autoVersion: false);
+
+            // Verify outcome
+            result.Should().BeOfType<NotParsed<Simple_Options>>()
+                .Which.Errors.Should().ContainSingle()
+                .Which.Tag.Should().Be(errorType);
+
+            // Teardown
+        }
+
+        [Theory]
+        [InlineData(new[] { "--version" }, true)]
+        [InlineData(new[] { "-v" }, true)]
+        [InlineData(new[] { "-s", "s" }, false)]
+        public void Parse_with_custom_version_option(string[] arguments, bool isVersion)
+        {
+            // Fixture setup in attributes
+
+            // Exercize system 
+            var result = InvokeBuild<Options_With_Custom_Version_Option>(arguments, autoVersion: false);
+
+            // Verify outcome
+            result.Should().BeOfType<Parsed<Options_With_Custom_Version_Option>>()
+                .Which.Value.MyVersion.Should().Be(isVersion);
+
+            // Teardown
+        }
+
         [Theory]
         [MemberData("GuidData")]
         public void Parse_Guid(string[] arguments, Options_With_Guid expected)

tests/CommandLine.Tests/Unit/Core/InstanceChooserTests.cs

@@ -24,6 +24,8 @@ private static ParserResult<object> InvokeChoose(
                 StringComparer.Ordinal,
                 false,
                 CultureInfo.InvariantCulture,
+                true,
+                true,
                 Enumerable.Empty<ErrorType>());
         }