Nullability

wallymathieu · Jun 7, 2024 · 1e1e7c5 · 1e1e7c5
1 parent 29019c7
commit 1e1e7c5
Show file tree

Hide file tree

Showing 45 changed files with 187 additions and 171 deletions.
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -12,6 +12,8 @@
     <PackageProjectUrl>https://github.com/wallymathieu/isop</PackageProjectUrl>
     <PackageTags>CLI;command line;commandline;argument;option;parser;parsing;library;syntax;shell</PackageTags>
     <LangVersion>12.0</LangVersion>
+    <Nullable>enable</Nullable>
+    <WarningsAsErrors>Nullable</WarningsAsErrors>
   </PropertyGroup>
 
   <!-- mono -->

diff --git a/src/Example/MyController.cs b/src/Example/MyController.cs
@@ -32,7 +32,7 @@ public string ActionWithGlobalParameter(string global)
         }
         public class Argument
         {
-            public string MyProperty { get; set; }
+            public string? MyProperty { get; set; }
 
         }
         public string ActionWithObjectArgument(Argument arg)

diff --git a/src/FullExample/MyController.cs b/src/FullExample/MyController.cs
@@ -42,7 +42,7 @@ public string ActionWithGlobalParameter(string global)
         }
         public class Argument
         {
-            public string MyProperty { get; set; }
+            public string? MyProperty { get; set; }
 
         }
         public string ActionWithObjectArgument(Argument arg)

diff --git a/src/Isop/Abstractions/ArgumentAction.cs b/src/Isop/Abstractions/ArgumentAction.cs
@@ -5,5 +5,5 @@ namespace Isop.Abstractions
     /// <summary>
     /// Action that should be invoked when argument is encountered
     /// </summary>
-    public delegate Task<object> ArgumentAction(string value);
+    public delegate Task<object?> ArgumentAction(string? value);
 }
diff --git a/src/Isop/Abstractions/IActionOnController.cs b/src/Isop/Abstractions/IActionOnController.cs
@@ -16,7 +16,7 @@ public interface IActionOnController
         /// <summary>
         /// send parameters to controller actions
         /// </summary>
-        IParsed Parameters(Dictionary<string, string> parameters);
+        IParsed Parameters(Dictionary<string, string?> parameters);
 
         /// <summary>
         /// Get help for controller action

diff --git a/src/Isop/Abstractions/IAppHostBuilder.cs b/src/Isop/Abstractions/IAppHostBuilder.cs
@@ -25,7 +25,7 @@ public interface IAppHostBuilder
         /// <param name="required"></param>
         /// <param name="description"></param>
         /// <returns></returns>
-        IAppHostBuilder Parameter(string argument, ArgumentAction action = null, bool required = false, string description = null);
+        IAppHostBuilder Parameter(string argument, ArgumentAction? action = null, bool required = false, string? description = null);
 
         /// <summary>
         /// 
@@ -35,7 +35,7 @@ public interface IAppHostBuilder
         /// <param name="required"></param>
         /// <param name="description"></param>
         /// <returns></returns>
-        IAppHostBuilder Parameter(string argument, Action<string> action, bool required = false, string description = null);
+        IAppHostBuilder Parameter(string argument, Action<string?> action, bool required = false, string? description = null);
 
         /// <summary>
         /// 

diff --git a/src/Isop/Abstractions/InvokeResult.cs b/src/Isop/Abstractions/InvokeResult.cs
@@ -9,19 +9,19 @@ public class Empty : InvokeResult
         {
         }
 
-        public class ControllerAction(object result) : InvokeResult
+        public class ControllerAction(object? result) : InvokeResult
         {
-            public object Result { get; } = result;
+            public object? Result { get; } = result;
         }
 
-        public class Argument(object result) : InvokeResult
+        public class Argument(object? result) : InvokeResult
         {
-            public object Result { get; } = result;
+            public object? Result { get; } = result;
         }
 
