DATAMONGO-420 - Improve support of quote handling for custom query parameters.

We now allow users to specify whether a given query or fields value is already quoted. This can be configured via the newly introduced customQuoting property of @query. This enables the user to specify complete query parts via String parameters.

Original pull request: #185.

Author: Thomas Darimont

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/Query.java

@@ -68,4 +68,29 @@
 	 * @return
 	 */
 	boolean delete() default false;
+
+/**
+	 * Returns an array of {@link CustomQuoting} that controls the quote handling for the respective query parts. Defaults
+	 * to {@code which means no custom quoting.
+	 * 
+	 * @since 1.5
+	 * @return
+	 */
+	CustomQuoting[] customQuoting() default {};
+
+	/**
+	 * @author Thomas Darimont
+	 * @since 1.5
+	 */
+	public enum CustomQuoting {
+		/**
+		 * The {@link Query#value()} should be treated as already quoted.
+		 */
+		QUERY,
+
+		/**
+		 * The {@link Query#fields()} should be treated as already quoted.
+		 */
+		FIELDS
+	}
 }

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/query/MongoQueryMethod.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2011-2013 the original author or authors.
+ * Copyright 2011-2014 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.
@@ -18,6 +18,7 @@
 import java.io.Serializable;
 import java.lang.reflect.Method;
 import java.util.Arrays;
+import java.util.Collections;
 import java.util.List;
 
 import org.springframework.core.annotation.AnnotationUtils;
@@ -28,6 +29,7 @@
 import org.springframework.data.mongodb.core.mapping.MongoPersistentEntity;
 import org.springframework.data.mongodb.core.mapping.MongoPersistentProperty;
 import org.springframework.data.mongodb.repository.Query;
+import org.springframework.data.mongodb.repository.Query.CustomQuoting;
 import org.springframework.data.repository.core.RepositoryMetadata;
 import org.springframework.data.repository.query.QueryMethod;
 import org.springframework.data.util.ClassTypeInformation;
@@ -39,9 +41,12 @@
  * Mongo specific implementation of {@link QueryMethod}.
  * 
  * @author Oliver Gierke
