DATAMONGO-2138 - Refactor to syntax 2

Author: TjeuKayim

spring-data-mongodb/src/main/kotlin/org/springframework/data/mongodb/core/query/TypedCriteria.kt

@@ -0,0 +1,385 @@
+/*
+ * Copyright 2010-2018 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.springframework.data.mongodb.core.query
+
+import org.bson.BsonRegularExpression
+import org.bson.Document
+import org.springframework.data.domain.Example
+import org.springframework.data.geo.Circle
+import org.springframework.data.geo.Point
+import org.springframework.data.geo.Shape
+import org.springframework.data.mongodb.core.geo.GeoJson
+import org.springframework.data.mongodb.core.schema.JsonSchemaObject
+import org.springframework.data.mongodb.core.schema.MongoJsonSchema
+import java.util.regex.Pattern
+import kotlin.reflect.KProperty
+import kotlin.reflect.KProperty1
+
+/**
+ * Build [Criteria] with Property References as field names.
+ * @author Tjeu Kayim
+ * @since 2.2
+ */
+class TypedCriteria(
+	val operation: Criteria.() -> Criteria,
+	property: KProperty<*>? = null
+) : CriteriaDefinition {
+	val name = property?.let(::nestedFieldName)
+	val criteria by lazy { operation(name?.let(::Criteria) ?: Criteria()) }
+
+	override fun getCriteriaObject(): Document = criteria.criteriaObject
+
+	override fun getKey(): String? = criteria.key
+}
+
+
+/**
+ * Creates a criterion using equality.
+ * @see Criteria.isEqualTo
+ */
+infix fun <T> KProperty<T>.isEqualTo(value: T) = TypedCriteria({ isEqualTo(value) }, this)
+
+/**
+ * Creates a criterion using the $ne operator.
+ *
+ * See [MongoDB Query operator: $ne](https://docs.mongodb.com/manual/reference/operator/query/ne/)
+ * @see Criteria.ne
+ */
+infix fun <T> KProperty<T>.ne(value: T) = TypedCriteria({ ne(value) }, this)
+
+/**
+ * Creates a criterion using the $lt operator.
+ *
+ * See [MongoDB Query operator: $lt](https://docs.mongodb.com/manual/reference/operator/query/lt/)
+ * @see Criteria.lt
+ */
+infix fun <T> KProperty<T>.lt(value: T) = TypedCriteria({ lt(value) }, this)
+
+/**
+ * Creates a criterion using the $lte operator.
+ *
+ * See [MongoDB Query operator: $lte](https://docs.mongodb.com/manual/reference/operator/query/lte/)
+ * @see Criteria.lte
+ */
+infix fun <T> KProperty<T>.lte(value: T) = TypedCriteria({ lte(value) }, this)
+
+/**
+ * Creates a criterion using the $gt operator.
+ *
+ * See [MongoDB Query operator: $gt](https://docs.mongodb.com/manual/reference/operator/query/gt/)
+ * @see Criteria.gt
+ */
+infix fun <T> KProperty<T>.gt(value: T) = TypedCriteria({ gt(value) }, this)
+
+/**
+ * Creates a criterion using the $gte operator.
+ *
+ * See [MongoDB Query operator: $gte](https://docs.mongodb.com/manual/reference/operator/query/gte/)
+ * @see Criteria.gte
+ */
+infix fun <T> KProperty<T>.gte(value: T) = TypedCriteria({ gte(value) }, this)
+
+/**
+ * Creates a criterion using the $in operator.
+ *
+ * See [MongoDB Query operator: $in](https://docs.mongodb.com/manual/reference/operator/query/in/)
+ * @see Criteria.inValues
+ */
+fun <T> KProperty<T>.inValues(vararg o: Any) = TypedCriteria({ `in`(*o) }, this)
+
+/**
+ * Creates a criterion using the $in operator.
+ *
+ * See [MongoDB Query operator: $in](https://docs.mongodb.com/manual/reference/operator/query/in/)
+ * @see Criteria.inValues
+ */
+infix fun <T> KProperty<T>.inValues(value: Collection<T>) = TypedCriteria({ `in`(value) }, this)
+
+/**
+ * Creates a criterion using the $nin operator.
+ *
+ * See [MongoDB Query operator: $nin](https://docs.mongodb.com/manual/reference/operator/query/nin/)
+ * @see Criteria.nin
+ */
+fun <T> KProperty<T>.nin(vararg o: Any) = TypedCriteria({ nin(*o) }, this)
+
+/**
+ * Creates a criterion using the $nin operator.
+ *
+ * See [MongoDB Query operator: $nin](https://docs.mongodb.com/manual/reference/operator/query/nin/)
+ * @see Criteria.nin
+ */
+infix fun <T> KProperty<T>.nin(value: Collection<T>) = TypedCriteria({ nin(value) }, this)
+
+/**
+ * Creates a criterion using the $mod operator.
+ *
+ * See [MongoDB Query operator: $mod](https://docs.mongodb.com/manual/reference/operator/query/mod/)
+ * @see Criteria.mod
+ */
+fun KProperty<Number>.mod(value: Number, remainder: Number) = TypedCriteria({ mod(value, remainder) }, this)
+
+/**
+ * Creates a criterion using the $all operator.
+ *
+ * See [MongoDB Query operator: $all](https://docs.mongodb.com/manual/reference/operator/query/all/)
+ * @see Criteria.all
+ */
+fun KProperty<*>.all(vararg o: Any) = TypedCriteria({ all(*o) }, this)
+
+/**
+ * Creates a criterion using the $all operator.
+ *
+ * See [MongoDB Query operator: $all](https://docs.mongodb.com/manual/reference/operator/query/all/)
+ * @see Criteria.all
+ */
+infix fun KProperty<*>.all(value: Collection<*>) = TypedCriteria({ all(value) }, this)
+
+/**
+ * Creates a criterion using the $size operator.
+ *
+ * See [MongoDB Query operator: $size](https://docs.mongodb.com/manual/reference/operator/query/size/)
+ * @see Criteria.size
+ */
+infix fun KProperty<*>.size(s: Int) = TypedCriteria({ size(s) }, this)
+
+/**
+ * Creates a criterion using the $exists operator.
+ *
+ * See [MongoDB Query operator: $exists](https://docs.mongodb.com/manual/reference/operator/query/exists/)
+ * @see Criteria.exists
+ */
+infix fun KProperty<*>.exists(b: Boolean) = TypedCriteria({ exists(b) }, this)
+
+/**
+ * Creates a criterion using the $type operator.
+ *
+ * See [MongoDB Query operator: $type](https://docs.mongodb.com/manual/reference/operator/query/type/)
+ * @see Criteria.type
+ */
+infix fun KProperty<*>.type(t: Int) = TypedCriteria({ type(t) }, this)
+
+/**
+ * Creates a criterion using the $type operator.
+ *
+ * See [MongoDB Query operator: $type](https://docs.mongodb.com/manual/reference/operator/query/type/)
+ * @see Criteria.type
+ */
+infix fun KProperty<*>.type(t: Collection<JsonSchemaObject.Type>) = TypedCriteria({ type(*t.toTypedArray()) }, this)
+
+/**
+ * Creates a criterion using the $type operator.
+ *
+ * See [MongoDB Query operator: $type](https://docs.mongodb.com/manual/reference/operator/query/type/)
+ * @see Criteria.type
+ */
+fun KProperty<*>.type(vararg t: JsonSchemaObject.Type) = TypedCriteria({ type(*t) }, this)
+
+/**
+ * Creates a criterion using the $not meta operator which affects the clause directly following
+ *
+ * See [MongoDB Query operator: $not](https://docs.mongodb.com/manual/reference/operator/query/not/)
+ * @see Criteria.not
+ */
+fun KProperty<*>.not() = TypedCriteria({ not() }, this)
+
+/**
+ * Creates a criterion using a $regex operator.
+ *
+ * See [MongoDB Query operator: $regex](https://docs.mongodb.com/manual/reference/operator/query/regex/)
+ * @see Criteria.regex
+ */
+infix fun KProperty<String?>.regex(re: String) = TypedCriteria({ regex(re, null) }, this)
+
+/**
+ * Creates a criterion using a $regex and $options operator.
+ *
+ * See [MongoDB Query operator: $regex](https://docs.mongodb.com/manual/reference/operator/query/regex/)
+ * @see Criteria.regex
+ */
+fun KProperty<String?>.regex(re: String, options: String?) = TypedCriteria({ regex(re, options) }, this)
+
+/**
+ * Syntactical sugar for [isEqualTo] making obvious that we create a regex predicate.
+ * @see Criteria.regex
+ */
+infix fun KProperty<String?>.regex(re: Regex) = TypedCriteria({ regex(re.toPattern()) }, this)
+
+/**
+ * Syntactical sugar for [isEqualTo] making obvious that we create a regex predicate.
+ * @see Criteria.regex
+ */
+infix fun KProperty<String?>.regex(re: Pattern) = TypedCriteria({ regex(re) }, this)
+
+/**
+ * Syntactical sugar for [isEqualTo] making obvious that we create a regex predicate.
+ * @see Criteria.regex
+ */
+infix fun KProperty<String?>.regex(re: BsonRegularExpression) = TypedCriteria({ regex(re) }, this)
+
+/**
+ * Creates a geospatial criterion using a $geoWithin $centerSphere operation. This is only available for
+ * Mongo 2.4 and higher.
+ *
+ * See [MongoDB Query operator:
+	 * $geoWithin](https://docs.mongodb.com/manual/reference/operator/query/geoWithin/)
+ *
+ * See [MongoDB Query operator:
+	 * $centerSphere](https://docs.mongodb.com/manual/reference/operator/query/centerSphere/)
+ * @see Criteria.withinSphere
+ */
+infix fun KProperty<GeoJson<*>>.withinSphere(circle: Circle) = TypedCriteria({ withinSphere(circle) }, this)
+
+/**
+ * Creates a geospatial criterion using a $geoWithin operation.
+ *
+ * See [MongoDB Query operator:
+	 * $geoWithin](https://docs.mongodb.com/manual/reference/operator/query/geoWithin/)
+ * @see Criteria.within
+ */
+infix fun KProperty<GeoJson<*>>.within(shape: Shape) = TypedCriteria({ within(shape) }, this)
+
+/**
+ * Creates a geospatial criterion using a $near operation.
+ *
+ * See [MongoDB Query operator: $near](https://docs.mongodb.com/manual/reference/operator/query/near/)
+ * @see Criteria.near
+ */
+infix fun KProperty<GeoJson<*>>.near(point: Point) = TypedCriteria({ near(point) }, this)
+
+/**
+ * Creates a geospatial criterion using a $nearSphere operation. This is only available for Mongo 1.7 and
+ * higher.
+ *
+ * See [MongoDB Query operator:
+	 * $nearSphere](https://docs.mongodb.com/manual/reference/operator/query/nearSphere/)
+ * @see Criteria.nearSphere
+ */
+infix fun KProperty<GeoJson<*>>.nearSphere(point: Point) = TypedCriteria({ nearSphere(point) }, this)
+
+/**
+ * Creates criterion using `$geoIntersects` operator which matches intersections of the given `geoJson`
+ * structure and the documents one. Requires MongoDB 2.4 or better.
+ * @see Criteria.intersects
+ */
+infix fun KProperty<GeoJson<*>>.intersects(geoJson: GeoJson<*>) = TypedCriteria({ intersects(geoJson) }, this)
+
+/**
+ * Creates a geo-spatial criterion using a $maxDistance operation, for use with $near
+ *
+ * See [MongoDB Query operator:
+	 * $maxDistance](https://docs.mongodb.com/manual/reference/operator/query/maxDistance/)
+ * @see Criteria.maxDistance
+ */
+infix fun KProperty<GeoJson<*>>.maxDistance(d: Double) = TypedCriteria({ maxDistance(d) }, this)
+
+/**
+ * Creates a geospatial criterion using a $minDistance operation, for use with $near or
+ * $nearSphere.
+ * @see Criteria.minDistance
+ */
+infix fun KProperty<GeoJson<*>>.minDistance(d: Double) = TypedCriteria({ minDistance(d) }, this)
+
+/**
+ * Creates a criterion using the $elemMatch operator
+ *
+ * See [MongoDB Query operator:
+	 * $elemMatch](https://docs.mongodb.com/manual/reference/operator/query/elemMatch/)
+ * @see Criteria.elemMatch
+ */
+infix fun KProperty<*>.elemMatch(c: Criteria) = TypedCriteria({ elemMatch(c) }, this)
+
+/**
+ * Creates a criterion using the $elemMatch operator
+ *
+ * See [MongoDB Query operator:
+	 * $elemMatch](https://docs.mongodb.com/manual/reference/operator/query/elemMatch/)
+ * @see Criteria.elemMatch
+ */
+infix fun KProperty<*>.elemMatch(c: TypedCriteria) = TypedCriteria({ elemMatch(typedCriteria(c)) }, this)
+
+/**
+ * Creates a criterion using the given object as a pattern.
+ * @see Criteria.alike
+ */
+fun alike(sample: Example<*>) = TypedCriteria({ alike(sample) })
+
+/**
+ * Creates a criterion (`$jsonSchema`) matching documents against a given structure defined by the
+ * [MongoJsonSchema].
+ *
+ * See [MongoDB Query operator:
+	 * $jsonSchema](https://docs.mongodb.com/manual/reference/operator/query/jsonSchema/)
+ * @see Criteria.andDocumentStructureMatches
+ */
+infix fun KProperty<*>.andDocumentStructureMatches(schema: MongoJsonSchema) =
+	TypedCriteria({ andDocumentStructureMatches(schema) }, this)
+
+/**
+ * Use [Criteria.BitwiseCriteriaOperators] as gateway to create a criterion using one of the
+ * [bitwise operators](https://docs.mongodb.com/manual/reference/operator/query-bitwise/) like
+ * `$bitsAllClear`.
+ *
+ * Example:
+ * ```
+ * bits { allClear(123) }
+ * ```
+ * @see Criteria.bits
+ */
+infix fun KProperty<*>.bits(bitwiseCriteria: Criteria.BitwiseCriteriaOperators.() -> Criteria) =
+	TypedCriteria({ bits().let(bitwiseCriteria) }, this)
+
+/**
+ * Creates an 'or' criteria using the $or operator for all of the provided criteria
+ *
+ * Note that mongodb doesn't support an $or operator to be wrapped in a $not operator.
+ * @see Criteria.orOperator
+ */
+fun orOperator(vararg builders: TypedCriteria) = addOperatorWithCriteria(builders, Criteria::orOperator)
+
+/**
+ * Creates a 'nor' criteria using the $nor operator for all of the provided criteria.
+ *
+ * Note that mongodb doesn't support an $nor operator to be wrapped in a $not operator.
+ * @see Criteria.norOperator
+ */
+fun norOperator(vararg builders: TypedCriteria) = addOperatorWithCriteria(builders, Criteria::norOperator)
+
+/**
+ * Creates an 'and' criteria using the $and operator for all of the provided criteria.
+ *
+ * Note that mongodb doesn't support an $and operator to be wrapped in a $not operator.
+ * @see Criteria.andOperator
+ */
+fun andOperator(vararg builders: TypedCriteria) = addOperatorWithCriteria(builders, Criteria::andOperator)
+
+private fun addOperatorWithCriteria(
+	builders: Array<out TypedCriteria>,
+	operation: Criteria.(Array<Criteria>) -> Criteria
+) = TypedCriteria({ operation(builders.map { it.criteria }.toTypedArray()) })
+
+/**
+ * Build nested properties.
+ * Refer to a field in an embedded/nested document.
+ *
+ * For example, referring to the field "book.author":
+ * ```
+ * Book::author / Author::name isEqualTo "Herman Melville"
+ * ```
+ */
+operator fun <T, U> KProperty<T>.div(other: KProperty1<T, U>) =
+	NestedProperty(this, other)