refactor: Remove code duplications in SmartFormatter (#396)

* Remove code duplications in SmartFormatter
* Remove redudant usings
* Unify preprocessor directives

Author: axunonb

src/SmartFormat.Tests/Core/FormatterExtensionsTests.cs

@@ -34,10 +34,10 @@ public void Formatters_Can_Be_Initialized()
             var guid = Guid.NewGuid().ToString("N");
             var negatedAutoDetection = formatter.CanAutoDetect;
             formatter.Name = guid;
-            formatter.GetType().GetProperty("Names")?.SetValue(formatter, new[] {guid}); // "Names" property is obsolete
+            formatter.GetType().GetProperty("Name")?.SetValue(formatter,  guid);  // "Names" property is obsolete
             Assert.Multiple(() =>
             {
-                Assert.That(formatter.GetType().GetProperty("Names")?.GetValue(formatter), Is.EqualTo(new[] { guid }));  // "Names" property is obsolete
+                Assert.That(formatter.GetType().GetProperty("Name")?.GetValue(formatter), Is.EqualTo(guid));  // "Names" property is obsolete
                 Assert.That(formatter.Name, Is.EqualTo(guid));
             });
 
@@ -116,7 +116,6 @@ public void Conditional_Formatter_With_Parenthesis(bool value, string expected)
 
     #region: Custom Extensions :
 
-    [Test]
     [TestCase("{0}", 5, "TestExtension1 Options: , Format: ")]
     [TestCase("{0:N2}", 5, "TestExtension1 Options: , Format: N2")]
     public void Without_NamedFormatter_extensions_are_invoked_in_order(string format, object arg0, string expectedResult)
@@ -126,7 +125,6 @@ public void Without_NamedFormatter_extensions_are_invoked_in_order(string format
         Assert.That(actualResult, Is.EqualTo(expectedResult));
     }
 
-    [Test]
     [TestCase("{0:test1:}", 5, "TestExtension1 Options: , Format: ")]
     [TestCase("{0:test1():}", 5, "TestExtension1 Options: , Format: ")]
     [TestCase("{0:test1:N2}", 5, "TestExtension1 Options: , Format: N2")]

src/SmartFormat.Tests/Extensions/ListFormatterTests.cs

@@ -1,9 +1,7 @@
 using System;
-using System.Collections;
 using System.Collections.Generic;
 using System.Globalization;
 using System.Linq;
-using System.Threading;
 using System.Threading.Tasks;
 using NUnit.Framework;
 using SmartFormat.Core.Formatting;

src/SmartFormat.Tests/TestSetup.cs

@@ -28,4 +28,4 @@ public void RunAfterAnyTests()
     {
         // Nothing defined here
     }
-}
+}

src/SmartFormat.Tests/TestUtils/Person.cs

@@ -23,13 +23,13 @@ public Person(string newName, Gender gender, DateTime newBirthday, string newAdd
 
     private static int GetRandomNumber(int min, int max)
     {
-#if !NET6_0_OR_GREATER
+#if NET6_0_OR_GREATER
+        return RandomNumberGenerator.GetInt32(min, max);
+#else
         var randomNumber = new byte[4];
         using var rng = RandomNumberGenerator.Create();
         rng.GetBytes(randomNumber);
         return Math.Abs(BitConverter.ToInt32(randomNumber, 0) % 10) + 1;
-#else
-        return RandomNumberGenerator.GetInt32(min, max);
 #endif
     }
 

src/SmartFormat/Core/Formatting/FormatDetails.cs

@@ -111,4 +111,4 @@ internal void Clear()
         Provider = null;
         FormattingException = null;
     }
-}
+}

src/SmartFormat/Core/Formatting/FormattingInfo.cs

@@ -186,7 +186,7 @@ public void FormatAsChild(Format format, object? value)
         // recursive method call
         FormatDetails.Formatter.Format(nestedFormatInfo);
     }
-        
+
     /// <summary>
     /// Creates a new <see cref="FormattingException"/>.
     /// </summary>
@@ -251,4 +251,4 @@ private void PostAlign(int textLength)
         var filler = -Alignment - textLength;
         if (filler > 0) FormatDetails.Output.Write(new string(FormatDetails.Settings.Formatter.AlignmentFillCharacter, filler), this);
     }
-}
+}

src/SmartFormat/Core/Formatting/ISelectorInfo.cs

@@ -56,4 +56,4 @@ public interface ISelectorInfo
     /// </summary>
     [EditorBrowsable(EditorBrowsableState.Advanced)]
     FormatDetails FormatDetails { get; }
