Introduce option groups

hadzhiyski · hadzhiyski · commit 465cbd0a8484 · 2019-12-08T13:29:09.000+02:00
When one or more options has group set, at least one of these properties should have set value (they behave as required)
diff --git a/src/CommandLine/Core/OptionSpecification.cs b/src/CommandLine/Core/OptionSpecification.cs
@@ -1,4 +1,4 @@
-﻿// Copyright 2005-2015 Giacomo Stelluti Scala & Contributors. All rights reserved. See License.md in the project root for license information.
+// Copyright 2005-2015 Giacomo Stelluti Scala & Contributors. All rights reserved. See License.md in the project root for license information.
 
 using System;
 using System.Collections.Generic;
@@ -13,16 +13,18 @@ sealed class OptionSpecification : Specification
         private readonly string longName;
         private readonly char separator;
         private readonly string setName;
+        private readonly Maybe<string> group;
 
         public OptionSpecification(string shortName, string longName, bool required, string setName, Maybe<int> min, Maybe<int> max,
             char separator, Maybe<object> defaultValue, string helpText, string metaValue, IEnumerable<string> enumValues,
-            Type conversionType, TargetType targetType, bool hidden = false)
+            Type conversionType, TargetType targetType, Maybe<string> group, bool hidden = false)
             : base(SpecificationType.Option, required, min, max, defaultValue, helpText, metaValue, enumValues, conversionType, targetType, hidden)
         {
             this.shortName = shortName;
             this.longName = longName;
             this.separator = separator;
             this.setName = setName;
+            this.group = group;
         }
 
         public static OptionSpecification FromAttribute(OptionAttribute attribute, Type conversionType, IEnumerable<string> enumValues)
@@ -41,13 +43,14 @@ public static OptionSpecification FromAttribute(OptionAttribute attribute, Type
                 enumValues,
                 conversionType,
                 conversionType.ToTargetType(),
+                string.IsNullOrWhiteSpace(attribute.Group) ? Maybe.Nothing<string>() : Maybe.Just(attribute.Group),
                 attribute.Hidden);
         }
 
         public static OptionSpecification NewSwitch(string shortName, string longName, bool required, string helpText, string metaValue, bool hidden = false)
         {
             return new OptionSpecification(shortName, longName, required, string.Empty, Maybe.Nothing<int>(), Maybe.Nothing<int>(),
-                '\0', Maybe.Nothing<object>(), helpText, metaValue, Enumerable.Empty<string>(), typeof(bool), TargetType.Switch, hidden);
+                '\0', Maybe.Nothing<object>(), helpText, metaValue, Enumerable.Empty<string>(), typeof(bool), TargetType.Switch, Maybe.Nothing<string>(), hidden);
         }
 
         public string ShortName
@@ -69,5 +72,10 @@ public string SetName
         {
             get { return setName; }
         }
+
+        public Maybe<string> Group
+        {
+            get { return group; }
+        }
     }
-}
+}
diff --git a/src/CommandLine/Core/SpecificationExtensions.cs b/src/CommandLine/Core/SpecificationExtensions.cs
@@ -34,6 +34,7 @@ public static OptionSpecification WithLongName(this OptionSpecification specific
                 specification.EnumValues,
                 specification.ConversionType,
                 specification.TargetType,
+                specification.Group,
                 specification.Hidden);
         }
 
diff --git a/src/CommandLine/Core/SpecificationPropertyRules.cs b/src/CommandLine/Core/SpecificationPropertyRules.cs
@@ -1,4 +1,4 @@
-﻿// Copyright 2005-2015 Giacomo Stelluti Scala & Contributors. All rights reserved. See License.md in the project root for license information.
+// Copyright 2005-2015 Giacomo Stelluti Scala & Contributors. All rights reserved. See License.md in the project root for license information.
 
 using System;
 using System.Collections.Generic;
@@ -16,12 +16,43 @@ public static IEnumerable<Func<IEnumerable<SpecificationProperty>, IEnumerable<E
             return new List<Func<IEnumerable<SpecificationProperty>, IEnumerable<Error>>>
                 {
                     EnforceMutuallyExclusiveSet(),
+                    EnforceGroup(),
                     EnforceRequired(),
                     EnforceRange(),
                     EnforceSingle(tokens)
                 };
         }
 
