tk/spectre.console
1
0
Fork 0
mirror of https://github.com/nsnail/spectre.console.git synced 2025-04-14 16:02:50 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix DefaultValue for FileInfo and DirectoryInfo (#1238)

Browse Source 
Commit d3f4f5f208ee76a22ff39c13df4d150712685f5f introduced automatic conversion to FileInfo and DirectoryInfo but failed to properly handle the conversion if the value comes from the [DefaultValue] attribute.

Using both `var (converter, stringConstructor) = GetConverter(...)` and `var (converter, _) = GetConverter(...)` should have been a red flag!
This commit is contained in:
Cédric Luthi 2023-09-21 13:05:42 +02:00 committed by GitHub
parent 943c045fab
commit 5296e56b1c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 51 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
src/Spectre.Console.Cli/Internal/Binding/CommandValueResolver.cs
View File

@ -78,28 +78,16 @@ internal static class CommandValueResolver
}
else
{
var (converter, stringConstructor) = GetConverter(lookup, binder, resolver, mapped.Parameter);
if (converter == null)
{
throw CommandRuntimeException.NoConverterFound(mapped.Parameter);
}
object? value;
var converter = GetConverter(lookup, binder, resolver, mapped.Parameter);
var mappedValue = mapped.Value ?? string.Empty;
try
{
try
{
value = converter.ConvertFromInvariantString(mappedValue);
}
catch (NotSupportedException) when (stringConstructor != null)
{
value = stringConstructor.Invoke(new object[] { mappedValue });
}
value = converter.ConvertFrom(mappedValue);
}
catch (Exception exception) when (exception is not CommandRuntimeException)
{
throw CommandRuntimeException.ConversionFailed(mapped, converter, exception);
throw CommandRuntimeException.ConversionFailed(mapped, converter.TypeConverter, exception);
}
// Assign the value to the parameter.
@ -130,17 +118,14 @@ internal static class CommandValueResolver
{
if (result != null && result.GetType() != parameter.ParameterType)
{
var (converter, _) = GetConverter(lookup, binder, resolver, parameter);
if (converter != null)
{
result = result is Array array ? ConvertArray(array, converter) : converter.ConvertFrom(result);
}
var converter = GetConverter(lookup, binder, resolver, parameter);
result = result is Array array ? ConvertArray(array, converter) : converter.ConvertFrom(result);
}
return result;
}
private static Array ConvertArray(Array sourceArray, TypeConverter converter)
private static Array ConvertArray(Array sourceArray, SmartConverter converter)
{
Array? targetArray = null;
for (var i = 0; i < sourceArray.Length; i++)
@ -161,14 +146,8 @@ internal static class CommandValueResolver
}
[SuppressMessage("Style", "IDE0019:Use pattern matching", Justification = "It's OK")]
private static (TypeConverter? Converter, ConstructorInfo? StringConstructor) GetConverter(CommandValueLookup lookup, CommandValueBinder binder, ITypeResolver resolver, CommandParameter parameter)
private static SmartConverter GetConverter(CommandValueLookup lookup, CommandValueBinder binder, ITypeResolver resolver, CommandParameter parameter)
{
static ConstructorInfo? GetStringConstructor(Type type)
{
var constructor = type.GetConstructor(BindingFlags.Public | BindingFlags.Instance, null, new[] { typeof(string) }, null);
return constructor?.GetParameters()[0].ParameterType == typeof(string) ? constructor : null;
}
if (parameter.Converter == null)
{
if (parameter.ParameterType.IsArray)
@ -180,7 +159,7 @@ internal static class CommandValueResolver
throw new InvalidOperationException("Could not get element type");
}
return (TypeDescriptor.GetConverter(elementType), GetStringConstructor(elementType));
return new SmartConverter(TypeDescriptor.GetConverter(elementType), elementType);
}
if (parameter.IsFlagValue())
@ -200,13 +179,51 @@ internal static class CommandValueResolver
}
// Return a converter for the flag element type.
return (TypeDescriptor.GetConverter(value.Type), GetStringConstructor(value.Type));
return new SmartConverter(TypeDescriptor.GetConverter(value.Type), value.Type);
}
return (TypeDescriptor.GetConverter(parameter.ParameterType), GetStringConstructor(parameter.ParameterType));
return new SmartConverter(TypeDescriptor.GetConverter(parameter.ParameterType), parameter.ParameterType);
}
var type = Type.GetType(parameter.Converter.ConverterTypeName);
return (resolver.Resolve(type) as TypeConverter, null);
if (type == null || resolver.Resolve(type) is not TypeConverter typeConverter)
{
throw CommandRuntimeException.NoConverterFound(parameter);
}
return new SmartConverter(typeConverter, type);
}
/// <summary>
/// Convert inputs using the given <see cref="TypeConverter"/> and fallback to finding a constructor taking a single argument of the input type.
/// </summary>
private readonly ref struct SmartConverter
{
public SmartConverter(TypeConverter typeConverter, Type type)
{
TypeConverter = typeConverter;
Type = type;
}
public TypeConverter TypeConverter { get; }
private Type Type { get; }
public object? ConvertFrom(object input)
{
try
{
return TypeConverter.ConvertFrom(null, CultureInfo.InvariantCulture, input);
}
catch (NotSupportedException)
{
var constructor = Type.GetConstructor(BindingFlags.Public | BindingFlags.Instance, null, new[] { input.GetType() }, null);
if (constructor == null)
{
throw;
}
return constructor.Invoke(new[] { input });
}
}
}
}

1
test/Spectre.Console.Cli.Tests/Data/Settings/HorseSettings.cs
View File

@ -8,6 +8,7 @@ public class HorseSettings : MammalSettings
public DayOfWeek Day { get; set; }
[CommandOption("--file")]
[DefaultValue("food.txt")]
public FileInfo File { get; set; }
[CommandOption("--directory")]

1
test/Spectre.Console.Cli.Tests/Unit/CommandAppTests.cs
View File

@ -989,6 +989,7 @@ public sealed partial class CommandAppTests
{
horse.Legs.ShouldBe(4);
horse.Name.ShouldBe("Arkle");
horse.File.Name.ShouldBe("food.txt");
});
}