-}
+}

src/SmartFormat/Core/Parsing/Format.cs

@@ -310,7 +310,7 @@ public IList<Format> Split(char search, int maxCount)
     {
         var splits = FindAll(search, maxCount);
         var splitList = SplitListPool.Instance.Get().Initialize(this, splits);
-
+        
         // Keep track of the split lists we create,
         // so that they can be returned to the object pool for later reuse.
         _listOfSplitLists.Add(splitList);

src/SmartFormat/Core/Parsing/Parser.cs

@@ -4,7 +4,6 @@
 
 using System;
 using System.Collections.Generic;
-using System.Linq;
 using System.Runtime.CompilerServices;
 using SmartFormat.Core.Settings;
 using SmartFormat.Pooling.SmartPools;
@@ -24,7 +23,7 @@ public class Parser
     private IndexContainer _index;
     private string _inputFormat;
     private Format _resultFormat;
-        
+
     #endregion
 
     #region: Settings :

src/SmartFormat/SmartFormatter.cs

@@ -1,4 +1,4 @@
-// 
+//
 // Copyright SmartFormat Project maintainers and contributors.
 // Licensed under the MIT license.
 
@@ -255,7 +255,7 @@ public string Format(string format, params object?[] args)
     {
         return Format(null, format, (IList<object?>) args);
     }
-        
+
     /// <summary>
     /// Replaces one or more format items in as specified string with the string representation of a specific object.
     /// </summary>
@@ -289,20 +289,9 @@ public string Format(IFormatProvider? provider, string format, params object?[]
     public string Format(IFormatProvider? provider, string format, IList<object?> args)
     {
         var formatParsed = Parser.ParseFormat(format); // The parser gets the Format from the pool
-            
-        // Note: Making ZStringOutput a class instance variable has no advantage for speed,
-        // but brings 10% less Gen 0 GC. Then, SmartFormatter would have to be IDisposable (dispose ZStringOutput)
-        using var zsOutput = new ZStringOutput(ZStringBuilderUtilities.CalcCapacity(formatParsed));
-            
-        var current = args.Count > 0 ? args[0] : args; // The first item is the default.
-
-        var formatDetails = FormatDetailsPool.Instance.Get().Initialize(this, formatParsed, args, provider, zsOutput);
-        Format(formatDetails, formatParsed, current);
-
-        FormatDetailsPool.Instance.Return(formatDetails);
-        FormatPool.Instance.Return(formatParsed); 
-
-        return zsOutput.ToString();
+        var result = Format(provider, formatParsed, args);
+        FormatPool.Instance.Return(formatParsed);
+        return result;
     }
 
     #region ** Format overloads with cached Format **
@@ -353,15 +342,12 @@ public string Format(IFormatProvider? provider, Format formatParsed, IList<objec
         // Note: Making ZStringOutput a class instance variable has no advantage for speed,
         // but brings 10% less Gen 0 GC. Then, SmartFormatter would have to be IDisposable (to dispose ZStringOutput)
         using var zsOutput = new ZStringOutput(ZStringBuilderUtilities.CalcCapacity(formatParsed));
-        var current = args.Count > 0 ? args[0] : args; // The first item is the default.
-        var formatDetails = FormatDetailsPool.Instance.Get().Initialize(this, formatParsed, args, provider, zsOutput);
-        Format(formatDetails, formatParsed, current);
-        FormatDetailsPool.Instance.Return(formatDetails);
+        FormatInto(zsOutput, provider, formatParsed, args);
         return zsOutput.ToString();
     }
 
     #endregion
-        
+
     /// <summary>
     /// Format the <see cref="FormattingInfo" /> argument.
     /// </summary>
@@ -407,7 +393,7 @@ public void Format(FormattingInfo formattingInfo)
             }
         }
     }
