DATAMONGO-408 - Added StringToWriteConverter for XML setup convenience.

When using a PropertyPlaceHolderConfigurer to set WriteConcerns on a MongoFactoryBean just like this:

<bean class="….mongodb.core.MongoFactoryBean">
  <property name="writeConcern" value="${mongodb.writeConcern}"/>
</bean>

we might create invalid WriteConcerns as the BeanFactory will use the WriteConcern's constructor taking a String to create the instance by default. To make Spring use the valueOf(…) method in advance one needs to register either our already existing WriteConcernPropertyEditor or the newly introduced StringToWriteConcernConverter in Springs ConversionService.

Author: odrotbohm

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/config/StringToWriteConcernConverter.java

@@ -0,0 +1,38 @@
+/*
+ * Copyright 2012 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.config;
+
+import org.springframework.core.convert.converter.Converter;
+
+import com.mongodb.WriteConcern;
+
+/**
+ * Converter to create {@link WriteConcern} instances from String representations.
+ * 
+ * @author Oliver Gierke
+ */
+public class StringToWriteConcernConverter implements Converter<String, WriteConcern> {
+
+	/* 
+	 * (non-Javadoc)
+	 * @see org.springframework.core.convert.converter.Converter#convert(java.lang.Object)
+	 */
+	public WriteConcern convert(String source) {
+
+		WriteConcern writeConcern = WriteConcern.valueOf(source);
+		return writeConcern != null ? writeConcern : new WriteConcern(source);
+	}
+}

spring-data-mongodb/src/test/java/org/springframework/data/mongodb/config/StringToWriteConcernConverterUnitTest.java

@@ -0,0 +1,43 @@
+/*
+ * Copyright 2012 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.config;
+
+import static org.hamcrest.CoreMatchers.*;
+import static org.junit.Assert.*;
+
+import org.junit.Test;
+
+import com.mongodb.WriteConcern;
+
+/**
+ * Unit tests for {@link StringToWriteConcernConverter}.
+ * 
+ * @author Oliver Gierke
+ */
+public class StringToWriteConcernConverterUnitTest {
+
+	StringToWriteConcernConverter converter = new StringToWriteConcernConverter();
+
+	@Test
+	public void createsWellKnownConstantsCorrectly() {
+		assertThat(converter.convert("SAFE"), is(WriteConcern.SAFE));
+	}
+
+	@Test
+	public void createsWriteConcernForUnknownValue() {
+		assertThat(converter.convert("-1"), is(new WriteConcern("-1")));
+	}
+}

spring-data-mongodb/src/test/java/org/springframework/data/mongodb/config/WriteConcernPropertyEditorUnitTests.java

@@ -0,0 +1,53 @@
+/*
+ * Copyright 2012 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.config;
+
+import static org.hamcrest.CoreMatchers.*;
+import static org.junit.Assert.*;
+
+import org.junit.Before;
+import org.junit.Test;
+
+import com.mongodb.WriteConcern;
+
+/**
+ * Unit tests for {@link WriteConcernPropertyEditor}.
+ * 
+ * @author Oliver Gierke
+ */
+public class WriteConcernPropertyEditorUnitTests {
+
+	WriteConcernPropertyEditor editor;
+
+	@Before
+	public void setUp() {
+		editor = new WriteConcernPropertyEditor();
+	}
+
+	@Test
+	public void createsWriteConcernForWellKnownConstants() {
+
+		editor.setAsText("SAFE");
+		assertThat(editor.getValue(), is((Object) WriteConcern.SAFE));
+	}
+
+	@Test
+	public void createsWriteConcernForUnknownConstants() {
+
+		editor.setAsText("-1");
+		assertThat(editor.getValue(), is((Object) new WriteConcern("-1")));
+	}
+}

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

@@ -0,0 +1,52 @@
+/*
+ * Copyright 2012 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;
+
+import static org.hamcrest.CoreMatchers.*;
+import static org.junit.Assert.*;
+
+import org.junit.Test;
+import org.springframework.beans.factory.support.DefaultListableBeanFactory;
+import org.springframework.beans.factory.support.RootBeanDefinition;
+import org.springframework.data.mongodb.config.WriteConcernPropertyEditor;
+import org.springframework.test.util.ReflectionTestUtils;
+
+import com.mongodb.WriteConcern;
+
+/**
+ * Integration tests for {@link MongoFactoryBean}.
+ * 
+ * @author Oliver Gierke
+ */
+public class MongoFactoryBeanIntegrationTest {
+
+	/**
+	 * @see DATAMONGO-408
+	 */
+	@Test
+	public void convertsWriteConcernCorrectly() {
+
+		RootBeanDefinition definition = new RootBeanDefinition(MongoFactoryBean.class);
+		definition.getPropertyValues().addPropertyValue("writeConcern", "SAFE");
+
+		DefaultListableBeanFactory factory = new DefaultListableBeanFactory();
+		factory.registerCustomEditor(WriteConcern.class, WriteConcernPropertyEditor.class);
+		factory.registerBeanDefinition("factory", definition);
+
+		MongoFactoryBean bean = factory.getBean("&factory", MongoFactoryBean.class);
+		assertThat(ReflectionTestUtils.getField(bean, "writeConcern"), is((Object) WriteConcern.SAFE));
+	}
+}