Major Kotlin DSL Improvement (#353)

* Update and extend the Kotlin DSL
   - Remove dependency on org.mybatis.dynamic.sql.SqlBuilder as this causes name collisions in some cases
   - Explicitly denote the nullability aspects of the API
   - Specify all return types per Kotlin Library coding conventions
* Use new Kotlin IR compiler
* Improved Kotlin specific column builder
* Remove the supplier based methods - they cause weird overload issues and the don't make much sense anymore as
the underlying Java code doesn't use them
* New meta-model pattern
* Add support for batch inserts with MyBatis
* Kotlin documentation updates
* Add flush capability to CommonInsertMapper
* Add support for generated keys with insert select in Spring

Author: jeffgbutler

CHANGELOG.md

@@ -19,7 +19,7 @@ The major themes of this release include the following:
 1. Remove deprecated code from prior releases.
 
 ### Built-In Condition Refactoring
-All built-in conditions have been rafactored. The changes should have no impact for the vast majority of users.
+All built-in conditions have been refactored. The changes should have no impact for the vast majority of users.
 However, there are some changes in behavior and one breaking change.
 
 1. Internally, the conditions no longer hold value Suppliers, they now hold the values themselves. The SqlBuilder
@@ -100,6 +100,7 @@ Kotlin DSL.
 - Added a mapping for general insert and update statements that will render null values as "null" in the SQL ([#343](https://github.com/mybatis/mybatis-dynamic-sql/pull/343))
 - Allow the "in when present" conditions to accept a null Collection as a parameter ([#346](https://github.com/mybatis/mybatis-dynamic-sql/pull/346))
 - Add Better Support for MyBatis Multi-Row Inserts that Return Generated Keys ([#349](https://github.com/mybatis/mybatis-dynamic-sql/pull/349))
+- Major improvement to the Kotlin DSL ([#353](https://github.com/mybatis/mybatis-dynamic-sql/pull/353))
 
 ## Release 1.2.1 - September 29, 2020
 

pom.xml

@@ -38,7 +38,8 @@
     <spring.batch.version>4.3.2</spring.batch.version>
     <clirr.comparisonVersion>1.2.0</clirr.comparisonVersion>
     <module.name>org.mybatis.dynamic.sql</module.name>
-    <kotlin.version>1.5.0</kotlin.version>
+    <!-- Kotlin 1.5.0/IR Compiler must wait for Jacoco 0.8.7 -->
+    <kotlin.version>1.4.32</kotlin.version>
     <kotlin.compiler.jvmTarget>1.8</kotlin.compiler.jvmTarget>
     <sonar.sources>pom.xml,src/main/java,src/main/kotlin</sonar.sources>
     <sonar.tests>src/test/java,src/test/kotlin</sonar.tests>
@@ -64,6 +65,11 @@
         <groupId>org.jetbrains.kotlin</groupId>
         <artifactId>kotlin-maven-plugin</artifactId>
         <version>${kotlin.version}</version>
+        <configuration>
+          <args>
+            <arg>-Xuse-ir</arg>
+          </args>
+        </configuration>
         <executions>
           <execution>
             <id>compile</id>

src/main/java/org/mybatis/dynamic/sql/select/function/Concatenate.java

@@ -1,5 +1,5 @@
 /*
- *    Copyright 2016-2020 the original author or authors.
+ *    Copyright 2016-2021 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.
@@ -37,4 +37,9 @@ public static <T> Concatenate<T> concatenate(BindableColumn<T> firstColumn, Basi
             BasicColumn... subsequentColumns) {
         return new Concatenate<>(firstColumn, secondColumn, Arrays.asList(subsequentColumns));
     }
+
+    public static <T> Concatenate<T> of(BindableColumn<T> firstColumn, BasicColumn secondColumn,
+                                        List<BasicColumn> subsequentColumns) {
+        return new Concatenate<>(firstColumn, secondColumn, subsequentColumns);
+    }
 }

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

@@ -15,6 +15,10 @@
  */
 package org.mybatis.dynamic.sql.util;
 
+import java.util.List;
+import java.util.Map;
+import java.util.stream.Collectors;
+
 import org.mybatis.dynamic.sql.delete.render.DeleteStatementProvider;
 import org.mybatis.dynamic.sql.insert.render.GeneralInsertStatementProvider;
 import org.mybatis.dynamic.sql.insert.render.InsertSelectStatementProvider;
@@ -23,10 +27,6 @@
 import org.mybatis.dynamic.sql.select.render.SelectStatementProvider;
 import org.mybatis.dynamic.sql.update.render.UpdateStatementProvider;
 
-import java.util.List;
-import java.util.Map;
-import java.util.stream.Collectors;
-
 /**
  * Adapter for use with MyBatis SQL provider annotations.
  *
@@ -52,8 +52,17 @@ public String insertMultiple(MultiRowInsertStatementProvider<?> insertStatement)
     }
 
     /**
-     * This adapter method is intended for use with MyBatis' @InsertProvider annotation when there are generated
-     * values expected from executing the insert statement.
+     * This adapter method is intended for use with MyBatis' &#064;InsertProvider annotation when there are generated
+     * values expected from executing the insert statement. The canonical method signature for using this
+     * adapter method is as follows:
+     *
+     * <pre>
+     * public interface FooMapper {
+     *     &#064;InsertProvider(type=SqlProviderAdapter.class, method="insertMultipleWithGeneratedKeys")
+     *     &#064;Options(useGeneratedKeys=true, keyProperty="records.id")
+     *     int insertMultiple(String insertStatement, &#064;Param("records") List&lt;Foo&gt; records)
+     * }
+     * </pre>
      *
      * @param parameterMap The parameter map is automatically created by MyBatis when there are multiple
      *     parameters in the insert method.
@@ -63,8 +72,9 @@ public String insertMultiple(MultiRowInsertStatementProvider<?> insertStatement)
     public String insertMultipleWithGeneratedKeys(Map<String, Object> parameterMap) {
         List<String> entries = parameterMap.entrySet().stream()
                 .filter(e -> e.getKey().startsWith("param")) //$NON-NLS-1$
-                .filter(e -> String.class.isAssignableFrom(e.getValue().getClass()))
-                .map(e -> (String) e.getValue())
+                .map(Map.Entry::getValue)
+                .filter(String.class::isInstance)
+                .map(String.class::cast)
                 .collect(Collectors.toList());
 
         if (entries.size() == 1) {

src/main/java/org/mybatis/dynamic/sql/util/mybatis3/CommonInsertMapper.java

@@ -1,5 +1,5 @@
 /*
- *    Copyright 2016-2020 the original author or authors.
+ *    Copyright 2016-2021 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.
@@ -15,15 +15,20 @@
  */
 package org.mybatis.dynamic.sql.util.mybatis3;
 
+import java.util.List;
+
+import org.apache.ibatis.annotations.Flush;
 import org.apache.ibatis.annotations.InsertProvider;
+import org.apache.ibatis.executor.BatchResult;
 import org.mybatis.dynamic.sql.insert.render.GeneralInsertStatementProvider;
 import org.mybatis.dynamic.sql.insert.render.InsertSelectStatementProvider;
 import org.mybatis.dynamic.sql.insert.render.InsertStatementProvider;
 import org.mybatis.dynamic.sql.insert.render.MultiRowInsertStatementProvider;
 import org.mybatis.dynamic.sql.util.SqlProviderAdapter;
 
 /**
- * This is a general purpose mapper for executing various types of insert statement.
+ * This is a general purpose mapper for executing various types of insert statements.
+ * This mapper is appropriate for insert statements that do NOT expect generated keys.
  *
  * @param <T> the type of record associated with this mapper
  */
@@ -64,4 +69,13 @@ public interface CommonInsertMapper<T> {
      */
     @InsertProvider(type = SqlProviderAdapter.class, method = "insertMultiple")
     int insertMultiple(MultiRowInsertStatementProvider<T> insertStatement);
+
+    /**
+     * Flush batched insert statements and return details of the current batch.
+     * This is useful when there is no direct access to the @link({@link org.apache.ibatis.session.SqlSession}.
+     *
+     * @return details about the current batch including update counts, etc.
+     */
+    @Flush
+    List<BatchResult> flush();
 }

src/main/kotlin/org/mybatis/dynamic/sql/util/kotlin/CriteriaCollector.kt

@@ -1,5 +1,5 @@
 /*
- *    Copyright 2016-2020 the original author or authors.
+ *    Copyright 2016-2021 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.
@@ -28,7 +28,7 @@ typealias CriteriaReceiver = CriteriaCollector.() -> Unit
 class CriteriaCollector {
     val criteria = mutableListOf<SqlCriterion>()
 
-    fun <T> and(column: BindableColumn<T>, condition: VisitableCondition<T>) =
+    fun <T> and(column: BindableColumn<T>, condition: VisitableCondition<T>): CriteriaCollector =
         apply {
             criteria.add(
                 ColumnAndConditionCriterion.withColumn(column)
@@ -42,7 +42,7 @@ class CriteriaCollector {
         column: BindableColumn<T>,
         condition: VisitableCondition<T>,
         criteriaReceiver: CriteriaReceiver
-    ) =
+    ): CriteriaCollector =
         apply {
             criteria.add(
                 ColumnAndConditionCriterion.withColumn(column)
@@ -53,7 +53,7 @@ class CriteriaCollector {
             )
         }
 
-    fun and(existsPredicate: ExistsPredicate) =
+    fun and(existsPredicate: ExistsPredicate): CriteriaCollector =
         apply {
             criteria.add(
                 ExistsCriterion.Builder()
@@ -63,7 +63,7 @@ class CriteriaCollector {
             )
         }
 
-    fun and(existsPredicate: ExistsPredicate, criteriaReceiver: CriteriaReceiver) =
+    fun and(existsPredicate: ExistsPredicate, criteriaReceiver: CriteriaReceiver): CriteriaCollector =
         apply {
             criteria.add(
                 ExistsCriterion.Builder()
@@ -74,7 +74,7 @@ class CriteriaCollector {
             )
         }
 
-    fun <T> or(column: BindableColumn<T>, condition: VisitableCondition<T>) =
+    fun <T> or(column: BindableColumn<T>, condition: VisitableCondition<T>): CriteriaCollector =
         apply {
             criteria.add(
                 ColumnAndConditionCriterion.withColumn(column)
@@ -88,7 +88,7 @@ class CriteriaCollector {
         column: BindableColumn<T>,
         condition: VisitableCondition<T>,
         criteriaReceiver: CriteriaReceiver
-    ) =
+    ): CriteriaCollector =
         apply {
             criteria.add(
                 ColumnAndConditionCriterion.withColumn(column)
@@ -99,7 +99,7 @@ class CriteriaCollector {
             )
         }
 
-    fun or(existsPredicate: ExistsPredicate) =
+    fun or(existsPredicate: ExistsPredicate): CriteriaCollector =
         apply {
             criteria.add(
                 ExistsCriterion.Builder()
@@ -109,7 +109,7 @@ class CriteriaCollector {
             )
         }
 
-    fun or(existsPredicate: ExistsPredicate, criteriaReceiver: CriteriaReceiver) =
+    fun or(existsPredicate: ExistsPredicate, criteriaReceiver: CriteriaReceiver): CriteriaCollector =
         apply {
             criteria.add(
                 ExistsCriterion.Builder()

src/main/kotlin/org/mybatis/dynamic/sql/util/kotlin/JoinCollector.kt

@@ -27,7 +27,7 @@ class JoinCollector {
     val andJoinCriteria = mutableListOf<JoinCriterion>()
     private lateinit var internalOnCriterion: JoinCriterion
 
-    fun on(column: BasicColumn, condition: JoinCondition) =
+    fun on(column: BasicColumn, condition: JoinCondition): JoinCollector =
         apply {
             internalOnCriterion = JoinCriterion.Builder()
                 .withConnector("on")
@@ -36,7 +36,7 @@ class JoinCollector {
                 .build()
         }
 
-    fun and(column: BasicColumn, condition: JoinCondition) =
+    fun and(column: BasicColumn, condition: JoinCondition): JoinCollector =
         apply {
             andJoinCriteria.add(
                 JoinCriterion.Builder()