Support for invalid multiple languages.

Author: o.nadymov

src/Core.Common.LocalizableString.Tests/Core.Common.LocalizableString.Tests.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net7.0</TargetFramework>
+    <TargetFramework>net8.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <!--<Nullable>enable</Nullable>-->
 

src/Core.Common.LocalizableString.Tests/LocalizableStringJsonConverterTests.cs

@@ -153,5 +153,51 @@ public void DeserializeObjectWithEmptyLocalizableString()
             // Assert
             Assert.That(obj.Description.Languages, Has.Count.EqualTo(2));
         }
+
+        [Test]
+        public void DeserializeObjectListWithExcessLSCharacters()
+        {
+            // Arrange
+            var language1 = "ru";
+            var language2 = "en";
+            // without the third EndPattern. Substring in string:
+            var text = $"{LocalizableString.StartPattern}{language1}{LocalizableString.StartPattern}Текст на русском{LocalizableString.EndPattern}{LocalizableString.StartPattern}{language2}{LocalizableString.StartPattern}Text in English{LocalizableString.StartPattern}{language1}{LocalizableString.StartPattern}Снова текст на русском!{LocalizableString.EndPattern}";
+            var testObjList = new List<TestClass>{
+                new() 
+                {
+                    Name = "One",
+                    Description = text
+                }
+            };
+
+            // Act
+            var json = JsonSerializer.Serialize(testObjList, _jsonSerializerOptions);
+            var afterJson = JsonSerializer.Deserialize<List<TestClass>>(json, _jsonSerializerOptions);
+
+            // Assert
+            Assert.That(afterJson[0].Description.OriginalString, Is.Not.EqualTo(text));
+            Assert.That(afterJson[0].Description.OriginalString, Is.EqualTo(text.Replace(LocalizableString.StartPattern, string.Empty).Replace(LocalizableString.EndPattern, string.Empty)));
+        }
+
+        [Test]
+        public void DeserializeObjectListWithoutMultilanguage()
+        {
+            // Arrange
+            var text = "string";
+            var testObjList = new List<TestClass>{
+                new()
+                {
+                    Name = "One",
+                    Description = text
+                }
+            };
+
+            // Act
+            var json = JsonSerializer.Serialize(testObjList, _jsonSerializerOptions);
+            var afterJson = JsonSerializer.Deserialize<List<TestClass>>(json, _jsonSerializerOptions);
+
+            // Assert
+            Assert.That(afterJson[0].Description.OriginalString, Is.EqualTo(text));
+        }
     }
 }

src/Core.Common.LocalizableString.Tests/LocalizableStringTests.cs

@@ -128,5 +128,26 @@ public void DictionaryToLocalizableString()
                 Assert.That(ls.GetCurrentString("en"), Is.EqualTo(enText));
             });
         }
+
+        [Test]
+        public void StringWithLanguageInConstructorWithTwoSameLanguageCodes()
+        {
+            // Arrange
+            var language1 = "ru";
+            var language2 = "en";
+            var text = $"{LocalizableString.StartPattern}{language1}{LocalizableString.StartPattern}Текст на русском{LocalizableString.EndPattern}{LocalizableString.StartPattern}{language2}{LocalizableString.StartPattern}Text in English{LocalizableString.EndPattern}{LocalizableString.StartPattern}{language1}{LocalizableString.StartPattern}Снова текст на русском!{LocalizableString.EndPattern}";
+
+            // Act
+            var ls = new LocalizableString(text);
+
+            // Assert
+            Assert.Multiple(() =>
+            {
+                Assert.That(ls, Is.Not.Null);
+                Assert.That(ls.StringCurrent, Is.Not.Null);
+                Assert.That(ls.OriginalString, Is.EqualTo(text));
+                Assert.That(text, Does.Contain(ls.StringCurrent));
+            });
+        }
     }
 }

src/Core.Common.LocalizableString/Core.Common.LocalizableString.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
     <PropertyGroup>
-        <TargetFrameworks>net7.0;netstandard2.0</TargetFrameworks>
+        <TargetFrameworks>net8.0;net7.0;netstandard2.0</TargetFrameworks>
         <AssemblyName>Core.Common.LocalizableString</AssemblyName>
         <RootNamespace>Core.Common.LocalizableString</RootNamespace>
         <Title>Core.Common.LocalizableString</Title>
@@ -51,7 +51,7 @@
 
     <ItemGroup Condition="'$(TargetFramework.TrimEnd(`0123456789.`))' == 'netstandard'">
         <!-- Properties for netstandard -->
