DATAMONGO-2138 - Polishing.

Rename NestedProperty to KPropertyPath to reflect the underlying concept in alignment with our own PropertyPath type. Rename nestedFieldName(…) method to asString(…) to align with Kotlin method terminology. Reformat.

Slightly reword documentation. Add Type-safe Queries for Kotlin to What's New section.

Original pull request: #622.

Author: mp911de

Diff for: spring-data-mongodb/src/main/kotlin/org/springframework/data/mongodb/core/query/CriteriaExtensions.kt

@@ -23,35 +23,36 @@ import kotlin.reflect.KProperty
  * @author Sebastien Deleuze
  * @since 2.0
  */
-fun Criteria.isEqualTo(o: Any?) : Criteria = `is`(o)
+fun Criteria.isEqualTo(o: Any?): Criteria = `is`(o)
 
 /**
  * Extension for [Criteria.in] providing an `inValues` alias since `in` is a reserved keyword in Kotlin.
  *
  * @author Sebastien Deleuze
  * @since 2.0
  */
-fun <T: Any?> Criteria.inValues(c: Collection<T>) : Criteria = `in`(c)
+fun <T : Any?> Criteria.inValues(c: Collection<T>): Criteria = `in`(c)
 
 /**
  * Extension for [Criteria.in] providing an `inValues` alias since `in` is a reserved keyword in Kotlin.
  *
  * @author Sebastien Deleuze
  * @since 2.0
  */
-fun Criteria.inValues(vararg o: Any?) : Criteria = `in`(*o)
+fun Criteria.inValues(vararg o: Any?): Criteria = `in`(*o)
 
 /**
  * Creates a Criteria using a KProperty as key.
- * Supports nested field names with [NestedProperty].
+ * Supports nested field names with [KPropertyPath].
  * @author Tjeu Kayim
  * @since 2.2
  */
-fun where(key: KProperty<*>): Criteria = Criteria.where(nestedFieldName(key))
+fun where(key: KProperty<*>): Criteria = Criteria.where(asString(key))
+
 /**
  * Add new key to the criteria chain using a KProperty.
- * Supports nested field names with [NestedProperty].
+ * Supports nested field names with [KPropertyPath].
  * @author Tjeu Kayim
  * @since 2.2
  */
-infix fun Criteria.and(key: KProperty<*>): Criteria = and(nestedFieldName(key))
+infix fun Criteria.and(key: KProperty<*>): Criteria = and(asString(key))

Diff for: spring-data-mongodb/src/main/kotlin/org/springframework/data/mongodb/core/query/NestedProperty.kt renamed to spring-data-mongodb/src/main/kotlin/org/springframework/data/mongodb/core/query/KPropertyPath.kt

@@ -19,29 +19,30 @@ import kotlin.reflect.KProperty
 import kotlin.reflect.KProperty1
 
 /**
- * Refer to a field in an embedded/nested document.
+ * Abstraction of a property path consisting of [KProperty].
  * @author Tjeu Kayim
+ * @author Mark Paluch
  * @since 2.2
  */
-class NestedProperty<T, U>(
-	internal val parent: KProperty<U>,
-	internal val child: KProperty1<U, T>
+class KPropertyPath<T, U>(
+		internal val parent: KProperty<U>,
+		internal val child: KProperty1<U, T>
 ) : KProperty<T> by child
 
 /**
  * Recursively construct field name for a nested property.
  * @author Tjeu Kayim
  */
-internal fun nestedFieldName(property: KProperty<*>): String {
+internal fun asString(property: KProperty<*>): String {
 	return when (property) {
-		is NestedProperty<*, *> ->
-			"${nestedFieldName(property.parent)}.${property.child.name}"
+		is KPropertyPath<*, *> ->
+			"${asString(property.parent)}.${property.child.name}"
 		else -> property.name
 	}
 }
 
 /**
- * Builds [NestedProperty] from Property References.
+ * Builds [KPropertyPath] from Property References.
  * Refer to a field in an embedded/nested document.
  *
  * For example, referring to the field "book.author":
@@ -52,4 +53,4 @@ internal fun nestedFieldName(property: KProperty<*>): String {
  * @since 2.2
  */
 operator fun <T, U> KProperty<T>.div(other: KProperty1<T, U>) =
-	NestedProperty(this, other)
+		KPropertyPath(this, other)