+        private static Func<IEnumerable<SpecificationProperty>, IEnumerable<Error>> EnforceGroup()
+        {
+            return specProps =>
+            {
+                var optionsValues =
+                    from sp in specProps
+                    where sp.Specification.IsOption()
+                    let o = (OptionSpecification)sp.Specification
+                    where o.Group.IsJust()
+                    select new
+                    {
+                        Option = o,
+                        Value = sp.Value
+                    };
+
+                var groups = from o in optionsValues
+                             group o by o.Option.Group.GetValueOrDefault(null) into g
+                             select g;
+
+                var errorGroups = groups.Where(gr => gr.All(g => g.Value.IsNothing()));
+
+                if (errorGroups.Any())
+                {
+                    return errorGroups.Select(gr => new MissingGroupOptionError(gr.Key));
+                }
+
+                return Enumerable.Empty<Error>();
+            };
+        }
+
         private static Func<IEnumerable<SpecificationProperty>, IEnumerable<Error>> EnforceMutuallyExclusiveSet()
         {
             return specProps =>
@@ -51,26 +82,26 @@ private static Func<IEnumerable<SpecificationProperty>, IEnumerable<Error>> Enfo
             return specProps =>
             {
                 var requiredWithValue = from sp in specProps
-                    where sp.Specification.IsOption()
-                    where sp.Specification.Required
-                    where sp.Value.IsJust()
-                    let o = (OptionSpecification)sp.Specification
-                    where o.SetName.Length > 0
-                    select sp.Specification;
+                                        where sp.Specification.IsOption()
+                                        where sp.Specification.Required
+                                        where sp.Value.IsJust()
+                                        let o = (OptionSpecification)sp.Specification
+                                        where o.SetName.Length > 0
+                                        select sp.Specification;
                 var setWithRequiredValue = (
                     from s in requiredWithValue
                     let o = (OptionSpecification)s
                     where o.SetName.Length > 0
                     select o.SetName)
                         .Distinct();
                 var requiredWithoutValue = from sp in specProps
-                    where sp.Specification.IsOption()
-                    where sp.Specification.Required
-                    where sp.Value.IsNothing()
-                    let o = (OptionSpecification)sp.Specification
-                    where o.SetName.Length > 0
-                    where setWithRequiredValue.ContainsIfNotEmpty(o.SetName)
-                    select sp.Specification;
+                                           where sp.Specification.IsOption()
+                                           where sp.Specification.Required
+                                           where sp.Value.IsNothing()
+                                           let o = (OptionSpecification)sp.Specification
+                                           where o.SetName.Length > 0
+                                           where setWithRequiredValue.ContainsIfNotEmpty(o.SetName)
+                                           select sp.Specification;
                 var missing =
                     requiredWithoutValue
                         .Except(requiredWithValue)
@@ -130,11 +161,11 @@ from o in to.DefaultIfEmpty()
                                        where o != null
                                        select new { o.ShortName, o.LongName };
                     var longOptions = from t in tokens
-                                       where t.IsName()
-                                       join o in specs on t.Text equals o.LongName into to
-                                       from o in to.DefaultIfEmpty()
-                                       where o != null
-                                       select new { o.ShortName, o.LongName };
+                                      where t.IsName()
+                                      join o in specs on t.Text equals o.LongName into to
+                                      from o in to.DefaultIfEmpty()
+                                      where o != null
+                                      select new { o.ShortName, o.LongName };
                     var groups = from x in shortOptions.Concat(longOptions)
                                  group x by x into g
                                  let count = g.Count()
@@ -155,4 +186,4 @@ private static bool ContainsIfNotEmpty<T>(this IEnumerable<T> sequence, T value)
             return true;
         }
     }
-}
+}
diff --git a/src/CommandLine/Error.cs b/src/CommandLine/Error.cs
@@ -210,7 +210,7 @@ public override bool Equals(object obj)
         /// <remarks>A hash code for the current <see cref="System.Object"/>.</remarks>
         public override int GetHashCode()
         {
-            return new {Tag, StopsProcessing, Token}.GetHashCode();
+            return new { Tag, StopsProcessing, Token }.GetHashCode();
         }
 
         /// <summary>
