Merge pull request #139 from jeffgbutler/kotlin-spring

Kotlin Extensions for Spring JDBC Template

Author: jeffgbutler

CHANGELOG.md

@@ -11,7 +11,7 @@ GitHub milestone: [https://github.com/mybatis/mybatis-dynamic-sql/issues?q=miles
 - Added support for `count(distinct ...)` ([#112](https://github.com/mybatis/mybatis-dynamic-sql/issues/112))
 - Added support for multiple row inserts ([#116](https://github.com/mybatis/mybatis-dynamic-sql/issues/116))
 - Utility classes and a new canonical pattern for MyBatis Generator (CRUD) mappers ([#118](https://github.com/mybatis/mybatis-dynamic-sql/issues/118)) ([#125](https://github.com/mybatis/mybatis-dynamic-sql/pull/125)) ([#128](https://github.com/mybatis/mybatis-dynamic-sql/pull/128))
-- Kotlin Extensions and Kotlin DSL ([#133](https://github.com/mybatis/mybatis-dynamic-sql/pull/133))
+- Kotlin Extensions and Kotlin DSL ([#133](https://github.com/mybatis/mybatis-dynamic-sql/pull/133)) ([#139](https://github.com/mybatis/mybatis-dynamic-sql/pull/139))
 
 
 ## Release 1.1.2 - July 5, 2019

README.md

@@ -26,9 +26,10 @@ See the following pages for further information:
 |------|---------|
 |[Quick Start](src/site/markdown/docs/quickStart.md) | Shows a complete example of building code for this library |
 |[MyBatis3 Support](src/site/markdown/docs/mybatis3.md) | Information about specialized support for [MyBatis3](https://github.com/mybatis/mybatis-3). The examples on this page are similar to the code generated by [MyBatis Generator](https://github.com/mybatis/generator) |
+|[Kotlin Support with MyBatis3](src/site/markdown/docs/kotlinMyBatis3.md) | Information about the Kotlin extensions and Kotlin DSL when using MyBatis3 as the runtime |
 |[Spring Support](src/site/markdown/docs/spring.md) | Information about specialized support for Spring JDBC Templates |
+|[Kotlin Support with Spring](src/site/markdown/docs/kotlinSpring.md) | Information about the Kotlin extensions and Kotlin DSL when using Spring JDBC Template as the runtime |
 |[Spring Batch Support](src/site/markdown/docs/springBatch.md) | Information about specialized support for Spring Batch using the [MyBatis Spring Integration](https://github.com/mybatis/spring) |
-|[Kotlin Support](src/site/markdown/docs/kotlin.md) | Information about the Kotlin extensions and Kotlin DSL |
 
 ## Requirements
 

pom.xml

@@ -35,8 +35,8 @@
     <java.version>1.8</java.version>
     <maven.compiler.source>${java.version}</maven.compiler.source>
     <maven.compiler.target>${java.version}</maven.compiler.target>
-    <junit.jupiter.version>5.5.1</junit.jupiter.version>
-    <junit.platform.version>1.5.1</junit.platform.version>
+    <junit.jupiter.version>5.5.2</junit.jupiter.version>
+    <junit.platform.version>1.5.2</junit.platform.version>
     <spring.batch.version>4.1.2.RELEASE</spring.batch.version>
     <clirr.comparisonVersion>1.1.0</clirr.comparisonVersion>
     <module.name>org.mybatis.dynamic.sql</module.name>
@@ -173,6 +173,13 @@
       <version>${kotlin.version}</version>
       <scope>provided</scope>
     </dependency>
+    <dependency>
+      <groupId>org.springframework</groupId>
+      <artifactId>spring-jdbc</artifactId>
+      <version>5.1.9.RELEASE</version>
+      <scope>provided</scope>
+    </dependency>
+
     <dependency>
       <groupId>org.junit.jupiter</groupId>
       <artifactId>junit-jupiter-api</artifactId>
@@ -191,7 +198,6 @@
       <version>${junit.platform.version}</version>
       <scope>test</scope>
     </dependency>
-
     <dependency>
       <groupId>org.assertj</groupId>
       <artifactId>assertj-core</artifactId>
@@ -216,12 +222,6 @@
       <version>2.5.0</version>
       <scope>test</scope>
     </dependency>
-    <dependency>
-      <groupId>org.springframework</groupId>
-      <artifactId>spring-jdbc</artifactId>
-      <version>5.1.9.RELEASE</version>
-      <scope>test</scope>
-    </dependency>
     <dependency>
       <groupId>org.springframework.batch</groupId>
       <artifactId>spring-batch-core</artifactId>

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

@@ -96,8 +96,8 @@ public String renderWithTableAlias(TableAliasCalculator tableAliasCalculator) {
                 .orElseGet(this::name);
     }
 
-    public <S> SqlColumn<S> withTypeHandler(String typeHandler) {
-        SqlColumn<S> column = new SqlColumn<>(this);
+    public SqlColumn<T> withTypeHandler(String typeHandler) {
+        SqlColumn<T> column = new SqlColumn<>(this);
         column.typeHandler = typeHandler;
         return column;
     }

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

@@ -98,7 +98,8 @@ public <T> SqlColumn<T> column(String name, JDBCType jdbcType) {
 
     @NotNull
     public <T> SqlColumn<T> column(String name, JDBCType jdbcType, String typeHandler) {
-        return SqlColumn.of(name, this, jdbcType).withTypeHandler(typeHandler);
+        SqlColumn<T> column = SqlColumn.of(name, this, jdbcType);
+        return column.withTypeHandler(typeHandler);
     }
 
     public static SqlTable of(String name) {

src/main/java/org/mybatis/dynamic/sql/select/CountDSLCompleter.java

@@ -27,7 +27,7 @@
  * client code look a bit cleaner.
  *
  * <p>This function is intended to by used in conjunction with a utility method like
- * {@link MyBatis3Utils#count(ToLongFunction, CountDSL, CountDSLCompleter)}
+ * {@link MyBatis3Utils#countFrom(ToLongFunction, CountDSL, CountDSLCompleter)}
  *
  * <p>For example, you can create mapper interface methods like this:
  *

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

@@ -17,14 +17,11 @@
 
 import java.util.Collection;
 import java.util.List;
-import java.util.Optional;
 import java.util.function.Function;
 import java.util.function.ToIntFunction;
 import java.util.function.ToLongFunction;
 import java.util.function.UnaryOperator;
 
-import org.jetbrains.annotations.NotNull;
-import org.jetbrains.annotations.Nullable;
 import org.mybatis.dynamic.sql.BasicColumn;
 import org.mybatis.dynamic.sql.SqlBuilder;
 import org.mybatis.dynamic.sql.SqlTable;
@@ -53,86 +50,110 @@
 public class MyBatis3Utils {
     private MyBatis3Utils() {}
 
-    public static long count(ToLongFunction<SelectStatementProvider> mapper,
+    public static SelectStatementProvider countFrom(SqlTable table, CountDSLCompleter completer) {
+        return countFrom(SqlBuilder.countFrom(table), completer);
+    }
+
+    public static long countFrom(ToLongFunction<SelectStatementProvider> mapper,
             SqlTable table, CountDSLCompleter completer) {
-        return count(mapper, SqlBuilder.countFrom(table), completer);
+        return mapper.applyAsLong(countFrom(table, completer));
+    }
+
+    public static SelectStatementProvider countFrom(CountDSL<SelectModel> start, CountDSLCompleter completer) {
+        return completer.apply(start)
+                .build()
+                .render(RenderingStrategies.MYBATIS3);
     }
 
-    public static long count(ToLongFunction<SelectStatementProvider> mapper,
+    public static long countFrom(ToLongFunction<SelectStatementProvider> mapper,
             CountDSL<SelectModel> start, CountDSLCompleter completer) {
-        return mapper.applyAsLong(completer.apply(start).build().render(RenderingStrategies.MYBATIS3));
+        return mapper.applyAsLong(countFrom(start, completer));
+    }
+
+    public static DeleteStatementProvider deleteFrom(SqlTable table, DeleteDSLCompleter completer) {
+        return completer.apply(SqlBuilder.deleteFrom(table))
+                .build()
+                .render(RenderingStrategies.MYBATIS3);
     }
 
     public static int deleteFrom(ToIntFunction<DeleteStatementProvider> mapper,
             SqlTable table, DeleteDSLCompleter completer) {
-        return mapper.applyAsInt(
-                completer.apply(SqlBuilder.deleteFrom(table))
-                .build()
-                .render(RenderingStrategies.MYBATIS3));
+        return mapper.applyAsInt(deleteFrom(table, completer));
     }
 
+    public static <R> InsertStatementProvider<R> insert(R record, SqlTable table, UnaryOperator<InsertDSL<R>> completer) {
+        return completer.apply(SqlBuilder.insert(record).into(table))
+                .build()
+                .render(RenderingStrategies.MYBATIS3);
+    }
+
     public static <R> int insert(ToIntFunction<InsertStatementProvider<R>> mapper, R record, 
             SqlTable table, UnaryOperator<InsertDSL<R>> completer) {
-        return mapper.applyAsInt(completer.apply(
-                SqlBuilder.insert(record).into(table)).build().render(RenderingStrategies.MYBATIS3));
+        return mapper.applyAsInt(insert(record, table, completer));
     }
 
+    public static <R> MultiRowInsertStatementProvider<R> insertMultiple(Collection<R> records, SqlTable table,
+            UnaryOperator<MultiRowInsertDSL<R>> completer) {
+        return completer.apply(SqlBuilder.insertMultiple(records).into(table))
+                .build()
+                .render(RenderingStrategies.MYBATIS3);
+    }
+
     public static <R> int insertMultiple(ToIntFunction<MultiRowInsertStatementProvider<R>> mapper,
             Collection<R> records, SqlTable table, UnaryOperator<MultiRowInsertDSL<R>> completer) {
-        return mapper.applyAsInt(completer.apply(
-                SqlBuilder.insertMultiple(records).into(table)).build().render(RenderingStrategies.MYBATIS3));
+        return mapper.applyAsInt(insertMultiple(records, table, completer));
     }
 
-    public static <R> List<R> selectDistinct(Function<SelectStatementProvider, List<R>> mapper,
-            BasicColumn[] selectList, SqlTable table, SelectDSLCompleter completer) {
-        return selectDistinct(mapper, SqlBuilder.selectDistinct(selectList).from(table), completer);
+    public static SelectStatementProvider select(BasicColumn[] selectList, SqlTable table,
+            SelectDSLCompleter completer) {
+        return select(SqlBuilder.select(selectList).from(table), completer);
+    }
+
+    public static SelectStatementProvider select(QueryExpressionDSL<SelectModel> start,
+            SelectDSLCompleter completer) {
+        return completer.apply(start)
+                .build()
+                .render(RenderingStrategies.MYBATIS3);
+    }
+
+    public static SelectStatementProvider selectDistinct(BasicColumn[] selectList, SqlTable table,
+            SelectDSLCompleter completer) {
+        return select(SqlBuilder.selectDistinct(selectList).from(table), completer);
     }
 
     public static <R> List<R> selectDistinct(Function<SelectStatementProvider, List<R>> mapper,
-            QueryExpressionDSL<SelectModel> start, SelectDSLCompleter completer) {
-        return mapper.apply(completer.apply(start).build().render(RenderingStrategies.MYBATIS3));
+            BasicColumn[] selectList, SqlTable table, SelectDSLCompleter completer) {
+        return mapper.apply(selectDistinct(selectList, table, completer));
     }
 
     public static <R> List<R> selectList(Function<SelectStatementProvider, List<R>> mapper,
             BasicColumn[] selectList, SqlTable table, SelectDSLCompleter completer) {
-        return selectList(mapper, SqlBuilder.select(selectList).from(table), completer);
+        return mapper.apply(select(selectList, table, completer));
     }
 
     public static <R> List<R> selectList(Function<SelectStatementProvider, List<R>> mapper,
             QueryExpressionDSL<SelectModel> start, SelectDSLCompleter completer) {
-        return mapper.apply(completer.apply(start).build().render(RenderingStrategies.MYBATIS3));
+        return mapper.apply(select(start, completer));
     }
 
-    @Nullable
     public static <R> R selectOne(Function<SelectStatementProvider, R> mapper,
             BasicColumn[] selectList, SqlTable table, SelectDSLCompleter completer) {
-        return selectOne(mapper, SqlBuilder.select(selectList).from(table), completer);
+        return mapper.apply(select(selectList, table, completer));
     }
 
-    @Nullable
     public static <R> R selectOne(Function<SelectStatementProvider, R> mapper,
-            QueryExpressionDSL<SelectModel> start,
-            SelectDSLCompleter completer) {
-        return mapper.apply(completer.apply(start).build().render(RenderingStrategies.MYBATIS3));
-    }
-
-    @NotNull
-    public static <R> Optional<R> selectOptional(Function<SelectStatementProvider, Optional<R>> mapper, 
-            BasicColumn[] selectList, SqlTable table, SelectDSLCompleter completer) {
-        return selectOptional(mapper, SqlBuilder.select(selectList).from(table), completer);
+            QueryExpressionDSL<SelectModel> start,SelectDSLCompleter completer) {
+        return mapper.apply(select(start, completer));
     }
 
-    @NotNull
-    public static <R> Optional<R> selectOptional(Function<SelectStatementProvider, Optional<R>> mapper, 
-            QueryExpressionDSL<SelectModel> start, SelectDSLCompleter completer) {
-        return mapper.apply(completer.apply(start).build().render(RenderingStrategies.MYBATIS3));
+    public static UpdateStatementProvider update(SqlTable table, UpdateDSLCompleter completer) {
+        return completer.apply(SqlBuilder.update(table))
+                .build()
+                .render(RenderingStrategies.MYBATIS3);
     }
 
     public static int update(ToIntFunction<UpdateStatementProvider> mapper,
             SqlTable table, UpdateDSLCompleter completer) {
-        return mapper.applyAsInt(
-                completer.apply(SqlBuilder.update(table))
-                .build()
-                .render(RenderingStrategies.MYBATIS3));
+        return mapper.applyAsInt(update(table, completer));
     }
 }

src/main/java/org/mybatis/dynamic/sql/where/render/WhereConditionVisitor.java

@@ -117,7 +117,7 @@ public Optional<FragmentAndParameters> visit(AbstractColumnComparisonCondition<T
         return FragmentAndParameters.withFragment(fragment).buildOptional();
     }
 
-    private FragmentAndParameters toFragmentAndParameters(Object value) {
+    private FragmentAndParameters toFragmentAndParameters(T value) {
         String mapKey = formatParameterMapKey(sequence.getAndIncrement());
 
         return FragmentAndParameters.withFragment(getFormattedJdbcPlaceholder(mapKey))

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

@@ -17,10 +17,16 @@ package org.mybatis.dynamic.sql.util.kotlin
 
 import org.mybatis.dynamic.sql.BindableColumn
 import org.mybatis.dynamic.sql.VisitableCondition
+import org.mybatis.dynamic.sql.insert.InsertDSL
+import org.mybatis.dynamic.sql.insert.MultiRowInsertDSL
 import org.mybatis.dynamic.sql.update.UpdateDSL
 import org.mybatis.dynamic.sql.update.UpdateModel
 import org.mybatis.dynamic.sql.util.Buildable
 
+// insert completers are here because sonar doesn't see them as covered if they are in a file by themselves
+typealias InsertCompleter<T> = InsertDSL<T>.() -> InsertDSL<T>
+typealias MultiRowInsertCompleter<T> = MultiRowInsertDSL<T>.() -> MultiRowInsertDSL<T>
+
 typealias UpdateCompleter = UpdateDSL<UpdateModel>.() -> Buildable<UpdateModel>
 
 fun <T> UpdateDSL<UpdateModel>.where(column: BindableColumn<T>, condition: VisitableCondition<T>, collect: CriteriaReceiver) =

src/main/kotlin/org/mybatis/dynamic/sql/util/kotlin/mybatis3/MapperSupportFunctions.kt

@@ -16,6 +16,7 @@
 package org.mybatis.dynamic.sql.util.kotlin.mybatis3
 
 import org.mybatis.dynamic.sql.BasicColumn
+import org.mybatis.dynamic.sql.SqlBuilder
 import org.mybatis.dynamic.sql.SqlTable
 import org.mybatis.dynamic.sql.delete.render.DeleteStatementProvider
 import org.mybatis.dynamic.sql.insert.render.InsertStatementProvider
@@ -24,34 +25,31 @@ import org.mybatis.dynamic.sql.select.QueryExpressionDSL
 import org.mybatis.dynamic.sql.select.SelectModel
 import org.mybatis.dynamic.sql.select.render.SelectStatementProvider
 import org.mybatis.dynamic.sql.update.render.UpdateStatementProvider
-import org.mybatis.dynamic.sql.util.kotlin.CountCompleter
-import org.mybatis.dynamic.sql.util.kotlin.DeleteCompleter
-import org.mybatis.dynamic.sql.util.kotlin.SelectCompleter
-import org.mybatis.dynamic.sql.util.kotlin.UpdateCompleter
+import org.mybatis.dynamic.sql.util.kotlin.*
 
-fun count(mapper: (SelectStatementProvider) -> Long, table: SqlTable, completer: CountCompleter) =
-    mapper(count(table, completer))
+fun countFrom(mapper: (SelectStatementProvider) -> Long, table: SqlTable, completer: CountCompleter) =
+    mapper(countFrom(table, completer))
 
 fun deleteFrom(mapper: (DeleteStatementProvider) -> Int, table: SqlTable, completer: DeleteCompleter) =
     mapper(deleteFrom(table, completer))
 
 fun <T> insert(mapper: (InsertStatementProvider<T>) -> Int, record: T, table: SqlTable, completer: InsertCompleter<T>) =
-    mapper(insert(record, table, completer))
+    mapper(SqlBuilder.insert(record).into(table, completer))
 
 fun <T> insertMultiple(mapper: (MultiRowInsertStatementProvider<T>) -> Int, records: Collection<T>, table: SqlTable, completer: MultiRowInsertCompleter<T>) =
-    mapper(insertMultiple(records, table, completer))
+    mapper(SqlBuilder.insertMultiple(records).into(table, completer))
 
 fun <T> selectDistinct(mapper: (SelectStatementProvider) -> List<T>, selectList: List<BasicColumn>, table: SqlTable, completer: SelectCompleter) =
-    mapper(selectDistinct(selectList, table, completer))
+    mapper(SqlBuilder.selectDistinct(selectList).from(table, completer))
 
 fun <T> selectList(mapper: (SelectStatementProvider) -> List<T>, selectList: List<BasicColumn>, table: SqlTable, completer: SelectCompleter) =
-    mapper(select(selectList, table, completer))
+    mapper(SqlBuilder.select(selectList).from(table, completer))
 
 fun <T> selectList(mapper: (SelectStatementProvider) -> List<T>, start: QueryExpressionDSL<SelectModel>, completer: SelectCompleter) =
     mapper(select(start, completer))
 
 fun <T> selectOne(mapper: (SelectStatementProvider) -> T?, selectList: List<BasicColumn>, table: SqlTable, completer: SelectCompleter) =
-    mapper(select(selectList, table, completer))
+    mapper(SqlBuilder.select(selectList).from(table, completer))
 
 fun <T> selectOne(mapper: (SelectStatementProvider) -> T?, start: QueryExpressionDSL<SelectModel>, completer: SelectCompleter) =
     mapper(select(start, completer))