Merge pull request #19 from shiva2991/dateSupport

java.util.Date support using Spring's CustomDateEditor

Author: jamesmorgan

README.md

@@ -7,7 +7,7 @@ These properties also auto reload if the given properties file changes during ru
 <pre>
 	@ReloadableProperty("dynamicProperty.longValue")
 	private long primitiveWithDefaultValue = 55;
-
+	
 	@ReloadableProperty("dynamicProperty.substitutionValue")
 	private String stringProperty;
 
@@ -58,41 +58,43 @@ A set of integration and unit tests can be found in _src/test/java_ (tests) & _s
 
 ### Future Changes ###
 * Ability to use Spring Expression language to map properties files
-* Support for Java 7 Data and Time classes
+* Support for Java 7 Date and Time classes
 * Include the ability to define a database driven properties source not just properties files
 * Implement error recovery inside PropertiesWatcher.class, including better thread recovery
-* Ability to perform additional re-bind logic when a property is changed, i.e. if a class has an open DB connection whcih needs tobe re-established using newly set properties.
+* Ability to perform additional re-bind logic when a property is changed, i.e. if a class has an open DB connection which needs to be re-established using newly set properties.
 * Replace callback Properties EventHandler with Guava EventBus
 * Ability to configure usage via spring's @Configuration 
 
 ### Contributions ###
