Merge pull request #277 from mexx/custom-enum-description-attribute-p…

…roperty-names

Custom enum description attribute property names

readme.md

@@ -186,6 +186,10 @@ EnumUnderTest.MemberWithoutDescriptionAttribute.Humanize().Transform(To.TitleCas
 You are not limited to `DescriptionAttribute` for custom description. Any attribute applied on enum members with a `string Description` property counts.
 This is to help with platforms with missing `DescriptionAttribute` and also for allowing subclasses of the `DescriptionAttribute`.
 
+You can even configure the name of the property of attibute to use as description.
+
+`Configurator.EnumDescriptionPropertyLocator = p => p.Name == "Info"`
+
 Hopefully this will help avoid littering enums with unnecessary attributes!
 
 ###<a id="dehumanize-enums">Dehumanize Enums</a>

release_notes.md

@@ -1,4 +1,5 @@
 ###In Development
+  - [#257](https://github.com/MehdiK/Humanizer/pull/277): Added support for custom enum description attribute property names
 
 [Commits](https://github.com/MehdiK/Humanizer/compare/v1.26.1...master)
 

src/Humanizer.Tests/ApiApprover/PublicApiApprovalTest.approve_public_api.approved.txt

@@ -75,6 +75,7 @@ public class Configurator
 {
     public Humanizer.Configuration.LocaliserRegistry<Humanizer.Localisation.CollectionFormatters.ICollectionFormatter> CollectionFormatters { get; }
     public Humanizer.DateTimeHumanizeStrategy.IDateTimeHumanizeStrategy DateTimeHumanizeStrategy { get; set; }
+    public System.Func<System.Reflection.PropertyInfo, bool> EnumDescriptionPropertyLocator { get; set; }
     public Humanizer.Configuration.LocaliserRegistry<Humanizer.Localisation.Formatters.IFormatter> Formatters { get; }
     public Humanizer.Configuration.LocaliserRegistry<Humanizer.Localisation.NumberToWords.INumberToWordsConverter> NumberToWordsConverters { get; }
     public Humanizer.Configuration.LocaliserRegistry<Humanizer.Localisation.Ordinalizers.IOrdinalizer> Ordinalizers { get; }

src/Humanizer.Tests/EnumHumanizeWithCustomDescriptionPropertyNamesTests.cs

@@ -0,0 +1,35 @@
+using System;
+using Humanizer.Configuration;
+using Xunit;
+
+namespace Humanizer.Tests
+{
+    [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1063:ImplementIDisposableCorrectly",
+        Justification = "This is a test only class, and doesn't need a 'proper' IDisposable implementation.")]
+    public class EnumHumanizeWithCustomDescriptionPropertyNamesTests : IDisposable
+    {
+        public EnumHumanizeWithCustomDescriptionPropertyNamesTests()
+        {
+            Configurator.EnumDescriptionPropertyLocator = p => p.Name == "Info";
+        }
+
+        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1063:ImplementIDisposableCorrectly",
+            Justification = "This is a test only class, and doesn't need a 'proper' IDisposable implementation.")]
+        public void Dispose()
+        {
+            Configurator.EnumDescriptionPropertyLocator = null;
+        }
+
+        [Fact]
+        public void HonorsCustomPropertyAttribute()
+        {
+            Assert.Equal(EnumTestsResources.MemberWithCustomPropertyAttribute, EnumUnderTest.MemberWithCustomPropertyAttribute.Humanize());
+        }
+
+        [Fact]
+        public void CanHumanizeMembersWithoutDescriptionAttribute()
+        {
+            Assert.Equal(EnumTestsResources.MemberWithoutDescriptionAttributeSentence, EnumUnderTest.MemberWithoutDescriptionAttribute.Humanize());
+        }
+    }
+}

src/Humanizer.Tests/EnumUnderTest.cs

@@ -13,6 +13,8 @@ public enum EnumUnderTest
         MemberWithCustomDescriptionAttribute,
         [ImposterDescription(42)]
         MemberWithImposterDescriptionAttribute,
+        [CustomProperty(EnumTestsResources.MemberWithCustomPropertyAttribute)]
+        MemberWithCustomPropertyAttribute,
         MemberWithoutDescriptionAttribute,
         ALLCAPITALS
     }
@@ -23,6 +25,7 @@ public class EnumTestsResources
         public const string MemberWithDescriptionAttributeSubclass = "Description in Description subclass";
         public const string MemberWithCustomDescriptionAttribute = "Description in custom Description attribute";
         public const string MemberWithImposterDescriptionAttribute = "Member with imposter description attribute";
