LogLevel - Added support for TypeConverter

NLog · Jun 10, 2019 · c39baa0 · c39baa0
1 parent 3d07bd9
commit c39baa0
Show file tree

Hide file tree

Showing 5 changed files with 83 additions and 6 deletions.
diff --git a/src/NLog/Attributes/LogLevelTypeConverter.cs b/src/NLog/Attributes/LogLevelTypeConverter.cs
@@ -0,0 +1,69 @@
+namespace NLog.Attributes
+{
+    using System;
+    using System.ComponentModel;
+    using System.Globalization;
+
+    /// <summary>
+    /// Support <see cref="NLog.LogLevel"/> implementation of <see cref="IConvertible"/>
+    /// </summary>
+    public class LogLevelTypeConverter : TypeConverter
+    {
+        /// <inheritdoc/>
+        public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourceType)
+        {
+            return IsSupportedType(sourceType) || base.CanConvertFrom(context, sourceType);
+        }
+
+        /// <inheritdoc/>
+        public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo culture, object value)
+        {
+            TypeCode casted = Convert.GetTypeCode(value);
+            switch (casted)
+            {
+                case TypeCode.String:
+                    return LogLevel.FromString(value.ToString());
+                case TypeCode.Int16:
+                    return LogLevel.FromOrdinal(Convert.ToInt16(value));
+                case TypeCode.UInt16:
+                    return LogLevel.FromOrdinal(Convert.ToUInt16(value));
+                case TypeCode.Int32:
+                    return LogLevel.FromOrdinal(Convert.ToInt32(value));
+                case TypeCode.UInt32:
+                    return LogLevel.FromOrdinal((int)Convert.ToUInt32(value));
+                case TypeCode.Int64:
+                    return LogLevel.FromOrdinal((int)Convert.ToInt64(value));
+                case TypeCode.UInt64:
+                    return LogLevel.FromOrdinal((int)Convert.ToUInt64(value));
+                default:
+                    return base.ConvertFrom(context, culture, value);
+            }
+        }
+
+        /// <inheritdoc/>
+        public override bool CanConvertTo(ITypeDescriptorContext context, Type destinationType)
+        {
+            return IsSupportedType(destinationType) || base.CanConvertTo(context, destinationType);
+        }
+
+        /// <inheritdoc/>
+        public override object ConvertTo(ITypeDescriptorContext context, CultureInfo culture, object value, Type destinationType)
+        {
+            var casted = value as LogLevel;
+            return destinationType == typeof(string) && casted != null
+                ? casted.ToString()
+                : base.ConvertTo(context, culture, casted?.Ordinal ?? value, destinationType);
+        }
+
+        private static bool IsSupportedType(Type sourceType)
+        {
+            return sourceType == typeof(string) ||
+                sourceType == typeof(short) ||
+                sourceType == typeof(ushort) ||
+                sourceType == typeof(int) ||
+                sourceType == typeof(uint) ||
+                sourceType == typeof(long) ||
+                sourceType == typeof(ulong);
+        }
+    }
+}
diff --git a/src/NLog/Internal/ObjectReflectionCache.cs b/src/NLog/Internal/ObjectReflectionCache.cs
@@ -99,7 +99,7 @@ public ObjectPropertyList LookupObjectProperties(object value)
         private static ObjectPropertyInfos BuildObjectPropertyInfos(object value, Type objectType)
         {
             ObjectPropertyInfos propertyInfos;
-            if (ConvertToString(objectType))
+            if (ConvertSimpleToString(objectType))
             {
                 propertyInfos = ObjectPropertyInfos.SimpleToString;
             }
@@ -125,7 +125,7 @@ private static ObjectPropertyInfos BuildObjectPropertyInfos(object value, Type o
             return propertyInfos;
         }
 
-        private static bool ConvertToString(Type objectType)
+        private static bool ConvertSimpleToString(Type objectType)
         {
             if (objectType == typeof(Guid))
                 return true;

diff --git a/src/NLog/LogLevel.cs b/src/NLog/LogLevel.cs
@@ -35,11 +35,12 @@ namespace NLog
 {
     using System;
     using System.Collections.Generic;
-    using NLog.Internal;
+    using System.ComponentModel;
 
     /// <summary>
     /// Defines available log levels.
     /// </summary>
+    [TypeConverter(typeof(Attributes.LogLevelTypeConverter))]
     public sealed class LogLevel : IComparable, IEquatable<LogLevel>, IConvertible
     {
         /// <summary>
@@ -464,7 +465,10 @@ string IConvertible.ToString(IFormatProvider provider)
 
         object IConvertible.ToType(Type conversionType, IFormatProvider provider)
         {
-            return Convert.ChangeType(_ordinal, conversionType, provider);
+            if (conversionType == typeof(string))
+                return Name;
+            else
+                return Convert.ChangeType(_ordinal, conversionType, provider);
         }
 
         ushort IConvertible.ToUInt16(IFormatProvider provider)

diff --git a/src/NLog/NLog.csproj b/src/NLog/NLog.csproj
@@ -293,6 +293,7 @@ For all config options and platform support, check https://nlog-project.org/conf
   <ItemGroup Condition=" '$(TargetFramework)' == 'netstandard1.3' ">
     <PackageReference Include="Microsoft.Extensions.PlatformAbstractions" Version="1.0.0" />
     <PackageReference Include="System.ComponentModel.Primitives" Version="4.1.0" />
+    <PackageReference Include="System.ComponentModel.TypeConverter" Version="4.1.0" />
     <PackageReference Include="System.Data.Common" Version="4.1.0" />
     <PackageReference Include="System.Diagnostics.StackTrace" Version="4.0.1" />
     <PackageReference Include="System.Net.NameResolution" Version="4.0.0" />

diff --git a/tests/NLog.UnitTests/LayoutRenderers/LogLevelTests.cs b/tests/NLog.UnitTests/LayoutRenderers/LogLevelTests.cs
@@ -132,16 +132,19 @@ public void LogLevelGetTypeCodeTest()
         [Theory]
         [InlineData(typeof(int), 2)]
         [InlineData(typeof(uint), (uint)2)]
+        [InlineData(typeof(string), "Info")]
         public void LogLevelConvertTest(Type type, object expected)
         {
             // Arrange
             var logLevel = LogLevel.Info;
 
             // Act
-            var result = Convert.ChangeType(logLevel, type);
+            var changeToResult = Convert.ChangeType(logLevel, type);
+            var changeFromResult = System.ComponentModel.TypeDescriptor.GetConverter(typeof(LogLevel)).ConvertFrom(changeToResult);
 
             // Assert
-            Assert.Equal(expected, result);
+            Assert.Equal(expected, changeToResult);
+            Assert.Equal(logLevel, changeFromResult);
         }
     }
 }