@@ -289,7 +289,7 @@ public override bool Equals(object obj)
         /// <remarks>A hash code for the current <see cref="System.Object"/>.</remarks>
         public override int GetHashCode()
         {
-            return new {Tag, StopsProcessing, NameInfo}.GetHashCode();
+            return new { Tag, StopsProcessing, NameInfo }.GetHashCode();
         }
 
         /// <summary>
@@ -526,4 +526,22 @@ internal InvalidAttributeConfigurationError()
         {
         }
     }
+
+    public sealed class MissingGroupOptionError : Error
+    {
+        public const string ErrorMessage = "At least one option in a group must have value.";
+
+        private readonly string group;
+
+        internal MissingGroupOptionError(string group)
+            : base(ErrorType.HelpRequestedError, true)
+        {
+            this.group = group;
+        }
+
+        public string Group
+        {
+            get { return group; }
+        }
+    }
 }
diff --git a/src/CommandLine/GroupAttribute.cs b/src/CommandLine/GroupAttribute.cs
@@ -0,0 +1,15 @@
+﻿using System;
+
+namespace CommandLine
+{
+    [AttributeUsage(AttributeTargets.Property, AllowMultiple = false, Inherited = true)]
+    public class GroupAttribute : Attribute
+    {
+        public GroupAttribute(string name)
+        {
+            Name = name;
+        }
+
+        public string Name { get; }
+    }
+}
diff --git a/src/CommandLine/OptionAttribute.cs b/src/CommandLine/OptionAttribute.cs
@@ -1,8 +1,9 @@
 ﻿// Copyright 2005-2015 Giacomo Stelluti Scala & Contributors. All rights reserved. See License.md in the project root for license information.
 
-using System;
 using CommandLine.Infrastructure;
 
+using System;
+
 namespace CommandLine
 {
     /// <summary>
@@ -15,6 +16,7 @@ public sealed class OptionAttribute : BaseAttribute
         private readonly string shortName;
         private string setName;
         private char separator;
+        private string group;
 
         private OptionAttribute(string shortName, string longName) : base()
         {
@@ -100,8 +102,14 @@ public string SetName
         /// </summary>
         public char Separator
         {
-            get { return separator ; }
+            get { return separator; }
             set { separator = value; }
         }
+
+        public string Group
+        {
+            get { return group; }
+            set { group = value; }
+        }
     }
-}
+}
diff --git a/tests/CommandLine.Tests/Unit/Core/NameLookupTests.cs b/tests/CommandLine.Tests/Unit/Core/NameLookupTests.cs
@@ -1,11 +1,15 @@
 ﻿// Copyright 2005-2015 Giacomo Stelluti Scala & Contributors. All rights reserved. See License.md in the project root for license information.
 
-using System;
-using System.Collections.Generic;
 using CommandLine.Core;
+
+using CSharpx;
+
 using FluentAssertions;
+
+using System;
+using System.Collections.Generic;
+
 using Xunit;
-using CSharpx;
 
 namespace CommandLine.Tests.Unit.Core
 {
@@ -17,7 +21,7 @@ public void Lookup_name_of_sequence_option_with_separator()
             // Fixture setup
             var expected = Maybe.Just(".");
             var specs = new[] { new OptionSpecification(string.Empty, "string-seq",
-                false, string.Empty, Maybe.Nothing<int>(), Maybe.Nothing<int>(), '.', null, string.Empty, string.Empty, new List<string>(), typeof(IEnumerable<string>), TargetType.Sequence)};
+                false, string.Empty, Maybe.Nothing<int>(), Maybe.Nothing<int>(), '.', null, string.Empty, string.Empty, new List<string>(), typeof(IEnumerable<string>), TargetType.Sequence, Maybe.Nothing<string>())};
 
             // Exercize system
             var result = NameLookup.HavingSeparator("string-seq", specs, StringComparer.Ordinal);
@@ -35,7 +39,7 @@ public void Get_name_from_option_specification()
 
             // Fixture setup
             var expected = new NameInfo(ShortName, LongName);