-* Thankyou [normanatashbar](https://github.com/normanatashbar) for adding composite string replacement
+* Thank you [normanatashbar](https://github.com/normanatashbar) for adding composite string replacement
+* Thank you [shiva2991](https://github.com/normanatashbar) for adding java.util.Date type conversion.
 
 ### Supported Property Type Conversions Available ###
-* Joda Time Library (2.1) - [link](http://joda-time.sourceforge.net/)
- * LocalDate.class
- * LocalTime.class
- * LocalDateTime.class
- * Period.class
+* LocalDate.class
+* LocalTime.class
+* LocalDateTime.class
+* Period.class
 
 
 * Spring Supported (3.1.2-RELEASE)
- * String.class
- * boolean.class, Boolean.class
- * byte.class, Byte.class
- * char.class, Character.class
- * short.class, Short.class
- * int.class, Integer.class
- * long.class,	Long.class
- * float.class, Float.class
- * double.class, Double.class
+* String.class
+* Date.class
+* boolean.class, Boolean.class
+* byte.class, Byte.class
+* char.class, Character.class
+* short.class, Short.class
+* int.class, Integer.class
+   * long.class,Long.class
+* float.class, Float.class
+* double.class, Double.class
 
 ### Dependencies ###
 
 #### Core ####
 * Java 7 SDK
 * Spring (3.2.5-RELEASE)
 * Google Guava  (14.0.1)
+* Joda Time Library (2.1) - [link](http://joda-time.sourceforge.net/)
 
 #### Logging ####
 * logback (1.0.13)

src/main/java/com/morgan/design/properties/conversion/CustomEditorsRegistrar.java

@@ -0,0 +1,25 @@
+package com.morgan.design.properties.conversion;
+
+import java.beans.PropertyEditor;
+import java.util.Map;
+
+import org.springframework.beans.PropertyEditorRegistrar;
+import org.springframework.beans.PropertyEditorRegistry;
+
+public class CustomEditorsRegistrar implements PropertyEditorRegistrar {
+
+	private Map<Class<?>, PropertyEditor> extraEditors;
+	
+	public CustomEditorsRegistrar(Map<Class<?>, PropertyEditor> extraEditors)
+	{
+		this.extraEditors = extraEditors;
+	}
+	
+	@Override
+	public void registerCustomEditors(PropertyEditorRegistry registry) {
+		for (Map.Entry<Class<?>, PropertyEditor> entry : extraEditors.entrySet()) {
+			registry.registerCustomEditor(entry.getKey(), entry.getValue());
+		}
+	}
+
+}

src/main/java/com/morgan/design/properties/conversion/DefaultPropertyConversionService.java

@@ -3,12 +3,17 @@
 import java.lang.reflect.Field;
 import java.util.Map;
 
+import javax.annotation.PostConstruct;
+
 import org.joda.time.LocalDate;
 import org.joda.time.LocalDateTime;
 import org.joda.time.LocalTime;
 import org.joda.time.Period;
 import org.springframework.beans.SimpleTypeConverter;
+import org.springframework.beans.TypeConverter;
 import org.springframework.beans.factory.BeanInitializationException;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.config.ConfigurableBeanFactory;
 import org.springframework.stereotype.Component;
 
 import com.google.common.base.Function;
@@ -25,16 +30,22 @@
 @Component
 public class DefaultPropertyConversionService implements PropertyConversionService {
 
+	@Autowired
+	private ConfigurableBeanFactory configurableBeanFactory;
+	private static TypeConverter DEFAULT;
 	private static Map<Class<? extends Object>, Function<Object, ?>> CONVERTS = Maps.newHashMap();
 	static {
 		CONVERTS.put(Period.class, new PeriodConverter());
 		CONVERTS.put(LocalDateTime.class, new LocalDateTimeConverter());
 		CONVERTS.put(LocalDate.class, new LocalDateConverter());
 		CONVERTS.put(LocalTime.class, new LocalTimeConverter());
 	}
-
-	private static SimpleTypeConverter DEFAULT = new SimpleTypeConverter();
-
+	
+	@PostConstruct
+	public void init() {
+		DEFAULT = configurableBeanFactory.getTypeConverter();
+	}
+	
 	@Override
 	public Object convertPropertyForField(final Field field, final Object property) {
 		try {

src/main/resources/spring/spring-defaultConfiguration.xml

@@ -11,6 +11,35 @@
 		class="com.morgan.design.properties.conversion.DefaultPropertyConversionService"
 		id="conversionService" />
 
+	<!-- register property editors for date and other types -->
+	<bean class="org.springframework.beans.factory.config.CustomEditorConfigurer">
+		<property name="propertyEditorRegistrars">
+			<array>
+				<ref bean="customEditorRegistrar"/>
+			</array>
+		</property>
+	</bean>
+	
+	<!-- bean that helps to add as many editors as we require -->
+	<bean id="customEditorRegistrar" class="com.morgan.design.properties.conversion.CustomEditorsRegistrar">
+		<constructor-arg>
+			<map>
+				<entry key="java.util.Date" value-ref="dateEditor"/>
+			</map>
+		</constructor-arg>
+	</bean>
+	
+	<!-- spring's default date property editor -->
+	<bean id="dateEditor"
+   		class="org.springframework.beans.propertyeditors.CustomDateEditor">
+		<constructor-arg>
+			<bean class="java.text.SimpleDateFormat">
+				<constructor-arg value="dd-MM-yyyy" />
+			</bean>
+		</constructor-arg>
+		<constructor-arg value="true" />
+	</bean>
+	
 	<bean
 		class="com.morgan.design.properties.event.GuavaPropertyChangedEventNotifier"
 		autowire="constructor" id="eventNotifier">

src/test/java/com/morgan/design/properties/conversion/DefaultPropertyConversionServiceUnitTest.java

@@ -3,22 +3,25 @@
 import static org.hamcrest.Matchers.is;
 import static org.junit.Assert.assertThat;
 
+import java.text.ParseException;
+import java.text.SimpleDateFormat;
+import java.util.Date;
+
 import org.joda.time.LocalDate;
 import org.joda.time.LocalDateTime;
 import org.joda.time.LocalTime;
 import org.joda.time.Period;
-import org.junit.Before;
 import org.junit.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.junit4.AbstractJUnit4SpringContextTests;
 
-public class DefaultPropertyConversionServiceUnitTest {
+@ContextConfiguration(locations = {"classpath:/spring/spring-reloadablePropertyPostProcessorIntTest.xml"})
+public class DefaultPropertyConversionServiceUnitTest extends AbstractJUnit4SpringContextTests {
 
+	@Autowired
 	private PropertyConversionService conversionService;
 
-	@Before
-	public void setUp() throws Exception {
-		this.conversionService = new DefaultPropertyConversionService();
-	}
-
 	@Test
 	public void shouldConvertPeriodForPropertyForField() throws NoSuchFieldException, SecurityException {
 		assertThat((Period) convertPropertyForField("period", "24:00:00"), is(new Period(24, 0, 0, 0)));
@@ -52,11 +55,18 @@ public void shouldConvertBooleanValue() throws NoSuchFieldException, SecurityExc
 		assertThat((Boolean) convertPropertyForField("booleanValue", "true"), is(true));
 	}
 
+	@Test
+	public void shouldConvertDateValue() throws NoSuchFieldException, SecurityException, ParseException {
+		Date expected = new SimpleDateFormat("dd-MM-yyyy").parse("9-4-2017");
+		assertThat((Date) convertPropertyForField("dateValue", "9-4-2017"), is(expected));
+	}
+	
 	static class TestObject {
 		Period period = new Period();
 		LocalTime localTime = new LocalTime();
 		LocalDate localDate = new LocalDate();
 		LocalDateTime localDateTime = new LocalDateTime();
+		Date dateValue = new Date();
 		boolean booleanValue;
 	}
 

src/test/java/com/morgan/design/properties/internal/ReloadablePropertyPostProcessorIntTest.java

@@ -5,6 +5,9 @@
 
 import java.math.BigDecimal;
 import java.math.BigInteger;
+import java.text.ParseException;
+import java.text.SimpleDateFormat;
+import java.util.Date;
 
 import org.joda.time.LocalDate;
 import org.joda.time.LocalDateTime;
@@ -98,5 +101,10 @@ public void shouldInjectLocalDateTimeValue() {
 	public void shouldInjectLocalTimeValue() {
 		assertThat(this.bean.getLocalTimeProperty(), is(new LocalTime(12, 22, 45)));
 	}
-
+	
+	@Test
+	public void shouldInjectDateValue() throws ParseException {
+		Date d = new SimpleDateFormat("dd-MM-yyyy").parse("14-4-2017"); // exception is never throw
+		assertThat(this.bean.getDateProperty(), is(d));
+	}
 }

src/test/java/com/morgan/design/properties/testBeans/AutowiredPropertyBean.java

@@ -2,6 +2,7 @@
 
 import java.math.BigDecimal;
 import java.math.BigInteger;
+import java.util.Date;
 
 import org.joda.time.LocalDate;
 import org.joda.time.LocalDateTime;
@@ -71,6 +72,10 @@ public class AutowiredPropertyBean {
 
 	@ReloadableProperty("dynamicProperty.localTimeValue")
 	private LocalTime localTimeProperty;
+	
+	// java date
+	@ReloadableProperty("dynamicProperty.dateValue")
+	private Date dateProperty;
 
 	// recursive substitution
 
@@ -151,4 +156,7 @@ public String getSubstitutedProperty() {
 		return this.substitutedProperty;
 	}
 
+	public Date getDateProperty() {
+		return this.dateProperty;
+	}
 }

src/test/resources/test-files/example.properties

@@ -13,3 +13,4 @@ dynamicProperty.booleanValue=true
 dynamicProperty.localDateTimeValue=2009-07-05 12:56:02
 invalid.period=12:22:
 dynamicProperty.bigIntegerValue=224411
+dynamicProperty.dateValue=14-4-2017