-        
+
     private void Format(FormatDetails formatDetails, Format format, object? current)
     {
         var formattingInfo = FormattingInfoPool.Instance.Get().Initialize(formatDetails, format, current);
@@ -488,11 +474,11 @@ public void FormatInto(IOutput output, IFormatProvider? provider, Format formatP
     #endregion
 
     #endregion
-        
+
     #region: Private methods :
 
-    private void FormatError(FormatItem errorItem, Exception innerException, int startIndex,
-        FormattingInfo formattingInfo)
+    internal void FormatError(FormatItem errorItem, Exception innerException, int startIndex,
+        IFormattingInfo formattingInfo)
     {
         OnFormattingFailure?.Invoke(this,
             new FormattingErrorEventArgs(errorItem.RawText, startIndex,
@@ -537,24 +523,26 @@ private void CheckForExtensions()
     /// Example: "{ChildOne.ChildTwo.ChildThree: {Four}}" where "{Four}" is a child placeholder.
     /// </remarks>
     /// <param name="formattingInfo"></param>
+    /// <exception cref="FormattingException"></exception>
     private void EvaluateSelectors(FormattingInfo formattingInfo)
     {
         if (formattingInfo.Placeholder is null) return;
-           
+
         var firstSelector = true;
         foreach (var selector in formattingInfo.Placeholder.Selectors)
         {
             // Don't evaluate empty selectors
             // (used e.g. for Settings.Parser.NullableOperator and Settings.Parser.ListIndexEndChar final operators)
-            if(selector.Length == 0) continue;
-                
+            if (selector.Length == 0) continue;
+
+            // Ensure ISelectorInfo implementation returns the current selector values
             formattingInfo.Selector = selector;
             // Do not evaluate alignment-only selectors
             if (formattingInfo.SelectorOperator.Length > 0 &&
                 formattingInfo.SelectorOperator[0] == Settings.Parser.AlignmentOperator) continue;
-                
+
             formattingInfo.Result = null;
-                
+
             var handled = InvokeSourceExtensions(formattingInfo);
             if (handled) formattingInfo.CurrentValue = formattingInfo.Result;
 
@@ -567,6 +555,7 @@ private void EvaluateSelectors(FormattingInfo formattingInfo)
                 while (!handled && parentFormattingInfo.Parent != null)
                 {
                     parentFormattingInfo = parentFormattingInfo.Parent;
+                    // Ensure ISelectorInfo implementation returns the current selector values
                     parentFormattingInfo.Selector = selector;
                     parentFormattingInfo.Result = null;
                     handled = InvokeSourceExtensions(parentFormattingInfo);
@@ -580,12 +569,12 @@ private void EvaluateSelectors(FormattingInfo formattingInfo)
         }
     }
 
-    private bool InvokeSourceExtensions(FormattingInfo formattingInfo)
+    private bool InvokeSourceExtensions(ISelectorInfo selectorInfo)
     {
         // less GC than using Linq
         foreach (var sourceExtension in _sourceExtensions)
         {
-            var handled = sourceExtension.TryEvaluateSelector(formattingInfo);
+            var handled = sourceExtension.TryEvaluateSelector(selectorInfo);
             if (handled) return true;
         }
 
@@ -623,7 +612,7 @@ private bool InvokeFormatterExtensions(FormattingInfo formattingInfo)
         // Compatibility mode does not support formatter extensions except this one:
         if (Settings.StringFormatCompatibility)
         {
-            return 
+            return
                 _formatterExtensions.First(fe => fe is DefaultFormatter)
                     .TryEvaluateFormat(formattingInfo);
         }
@@ -636,18 +625,18 @@ private bool InvokeFormatterExtensions(FormattingInfo formattingInfo)
             foreach (var fe in _formatterExtensions)
             {
                 if (!fe.Name.Equals(formatterName, comparison)) continue;
-                    
+
                 formatterExtension = fe;
                 break;
             }
-                
+
             if (formatterExtension is null)
                 throw formattingInfo.FormattingException($"No formatter with name '{formatterName}' found",
                     formattingInfo.Format, formattingInfo.Selector?.SelectorIndex ?? -1);
 
             return formatterExtension.TryEvaluateFormat(formattingInfo);
         }
-            
+
         // Go through all (implicit) formatters which contain an empty name
         // much higher performance and less GC than using Linq
         foreach (var fe in _formatterExtensions)

src/SmartFormat/ZString/ZStringBuilder.cs

@@ -5,7 +5,6 @@
 using System;
 using System.Collections.Generic;
 using System.Diagnostics.CodeAnalysis;
-using System.Runtime.InteropServices.ComTypes;
 using Cysharp.Text;
 
 namespace SmartFormat.ZString;

src/SmartFormat/ZString/ZStringWriter.cs

@@ -144,7 +144,7 @@ public override string ToString()
         return _zw.ToString();
     }
 
-#if !NETSTANDARD2_0 && !NETFRAMEWORK
+#if NETSTANDARD2_1 || NET6_0_OR_GREATER
 
     /// <summary>
     /// Writes a span of characters.