Add configuration settting AreContextSymbolsEnabled

zzzprojects · Aug 13, 2023 · 118ffc3 · 118ffc3
1 parent 06d4110
commit 118ffc3
Show file tree

Hide file tree

Showing 3 changed files with 55 additions and 4 deletions.
diff --git a/src/System.Linq.Dynamic.Core/Parser/KeywordsHelper.cs b/src/System.Linq.Dynamic.Core/Parser/KeywordsHelper.cs
@@ -37,9 +37,12 @@ public KeywordsHelper(ParsingConfig config)
                 _keywords.Add(KEYWORD_ROOT, KEYWORD_ROOT);
             }
 
-            _keywords.Add(SYMBOL_IT, SYMBOL_IT);
-            _keywords.Add(SYMBOL_PARENT, SYMBOL_PARENT);
-            _keywords.Add(SYMBOL_ROOT, SYMBOL_ROOT);
+            if (config.AreContextSymbolsEnabled)
+            {
+                _keywords.Add(SYMBOL_IT, SYMBOL_IT);
+                _keywords.Add(SYMBOL_PARENT, SYMBOL_PARENT);
+                _keywords.Add(SYMBOL_ROOT, SYMBOL_ROOT);
+            }
 
             _keywords.Add(FUNCTION_IIF, FUNCTION_IIF);
             _keywords.Add(FUNCTION_ISNULL, FUNCTION_ISNULL);

diff --git a/src/System.Linq.Dynamic.Core/ParsingConfig.cs b/src/System.Linq.Dynamic.Core/ParsingConfig.cs
@@ -107,10 +107,18 @@ public IQueryableAnalyzer QueryableAnalyzer
     /// Determines if the context keywords (it, parent, and root) are valid and usable inside a Dynamic Linq string expression.  
     /// Does not affect the usability of the equivalent context symbols ($, ^ and ~).
     /// 
-    /// Default value is <c>false</c>.
+    /// Default value is <c>true</c>.
     /// </summary>
     public bool AreContextKeywordsEnabled { get; set; } = true;
 
+    /// <summary>
+    /// Determines if the context symbols ($, ^ and ~) are valid and usable inside a Dynamic Linq string expression.  
+    /// Does not affect the usability of the equivalent context keywords (it, parent, and root).
+    /// 
+    /// Default value is <c>true</c>.
+    /// </summary>
+    public bool AreContextSymbolsEnabled { get; set; } = true;
+
     /// <summary>
     /// Gets or sets a value indicating whether the EntityFramework version supports evaluating GroupBy at database level.
     /// See https://docs.microsoft.com/en-us/ef/core/what-is-new/ef-core-2.1#linq-groupby-translation

diff --git a/test/System.Linq.Dynamic.Core.Tests/Parser/ExpressionParserTests.cs b/test/System.Linq.Dynamic.Core.Tests/Parser/ExpressionParserTests.cs
@@ -391,4 +391,44 @@ public void Parse_When_PrioritizePropertyOrFieldOverTheType_IsFalse(string expre
         // Assert
         parsedExpression.Should().StartWith(result);
     }
+
+    [Theory]
+    [InlineData("it != null")]
+    [InlineData("parent != null")]
+    [InlineData("root != null")]
+    public void Parse_When_AreContextKeywordsEnabled_IsFalse_Should_Not_SupportKeywords(string expression)
+    {
+        // Arrange
+        var config = new ParsingConfig
+        {
+            AreContextKeywordsEnabled = false
+        };
+        ParameterExpression[] parameters = { ParameterExpressionHelper.CreateParameterExpression(typeof(Company), "company") };
+
+        // Act
+        Action a = () => new ExpressionParser(parameters, expression, null, config).Parse(null);
+
+        // Assert
+        a.Should().Throw<ParseException>().And.Message.Should().NotBeEmpty();
+    }
+
+    [Theory]
+    [InlineData("$ != null")]
+    [InlineData("^ != null")]
+    [InlineData("~ != null")]
+    public void Parse_When_AreContextSymbolsEnabled_IsFalse_Should_Not_SupportKeywords(string expression)
+    {
+        // Arrange
+        var config = new ParsingConfig
+        {
+            AreContextSymbolsEnabled = false
+        };
+        ParameterExpression[] parameters = { ParameterExpressionHelper.CreateParameterExpression(typeof(Company), "company") };
+
+        // Act
+        Action a = () => new ExpressionParser(parameters, expression, null, config).Parse(null);
+
+        // Assert
+        a.Should().Throw<ParseException>().And.Message.Should().NotBeEmpty();
+    }
 }