-        <PackageReference Include="System.Text.Json" Version="7.0.2" />
+        <PackageReference Include="System.Text.Json" Version="8.0.5" />
     </ItemGroup>
 
     <ItemGroup>

src/Core.Common.LocalizableString/Extensions/LocalizableStringExtensions.cs

@@ -86,19 +86,22 @@ public static LocalizableString AsLocalizableString(this IDictionary dict)
         /// </summary>
         public static object AsJsonCompatible(this LocalizableString localizableString)
         {
-            var languages = localizableString.Languages;
-            if (languages.Count > 0)
+            if (localizableString.HaveMultipleLanguages)
             {
-                var dict = new OrderedDictionary();
-                foreach (var language in languages)
+                var languages = localizableString.Languages;
+                if (languages.Count > 0)
                 {
-                    var currentString = localizableString.GetCurrentString(language);
-                    EnsureIsJsonCompatible(currentString, localizableString.OriginalString);
+                    var dict = new OrderedDictionary();
+                    foreach (var language in languages)
+                    {
+                        var currentString = localizableString.GetCurrentString(language);
+                        EnsureIsJsonCompatible(currentString, localizableString.OriginalString);
 
-                    dict[language] = currentString;
-                }
+                        dict[language] = currentString;
+                    }
 
-                return dict;
+                    return dict;
+                }
             }
 
             var oneLanguageString = localizableString.StringCurrent;

src/Core.Common.LocalizableString/Extensions/StringExtensions.cs

@@ -0,0 +1,16 @@
+namespace Core.Common
+{
+    /// <summary>
+    /// String extensions.
+    /// </summary>
+    public static class StringExtensions
+    {
+        /// <summary>
+        /// Count of sub-string occurrences within the string.
+        /// </summary>
+        public static int CountSubstring(this string text, string value)
+        {
+            return (text.Length - text.Replace(value, string.Empty).Length) / value.Length;
+        }
+    }
+}

src/Core.Common.LocalizableString/LocalizableString.cs

@@ -16,6 +16,8 @@ namespace Core.Common
     [DataContract]
     public class LocalizableString : IComparable, ICloneable, IConvertible, IComparable<string>, IEnumerable<char>, IEnumerable, IEquatable<string>
     {
+        private enum ValidationState { SingleLanguage, ValidMultipleLanguages, InvalidMultipleLanguages }
+
         [IgnoreDataMember]
         private string _stringCurrent;
 
@@ -102,18 +104,43 @@ private void ProcessOriginalString(string s)
         {
             if (s == null) return;
 
-            if (!Regex.IsMatch(s, Pattern))
+            var state = Validate(s);
+
+            if (state == ValidationState.SingleLanguage)
             {
                 _stringOriginal = _stringCurrent = s;
                 _haveMultipleLanguages = false;
             }
-            else
+            else if (state == ValidationState.ValidMultipleLanguages)
             {
                 _haveMultipleLanguages = true;
                 _stringOriginal = s;
 
                 _stringCurrent = GetString(_stringOriginal, true);
             }
+            else
+            {
+                _stringOriginal = _stringCurrent = s.Replace(StartPattern, string.Empty).Replace(EndPattern, string.Empty);
+                _haveMultipleLanguages = false;
+            }
+        }
+
+        private static ValidationState Validate(string s)
+        {
+            if (!Regex.IsMatch(s, Pattern))
+            {
+                return ValidationState.SingleLanguage;
+            }
+
+            var countStartPatterns = s.CountSubstring(StartPattern);
+            var countEndPatterns = s.CountSubstring(EndPattern);
+            if (countStartPatterns == countEndPatterns * 2)
+            {
+                return ValidationState.ValidMultipleLanguages;
+            }
+
+            return ValidationState.InvalidMultipleLanguages;
+
         }
 
         /// <summary>
@@ -525,13 +552,9 @@ public string StringCurrent
         /// <summary>
         /// GetString
         /// </summary>
-        /// <param name="s"></param>
-        /// <param name="getFirstValueIfNotExists"></param>
-        /// <param name="codeLanguage"></param>
-        /// <returns></returns>
         private string GetString(string s, bool getFirstValueIfNotExists = false, string codeLanguage = null)
         {
-            if (codeLanguage == null) codeLanguage = CurrentLanguageKey;
+            codeLanguage ??= CurrentLanguageKey;
 
             var matches = Regex.Matches(s, Pattern);