DATAMONGO-847 - Allow usage of Query within an Update clause.

In case we detect Query within a value used for an Update value we map the query itself to build the expression to use. This allows to form query statements for e.g. $pull using the same API as for the query itself.

Update update = new Update().pull("list", query(where("value").in("foo", "bar")));

Original Pull Request: spring-projects#172.

Author: christophstrobl

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/convert/UpdateMapper.java

@@ -25,6 +25,7 @@
 import org.springframework.data.mongodb.core.mapping.MongoPersistentEntity;
 import org.springframework.data.mongodb.core.mapping.MongoPersistentProperty;
 import org.springframework.data.mongodb.core.mapping.MongoPersistentProperty.PropertyToFieldNameConverter;
+import org.springframework.data.mongodb.core.query.Query;
 import org.springframework.data.mongodb.core.query.Update.Modifier;
 import org.springframework.data.mongodb.core.query.Update.Modifiers;
 import org.springframework.data.util.ClassTypeInformation;
@@ -79,10 +80,19 @@ protected Entry<String, Object> getMappedObjectForField(Field field, Object rawV
 			return createMapEntry(field, convertSimpleOrDBObject(rawValue, field.getPropertyEntity()));
 		}
 
-		if (!isUpdateModifier(rawValue)) {
-			return super.getMappedObjectForField(field, getMappedValue(field, rawValue));
+		if (isQuery(rawValue)) {
+			return createMapEntry(field,
+					super.getMappedObject(((Query) rawValue).getQueryObject(), field.getPropertyEntity()));
 		}
 
+		if (isUpdateModifier(rawValue)) {
+			return getMappedUpdateModifier(field, rawValue);
+		}
+
+		return super.getMappedObjectForField(field, getMappedValue(field, rawValue));
+	}
+
+	private Entry<String, Object> getMappedUpdateModifier(Field field, Object rawValue) {
 		Object value = null;
 
 		if (rawValue instanceof Modifier) {
@@ -99,7 +109,6 @@ protected Entry<String, Object> getMappedObjectForField(Field field, Object rawV
 
 			value = modificationOperations;
 		} else {
-
 			throw new IllegalArgumentException(String.format("Unable to map value of type '%s'!", rawValue.getClass()));
 		}
 
@@ -119,6 +128,10 @@ private boolean isUpdateModifier(Object value) {
 		return value instanceof Modifier || value instanceof Modifiers;
 	}
 
+	private boolean isQuery(Object value) {
+		return value instanceof Query;
+	}
+
 	private DBObject getMappedValue(Modifier modifier) {
 
 		Object value = converter.convertToMongoType(modifier.getValue(), ClassTypeInformation.OBJECT);

spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/convert/UpdateMapperUnitTests.java

@@ -41,10 +41,13 @@
 import org.springframework.data.mongodb.core.DBObjectTestUtils;
 import org.springframework.data.mongodb.core.mapping.Field;
 import org.springframework.data.mongodb.core.mapping.MongoMappingContext;
+import org.springframework.data.mongodb.core.query.Criteria;
+import org.springframework.data.mongodb.core.query.Query;
 import org.springframework.data.mongodb.core.query.Update;
 
 import com.mongodb.BasicDBList;
 import com.mongodb.BasicDBObject;
+import com.mongodb.BasicDBObjectBuilder;
 import com.mongodb.DBObject;
 import com.mongodb.DBRef;
 
@@ -471,6 +474,40 @@ public void updateOnDbrefPropertyOfInterfaceTypeWithoutExplicitGetterForIdShould
 		assertThat(model, allOf(instanceOf(DBRef.class), IsEqual.<Object> equalTo(expectedDBRef)));
 	}
 
+	/**
+	 * @see DATAMONGO-847
+	 */
+	@Test
+	public void updateMapperConvertsNestedQueryCorrectly() {
+
+		Update update = new Update().pull("list", Query.query(Criteria.where("value").in("foo", "bar")));
+		DBObject mappedUpdate = mapper.getMappedObject(update.getUpdateObject(),
+				context.getPersistentEntity(ParentClass.class));
+
+		DBObject $pull = DBObjectTestUtils.getAsDBObject(mappedUpdate, "$pull");
+		DBObject list = DBObjectTestUtils.getAsDBObject($pull, "aliased");
+		DBObject value = DBObjectTestUtils.getAsDBObject(list, "value");
+		BasicDBList $in = DBObjectTestUtils.getAsDBList(value, "$in");
+
+		assertThat($in, IsIterableContainingInOrder.<Object> contains("foo", "bar"));
+	}
+
+	/**
+	 * @see DATAMONGO-847
+	 */
+	@Test
+	public void updateMapperConvertsPullWithNestedQuerfyOnDBRefCorrectly() {
+
+		Update update = new Update().pull("dbRefAnnotatedList", Query.query(Criteria.where("id").is("1")));
+		DBObject mappedUpdate = mapper.getMappedObject(update.getUpdateObject(),
+				context.getPersistentEntity(DocumentWithDBRefCollection.class));
+
+		DBObject $pull = DBObjectTestUtils.getAsDBObject(mappedUpdate, "$pull");
+		DBObject list = DBObjectTestUtils.getAsDBObject($pull, "dbRefAnnotatedList");
+
+		assertThat(list, equalTo(new BasicDBObjectBuilder().add("_id", "1").get()));
+	}
+
 	@org.springframework.data.mongodb.core.mapping.Document(collection = "DocumentWithReferenceToInterface")
 	static interface DocumentWithReferenceToInterface {