Hot reloading support and more tests

Author: ldaley

ViewModelsGrailsPlugin.groovy

@@ -40,7 +40,10 @@ class ViewModelsGrailsPlugin {
 		"file:../../plugins/*/viewModels/**/*ViewModel.groovy",
 	]
 
-	def pluginExcludes = []
+	def pluginExcludes = [
+		"grails-app/**/*",
+		"web-app/**/*"
+	]
 
 	def doWithSpring = {
 		for (viewModelClass in application.viewModelClasses) {
@@ -58,7 +61,7 @@ class ViewModelsGrailsPlugin {
 	}
 
 	def doWithDynamicMethods = { context ->
-		def autowiringDecorator = new AutowiringConstructionDecorator(context)
+		def autowiringDecorator = createConstructionDecorator(application)
 		for (viewModelClass in application.viewModelClasses) {
 			enhanceViewModelClass(viewModelClass, autowiringDecorator)
 		}
@@ -84,22 +87,24 @@ class ViewModelsGrailsPlugin {
 
 	static private handleChange(application, event, type) {
 		if (application.isArtefactOfType(type, event.source)) {
-			def autowiringDecorator = new AutowiringConstructionDecorator(event.ctx)
+			def autowiringDecorator = createConstructionDecorator(application)
 
 			def oldClass = application.getArtefact(type, event.source.name)
-			application.addArtefact(type, event.source)
-			enhanceViewModelClass(event.source, autowiringDecorator)
+			enhanceViewModelClass(application.addArtefact(type, event.source), autowiringDecorator)
 
 
 			// Reload subclasses
 			application.getArtefacts(type).each {
 				if (it.clazz != event.source && oldClass.clazz.isAssignableFrom(it.clazz)) {
 					def newClass = application.classLoader.reloadClass(it.clazz.name)
-					application.addArtefact(type, newClass)
-					enhanceViewModelClass(newClass, autowiringDecorator)
+					enhanceViewModelClass(application.addArtefact(type, newClass), autowiringDecorator)
 				}
 			}
 		}
 	}
+	
+	static private createConstructionDecorator(grailsApplication) {
+		new ReloadCapableConstructionDecorator(grailsApplication.classLoader).chainWith(new AutowiringConstructionDecorator(grailsApplication.mainContext))
+	}
 
 }

application.properties

@@ -1,4 +1,4 @@
 #Grails Metadata file
 #Thu Feb 24 11:17:03 EST 2011
-app.grails.version=1.3.6
+app.grails.version=1.3.4
 app.name=view-models

grails-app/controllers/TheController.groovy

@@ -0,0 +1,6 @@
+class TheController {
+	def index = { 
+		NoConstructorViewModel vm = new NoConstructorViewModel()
+		render(text: vm.arbitraryProperty)
+	}
+}

grails-app/viewModels/InitializingBeanViewModel.groovy

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2011 Luke Daley
+ *
+ * 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.
+ */
+
+import org.springframework.beans.factory.InitializingBean
+
+class InitializingBeanViewModel implements InitializingBean {
+	
+	def p1 = 0
+	def p2 = 0
+	
+	void afterPropertiesSet() {
+		p2 = p1 + 1
+	}
+}

src/java/grails/plugin/viewmodels/ViewModelArtefactHandler.java

@@ -26,4 +26,8 @@ public ViewModelArtefactHandler() {
 		super(TYPE, ViewModelClass.class, DefaultViewModelClass.class, SUFFIX);
 	}
 
+	public String getPluginName() {
+		return "view-models";
+	}
+
 }

src/java/grails/plugin/viewmodels/constructor/ConstructionDecorator.java

@@ -24,5 +24,6 @@ public interface ConstructionDecorator<T> {
 	public void decorate(T instance, Object[] originalArgs, Object[] transformedArgs);
 
 	public Class<?>[] getSignature(Constructor<T> constructor);
-	
+
+	public Constructor<T> transformConstructor(Constructor<T> constructor);
 }

src/java/grails/plugin/viewmodels/constructor/ConstructionDecoratorChain.java

@@ -42,5 +42,13 @@ public void decorate(T instance, Object[] originalArgs, Object[] transformedArgs
 	public Class<?>[] getSignature(Constructor<T> constructor) {
 		return decorators[0].getSignature(constructor);
 	}
+
+	public Constructor<T> transformConstructor(Constructor<T> constructor) {
+		Constructor<T> transformedConstructor = constructor;
+		for (ConstructionDecorator<T> decorator : decorators) {
+			transformedConstructor = decorator.transformConstructor(transformedConstructor);
+		}
+		return transformedConstructor;
+	}
 
 }

src/java/grails/plugin/viewmodels/constructor/ConstructionDecoratorSupport.java

@@ -30,5 +30,9 @@ public void decorate(T instance, Object[] originalArgs, Object[] transformedArgs
 	public Class<?>[] getSignature(Constructor<T> constructor) {
 		return constructor.getParameterTypes();
 	}
+
+	public Constructor<T> transformConstructor(Constructor<T> constructor) {
+		return constructor;
+	}
 
 }

src/java/grails/plugin/viewmodels/constructor/DecoratingMetaConstructor.java

@@ -64,7 +64,7 @@ public Object invoke(Object object, Object[] arguments) {
 
 	protected T instantiate(Object[] arguments) {
 		try {
-			return constructor.newInstance(arguments);
+			return decorator.transformConstructor(constructor).newInstance(arguments);
 		} catch (InstantiationException e) {
 			throw new RuntimeException("Failed to invoke constructor " + constructor + " with args: " + arguments, e);
 		} catch (IllegalAccessException e) {

src/java/grails/plugin/viewmodels/constructor/ReloadCapableConstructionDecorator.java

@@ -0,0 +1,45 @@
+/*
+ * Copyright 2011 Luke Daley
+ *
+ * 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 grails.plugin.viewmodels.constructor;
+
+import java.lang.reflect.Constructor;
+
+class ReloadCapableConstructionDecorator<T> extends ConstructionDecoratorSupport<T> {
+	
+	private final ClassLoader classLoader;
+	
+	public ReloadCapableConstructionDecorator(ClassLoader classLoader) {
+		this.classLoader = classLoader;
+	}
+	
+	public Constructor<T> transformConstructor(Constructor<T> constructor) {
+		try {
+			Class<T> originalClassVersion = constructor.getDeclaringClass();
+			Class<T> newestClassVersion = (Class<T>)classLoader.loadClass(originalClassVersion.getName());
+			
+			return newestClassVersion.getConstructor(constructor.getParameterTypes());
+		} catch (NoSuchMethodException e) {
+			return constructor;
+		} catch (ClassNotFoundException e) {
+			return constructor;
+		}
+	}
+	
+	ConstructionDecoratorChain<T> chainWith(ConstructionDecorator<T> decorator) {
+		return new ConstructionDecoratorChain(decorator, this);
+	}
+	
+}

test/integration/InitialisationSpec.groovy

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2011 Luke Daley
+ *
+ * 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.
+ */
+
+import spock.lang.*
+import grails.plugin.spock.*
+
+class InitialisationSpec extends IntegrationSpec {
+	
+	def "initialising bean method is called"() {
+		when:
+		def vm = new InitializingBeanViewModel()
+		
+		then:
+		vm.p1 == 0
+		vm.p2 == 1
+	}
+
+	def "initialising bean method is called after constructor"() {
+		when:
+		def vm = new InitializingBeanViewModel(p1: 1)
+		
+		then:
+		vm.p1 == 1
+		vm.p2 == 2
+	}
+	
+}

test/integration/ReloadingSpec.groovy

@@ -0,0 +1,45 @@
+/*
+ * Copyright 2011 Luke Daley
+ *
+ * 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.
+ */
+
+import org.codehaus.groovy.grails.plugins.PluginManagerHolder
+import grails.plugin.spock.*
+import spock.lang.*
+
+class ReloadingSpec extends IntegrationSpec {
+
+	def grailsApplication
+	
+	def "reloading a view model class doesn't destroy autowiring"() {
+		expect:
+		createViewModel().exampleService != null
+
+		when:
+		reloadViewModelClass()
+
+		then:
+		createViewModel().exampleService != null
+	}
+	
+	protected createViewModel() {
+		grailsApplication.classLoader.loadClass(NoConstructorViewModel.name).newInstance()
+	}
+	
+	protected reloadViewModelClass() {
+		def newClass = grailsApplication.classLoader.reloadClass(NoConstructorViewModel.name)
+		PluginManagerHolder.pluginManager.informOfClassChange(newClass)
+	}
+
+}

test/integration/ViewModelValidInstantiationSpec.groovy

@@ -25,7 +25,7 @@ class ViewModelValidInstantiationSpec extends IntegrationSpec {
 
 		then:
 		vm != null
-		vm instanceof NoConstructorViewModel
+		vm.class.name == NoConstructorViewModel.name
 	}
 
 	def "instantiated view model is autowired"() {