-            var spec = new OptionSpecification(ShortName, LongName, false, string.Empty, Maybe.Nothing<int>(), Maybe.Nothing<int>(), '.', null, string.Empty, string.Empty, new List<string>(), typeof(IEnumerable<string>), TargetType.Sequence);
+            var spec = new OptionSpecification(ShortName, LongName, false, string.Empty, Maybe.Nothing<int>(), Maybe.Nothing<int>(), '.', null, string.Empty, string.Empty, new List<string>(), typeof(IEnumerable<string>), TargetType.Sequence, Maybe.Nothing<string>());
 
             // Exercize system
             var result = spec.FromOptionSpecification();
diff --git a/tests/CommandLine.Tests/Unit/Core/OptionMapperTests.cs b/tests/CommandLine.Tests/Unit/Core/OptionMapperTests.cs
@@ -4,13 +4,17 @@
 using System.Collections.Generic;
 using System.Globalization;
 using System.Linq;
+
 #if PLATFORM_DOTNET
 using System.Reflection;
 #endif
 using CommandLine.Core;
 using CommandLine.Tests.Fakes;
+
 using Xunit;
+
 using CSharpx;
+
 using RailwaySharp.ErrorHandling;
 
 namespace CommandLine.Tests.Unit.Core
@@ -28,7 +32,7 @@ public void Map_boolean_switch_creates_boolean_value()
             var specProps = new[]
                 {
                     SpecificationProperty.Create(
-                        new OptionSpecification("x", string.Empty, false, string.Empty, Maybe.Nothing<int>(), Maybe.Nothing<int>(), '\0', Maybe.Nothing<object>(), string.Empty, string.Empty, new List<string>(), typeof(bool), TargetType.Switch), 
+                        new OptionSpecification("x", string.Empty, false, string.Empty, Maybe.Nothing<int>(), Maybe.Nothing<int>(), '\0', Maybe.Nothing<object>(), string.Empty, string.Empty, new List<string>(), typeof(bool), TargetType.Switch, Maybe.Nothing<string>()),
                         typeof(Simple_Options).GetProperties().Single(p => p.Name.Equals("BoolValue", StringComparison.Ordinal)),
                         Maybe.Nothing<object>())
                 };
diff --git a/tests/CommandLine.Tests/Unit/Core/TokenPartitionerTests.cs b/tests/CommandLine.Tests/Unit/Core/TokenPartitionerTests.cs
@@ -1,10 +1,13 @@
 ﻿// Copyright 2005-2015 Giacomo Stelluti Scala & Contributors. All rights reserved. See License.md in the project root for license information.
 
+using CommandLine.Core;
+
+using CSharpx;
+
 using System;
 using System.Collections.Generic;
 using System.Linq;
-using CommandLine.Core;
-using CSharpx;
+
 using Xunit;
 
 namespace CommandLine.Tests.Unit.Core
@@ -17,12 +20,12 @@ public void Partition_sequence_returns_sequence()
             // Fixture setup
             var expectedSequence = new[]
                 {
-                    new KeyValuePair<string, IEnumerable<string>>("i", new[] {"10", "20", "30", "40"}) 
+                    new KeyValuePair<string, IEnumerable<string>>("i", new[] {"10", "20", "30", "40"})
                 };
-            var specs =new[]
+            var specs = new[]
                 {
-                    new OptionSpecification(string.Empty, "stringvalue", false, string.Empty, Maybe.Nothing<int>(), Maybe.Nothing<int>(), '\0', null, string.Empty, string.Empty, new List<string>(), typeof(string), TargetType.Scalar),
-                    new OptionSpecification("i", string.Empty, false, string.Empty, Maybe.Just(3), Maybe.Just(4), '\0', null, string.Empty, string.Empty, new List<string>(), typeof(IEnumerable<int>), TargetType.Sequence)
+                    new OptionSpecification(string.Empty, "stringvalue", false, string.Empty, Maybe.Nothing<int>(), Maybe.Nothing<int>(), '\0', null, string.Empty, string.Empty, new List<string>(), typeof(string), TargetType.Scalar, Maybe.Nothing<string>()),
+                    new OptionSpecification("i", string.Empty, false, string.Empty, Maybe.Just(3), Maybe.Just(4), '\0', null, string.Empty, string.Empty, new List<string>(), typeof(IEnumerable<int>), TargetType.Sequence, Maybe.Nothing<string>())
                 };
 
             // Exercize system 