+        public const string MemberWithCustomPropertyAttribute = "Description in custom property attribute";
         public const string MemberWithoutDescriptionAttributeSentence = "Member without description attribute";
         public const string MemberWithoutDescriptionAttributeTitle = "Member Without Description Attribute";
         public const string MemberWithoutDescriptionAttributeLowerCase = "member without description attribute";
@@ -59,4 +62,14 @@ public override string Description
             get { return "Overridden " + base.Description; }
         }
     }
+
+    public class CustomPropertyAttribute : Attribute
+    {
+        public string Info { get; set; }
+
+        public CustomPropertyAttribute(string info)
+        {
+            Info = info;
+        }
+    }
 }

src/Humanizer.Tests/Humanizer.Tests.csproj

@@ -63,6 +63,7 @@
     <Compile Include="CasingTests.cs" />
     <Compile Include="DateHumanize.cs" />
     <Compile Include="CollectionHumanizeTests.cs" />
+    <Compile Include="EnumHumanizeWithCustomDescriptionPropertyNamesTests.cs" />
     <Compile Include="Localisation\bg\DateHumanizeTests.cs" />
     <Compile Include="Localisation\bg\TimeSpanHumanizeTests.cs" />
     <Compile Include="Localisation\cs\DateHumanizeTests.cs" />

src/Humanizer/Configuration/Configurator.cs

@@ -1,3 +1,6 @@
+using System;
+using System.Collections.Generic;
+using System.Reflection;
 using Humanizer.DateTimeHumanizeStrategy;
 using Humanizer.Localisation.Formatters;
 using Humanizer.Localisation.NumberToWords;
@@ -98,5 +101,16 @@ public static IDateTimeHumanizeStrategy DateTimeHumanizeStrategy
             get { return _dateTimeHumanizeStrategy; }
             set { _dateTimeHumanizeStrategy = value; }
         }
+
+        private static readonly Func<PropertyInfo, bool> DefaultEnumDescriptionPropertyLocator = p => p.Name == "Description";
+        private static Func<PropertyInfo, bool> _enumDescriptionPropertyLocator = DefaultEnumDescriptionPropertyLocator;
+        /// <summary>
+        /// A predicate function for description property of attribute to use for Enum.Humanize
+        /// </summary>
+        public static Func<PropertyInfo, bool> EnumDescriptionPropertyLocator
+        {
+            get { return _enumDescriptionPropertyLocator; }
+            set { _enumDescriptionPropertyLocator = value ?? DefaultEnumDescriptionPropertyLocator; }
+        }
     }
 }

src/Humanizer/EnumHumanizeExtensions.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Linq;
 using System.Reflection;
+using Humanizer.Configuration;
 
 namespace Humanizer
 {
@@ -9,7 +10,7 @@ namespace Humanizer
     /// </summary>
     public static class EnumHumanizeExtensions
     {
-        private static readonly Func<PropertyInfo, bool> DescriptionProperty = p => p.Name == "Description" && p.PropertyType == typeof (string);
+        private static readonly Func<PropertyInfo, bool> StringTypedProperty = p => p.PropertyType == typeof(string);
 
         /// <summary>
         /// Turns an enum member into a human readable string; e.g. AnonymousUser -> Anonymous user. It also honors DescriptionAttribute data annotation
@@ -19,7 +20,8 @@ public static class EnumHumanizeExtensions
         public static string Humanize(this Enum input)
         {
             Type type = input.GetType();
-            var memInfo = type.GetMember(input.ToString());
+            var caseName = input.ToString();
+            var memInfo = type.GetMember(caseName);
 
             if (memInfo.Length > 0)
             {
@@ -29,7 +31,7 @@ public static string Humanize(this Enum input)
                     return customDescription;
             }
 
-            return input.ToString().Humanize();
+            return caseName.Humanize();
         }
 
         // I had to add this method because PCL doesn't have DescriptionAttribute & I didn't want two versions of the code & thus the reflection
@@ -40,7 +42,10 @@ private static string GetCustomDescription(MemberInfo memberInfo)
             foreach (var attr in attrs)
             {
                 var attrType = attr.GetType();
-                var descriptionProperty = attrType.GetProperties().FirstOrDefault(DescriptionProperty);
+                var descriptionProperty =
+                    attrType.GetProperties()
+                        .Where(StringTypedProperty)
+                        .FirstOrDefault(Configurator.EnumDescriptionPropertyLocator);
                 if (descriptionProperty != null)
                     return descriptionProperty.GetValue(attr, null).ToString();
             }