+ * @author Thomas Darimont
  */
 public class MongoQueryMethod extends QueryMethod {
 
+	private static final String CUSTOM_QUOTING = "customQuoting";
+
 	@SuppressWarnings("unchecked") private static final List<Class<? extends Serializable>> GEO_NEAR_RESULTS = Arrays
 			.asList(GeoResult.class, GeoResults.class, GeoPage.class);
 
@@ -96,6 +101,17 @@ String getAnnotatedQuery() {
 		return StringUtils.hasText(query) ? query : null;
 	}
 
+	/**
+	 * Returns the {@link CustomQuoting} that should be considered when rendering the query object.
+	 * 
+	 * @return
+	 */
+	List<CustomQuoting> getCustomQuoting() {
+
+		CustomQuoting[] customQuoting = (CustomQuoting[]) AnnotationUtils.getValue(getQueryAnnotation(), CUSTOM_QUOTING);
+		return customQuoting != null ? Arrays.asList(customQuoting) : Collections.<CustomQuoting> emptyList();
+	}
+
 	/**
 	 * Returns the field specification to be used for the query.
 	 * 
@@ -143,7 +159,7 @@ public MongoParameters getParameters() {
 	}
 
 	/**
-	 * Returns whether te query is a geo near query.
+	 * Returns whether the query is a geo near query.
 	 * 
 	 * @return
 	 */

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/query/StringBasedMongoQuery.java

@@ -15,6 +15,7 @@
  */
 package org.springframework.data.mongodb.repository.query;
 
+import java.util.List;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
@@ -23,6 +24,7 @@
 import org.springframework.data.mongodb.core.MongoOperations;
 import org.springframework.data.mongodb.core.query.BasicQuery;
 import org.springframework.data.mongodb.core.query.Query;
+import org.springframework.data.mongodb.repository.Query.CustomQuoting;
 
 import com.mongodb.util.JSON;
 
@@ -31,6 +33,7 @@
  * 
  * @author Oliver Gierke
  * @author Christoph Strobl
+ * @author Thomas Darimont
  */
 public class StringBasedMongoQuery extends AbstractMongoQuery {
 
@@ -42,6 +45,8 @@ public class StringBasedMongoQuery extends AbstractMongoQuery {
 	private final String fieldSpec;
 	private final boolean isCountQuery;
 	private final boolean isDeleteQuery;
+	private final boolean queryIsAlreadyQuoted;
+	private final boolean fieldsAreAlreadyQuoted;
 
 	/**
 	 * Creates a new {@link StringBasedMongoQuery} for the given {@link MongoQueryMethod} and {@link MongoOperations}.
@@ -69,6 +74,10 @@ public StringBasedMongoQuery(String query, MongoQueryMethod method, MongoOperati
 		this.isCountQuery = method.hasAnnotatedQuery() ? method.getQueryAnnotation().count() : false;
 		this.isDeleteQuery = method.hasAnnotatedQuery() ? method.getQueryAnnotation().delete() : false;
 
+		List<CustomQuoting> customQuoting = method.getCustomQuoting();
+		this.queryIsAlreadyQuoted = customQuoting.contains(CustomQuoting.QUERY);
+		this.fieldsAreAlreadyQuoted = customQuoting.contains(CustomQuoting.FIELDS);
+
 		if (isCountQuery && isDeleteQuery) {
 			throw new IllegalArgumentException(String.format(COUND_AND_DELETE, method));
 		}
@@ -81,12 +90,12 @@ public StringBasedMongoQuery(String query, MongoQueryMethod method, MongoOperati
 	@Override
 	protected Query createQuery(ConvertingParameterAccessor accessor) {
 
-		String queryString = replacePlaceholders(query, accessor);
+		String queryString = replacePlaceholders(query, accessor, queryIsAlreadyQuoted);
 
 		Query query = null;
 
 		if (fieldSpec != null) {
-			String fieldString = replacePlaceholders(fieldSpec, accessor);
+			String fieldString = replacePlaceholders(fieldSpec, accessor, fieldsAreAlreadyQuoted);
 			query = new BasicQuery(queryString, fieldString);
 		} else {
 			query = new BasicQuery(queryString);
@@ -119,21 +128,28 @@ protected boolean isDeleteQuery() {
 		return this.isDeleteQuery;
 	}
 
-	private String replacePlaceholders(String input, ConvertingParameterAccessor accessor) {
+	private String replacePlaceholders(String input, ConvertingParameterAccessor accessor, boolean valuesAreAlreadyQuoted) {
 
 		Matcher matcher = PLACEHOLDER.matcher(input);
 		String result = input;
 
 		while (matcher.find()) {
 			String group = matcher.group();
 			int index = Integer.parseInt(matcher.group(1));
-			result = result.replace(group, getParameterWithIndex(accessor, index));
+			result = result.replace(group, getParameterWithIndex(accessor, index, valuesAreAlreadyQuoted));
 		}
 
 		return result;
 	}
 
-	private String getParameterWithIndex(ConvertingParameterAccessor accessor, int index) {
+	private String getParameterWithIndex(ConvertingParameterAccessor accessor, int index, boolean valueIsQuoted) {
+
+		Object result = accessor.getBindableValue(index);
+
+		if (result instanceof String && valueIsQuoted) {
+			return (String) result;
+		}
+
 		return JSON.serialize(accessor.getBindableValue(index));
 	}
 }

spring-data-mongodb/src/test/java/org/springframework/data/mongodb/repository/query/StringBasedMongoQueryUnitTests.java

@@ -18,6 +18,7 @@
 import static org.hamcrest.Matchers.*;
 import static org.junit.Assert.*;
 import static org.mockito.Mockito.*;
+import static org.springframework.data.mongodb.repository.Query.CustomQuoting.*;
 
 import java.lang.reflect.Method;
 
@@ -46,6 +47,7 @@
  * 
  * @author Oliver Gierke
  * @author Christoph Strobl
+ * @author Thomas Darimont
  */
 @RunWith(MockitoJUnitRunner.class)
 public class StringBasedMongoQueryUnitTests {
@@ -158,6 +160,24 @@ public void preventsDeleteAndCountFlagAtTheSameTime() throws Exception {
 		createQueryForMethod("invalidMethod", String.class);
 	}
 
+	/**
+	 * @see DATAMONGO-420
+	 */
+	@Test
+	public void shouldSupportDetectingAlreadyQuotedValuesInQueryAndFieldDefinitions() throws Exception {
+
+		StringBasedMongoQuery mongoQuery = createQueryForMethod("findByDynamicQueryWithFieldsAndCustomQuoting",
+				String.class, String.class);
+		ConvertingParameterAccessor accessor = StubParameterAccessor.getAccessor(converter, new Object[] {
+				"'firstname':'bubu', 'lastname': 'baba'", "'lastname':1" });
+
+		org.springframework.data.mongodb.core.query.Query query = mongoQuery.createQuery(accessor);
+
+		assertThat(query.getQueryObject(),
+				is(new BasicQuery("{ \"firstname\": \"bubu\", \"lastname\": \"baba\"}").getQueryObject()));
+		assertThat(query.getFieldsObject(), is(new BasicQuery(null, "{ \"lastname\": 1}").getFieldsObject()));
+	}
+
 	private StringBasedMongoQuery createQueryForMethod(String name, Class<?>... parameters) throws Exception {
 
 		Method method = SampleRepository.class.getMethod(name, parameters);
@@ -184,5 +204,8 @@ private interface SampleRepository {
 
 		@Query(value = "{ 'lastname' : ?0 }", delete = true, count = true)
 		void invalidMethod(String lastname);
+
+		@Query(value = "{?0}", fields = "{?1}", customQuoting = { QUERY, FIELDS })
+		DBObject findByDynamicQueryWithFieldsAndCustomQuoting(String criteria, String fields);
 	}
 }