-        public class AsyncControllerAction(Task<object> task) : InvokeResult
+        public class AsyncControllerAction(Task<object?> task) : InvokeResult
         {
-            public Task<object> Task { get; } = task;
+            public Task<object?> Task { get; } = task;
         }
 
         /// <summary>

diff --git a/src/Isop/Abstractions/ToStrings.cs b/src/Isop/Abstractions/ToStrings.cs
@@ -5,6 +5,6 @@ namespace Isop.Abstractions
     /// <summary>
     /// Do a ToString conversion to format a value as a string. To format enumerable as multiple strings. 
     /// </summary>
-    public delegate IEnumerable<string> ToStrings(object value);
+    public delegate IEnumerable<string> ToStrings(object? value);
 }
 
diff --git a/src/Isop/Abstractions/TypeConverter.cs b/src/Isop/Abstractions/TypeConverter.cs
@@ -4,5 +4,5 @@ namespace Isop.Abstractions
     /// <summary>
     /// Represents a type converter
     /// </summary>
-    public delegate object TypeConverter(System.Type type, string value, System.Globalization.CultureInfo culture);
+    public delegate object? TypeConverter(System.Type type, string? value, System.Globalization.CultureInfo? culture);
 }
diff --git a/src/Isop/CommandLine/Argument.cs b/src/Isop/CommandLine/Argument.cs
@@ -1,15 +1,15 @@
 namespace Isop.CommandLine
 {
     using Parse;
-    public sealed class Argument(ArgumentParameter parameter, bool required = false, string description = null)
+    public sealed class Argument(ArgumentParameter parameter, bool required = false, string? description = null)
     {
         public ArgumentParameter Parameter { get; } = parameter;
 
-        public string Description { get; } = description;
+        public string? Description { get; } = description;
         public string Name => Parameter.LongAlias();
         public bool Required { get; } = required;
 
-        public override bool Equals(object obj)
+        public override bool Equals(object? obj)
         {
             if (obj is null) return false;
             if (ReferenceEquals(this, obj)) return true;

diff --git a/src/Isop/CommandLine/ArgumentInvoker.cs b/src/Isop/CommandLine/ArgumentInvoker.cs
@@ -15,13 +15,14 @@ namespace Isop.CommandLine
     using Infrastructure;
     using System.Threading;
     using System.Reflection;
+    using System.Diagnostics.CodeAnalysis;
 
     public class ArgumentInvoker(IServiceProvider serviceProvider, Recognizes recognizes, HelpController helpController)
     {
         private ILookup<string, ArgumentAction>? _recognizesMap;
 
         private ILookup<string,ArgumentAction> RecognizesMap =>
-            _recognizesMap ??= recognizes.Properties.Where(p=>p.Action!=null).ToLookup(p=>p.Name, p=>p.Action);
+            _recognizesMap ??= recognizes.Properties.Where(p=>p.Action!=null).ToLookup(p=>p.Name, p=>p.Action!);
 
 #if NET8_0_OR_GREATER
         private static bool IsIAsyncEnumerable(Type type) =>(
@@ -36,7 +37,7 @@ private static bool IsIAsyncEnumerable(Type type) =>(
                 yield return val;
             }
         }
-        private static bool AsyncEnumerable(object result, out IAsyncEnumerable<object?>? enumerable)
+        private static bool AsyncEnumerable(object? result, [NotNullWhen(true)] out IAsyncEnumerable<object?>? enumerable)
         {
             enumerable = null;
             if (result is null) return false;

diff --git a/src/Isop/CommandLine/ControllerRecognizer.cs b/src/Isop/CommandLine/ControllerRecognizer.cs
@@ -4,6 +4,7 @@
 using System.Globalization;
 using System.Linq;
 using Microsoft.Extensions.Options;
+using System.Diagnostics.CodeAnalysis;
 
 namespace Isop.CommandLine
 {
@@ -94,20 +95,24 @@ public ParsedArguments Parse(Controller controller, Method method, IReadOnlyColl
 
             if (! _convertArgument.TryGetParametersForMethod(method, 
                 parsedArguments.Recognized
-                    .Select(a => new KeyValuePair<string,string>(a.RawArgument, a.Value))
+                    .Select(a => new KeyValuePair<string,string?>(a.RawArgument, a.Value))
                     .ToArray(), out var recognizedActionParameters, out var missingParameters))
                 return new ParsedArguments.MethodMissingArguments(
-                    missingParameters: missingParameters,
+                    missingParameters: missingParameters!,
                     recognizedClass: controller.Type,
                     recognizedAction: method);
             return new ParsedArguments.Method(
-                recognizedActionParameters: recognizedActionParameters, 
+                recognizedActionParameters: recognizedActionParameters!, 
                 recognized: parsedArguments.Recognized,
                 recognizedClass: controller.Type,
                 recognizedAction: method);
         }
 
-        public bool TryFindController(string name, out Controller controller)
+        public bool TryFindController(string name, 
+            #if NET8_0_OR_GREATER
+            [NotNullWhen(true)]
+            #endif
+            out Controller? controller)
         {
             if (_controllerActionMap.TryGetValue(name,
                 out var controllerAndMap))

diff --git a/src/Isop/CommandLine/ConvertArgumentsToParameterValue.cs b/src/Isop/CommandLine/ConvertArgumentsToParameterValue.cs
@@ -3,7 +3,7 @@
 using System.Globalization;
 using System.Linq;
 using Microsoft.Extensions.Options;
-
+using System.Diagnostics.CodeAnalysis;
 namespace Isop.CommandLine
 {
     using Abstractions;
@@ -17,10 +17,18 @@ internal class ConvertArgumentsToParameterValue(
         private readonly CultureInfo? _culture = configuration?.Value.CultureInfo;
 
         public bool TryGetParametersForMethod(Method method,
-            IReadOnlyCollection<KeyValuePair<string,string>> parsedArguments, out IReadOnlyCollection<object> parameters, out IReadOnlyCollection<string> missingParameters)
+            IReadOnlyCollection<KeyValuePair<string,string?>> parsedArguments,
+            #if NET8_0_OR_GREATER
+            [NotNullWhen(true)]
+            #endif
+            out IReadOnlyCollection<object?>? parameters,
+            #if NET8_0_OR_GREATER
+            [NotNullWhen(false)]
+            #endif
+            out IReadOnlyCollection<string>? missingParameters)
         {
             var parameterInfos = method.GetParameters();
-            var parameterValues = new List<object>();
+            var parameterValues = new List<object?>();
             var missing = new List<string>();
             foreach (var paramInfo in parameterInfos)
             {
@@ -44,14 +52,16 @@ public bool TryGetParametersForMethod(Method method,
                 }
             }
 
-            parameters = missing.Any() ? null: parameterValues;
-            missingParameters = missing.Any() ? missing : null;
-            return !missing.Any();
+            bool anythingMissing = missing.Count != 0;
+            parameters = anythingMissing ? null: parameterValues;
+            missingParameters = anythingMissing ? missing : null;
+            return !anythingMissing;
         }
 
-        private object CreateObjectFromArguments(IReadOnlyCollection<KeyValuePair<string,string>> parsedArguments, Parameter paramInfo)
+        private object CreateObjectFromArguments(IReadOnlyCollection<KeyValuePair<string,string?>> parsedArguments, Parameter paramInfo)
         {
             var obj = Activator.CreateInstance(paramInfo.ParameterType);
+            if (obj is null) throw new Exception($"Failed to initialize {paramInfo.ParameterType.Name}");
             foreach (var prop in paramInfo.GetPublicInstanceProperties())
             {
                 var recognizedArgument = parsedArguments.FirstOrDefault(a => a.Key.EqualsIgnoreCase(prop.Name));
@@ -63,7 +73,7 @@ private object CreateObjectFromArguments(IReadOnlyCollection<KeyValuePair<string
             return obj;
         }
 
-        private object ConvertFrom(KeyValuePair<string,string> arg1, Type type)
+        private object? ConvertFrom(KeyValuePair<string,string?> arg1, Type type)
         {
             try
             {

diff --git a/src/Isop/CommandLine/Help/HelpForArgumentWithOptions.cs b/src/Isop/CommandLine/Help/HelpForArgumentWithOptions.cs
@@ -26,14 +26,14 @@ public string Help(string? val = null)
                 return _texts.TheArgumentsAre + Environment.NewLine +
                       string.Join(Environment.NewLine,
                                   recognizes.Properties.Select(ar => "  "+ Help(ar)).ToArray());
-            return Help(recognizes.Properties.First(ar => ar.ToArgument(config?.Value?.CultureInfo).Accept(val)));
+            return Help(recognizes.Properties.First(ar => ar.ToArgument(config?.Value?.CultureInfo).Accept(val!)));
         }
 
         public bool CanHelp(string? val = null)
         {
             return string.IsNullOrEmpty(val)
                 ? recognizes.Properties.Any()
-                : recognizes.Properties.Any(ar => ar.ToArgument(config?.Value?.CultureInfo).Accept(val));
+                : recognizes.Properties.Any(ar => ar.ToArgument(config?.Value?.CultureInfo).Accept(val!));
         }
     }
 }

diff --git a/src/Isop/CommandLine/Lex/Token.cs b/src/Isop/CommandLine/Lex/Token.cs
@@ -11,7 +11,7 @@ public struct Token(string value, TokenType tokenType, int index)
         /// </summary>
         public int Index = index;
 
-        public override readonly bool Equals(object obj)
+        public override readonly bool Equals(object? obj)
         {
             if (obj is null) return false;
             return obj is Token token && Equals(token);

diff --git a/src/Isop/CommandLine/Parse/ArgumentParameter.cs b/src/Isop/CommandLine/Parse/ArgumentParameter.cs
@@ -59,7 +59,7 @@ public bool Accept(int index, string val)
         public string LongAlias()
         {
             var maxLength = Aliases.Max(a => a.Length);
-            return Aliases.SingleOrDefault(a => a.Length == maxLength);
+            return Aliases.SingleOrDefault(a => a.Length == maxLength) ?? throw new NullReferenceException("alias");
         }
 
         public bool Accept(string value)

diff --git a/src/Isop/CommandLine/Parse/ArgumentParser.cs b/src/Isop/CommandLine/Parse/ArgumentParser.cs
@@ -85,7 +85,7 @@ public ParsedArguments.Properties Parse(IReadOnlyList<Token> lexed, IReadOnlyCol
                         !recognized.Any(otherArgument =>
                             argument.InferredOrdinal &&
                             !ReferenceEquals(argument, otherArgument) 
-                            && otherArgument.RawArgument.Equals(argument.RawArgument)))
+                            && (otherArgument.RawArgument?.Equals(argument.RawArgument)??false)))
                 .ToList();
             var recognizedIndexes = minusDuplicates.SelectMany(token=>token.Index).ToList();
 
@@ -112,10 +112,10 @@ private void InferParameter(IList<RecognizedArgument> recognized, Token current)
             if (null != argumentWithOptions)
             {
                 recognized.Add(new RecognizedArgument(
-                                   argumentWithOptions,
-                                   [current.Index],
-                                   argumentWithOptions.Name,
-                                   current.Value,
+                                   argument: argumentWithOptions,
+                                   index: [current.Index],
+                                   rawArgument: argumentWithOptions.Name,
+                                   value: current.Value,
                                    inferredOrdinal:true));
             }
         }

diff --git a/src/Isop/CommandLine/PropertyExtensions.cs b/src/Isop/CommandLine/PropertyExtensions.cs
@@ -7,7 +7,7 @@ namespace Isop.CommandLine
     internal static class PropertyExtensions
     {
         [Obsolete("Temporary")]
-        public static Argument ToArgument(this Property p, IFormatProvider formatProvider)
+        public static Argument ToArgument(this Property p, IFormatProvider? formatProvider)
         {
             var argumentParam= ArgumentParameter.Parse(p.Name, formatProvider);
             return new Argument(

diff --git a/src/Isop/CommandLine/ToStrings.cs b/src/Isop/CommandLine/ToStrings.cs
@@ -8,7 +8,7 @@ namespace Isop.CommandLine
 {
     internal static class ToStrings
     {
-        public static IEnumerable<string> Default(object value)
+        public static IEnumerable<string> Default(object? value)
         {
             if (value == null) yield break;
             switch (value)
@@ -28,12 +28,12 @@ public static IEnumerable<string> Default(object value)
                     break;
                 }
                 default:
-                    yield return value.ToString();
+                    yield return value.ToString()!;
                     break;
             }
         }
 
-        public static IEnumerable<string> AsTable(object value)
+        public static IEnumerable<string> AsTable(object? value)
         {
             if (value == null) yield break;
             switch (value)

diff --git a/src/Isop/Domain/Controller.cs b/src/Isop/Domain/Controller.cs
@@ -30,12 +30,12 @@ private static IEnumerable<MethodInfo> GetOwnPublicMethods(Type type) =>
                 .Where(m => !m.Name.StartsWithIgnoreCase("get_")
                             && !m.Name.StartsWithIgnoreCase("set_"));
 
-        public Method GetMethod(Conventions conventions, string name) => 
+        public Method? GetMethod(Conventions conventions, string name) => 
             GetControllerActionMethods(conventions).SingleOrDefault(m => m.Name.EqualsIgnoreCase(name));
 
         public bool IsHelp() => Type == typeof(HelpController);
 
-        public override bool Equals(object obj) => obj is Controller controller && Equals(controller);
+        public override bool Equals(object? obj) => obj is Controller controller && Equals(controller);
         public bool Equals(Controller obj) => Type == obj?.Type;
 
         public override int GetHashCode() => Type.GetHashCode();

diff --git a/src/Isop/Domain/Method.cs b/src/Isop/Domain/Method.cs
@@ -16,13 +16,15 @@ public class Method(MethodInfo methodInfo)
         public string Name => methodInfo.Name;
         public MethodInfo MethodInfo => methodInfo;
         public Parameter[] GetParameters() => methodInfo.GetParameters().Select(p => new Parameter(p)).ToArray();
-        public object Invoke(object instance, object[] values)
+        public object? Invoke(object instance, object[] values)
         {
-            if (instance==null) throw new ArgumentNullException(nameof(instance));
+            if (instance == null) throw new ArgumentNullException(nameof(instance));
             try
             {
                 return methodInfo.Invoke(instance, values);
-            }catch(TargetInvocationException ex){
+            }
+            catch (TargetInvocationException ex)
+            {
                 if (ex.InnerException != null)
                 {
                     ExceptionDispatchInfo.Capture(ex.InnerException).Throw();
@@ -52,14 +54,14 @@ private static Argument CreateArgument(Parameter parameterInfo, IFormatProvider?
             new Argument(required: parameterInfo.LooksRequired(),
                 parameter: ArgumentParameter.Parse(parameterInfo.Name, cultureInfo));
 
-        private static IEnumerable<Argument> CreateArgumentsForInstanceProperties(Parameter parameterInfo, IFormatProvider cultureInfo) =>
+        private static IEnumerable<Argument> CreateArgumentsForInstanceProperties(Parameter parameterInfo, IFormatProvider? cultureInfo) =>
             parameterInfo.GetPublicInstanceProperties()
-                .Select(prop => 
-                    new Argument( 
+                .Select(prop =>
+                    new Argument(
                         required: parameterInfo.LooksRequired() && IsRequired(prop),
                         parameter: ArgumentParameter.Parse(prop.Name, cultureInfo)));
 
-        private static bool IsRequired(PropertyInfo propertyInfo) => 
+        private static bool IsRequired(PropertyInfo propertyInfo) =>
             propertyInfo.GetCustomAttributes(typeof(RequiredAttribute), true).Any();
     }
 }