Merge pull request aspnetboilerplate#1155 from 4nonym0us/undefined-localization-humanizer

Undefined localization string humanizer (Issue aspnetboilerplate#853)

Author: hikalkan

src/Abp/Configuration/Startup/ILocalizationConfiguration.cs

@@ -40,5 +40,13 @@ public interface ILocalizationConfiguration
         /// Default: true.
         /// </summary>
         bool WrapGivenTextIfNotFound { get; set; }
+
+        /// <summary>
+        /// It returns the given text by converting string from 'PascalCase' to a 'Sentense case'
+        /// if not found in the localization source.
+        /// This is considered only if <see cref="ReturnGivenTextIfNotFound"/> is true.
+        /// Default: true.
+        /// </summary>
+        bool HumanizeTextIfNotFound { get; set; }
     }
-}
+}

src/Abp/Configuration/Startup/LocalizationConfiguration.cs

@@ -23,6 +23,9 @@ internal class LocalizationConfiguration : ILocalizationConfiguration
         /// <inheritdoc/>
         public bool WrapGivenTextIfNotFound { get; set; }
 
+        /// <inheritdoc/>
+        public bool HumanizeTextIfNotFound { get; set; }
+
         public LocalizationConfiguration()
         {
             Languages = new List<LanguageInfo>();
@@ -31,6 +34,7 @@ public LocalizationConfiguration()
             IsEnabled = true;
             ReturnGivenTextIfNotFound = true;
             WrapGivenTextIfNotFound = true;
+            HumanizeTextIfNotFound = true;
         }
     }
-}
+}

src/Abp/Localization/LocalizationSourceHelper.cs

@@ -1,4 +1,5 @@
-using Abp.Configuration.Startup;
+using System.Text.RegularExpressions;
+using Abp.Configuration.Startup;
 using Abp.Logging;
 
 namespace Abp.Localization
@@ -19,9 +20,18 @@ public static string ReturnGivenNameOrThrowException(ILocalizationConfiguration
 
             LogHelper.Logger.Warn(exceptionMessage);
 
-            return configuration.WrapGivenTextIfNotFound
-                ? string.Format("[{0}]", name)
+            var notFoundText = configuration.HumanizeTextIfNotFound
+                ? ToSentenceCase(name)
                 : name;
+
+            return configuration.WrapGivenTextIfNotFound
+                ? string.Format("[{0}]", notFoundText)
+                : notFoundText;
+        }
+
+        private static string ToSentenceCase(string str)
+        {
+            return Regex.Replace(str, "[a-z][A-Z]", m => m.Value[0] + " " + char.ToLower(m.Value[1]));
         }
     }
 }

test/Abp.Tests/Localization/HumanizerOfUndefinedLocalizationSource_Tests.cs

@@ -0,0 +1,45 @@
+using System.Globalization;
+using Abp.Configuration.Startup;
+using Abp.Dependency;
+using Abp.Localization.Sources.Resource;
+using Abp.Tests.Localization.TestResourceFiles;
+using Shouldly;
+using Xunit;
+
+namespace Abp.Tests.Localization
+{
+    public class HumanizerOfUndefinedLocalizationSource_Tests
+    {
+        private readonly ResourceFileLocalizationSource _resourceFileLocalizationSource;
+        private LocalizationConfiguration _localizationConfiguration;
+
+        public HumanizerOfUndefinedLocalizationSource_Tests()
+        {
+            _localizationConfiguration = new LocalizationConfiguration{ WrapGivenTextIfNotFound = false };
+            _resourceFileLocalizationSource = new ResourceFileLocalizationSource("MyTestResource", MyTestResource.ResourceManager);
+            _resourceFileLocalizationSource.Initialize(_localizationConfiguration, new IocManager());
+        }
+
+        [Fact]
+        public void Undefined_Localization_Source_Should_Be_Humanized()
+        {
+            // Default configuration
+            _localizationConfiguration = new LocalizationConfiguration();
+
+            // Fallback to the same text as It's already in sentence case
+            _resourceFileLocalizationSource
+                .GetString("Lorem ipsum dolor sit amet", new CultureInfo("en-US"))
+                .ShouldBe("Lorem ipsum dolor sit amet");
+
+            // Text in PascalCase should be converted properly
+            _resourceFileLocalizationSource
+                .GetString("LoremIpsumDolorSitAmet", new CultureInfo("en-US"))
+                .ShouldBe("Lorem ipsum dolor sit amet");
+
+            // Text with mixed cases should be converted properly
+            _resourceFileLocalizationSource
+                .GetString("LoremIpsum dolor sit amet", new CultureInfo("en-US"))
+                .ShouldBe("Lorem ipsum dolor sit amet");
+        }
+    }
+}

test/Abp.Tests/Localization/ResourceFileLocalizationSource_Tests.cs

@@ -15,7 +15,11 @@ public class ResourceFileLocalizationSource_Tests
         public ResourceFileLocalizationSource_Tests()
         {
             _resourceFileLocalizationSource = new ResourceFileLocalizationSource("MyTestResource", MyTestResource.ResourceManager);
-            _resourceFileLocalizationSource.Initialize(new LocalizationConfiguration(), new IocManager());
+            _resourceFileLocalizationSource.Initialize(new LocalizationConfiguration
+            {
+                HumanizeTextIfNotFound = false,
+                WrapGivenTextIfNotFound = true
+            }, new IocManager());
         }
 
         [Fact]
@@ -28,7 +32,7 @@ public void Test_GetString()
             _resourceFileLocalizationSource.GetString("Hello", new CultureInfo("en-US")).ShouldBe("Hello!");
             _resourceFileLocalizationSource.GetString("World", new CultureInfo("en-US")).ShouldBe("World!");
             _resourceFileLocalizationSource.GetString("Hello", new CultureInfo("en-GB")).ShouldBe("Hello!");
-            
+
             //Defined in Turkish
             _resourceFileLocalizationSource.GetString("Hello", new CultureInfo("tr")).ShouldBe("Merhaba!");
 
@@ -37,7 +41,7 @@ public void Test_GetString()
 
             //Undefined for Turkish, fallbacks to default language
             _resourceFileLocalizationSource.GetString("World", new CultureInfo("tr-TR")).ShouldBe("World!");
-            
+
             //Undefined at all, fallback to given text
             _resourceFileLocalizationSource.GetString("Apple", new CultureInfo("en-US")).ShouldBe("[Apple]");
         }

test/Abp.Tests/Localization/Test_DictionaryBasedLocalizationSource.cs

@@ -16,7 +16,11 @@ public class Test_DictionaryBasedLocalizationSource
         public Test_DictionaryBasedLocalizationSource()
         {
             _localizationSource = new DictionaryBasedLocalizationSource("Test", new FakeLocalizationDictionary());
-            _localizationSource.Initialize(new LocalizationConfiguration(), new IocManager());
+            _localizationSource.Initialize(new LocalizationConfiguration
+            {
+                HumanizeTextIfNotFound = false,
+                WrapGivenTextIfNotFound = true
+            }, new IocManager());
         }
 
         [Fact]