Merge pull request #216 from jeffgbutler/per-column-formatting

Add support for overriding rendering strategy per column

Author: jeffgbutler

.travis.yml

@@ -4,6 +4,9 @@ jdk:
   - openjdk11
   - openjdk8
 
+services:
+  - docker
+
 after_success:
   - chmod -R 777 ./travis/after_success.sh
   - ./travis/after_success.sh

CHANGELOG.md

@@ -9,6 +9,7 @@ GitHub milestone: [https://github.com/mybatis/mybatis-dynamic-sql/issues?q=miles
 ### Added
 
 - Added a general insert statement that does not require a separate record class to hold values for the insert. ([#201](https://github.com/mybatis/mybatis-dynamic-sql/issues/201))
+- Added the capability to specify a rendering strategy on a column to override the defaut rendering strategy for a statement. This will allow certain edge cases where a parameter marker needs to be formatted in a unique way (for example, "::jsonb" needs to be added to parameter markers for JSON fields in PostgreSQL) ([#200](https://github.com/mybatis/mybatis-dynamic-sql/issues/200))
 
 ## Release 1.1.4 - November 23, 2019
 

pom.xml

@@ -44,6 +44,7 @@
     <sonar.tests>src/test/java,src/test/kotlin</sonar.tests>
     <jacoco.version>0.8.5</jacoco.version>
     <kotlin.code.style>official</kotlin.code.style>
+    <test.containers.version>1.14.3</test.containers.version>
   </properties>
 
   <build>
@@ -252,6 +253,25 @@
       <version>2.2</version>
       <scope>test</scope>
     </dependency>
+    
+    <dependency>
+      <groupId>org.testcontainers</groupId>
+      <artifactId>postgresql</artifactId>
+      <version>${test.containers.version}</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.testcontainers</groupId>
+      <artifactId>junit-jupiter</artifactId>
+      <version>${test.containers.version}</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.postgresql</groupId>
+      <artifactId>postgresql</artifactId>
+      <version>42.2.14</version>
+      <scope>test</scope>
+    </dependency>
   </dependencies>
 
   <scm>

src/main/java/org/mybatis/dynamic/sql/BindableColumn.java

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2016-2018 the original author or authors.
+ *    Copyright 2016-2020 the original author or authors.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -18,6 +18,8 @@
 import java.sql.JDBCType;
 import java.util.Optional;
 
+import org.mybatis.dynamic.sql.render.RenderingStrategy;
+
 /**
  * Describes additional attributes of columns that are necessary for binding the column as a JDBC parameter.
  * Columns in where clauses are typically bound.
@@ -39,4 +41,8 @@ public interface BindableColumn<T> extends BasicColumn {
     Optional<JDBCType> jdbcType();
 
     Optional<String> typeHandler();
+    
+    default Optional<RenderingStrategy> renderingStrategy() {
+        return Optional.empty();
+    }
 }

src/main/java/org/mybatis/dynamic/sql/SqlColumn.java

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2016-2019 the original author or authors.
+ *    Copyright 2016-2020 the original author or authors.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -19,6 +19,7 @@
 import java.util.Objects;
 import java.util.Optional;
 
+import org.mybatis.dynamic.sql.render.RenderingStrategy;
 import org.mybatis.dynamic.sql.render.TableAliasCalculator;
 
 public class SqlColumn<T> implements BindableColumn<T>, SortSpecification {
@@ -29,6 +30,7 @@ public class SqlColumn<T> implements BindableColumn<T>, SortSpecification {
     protected boolean isDescending = false;
     protected String alias;
     protected String typeHandler;
+    protected RenderingStrategy renderingStrategy;
 
     private SqlColumn(Builder builder) {
         name = Objects.requireNonNull(builder.name);
@@ -44,12 +46,17 @@ protected SqlColumn(SqlColumn<?> sqlColumn) {
         isDescending = sqlColumn.isDescending;
         alias = sqlColumn.alias;
         typeHandler = sqlColumn.typeHandler;
+        renderingStrategy = sqlColumn.renderingStrategy;
     }
 
     public String name() {
         return name;
     }
 
+    public SqlTable table() {
+        return table;
+    }
+    
     @Override
     public Optional<JDBCType> jdbcType() {
         return Optional.ofNullable(jdbcType);
@@ -96,12 +103,23 @@ public String renderWithTableAlias(TableAliasCalculator tableAliasCalculator) {
                 .orElseGet(this::name);
     }
 
+    @Override
+    public Optional<RenderingStrategy> renderingStrategy() {
+        return Optional.ofNullable(renderingStrategy);
+    }
+    
     public SqlColumn<T> withTypeHandler(String typeHandler) {
         SqlColumn<T> column = new SqlColumn<>(this);
         column.typeHandler = typeHandler;
         return column;
     }
 
+    public <S> SqlColumn<S> withRenderingStrategy(RenderingStrategy renderingStrategy) {
+        SqlColumn<S> column = new SqlColumn<>(this);
+        column.renderingStrategy = renderingStrategy;
+        return column;
+    }
+
     private String applyTableAlias(String tableAlias) {
         return tableAlias + "." + name(); //$NON-NLS-1$
     }

src/main/java/org/mybatis/dynamic/sql/insert/render/GeneralInsertValuePhraseVisitor.java

@@ -69,7 +69,7 @@ public <R> FieldAndValueAndParameters visit(ValueMapping<R> mapping) {
     }
 
     private Function<SqlColumn<?>, String> toJdbcPlaceholder(String parameterName) {
-        return column -> renderingStrategy
+        return column -> column.renderingStrategy().orElse(renderingStrategy)
                 .getFormattedJdbcPlaceholder(column, RenderingStrategy.DEFAULT_PARAMETER_PREFIX, parameterName);
     }
 }

src/main/java/org/mybatis/dynamic/sql/insert/render/MultiRowValuePhraseVisitor.java

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2016-2019 the original author or authors.
+ *    Copyright 2016-2020 the original author or authors.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -35,7 +35,8 @@ public FieldAndValue visit(PropertyMapping mapping) {
     }
 
     private Function<SqlColumn<?>, String> toMultiRowJdbcPlaceholder(String parameterName) {
-        return column -> renderingStrategy.getFormattedJdbcPlaceholder(column, "records[%s]", //$NON-NLS-1$
-                parameterName);
+        return column -> column.renderingStrategy().orElse(renderingStrategy)
+                .getFormattedJdbcPlaceholder(column, "records[%s]", //$NON-NLS-1$
+                        parameterName);
     }
 }

src/main/java/org/mybatis/dynamic/sql/insert/render/ValuePhraseVisitor.java

@@ -62,6 +62,7 @@ public FieldAndValue visit(PropertyMapping mapping) {
     }
 
     private Function<SqlColumn<?>, String> toJdbcPlaceholder(String parameterName) {
-        return column -> renderingStrategy.getFormattedJdbcPlaceholder(column, "record", parameterName); //$NON-NLS-1$
+        return column -> column.renderingStrategy().orElse(renderingStrategy)
+                .getFormattedJdbcPlaceholder(column, "record", parameterName); //$NON-NLS-1$
     }
 }

src/main/java/org/mybatis/dynamic/sql/update/render/SetPhraseVisitor.java

@@ -110,7 +110,7 @@ public FragmentAndParameters visit(ColumnToColumnMapping mapping) {
     }
 
     private Function<SqlColumn<?>, String> toJdbcPlaceholder(String parameterName) {
-        return column -> renderingStrategy
+        return column -> column.renderingStrategy().orElse(renderingStrategy)
                 .getFormattedJdbcPlaceholder(column, RenderingStrategy.DEFAULT_PARAMETER_PREFIX, parameterName);
     }
 }

src/main/java/org/mybatis/dynamic/sql/util/AbstractColumnMapping.java

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2016-2019 the original author or authors.
+ *    Copyright 2016-2020 the original author or authors.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.