@@ -44,12 +47,12 @@ public void Partition_sequence_returns_sequence_with_duplicates()
             // Fixture setup
             var expectedSequence = new[]
                 {
-                    new KeyValuePair<string, IEnumerable<string>>("i", new[] {"10", "10", "30", "40"}) 
+                    new KeyValuePair<string, IEnumerable<string>>("i", new[] {"10", "10", "30", "40"})
                 };
-            var specs =new[]
+            var specs = new[]
                 {
-                    new OptionSpecification(string.Empty, "stringvalue", false, string.Empty, Maybe.Nothing<int>(), Maybe.Nothing<int>(), '\0', null, string.Empty, string.Empty, new List<string>(), typeof(string), TargetType.Scalar),
-                    new OptionSpecification("i", string.Empty, false, string.Empty, Maybe.Just(3), Maybe.Just(4), '\0', null, string.Empty, string.Empty, new List<string>(), typeof(IEnumerable<int>), TargetType.Sequence)
+                    new OptionSpecification(string.Empty, "stringvalue", false, string.Empty, Maybe.Nothing<int>(), Maybe.Nothing<int>(), '\0', null, string.Empty, string.Empty, new List<string>(), typeof(string), TargetType.Scalar, Maybe.Nothing<string>()),
+                    new OptionSpecification("i", string.Empty, false, string.Empty, Maybe.Just(3), Maybe.Just(4), '\0', null, string.Empty, string.Empty, new List<string>(), typeof(IEnumerable<int>), TargetType.Sequence, Maybe.Nothing<string>())
                 };
 
             // Exercize system 
diff --git a/tests/CommandLine.Tests/Unit/Core/TokenizerTests.cs b/tests/CommandLine.Tests/Unit/Core/TokenizerTests.cs

Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,7 @@ public static OptionSpecification WithLongName(this OptionSpecification specific`
`34`	`34`	`specification.EnumValues,`
`35`	`35`	`specification.ConversionType,`
`36`	`36`	`specification.TargetType,`
	`37`	`+ specification.Group,`
`37`	`38`	`specification.Hidden);`
`38`	`39`	`}`
`39`	`40`
Original file line number	Diff line number	Diff line change
`@@ -210,7 +210,7 @@ public override bool Equals(object obj)`
`210`	`210`	`/// <remarks>A hash code for the current <see cref="System.Object"/>.</remarks>`
`211`	`211`	`public override int GetHashCode()`
`212`	`212`	`{`
`213`		`- return new {Tag, StopsProcessing, Token}.GetHashCode();`
	`213`	`+ return new { Tag, StopsProcessing, Token }.GetHashCode();`
`214`	`214`	`}`
`215`	`215`
`216`	`216`	`/// <summary>`
`@@ -289,7 +289,7 @@ public override bool Equals(object obj)`
`289`	`289`	`/// <remarks>A hash code for the current <see cref="System.Object"/>.</remarks>`
`290`	`290`	`public override int GetHashCode()`
`291`	`291`	`{`
`292`		`- return new {Tag, StopsProcessing, NameInfo}.GetHashCode();`
	`292`	`+ return new { Tag, StopsProcessing, NameInfo }.GetHashCode();`
`293`	`293`	`}`
`294`	`294`
`295`	`295`	`/// <summary>`
`@@ -526,4 +526,22 @@ internal InvalidAttributeConfigurationError()`
`526`	`526`	`{`
`527`	`527`	`}`
`528`	`528`	`}`
	`529`	`+`
	`530`	`+ public sealed class MissingGroupOptionError : Error`
	`531`	`+ {`
	`532`	`+ public const string ErrorMessage = "At least one option in a group must have value.";`
	`533`	`+`
	`534`	`+ private readonly string group;`
	`535`	`+`
	`536`	`+ internal MissingGroupOptionError(string group)`
	`537`	`+ : base(ErrorType.HelpRequestedError, true)`
	`538`	`+ {`
	`539`	`+ this.group = group;`
	`540`	`+ }`
	`541`	`+`
	`542`	`+ public string Group`
	`543`	`+ {`
	`544`	`+ get { return group; }`
	`545`	`+ }`
	`546`	`+ }`
`529`	`547`	`}`