Added StringComparer property to TemplateContext (#681)

Co-authored-by: Hisham Bin Ateya <[email protected]>
Co-authored-by: Sebastien Ros <[email protected]>

Fluid.Tests/TemplateContextTests.cs

@@ -160,6 +160,25 @@ public async Task ShouldNotReleaseScopeAsynchronously()
 
             Assert.Equal("101", output);
         }
+
+        [Fact]
+        public void ShouldUseCustomStringComparer()
+        {
+            var context = new TemplateContext(StringComparer.OrdinalIgnoreCase);
+            context.SetValue("PageState", "insert");
+
+            Assert.Equal("insert", context.GetValue("pageState").ToStringValue());
+        }
+
+        [Fact]
+        public void ShouldUseTemplateOptionsStringComparer()
+        {
+            var options = new TemplateOptions { ModelNamesComparer = StringComparer.OrdinalIgnoreCase };
+            var context = new TemplateContext(options);
+            context.SetValue("PageState", "insert");
+
+            Assert.Equal("insert", context.GetValue("pageState").ToStringValue());
+        }
 
         private class TestClass
         {

Fluid/Scope.cs

@@ -8,9 +8,8 @@ public sealed class Scope
         private Dictionary<string, FluidValue> _properties;
         private readonly bool _forLoopScope;
 
-        public Scope()
+        public Scope() : this(null)
         {
-            Parent = null;
         }
 
         public Scope(Scope parent)
@@ -23,12 +22,12 @@ public Scope(Scope parent, bool forLoopScope)
             if (forLoopScope && parent == null) ExceptionHelper.ThrowArgumentNullException(nameof(parent));
 
             Parent = parent;
-
             // A ForLoop scope reads and writes its values in the parent scope.
             // Internal accessors to the inner properties grant access to the local properties.
             _forLoopScope = forLoopScope;
 
-            _properties = new Dictionary<string, FluidValue>();
+            // ForLoop scopes are ordinal since the properties are keywords: "forloop"
+            _properties = new Dictionary<string, FluidValue>(StringComparer.OrdinalIgnoreCase);
         }
 
         /// <summary>
@@ -115,7 +114,7 @@ public void SetValue(string name, FluidValue value)
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         public void SetOwnValue(string name, FluidValue value)
         {
-            _properties ??= new Dictionary<string, FluidValue>();
+            _properties ??= new Dictionary<string, FluidValue>(Parent?._properties?.Comparer ?? TemplateOptions.Default.ModelNamesComparer);
             _properties[name] = value ?? NilValue.Instance;
         }
 
@@ -138,4 +137,4 @@ public void CopyTo(Scope scope)
             }
         }
     }
-}
+}

Fluid/TemplateContext.cs

@@ -44,7 +44,8 @@ public TemplateContext(object model, TemplateOptions options, bool allowModelMem
         /// Initializes a new instance of <see cref="TemplateContext"/> with the specified <see cref="TemplateOptions"/>.
         /// </summary>
         /// <param name="options">The template options.</param>
-        public TemplateContext(TemplateOptions options)
+        /// <param name="modelNamesComparer">An optional <see cref="StringComparer"/> instance used when comparing model names.</param>
+        public TemplateContext(TemplateOptions options, StringComparer modelNamesComparer = null)
         {
             Options = options;
             LocalScope = new Scope(options.Scope);
@@ -54,14 +55,16 @@ public TemplateContext(TemplateOptions options)
             Captured = options.Captured;
             Now = options.Now;
             MaxSteps = options.MaxSteps;
+            ModelNamesComparer = modelNamesComparer ?? options.ModelNamesComparer;
         }
 
         /// <summary>
-        /// Initializes a new instance of <see cref="TemplateContext"/> wih a model and option regiter its properties.
+        /// Initializes a new instance of <see cref="TemplateContext"/> wih a model and option register its properties.
         /// </summary>
         /// <param name="model">The model.</param>
         /// <param name="allowModelMembers">Whether the members of the model can be accessed by default.</param>
-        public TemplateContext(object model, bool allowModelMembers = true) : this()
+        /// <param name="modelNamesComparer">An optional <see cref="StringComparer"/> instance used when comparing model names.</param>
+        public TemplateContext(object model, bool allowModelMembers = true, StringComparer modelNamesComparer = null) : this(TemplateOptions.Default, modelNamesComparer)
         {
             if (model == null)
             {
@@ -89,6 +92,11 @@ public TemplateContext(object model, bool allowModelMembers = true) : this()
         /// </summary>
         public int MaxSteps { get; set; } = TemplateOptions.Default.MaxSteps;
 
+        /// <summary>
+        /// Gets <see cref="StringComparer"/> used when comparing model names.
+        /// </summary>
+        public StringComparer ModelNamesComparer { get; private set; }
+
         /// <summary>
         /// Gets or sets the <see cref="CultureInfo"/> instance used to render locale values like dates and numbers.
         /// </summary>
@@ -136,7 +144,7 @@ public void IncrementSteps()
 
         /// <summary>
         /// Gets or sets a model object that is used to resolve properties in a template. This object is used if local and
-        /// global scopes are unsuccessfull.
+        /// global scopes are unsuccessful.
         /// </summary>
         public FluidValue Model { get; }
 

Fluid/TemplateOptions.cs

@@ -23,6 +23,14 @@ public class TemplateOptions
         /// </summary>
         public int MaxSteps { get; set; }
 
+        /// <summary>
+        /// Gets or sets the <see cref="StringComparer"/> to use when comparing model names.
+        /// </summary>
+        /// <value>
+        /// Default value is <see cref="StringComparer.OrdinalIgnoreCase"/>
+        /// </value>
+        public StringComparer ModelNamesComparer { get; set; } = StringComparer.OrdinalIgnoreCase;
+
         /// <summary>
         /// Gets or sets the <see cref="CultureInfo"/> instance used to render locale values like dates and numbers.
         /// </summary>