Fix for issue #592 : Fix places where the parameterPlaceholder is har…

…dcoded to a ? Added compiler to the constructor of SqlResult Made ParameterPlaceholder public
sqlkata · Nov 3, 2022 · 7597698 · 7597698
1 parent d9d0441
commit 7597698
Show file tree

Hide file tree

Showing 19 changed files with 170 additions and 99 deletions.
diff --git a/QueryBuilder.Tests/Firebird/FirebirdLimitTests.cs b/QueryBuilder.Tests/Firebird/FirebirdLimitTests.cs
@@ -17,7 +17,7 @@ public FirebirdLimitTests()
         public void NoLimitNorOffset()
         {
             var query = new Query("Table");
-            var ctx = new SqlResult { Query = query };
+            var ctx = new SqlResult(compiler) { Query = query };
 
             Assert.Null(compiler.CompileLimit(ctx));
         }
@@ -26,7 +26,7 @@ public void NoLimitNorOffset()
         public void LimitOnly()
         {
             var query = new Query("Table").Limit(10);
-            var ctx = new SqlResult { Query = query };
+            var ctx = new SqlResult(compiler) { Query = query };
 
             Assert.Null(compiler.CompileLimit(ctx));
         }
@@ -35,7 +35,7 @@ public void LimitOnly()
         public void OffsetOnly()
         {
             var query = new Query("Table").Offset(20);
-            var ctx = new SqlResult { Query = query };
+            var ctx = new SqlResult(compiler) { Query = query };
 
             Assert.Null(compiler.CompileLimit(ctx));
         }
@@ -44,7 +44,7 @@ public void OffsetOnly()
         public void LimitAndOffset()
         {
             var query = new Query("Table").Limit(5).Offset(20);
-            var ctx = new SqlResult { Query = query };
+            var ctx = new SqlResult(compiler) { Query = query };
 
             Assert.Equal("ROWS ? TO ?", compiler.CompileLimit(ctx));
             Assert.Equal(21L, ctx.Bindings[0]);

diff --git a/QueryBuilder.Tests/Infrastructure/TestCompilersContainer.cs b/QueryBuilder.Tests/Infrastructure/TestCompilersContainer.cs
@@ -1,8 +1,7 @@
+using SqlKata.Compilers;
 using System;
 using System.Collections.Generic;
 using System.Linq;
-using SqlKata.Compilers;
-
 namespace SqlKata.Tests.Infrastructure
 {
     public class TestCompilersContainer

diff --git a/QueryBuilder.Tests/MySql/MySqlLimitTests.cs b/QueryBuilder.Tests/MySql/MySqlLimitTests.cs
@@ -17,7 +17,7 @@ public MySqlLimitTests()
         public void WithNoLimitNorOffset()
         {
             var query = new Query("Table");
-            var ctx = new SqlResult { Query = query };
+            var ctx = new SqlResult(compiler) { Query = query };
 
             Assert.Null(compiler.CompileLimit(ctx));
         }
@@ -26,7 +26,7 @@ public void WithNoLimitNorOffset()
         public void WithNoOffset()
         {
             var query = new Query("Table").Limit(10);
-            var ctx = new SqlResult { Query = query };
+            var ctx = new SqlResult(compiler) { Query = query };
 
             Assert.Equal("LIMIT ?", compiler.CompileLimit(ctx));
             Assert.Equal(10, ctx.Bindings[0]);
@@ -36,7 +36,7 @@ public void WithNoOffset()
         public void WithNoLimit()
         {
             var query = new Query("Table").Offset(20);
-            var ctx = new SqlResult { Query = query };
+            var ctx = new SqlResult(compiler) { Query = query };
 
             Assert.Equal("LIMIT 18446744073709551615 OFFSET ?", compiler.CompileLimit(ctx));
             Assert.Equal(20L, ctx.Bindings[0]);
@@ -47,7 +47,7 @@ public void WithNoLimit()
         public void WithLimitAndOffset()
         {
             var query = new Query("Table").Limit(5).Offset(20);
-            var ctx = new SqlResult { Query = query };
+            var ctx = new SqlResult(compiler) { Query = query };
 
             Assert.Equal("LIMIT ? OFFSET ?", compiler.CompileLimit(ctx));
             Assert.Equal(5, ctx.Bindings[0]);

diff --git a/QueryBuilder.Tests/MySqlExecutionTest.cs b/QueryBuilder.Tests/MySqlExecutionTest.cs
@@ -1,11 +1,9 @@
+using MySql.Data.MySqlClient;
 using SqlKata.Compilers;
-using Xunit;
 using SqlKata.Execution;
-using MySql.Data.MySqlClient;
-using System;
-using System.Linq;
-using static SqlKata.Expressions;
 using System.Collections.Generic;
+using System.Linq;
+using Xunit;
 
 namespace SqlKata.Tests
 {
@@ -174,7 +172,7 @@ public void ExistsShouldReturnFalseForEmptyTable()
             });
 
             var exists = db.Query("Transaction").Exists();
-            Assert.Equal(false, exists);
+            Assert.False(exists);
 
             db.Drop("Transaction");
         }
@@ -195,7 +193,7 @@ public void ExistsShouldReturnTrueForNonEmptyTable()
             });
 
             var exists = db.Query("Transaction").Exists();
-            Assert.Equal(true, exists);
+            Assert.True(exists);
 
             db.Drop("Transaction");
         }
