Merge pull request #448 from jeffgbutler/update-dsl

[Kotlin] Minor DSL Improvements

Author: jeffgbutler

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

@@ -145,7 +145,21 @@ abstract class KotlinBaseBuilder<D : AbstractWhereSupport<*>> {
             or(existsPredicate, sc)
         }
 
-    fun allRows() {}
+    /**
+     * This function does nothing, but it can be used to make some code snippets more understandable.
+     *
+     * For example, to count all rows in a table you can write either of the following:
+     *
+     * val rows = countFrom(foo) { }
+     *
+     *    or
+     *
+     * val rows = countFrom(foo) { allRows() }
+     */
+    @SuppressWarnings("EmptyFunctionBlock")
+    fun allRows() {
+        // intentionally empty - this function exists for code beautification and clarity only
+    }
 
     private fun applyToWhere(block: AbstractWhereDSL<*>.() -> Unit) {
         getDsl().where().apply(block)

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

@@ -1,5 +1,5 @@
 /*
- *    Copyright 2016-2021 the original author or authors.
+ *    Copyright 2016-2022 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.
@@ -42,45 +42,44 @@ class KotlinGeneralInsertBuilder(private val dsl: GeneralInsertDSL) : Buildable<
 
     @MyBatisDslMarker
     inner class GeneralInsertSetClauseFinisher<T>(private val column: SqlColumn<T>) {
-        fun toNull(): KotlinGeneralInsertBuilder =
+        fun toNull(): Unit =
             applyToDsl {
                 set(column).toNull()
             }
 
-        fun toConstant(constant: String): KotlinGeneralInsertBuilder =
+        infix fun toConstant(constant: String): Unit =
             applyToDsl {
                 set(column).toConstant(constant)
             }
 
-        fun toStringConstant(constant: String): KotlinGeneralInsertBuilder =
+        infix fun toStringConstant(constant: String): Unit =
             applyToDsl {
                 set(column).toStringConstant(constant)
             }
 
-        fun toValue(value: T): KotlinGeneralInsertBuilder = toValue { value }
+        infix fun toValue(value: T): Unit = toValue { value }
 
-        fun toValue(value: () -> T): KotlinGeneralInsertBuilder =
+        infix fun toValue(value: () -> T): Unit =
             applyToDsl {
                 set(column).toValue(value)
             }
 
-        fun toValueOrNull(value: T?): KotlinGeneralInsertBuilder = toValueOrNull { value }
+        infix fun toValueOrNull(value: T?): Unit = toValueOrNull { value }
 
-        fun toValueOrNull(value: () -> T?): KotlinGeneralInsertBuilder =
+        infix fun toValueOrNull(value: () -> T?): Unit =
             applyToDsl {
                 set(column).toValueOrNull(value)
             }
 
-        fun toValueWhenPresent(value: T?): KotlinGeneralInsertBuilder = toValueWhenPresent { value }
+        infix fun toValueWhenPresent(value: T?): Unit = toValueWhenPresent { value }
 
-        fun toValueWhenPresent(value: () -> T?): KotlinGeneralInsertBuilder =
+        infix fun toValueWhenPresent(value: () -> T?): Unit =
             applyToDsl {
                 set(column).toValueWhenPresent(value)
             }
 
-        private fun applyToDsl(block: GeneralInsertDSL.() -> Unit): KotlinGeneralInsertBuilder =
-            this@KotlinGeneralInsertBuilder.apply {
-                dsl.apply(block)
-            }
+        private fun applyToDsl(block: GeneralInsertDSL.() -> Unit) {
+            this@KotlinGeneralInsertBuilder.dsl.apply(block)
+        }
     }
 }

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

@@ -40,46 +40,46 @@ class KotlinUpdateBuilder(private val dsl: UpdateDSL<UpdateModel>) :
                 set(column).equalToNull()
             }
 
-        fun equalToConstant(constant: String): Unit =
+        infix fun equalToConstant(constant: String): Unit =
             applyToDsl {
                 set(column).equalToConstant(constant)
             }
 
-        fun equalToStringConstant(constant: String): Unit =
+        infix fun equalToStringConstant(constant: String): Unit =
             applyToDsl {
                 set(column).equalToStringConstant(constant)
             }
 
-        fun equalTo(value: T): Unit = equalTo { value }
+        infix fun equalTo(value: T): Unit = equalTo { value }
 
-        fun equalTo(value: () -> T): Unit =
+        infix fun equalTo(value: () -> T): Unit =
             applyToDsl {
                 set(column).equalTo(value)
             }
 
-        fun equalTo(rightColumn: BasicColumn): Unit =
+        infix fun equalTo(rightColumn: BasicColumn): Unit =
             applyToDsl {
                 set(column).equalTo(rightColumn)
             }
 
-        fun equalToOrNull(value: T?): Unit = equalToOrNull { value }
+        infix fun equalToOrNull(value: T?): Unit = equalToOrNull { value }
 
-        fun equalToOrNull(value: () -> T?): Unit =
+        infix fun equalToOrNull(value: () -> T?): Unit =
             applyToDsl {
                 set(column).equalToOrNull(value)
             }
 
-        fun equalToQueryResult(subQuery: KotlinSubQueryBuilder.() -> Unit): Unit =
+        infix fun equalToQueryResult(subQuery: KotlinSubQueryBuilder.() -> Unit): Unit =
             applyToDsl {
                 set(column).equalTo(KotlinSubQueryBuilder().apply(subQuery))
             }
 
-        fun equalToWhenPresent(value: () -> T?): Unit =
+        infix fun equalToWhenPresent(value: () -> T?): Unit =
             applyToDsl {
                 set(column).equalToWhenPresent(value)
             }
 
-        fun equalToWhenPresent(value: T?): Unit = equalToWhenPresent { value }
+        infix fun equalToWhenPresent(value: T?): Unit = equalToWhenPresent { value }
 
         private fun applyToDsl(block: UpdateDSL<UpdateModel>.() -> Unit) {
             this@KotlinUpdateBuilder.dsl.apply(block)

src/main/kotlin/org/mybatis/dynamic/sql/util/kotlin/elements/ColumnExtensions.kt

@@ -0,0 +1,25 @@
+/*
+ *    Copyright 2016-2022 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.
+ *    You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+package org.mybatis.dynamic.sql.util.kotlin.elements
+
+import org.mybatis.dynamic.sql.DerivedColumn
+import org.mybatis.dynamic.sql.SqlColumn
+
+infix fun <T> DerivedColumn<T>.`as`(alias: String): DerivedColumn<T> = this.`as`(alias)
+
+infix fun <T> SqlColumn<T>.`as`(alias: String): SqlColumn<T> = this.`as`(alias)
+
+infix fun <T> SqlColumn<T>.qualifiedWith(tableQualifier: String): SqlColumn<T> = this.qualifiedWith(tableQualifier)

src/main/kotlin/org/mybatis/dynamic/sql/util/kotlin/elements/SqlTableExtensions.kt

@@ -1,5 +1,5 @@
 /*
- *    Copyright 2016-2021 the original author or authors.
+ *    Copyright 2016-2022 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.
@@ -27,6 +27,7 @@ import kotlin.reflect.KClass
  * This function preserves the non-nullable column type which is lost with the Java
  * native versions.
  */
+@SuppressWarnings("LongParameterList")
 fun <T : Any> SqlTable.column(
     name: String,
     jdbcType: JDBCType? = null,

src/main/kotlin/org/mybatis/dynamic/sql/util/kotlin/spring/NamedParameterJdbcTemplateExtensions.kt

@@ -1,5 +1,5 @@
 /*
- *    Copyright 2016-2021 the original author or authors.
+ *    Copyright 2016-2022 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.
@@ -188,6 +188,7 @@ fun NamedParameterJdbcTemplate.selectOne(
         this
     )
 
+@SuppressWarnings("SwallowedException")
 fun <T> NamedParameterJdbcTemplate.selectOne(
     selectStatement: SelectStatementProvider,
     rowMapper: (rs: ResultSet, rowNum: Int) -> T
@@ -197,6 +198,7 @@ fun <T> NamedParameterJdbcTemplate.selectOne(
     null
 }
 
+@SuppressWarnings("SwallowedException")
 fun <T : Any> NamedParameterJdbcTemplate.selectOne(
     selectStatement: SelectStatementProvider,
     type: KClass<T>