Added arity checks to analyzer (#29)

* Added arity checks to analyzer
* Added support to NamespaceQualifiedTypeName to support arrays
* Added support to `TypeSymbolExtensions.IsCollection`
* Added testing of the demo source (as a link) to ensure it will operate correctly

* Added nullability enable to all expected files
* Allows nullability annotations for any nullable types

Author: smaillet

docfx/CommandLine/Diagnostics/UNC005.md

@@ -0,0 +1,15 @@
+# UNC005 : Arity specified for property type is invalid.
+This diagnostic indicates that the arity specified in an attribute does not match the type
+of value for that property^1^. The default arity is usually enough but it is sometimes valid
+to limit the "or more" default to a max value. In particular with collections there may be
+a limit to the maximum number of values allowed so the arity specifies that. Not that the
+arity applies to the ***values*** of a property. That is:
+`--foo true` is ONLY allowed if the minimum arity is > 1, otherwise only the option itself
+is allowed (for example: `--foo`). Setting the arity to a maximum that is > 1 requires a
+collection type to bind the parsed values to. Setting a minimum > 0 makes it required to
+specify a value for the command. That is, with a minimum arity of 1 `--foo` is an error.
+
+
+---
+^1^ see the [System.CommandLine docs](https://learn.microsoft.com/en-us/dotnet/standard/commandline/syntax#argument-arity)
+for details.

docfx/CommandLine/index.md

@@ -14,3 +14,4 @@ Rule ID | Title |
 [UNC002](https://ubiquitydotnet.github.io/Ubiquity.NET.Utils/CommandLine/diagnostics/UNC002.html) | Property attribute not allowed standalone. |
 [UNC003](https://ubiquitydotnet.github.io/Ubiquity.NET.Utils/CommandLine/diagnostics/UNC003.html) | Property has incorrect type for attribute. |
 [UNC004](https://ubiquitydotnet.github.io/Ubiquity.NET.Utils/CommandLine/diagnostics/UNC004.html) | Property type is nullable but marked as required. |
+[UNC005](https://ubiquitydotnet.github.io/Ubiquity.NET.Utils/CommandLine/diagnostics/UNC004.html) | Arity specified for property type is invalid. |

docfx/IgnoredWords.dic

@@ -1 +1,2 @@
+arity
 nullable

src/DemoCommandLineSrcGen/TestOptions.cs

@@ -3,8 +3,8 @@
 
 #pragma warning disable IDE0130 // Namespace does not match folder structure
 
-using System.CommandLine;
 using System.IO;
+using System.Linq;
 
 using Ubiquity.NET.CommandLine;
 using Ubiquity.NET.CommandLine.GeneratorAttributes;
@@ -18,14 +18,14 @@ namespace TestNamespace
     [RootCommand( Description = "Root command for tests" )]
     internal partial class TestOptions
     {
-        [Option( "-o", Description = "Test SomePath" )]
+        [Option( "-o", Description = "Test SomePath", Required = true )]
         [FolderValidation( FolderValidation.CreateIfNotExist )]
         public required DirectoryInfo SomePath { get; init; }
 
         [Option( "-v", Description = "Verbosity Level" )]
         public MsgLevel Verbosity { get; init; } = MsgLevel.Information;
 
-        [Option( "-b", Description = "Test Some existing Path" )]
+        [Option( "-b", Description = "Test Some existing Path", Required = true )]
         [FolderValidation( FolderValidation.ExistingOnly )]
         public required DirectoryInfo SomeExistingPath { get; init; }
 
@@ -35,9 +35,12 @@ internal partial class TestOptions
         // This should be ignored by generator
         public string? NotAnOption { get; set; }
 
-        [Option( "-a", Hidden = true, Required = false, ArityMin = 0, ArityMax = 3, Description = "Test SomeOtherPath" )]
+        [Option( "-i", ArityMin = 0, Description = "include path" )]
+        public required DirectoryInfo[] IncludePath { get; init; }
+
+        [Option( "-a", Hidden = true, Required = false, Description = "Test SomeOtherPath" )]
         [FileValidation( FileValidation.ExistingOnly )]
-        public required FileInfo SomeOtherPath { get; init; }
+        public required FileInfo? SomeOtherPath { get; init; }
 
         public override string ToString( )
         {
@@ -48,6 +51,7 @@ public override string ToString( )
                 Thing1 = {Thing1}
                 NotAnOption = {NotAnOption ?? "<null>"}
                 SomeOtherPath = '{SomeOtherPath?.FullName ?? "<null>"}'
+                IncludePath = '{string.Join(";", IncludePath.Select(di=>di.FullName))}'
             """;
         }
     }

src/Ubiquity.NET.CodeAnalysis.Utils/DiagnosticInfo.cs

@@ -19,16 +19,16 @@ public sealed class DiagnosticInfo
         /// <param name="descriptor">Descriptor for the diagnostic</param>
         /// <param name="location">Location in the source file that triggered this diagnostic</param>
         /// <param name="msgArgs">Args for the message</param>
-        public DiagnosticInfo(DiagnosticDescriptor descriptor, Location? location, params string[] msgArgs)
-            : this(descriptor, location, (IEnumerable<string>)msgArgs)
+        public DiagnosticInfo(DiagnosticDescriptor descriptor, Location? location, params object[] msgArgs)
+            : this(descriptor, location, (IEnumerable<object>)msgArgs)
         {
         }
 
         /// <summary>Initializes a new instance of the <see cref="DiagnosticInfo"/> class.</summary>
         /// <param name="descriptor">Descriptor for the diagnostic</param>
         /// <param name="location">Location in the source file that triggered this diagnostic</param>
         /// <param name="msgArgs">Args for the message</param>
-        public DiagnosticInfo(DiagnosticDescriptor descriptor, Location? location, IEnumerable<string> msgArgs)
+        public DiagnosticInfo(DiagnosticDescriptor descriptor, Location? location, IEnumerable<object> msgArgs)
 #else
         /// <summary>Initializes a new instance of the <see cref="DiagnosticInfo"/> class.</summary>
         /// <param name="descriptor">Descriptor for the diagnostic</param>
@@ -43,7 +43,7 @@ public DiagnosticInfo(DiagnosticDescriptor descriptor, Location? location, param
         }
 
         /// <summary>Gets the parameters for this diagnostic</summary>
-        public ImmutableArray<string> Params { get; }
+        public ImmutableArray<object> Params { get; }
 
         /// <summary>Gets the descriptor for this diagnostic</summary>
         public DiagnosticDescriptor Descriptor { get; }

src/Ubiquity.NET.CodeAnalysis.Utils/NamespaceQualifiedNameFormatter.cs

@@ -111,6 +111,12 @@ public string Format( string format, NamespaceQualifiedName arg, IFormatProvider
         /// <exception cref="NotSupportedException"><paramref name="format"/> is not supported</exception>
         public string Format( string format, NamespaceQualifiedTypeName arg, IFormatProvider? formatProvider )
         {
+            if(arg.IsArray)
+            {
+                string formattedElement = Format(format, arg.ElementType, formatProvider);
+                return $"{formattedElement}[]";
+            }
+
             string formattedString = Format(format, (NamespaceQualifiedName)arg, formatProvider);
             return arg.NullableAnnotation == NullableAnnotation.Annotated
                  ? $"{formattedString}?"

src/Ubiquity.NET.CodeAnalysis.Utils/NamespaceQualifiedTypeName.cs

@@ -49,13 +49,25 @@ public NamespaceQualifiedTypeName(
         public NamespaceQualifiedTypeName( ITypeSymbol sym )
             : this( GetNullableNamespaceNames( sym ), GetNullableSimpleName( sym ), sym.NullableAnnotation )
         {
+            if(sym is IArrayTypeSymbol arrayType)
+            {
+                IsArray = true;
+                ElementType = arrayType.ElementType.GetNamespaceQualifiedName();
+            }
         }
 
         /// <summary>Gets a value indicating whether this type has nullability annotation (and a generator should use a language specific nullability form)</summary>
         public bool IsNullable => NullableAnnotation == NullableAnnotation.Annotated;
 
         /// <summary>Gets the nullability annotation state for this type</summary>
-        public NullableAnnotation NullableAnnotation { get; init; }
+        public NullableAnnotation NullableAnnotation { get; }
+
+        /// <summary>Gets a value indicating whether this name is an array</summary>
+        [MemberNotNullWhen( true, nameof( ElementType ) )]
+        public bool IsArray { get; }
+
+        /// <summary>Gets the array element type (Only valid if <see cref="IsArray"/> is true)</summary>
+        public NamespaceQualifiedTypeName? ElementType { get; }
 
         /// <summary>Formats this instance according to the args</summary>
         /// <param name="format">Format string for this instance (see remarks)</param>
@@ -132,15 +144,27 @@ public override int GetHashCode( )
         #endregion
 
         // IFF sym is a Nullable<T> (Nullable value type) this will get the simple name of T
+        [SuppressMessage( "Style", "IDE0046:Convert to conditional expression", Justification = "Nested conditionals != simpler" )]
         private static string GetNullableSimpleName( ITypeSymbol sym )
         {
+            if(sym is IArrayTypeSymbol arrayTypeSymbol)
+            {
+                return "Array";
+            }
+
             return sym.IsNullableValueType() && sym is INamedTypeSymbol ns
                 ? ns.TypeArguments[ 0 ].Name
                 : sym.Name;
         }
 
+        [SuppressMessage( "Style", "IDE0046:Convert to conditional expression", Justification = "Nested conditionals != simpler" )]
         private static IEnumerable<string> GetNullableNamespaceNames( ITypeSymbol sym )
         {
+            if(sym is IArrayTypeSymbol arrayTypeSymbol)
+            {
+                return ["System"];
+            }
+
             return sym.IsNullableValueType() && sym is INamedTypeSymbol ns
                  ? ns.TypeArguments[ 0 ].GetNamespaceNames()
                  : sym.GetNamespaceNames();

src/Ubiquity.NET.CodeAnalysis.Utils/TypeSymbolExtensions.cs

@@ -52,6 +52,24 @@ public static bool IsNullableValueType( this ITypeSymbol self )
                 && self.IsValueType;
         }
 
+        /// <summary>Determines if this type symbol is a collection</summary>
+        /// <param name="self">Type symbol to test</param>
+        /// <returns>true if the type is a collection and false if not</returns>
+        public static bool IsCollection( this ITypeSymbol self )
+        {
+            var collectionItf = new NamespaceQualifiedTypeName(["System", "Collections"], "ICollection");
+            for(int i = 0; i < self.AllInterfaces.Length; ++i)
+            {
+                var itf = self.AllInterfaces[i];
+                if(itf.GetNamespaceQualifiedName() == collectionItf)
+                {
+                    return true;
+                }
+            }
+
+            return false;
+        }
+
         // private iterator to defer the perf hit for reverse walk until the names
         // are iterated. The call to GetEnumerator() will take the hit to reverse walk
         // the names.

src/Ubiquity.NET.CommandLine.SrcGen.UT/CommandAnalyzerTests.cs

@@ -138,9 +138,25 @@ public async Task Required_nullable_types_produce_diagnostic( TestRuntime testRu
             await analyzerTest.RunAsync( TestContext.CancellationToken );
         }
 
-        // TODO: Test that a nullable value is not marked as required. (That's a conflicting claim, if it's required it can't be null)
-        //       A nullable type MAY have a default value handler to provide a null default. Additional test - anything with a default
-        //       value provider shouldn't be "required" it's also nonsensical.
+        [TestMethod]
+        [DataRow( TestRuntime.Net8_0 )]
+        [DataRow( TestRuntime.Net10_0 )]
+        public async Task OptionArity_Not_matching_type_produces_diagnostic( TestRuntime testRuntime )
+        {
+            SourceText txt = GetSourceText( nameof(OptionArity_Not_matching_type_produces_diagnostic), "input.cs" );
+            var analyzerTest = CreateTestRunner( txt, testRuntime );
+
+            // (9,6): error UNC005: Property '{0}' has type of '{1}' does not support arity of ({2}, {3}).
+            analyzerTest.ExpectedDiagnostics.AddRange(
+               [
+                   new DiagnosticResult("UNC005", DiagnosticSeverity.Error)
+                      .WithArguments("Thing1", "bool", 3, 5)
+                      .WithSpan(10, 6, 10, 138),
+               ]
+             );
+
+            await analyzerTest.RunAsync( TestContext.CancellationToken );
+        }
 
         private AnalyzerTest<MsTestVerifier> CreateTestRunner( string source, TestRuntime testRuntime )
         {

src/Ubiquity.NET.CommandLine.SrcGen.UT/RootCommandAttributeTests.cs

@@ -20,7 +20,7 @@ public async Task Basic_golden_path_succeeds( TestRuntime testRuntime )
             SourceText input = GetSourceText( nameof(Basic_golden_path_succeeds), inputFileName );
             SourceText expected = GetSourceText( nameof(Basic_golden_path_succeeds), expectedFileName );
 
-            var runner = CreateTestRunner(input, testRuntime, [TrackingNames.CommandClass], hintPath, expected );
+            var runner = CreateTestRunner( input, testRuntime, [TrackingNames.CommandClass], hintPath, expected );
             await runner.RunAsync( TestContext.CancellationToken );
         }
 
@@ -36,7 +36,23 @@ public async Task Generator_handles_nullable_types( TestRuntime testRuntime )
             SourceText input = GetSourceText( nameof(Generator_handles_nullable_types), inputFileName );
             SourceText expected = GetSourceText( nameof(Generator_handles_nullable_types), expectedFileName );
 
-            var runner = CreateTestRunner(input, testRuntime, [TrackingNames.CommandClass], hintPath, expected );
+            var runner = CreateTestRunner( input, testRuntime, [TrackingNames.CommandClass], hintPath, expected );
+            await runner.RunAsync( TestContext.CancellationToken );
+        }
+
+        [TestMethod]
+        [DataRow( TestRuntime.Net8_0 )]
+        [DataRow( TestRuntime.Net10_0 )]
+        public async Task DemoSource_succeeds( TestRuntime testRuntime )
+        {
+            const string inputFileName = "TestOptions.cs";
+            const string expectedFileName = "expected.cs";
+            string hintPath = Path.Combine("Ubiquity.NET.CommandLine.SrcGen", "Ubiquity.NET.CommandLine.SrcGen.CommandGenerator", "TestNamespace.TestOptions.g.cs");
+
+            SourceText input = GetSourceText( nameof(DemoSource_succeeds), inputFileName );
+            SourceText expected = GetSourceText( nameof(DemoSource_succeeds), expectedFileName );
+
+            var runner = CreateTestRunner( input, testRuntime, [TrackingNames.CommandClass], hintPath, expected );
             await runner.RunAsync( TestContext.CancellationToken );
         }
 
@@ -69,7 +85,7 @@ SourceText expectedContent
             };
         }
 
-        private static SourceText GetSourceText(params string[] nameParts)
+        private static SourceText GetSourceText( params string[] nameParts )
         {
             return TestHelpers.GetTestText( nameof( RootCommandAttributeTests ), nameParts );
         }