@@ -266,4 +264,4 @@ QueryFactory DB()
 
 
     }
-}
+}
diff --git a/QueryBuilder.Tests/Oracle/OracleLegacyLimitTests.cs b/QueryBuilder.Tests/Oracle/OracleLegacyLimitTests.cs
@@ -21,7 +21,7 @@ public void WithNoLimitNorOffset()
         {
             // Arrange:
             var query = new Query(TableName);
-            var ctx = new SqlResult { Query = query, RawSql = SqlPlaceholder };
+            var ctx = new SqlResult(compiler) { Query = query, RawSql = SqlPlaceholder };
 
             // Act:
             compiler.ApplyLegacyLimit(ctx);
@@ -35,7 +35,7 @@ public void WithNoOffset()
         {
             // Arrange:
             var query = new Query(TableName).Limit(10);
-            var ctx = new SqlResult { Query = query, RawSql = SqlPlaceholder };
+            var ctx = new SqlResult(compiler) { Query = query, RawSql = SqlPlaceholder };
 
             // Act:
             compiler.ApplyLegacyLimit(ctx);
@@ -51,7 +51,7 @@ public void WithNoLimit()
         {
             // Arrange:
             var query = new Query(TableName).Offset(20);
-            var ctx = new SqlResult { Query = query, RawSql = SqlPlaceholder };
+            var ctx = new SqlResult(compiler) { Query = query, RawSql = SqlPlaceholder };
 
             // Act:
             compiler.ApplyLegacyLimit(ctx);
@@ -67,7 +67,7 @@ public void WithLimitAndOffset()
         {
             // Arrange:
             var query = new Query(TableName).Limit(5).Offset(20);
-            var ctx = new SqlResult { Query = query, RawSql = SqlPlaceholder };
+            var ctx = new SqlResult(compiler) { Query = query, RawSql = SqlPlaceholder };
 
             // Act:
             compiler.ApplyLegacyLimit(ctx);

diff --git a/QueryBuilder.Tests/Oracle/OracleLimitTests.cs b/QueryBuilder.Tests/Oracle/OracleLimitTests.cs
@@ -21,7 +21,7 @@ public void NoLimitNorOffset()
         {
             // Arrange:
             var query = new Query(TableName);
-            var ctx = new SqlResult { Query = query, RawSql = SqlPlaceholder };
+            var ctx = new SqlResult(compiler) { Query = query, RawSql = SqlPlaceholder };
 
             // Act & Assert:
             Assert.Null(compiler.CompileLimit(ctx));
@@ -32,7 +32,7 @@ public void LimitOnly()
         {
             // Arrange:
             var query = new Query(TableName).Limit(10);
-            var ctx = new SqlResult { Query = query, RawSql = SqlPlaceholder };
+            var ctx = new SqlResult(compiler) { Query = query, RawSql = SqlPlaceholder };
 
             //  Act & Assert:
             Assert.EndsWith("OFFSET ? ROWS FETCH NEXT ? ROWS ONLY", compiler.CompileLimit(ctx));
@@ -46,7 +46,7 @@ public void OffsetOnly()
         {
             // Arrange:
             var query = new Query(TableName).Offset(20);
-            var ctx = new SqlResult { Query = query, RawSql = SqlPlaceholder };
+            var ctx = new SqlResult(compiler) { Query = query, RawSql = SqlPlaceholder };
 
             // Act & Assert:
             Assert.EndsWith("OFFSET ? ROWS", compiler.CompileLimit(ctx));
@@ -60,7 +60,7 @@ public void LimitAndOffset()
         {
             // Arrange:
             var query = new Query(TableName).Limit(5).Offset(20);
-            var ctx = new SqlResult { Query = query, RawSql = SqlPlaceholder };
+            var ctx = new SqlResult(compiler) { Query = query, RawSql = SqlPlaceholder };
 
             // Act & Assert:
             Assert.EndsWith("OFFSET ? ROWS FETCH NEXT ? ROWS ONLY", compiler.CompileLimit(ctx));

diff --git a/QueryBuilder.Tests/ParameterTypeTests.cs b/QueryBuilder.Tests/ParameterTypeTests.cs
@@ -1,10 +1,10 @@
+using SqlKata.Compilers;
+using SqlKata.Tests.Infrastructure;
 using System;
+using System.Collections;
 using System.Collections.Generic;
 using System.Globalization;
-using SqlKata.Compilers;
 using Xunit;
-using System.Collections;
-using SqlKata.Tests.Infrastructure;
 
 namespace SqlKata.Tests
 {
@@ -22,9 +22,9 @@ public class ParameterTypeGenerator : IEnumerable<object[]>
             private readonly List<object[]> _data = new List<object[]>
             {
                 new object[] {"1", 1},
-                new object[] {Convert.ToSingle("10.5", CultureInfo.InvariantCulture).ToString(), 10.5},
+                new object[] {Convert.ToSingle("10.5", CultureInfo.InvariantCulture).ToString(CultureInfo.InvariantCulture), 10.5},
                 new object[] {"-2", -2},
-                new object[] {Convert.ToSingle("-2.8", CultureInfo.InvariantCulture).ToString(), -2.8},
+                new object[] {Convert.ToSingle("-2.8", CultureInfo.InvariantCulture).ToString(CultureInfo.InvariantCulture), -2.8},
                 new object[] {"cast(1 as bit)", true},
                 new object[] {"cast(0 as bit)", false},
                 new object[] {"'2018-10-28 19:22:00'", new DateTime(2018, 10, 28, 19, 22, 0)},

diff --git a/QueryBuilder.Tests/PostgreSql/PostgreSqlLimitTests.cs b/QueryBuilder.Tests/PostgreSql/PostgreSqlLimitTests.cs
@@ -17,7 +17,7 @@ public PostgreSqlLimitTests()
         public void WithNoLimitNorOffset()
         {
             var query = new Query("Table");
-            var ctx = new SqlResult { Query = query };
+            var ctx = new SqlResult(compiler) { Query = query };
 
             Assert.Null(compiler.CompileLimit(ctx));
         }
@@ -26,7 +26,7 @@ public void WithNoLimitNorOffset()
         public void WithNoOffset()
         {
             var query = new Query("Table").Limit(10);
-            var ctx = new SqlResult { Query = query };
+            var ctx = new SqlResult(compiler) { Query = query };
 
             Assert.Equal("LIMIT ?", compiler.CompileLimit(ctx));
             Assert.Equal(10, ctx.Bindings[0]);
@@ -36,7 +36,7 @@ public void WithNoOffset()
         public void WithNoLimit()
         {
             var query = new Query("Table").Offset(20);
-            var ctx = new SqlResult { Query = query };
+            var ctx = new SqlResult(compiler) { Query = query };
 
             Assert.Equal("OFFSET ?", compiler.CompileLimit(ctx));
             Assert.Equal(20L, ctx.Bindings[0]);
@@ -47,7 +47,7 @@ public void WithNoLimit()
         public void WithLimitAndOffset()
         {
             var query = new Query("Table").Limit(5).Offset(20);
-            var ctx = new SqlResult { Query = query };
+            var ctx = new SqlResult(compiler) { Query = query };
 
             Assert.Equal("LIMIT ? OFFSET ?", compiler.CompileLimit(ctx));
             Assert.Equal(5, ctx.Bindings[0]);

diff --git a/QueryBuilder.Tests/PostgreSql/PostgresJsonTests.cs b/QueryBuilder.Tests/PostgreSql/PostgresJsonTests.cs
@@ -0,0 +1,70 @@
+using SqlKata.Compilers;
+using SqlKata.Tests.Infrastructure;
+using System;
+using Xunit;
+
+namespace SqlKata.Tests.PostgreSql
+{
+    public class PostgresJsonTests : TestSupport
+    {
+        public class JsonAwarePostgresCompiler : PostgresCompiler
+        {
+            public override string ParameterPlaceholder { get; protected set; } = "$$";
+        }
+
+        private readonly JsonAwarePostgresCompiler compiler = new();
+        private PostgresCompiler regularCompiler;
+
+        public PostgresJsonTests()
+        {
+            regularCompiler = Compilers.Get<PostgresCompiler>(EngineCodes.PostgreSql);
+        }
+
+        [Fact]
+        public void LimitWithCustomPlaceHolder()
+        {
+            var query = new Query("Table").Limit(10);
+            var ctx = new SqlResult(compiler) { Query = query };
+
+            Assert.Equal($"LIMIT $$", compiler.CompileLimit(ctx));
+            Assert.Equal(10, ctx.Bindings[0]);
+        }
+
+        [Fact]
+        public void RegularCompilerThrowsExceptionWhereRawJsonContainsQuestionMarkData()
+        {
+            Assert.Throws<IndexOutOfRangeException>(() =>
+            {
+                Query query = CreateQuestionMarkJsonQuery(out var rawCondition);
+
+                SqlResult result = regularCompiler.Compile(query);
+                Assert.Equal($"SELECT * FROM \"Table\" WHERE {rawCondition}", result.ToString());
+            });
+        }
+
+        private Query CreateQuestionMarkJsonQuery(out string rawCondition)
+        {
+            rawCondition = "my_json_column @> '{\"json_param\" : \"question mark ? \"}'";
+            var escapedJsonCondition = rawCondition.Replace("{", "\\{").Replace("}", "\\}");
+            return new Query("Table").WhereRaw(escapedJsonCondition);
+        }
+
+        [Fact]
+        public void WhereRawJsonWithQuestionMarkData()
+        {
+            Query query = CreateQuestionMarkJsonQuery(out var rawCondition);
+            SqlResult result = compiler.Compile(query);
+            Assert.Equal($"SELECT * FROM \"Table\" WHERE {rawCondition}", result.ToString());
+        }
+
+        [Fact]
+        public void UsingJsonArray()
+        {
+            var query = new Query("Table").WhereRaw("[Json]->'address'->>'country' in ($$)", new[] { 1, 2, 3, 4 });
+
+            SqlResult result = compiler.Compile(query);
+
+            Assert.Equal("SELECT * FROM \"Table\" WHERE \"Json\"->'address'->>'country' in (1,2,3,4)", result.ToString());
+        }
+    }
+}
diff --git a/QueryBuilder.Tests/SqlServer/SqlServerLegacyLimitTests.cs b/QueryBuilder.Tests/SqlServer/SqlServerLegacyLimitTests.cs
@@ -18,7 +18,7 @@ public SqlServerLegacyLimitTests()
         public void NoLimitNorOffset()
         {
             var query = new Query("Table");
-            var ctx = new SqlResult { Query = query };
+            var ctx = new SqlResult(compiler) { Query = query };
 
             Assert.Null(compiler.CompileLimit(ctx));
         }
@@ -27,7 +27,7 @@ public void NoLimitNorOffset()
         public void LimitOnly()
         {
             var query = new Query("Table").Limit(10);
-            var ctx = new SqlResult { Query = query };
+            var ctx = new SqlResult(compiler) { Query = query };
 
             Assert.Null(compiler.CompileLimit(ctx));
         }
@@ -36,7 +36,7 @@ public void LimitOnly()
         public void OffsetOnly()
         {
             var query = new Query("Table").Offset(20);
-            var ctx = new SqlResult { Query = query };
+            var ctx = new SqlResult(compiler) { Query = query };
 
             Assert.Null(compiler.CompileLimit(ctx));
         }
@@ -45,7 +45,7 @@ public void OffsetOnly()
         public void LimitAndOffset()
         {
             var query = new Query("Table").Limit(5).Offset(20);
-            var ctx = new SqlResult { Query = query };
+            var ctx = new SqlResult(compiler) { Query = query };
 
             Assert.Null(compiler.CompileLimit(ctx));
         }

diff --git a/QueryBuilder.Tests/SqlServer/SqlServerLimitTests.cs b/QueryBuilder.Tests/SqlServer/SqlServerLimitTests.cs
@@ -18,7 +18,7 @@ public SqlServerLimitTests()
         public void NoLimitNorOffset()
         {
             var query = new Query("Table");
-            var ctx = new SqlResult { Query = query };
+            var ctx = new SqlResult(compiler) { Query = query };
 
             Assert.Null(compiler.CompileLimit(ctx));
         }
@@ -27,7 +27,7 @@ public void NoLimitNorOffset()
         public void LimitOnly()
         {
             var query = new Query("Table").Limit(10);
-            var ctx = new SqlResult { Query = query };
+            var ctx = new SqlResult(compiler) { Query = query };
 
             Assert.EndsWith("OFFSET ? ROWS FETCH NEXT ? ROWS ONLY", compiler.CompileLimit(ctx));
             Assert.Equal(2, ctx.Bindings.Count);
@@ -39,7 +39,7 @@ public void LimitOnly()
         public void OffsetOnly()
         {
             var query = new Query("Table").Offset(20);
-            var ctx = new SqlResult { Query = query };
+            var ctx = new SqlResult(compiler) { Query = query };
 
             Assert.EndsWith("OFFSET ? ROWS", compiler.CompileLimit(ctx));
 
@@ -51,7 +51,7 @@ public void OffsetOnly()
         public void LimitAndOffset()
         {
             var query = new Query("Table").Limit(5).Offset(20);
-            var ctx = new SqlResult { Query = query };
+            var ctx = new SqlResult(compiler) { Query = query };
 
             Assert.EndsWith("OFFSET ? ROWS FETCH NEXT ? ROWS ONLY", compiler.CompileLimit(ctx));