resolves #251 add setValueOnInsert

Litote · Jan 30, 2021 · 6b404d0 · 6b404d0
1 parent c421503
commit 6b404d0
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 1 deletion.
diff --git a/kmongo-core-tests/src/main/kotlin/org/litote/kmongo/FindOneAndModifyTypedTest.kt b/kmongo-core-tests/src/main/kotlin/org/litote/kmongo/FindOneAndModifyTypedTest.kt
@@ -90,4 +90,16 @@ class FindOneAndModifyTypedTest : AllCategoriesKMongoBaseTest<Friend>() {
 
         assertEquals(expected, r)
     }
+
+    @Test
+    fun canUseSetValueOnInsert() {
+        val expected = ExposableFriend(ObjectId().toString(), "John")
+        val r = col.withDocumentClass<ExposableFriend>().findOneAndUpdate(
+            ExposableFriend::_id eq expected._id,
+            setValueOnInsert(expected),
+            findOneAndUpdateUpsert().returnDocument(ReturnDocument.AFTER)
+        )
+
+        assertEquals(expected, r)
+    }
 }
diff --git a/kmongo-property/src/main/kotlin/org/litote/kmongo/Updates.kt b/kmongo-property/src/main/kotlin/org/litote/kmongo/Updates.kt
@@ -29,6 +29,8 @@ import com.mongodb.client.model.UpdateOneModel
 import com.mongodb.client.model.UpdateOptions
 import com.mongodb.client.model.Updates
 import org.bson.conversions.Bson
+import org.litote.kmongo.util.KMongoUtil
+import org.litote.kmongo.util.ObjectMappingConfiguration
 import kotlin.internal.OnlyInputTypes
 import kotlin.reflect.KProperty
 
@@ -101,11 +103,25 @@ fun <T> unset(property: KProperty<T>): Bson = Updates.unset(property.path())
 fun <@OnlyInputTypes T> setOnInsert(property: KProperty<T?>, value: T): Bson =
     Updates.setOnInsert(property.path(), value)
 
+/**
+ * Creates an update that sets the the collection to the given value, but only if the update is an upsert that
+ * results in an insert of a document.
+ *
+ * @param value the value to insert
+ * @return the update
+ * @mongodb.driver.manual reference/operator/update/setOnInsert/ $setOnInsert
+ * @see UpdateOptions#upsert(boolean)
+ */
+fun setValueOnInsert(
+    value: Any
+): Bson =
+    Updates.setOnInsert(KMongoUtil.filterIdToBson(value, !ObjectMappingConfiguration.serializeNull))
+
 /**
  * Creates an update that renames a field.
  *
  * @param property    the property
- * @param newFieldName the new property
+ * @param newProperty the new property
  * @return the update
  * @mongodb.driver.manual reference/operator/update/rename/ $rename
  */