Merge pull request #216 from joshcobalt/sqlkata#215

Adds ability to escape identifiers w/ tests

Author: ahmad-moussawi

QueryBuilder.Tests/GeneralTests.cs

@@ -123,6 +123,16 @@ public void Raw_WrapIdentifiers()
             Assert.Equal("SELECT \"Id\", \"Name\", \"Age\" FROM \"Users\"", c[EngineCodes.PostgreSql]);
             Assert.Equal("SELECT \"Id\", \"Name\", \"Age\" FROM \"USERS\"", c[EngineCodes.Firebird]);
         }
+        
+        [Fact]
+        public void Raw_WrapIdentifiers_Escaped()
+        {
+            var query = new Query("Users").SelectRaw("'\\{1,2,3\\}'::int\\[\\]");
+
+            var c = Compile(query);
+
+            Assert.Equal("SELECT '{1,2,3}'::int[] FROM \"Users\"", c[EngineCodes.PostgreSql]);
+        }
 
         [Fact]
         public void WrapWithSpace()

QueryBuilder.Tests/HelperTests.cs

@@ -224,5 +224,14 @@ public void ExpandParameters()
 
             Assert.Equal("where id = ? or id in (?,?) or id in ()", expanded);
         }
+
+        [Theory]
+        [InlineData(@"\{ text {", @"\", "{", "[", "{ text [")]
+        [InlineData(@"{ text {", @"\", "{", "[", "[ text [")]
+        public void WrapIdentifiers(string input, string escapeCharacter, string identifier, string newIdentifier, string expected)
+        {
+            var result = input.ReplaceIdentifierUnlessEscaped(escapeCharacter, identifier, newIdentifier);
+            Assert.Equal(expected, result);
+        }
     }
 }

QueryBuilder.Tests/SelectTests.cs

@@ -619,5 +619,15 @@ public void JoinTypes(string given, string output)
                 $"SELECT * FROM \"USERS\" \n{output} \"COUNTRIES\" ON \"COUNTRIES\".\"ID\" = \"USERS\".\"COUNTRY_ID\"",
                 c[EngineCodes.Firebird]);
         }
+        
+        [Fact]
+        public void OrWhereRawEscaped()
+        {
+            var query = new Query("Table").WhereRaw("[MyCol] = ANY(?::int\\[\\])", "{1,2,3}");
+
+            var c = Compile(query);
+
+            Assert.Equal("SELECT * FROM \"Table\" WHERE \"MyCol\" = ANY('{1,2,3}'::int[])", c[EngineCodes.PostgreSql]);
+        }
     }
 }

QueryBuilder/Compilers/Compiler.cs

@@ -15,6 +15,7 @@ public partial class Compiler
         protected virtual string ColumnAsKeyword { get; set; } = "AS ";
         protected virtual string TableAsKeyword { get; set; } = "AS ";
         protected virtual string LastId { get; set; } = "";
+        protected virtual string EscapeCharacter { get; set; } = "\\";
 
         protected Compiler()
         {
@@ -809,12 +810,11 @@ public virtual string WrapIdentifiers(string input)
             return input
 
                 // deprecated
-                .Replace("{", this.OpeningIdentifier)
-                .Replace("}", this.ClosingIdentifier)
+                .ReplaceIdentifierUnlessEscaped(this.EscapeCharacter,"{", this.OpeningIdentifier)
+                .ReplaceIdentifierUnlessEscaped(this.EscapeCharacter,"}", this.ClosingIdentifier)
 
-                .Replace("[", this.OpeningIdentifier)
-                .Replace("]", this.ClosingIdentifier);
+                .ReplaceIdentifierUnlessEscaped(this.EscapeCharacter,"[", this.OpeningIdentifier)
+                .ReplaceIdentifierUnlessEscaped(this.EscapeCharacter,"]", this.ClosingIdentifier);
         }
-
     }
 }

QueryBuilder/Helper.cs

@@ -158,5 +158,16 @@ public static IEnumerable<string> Repeat(this string str, int count)
         {
             return Enumerable.Repeat(str, count);
         }
+        
+        public static string ReplaceIdentifierUnlessEscaped(this string input, string escapeCharacter, string identifier, string newIdentifier)
+        {
+            //Replace standard, non-escaped identifiers first
+            var nonEscapedRegex = new Regex($@"(?<!{Regex.Escape(escapeCharacter)}){Regex.Escape(identifier)}");
+            var nonEscapedReplace = nonEscapedRegex.Replace(input, newIdentifier);
+            
+            //Then replace escaped identifiers, by just removing the escape character
+            var escapedRegex = new Regex($@"{Regex.Escape(escapeCharacter)}{Regex.Escape(identifier)}");
+            return escapedRegex.Replace(nonEscapedReplace, identifier);
+        }
     }
 }