Improvements to subproject reloading in multi-project builds

Author: graemerocher

grails-bootstrap/src/main/groovy/grails/io/IOUtils.groovy

@@ -125,7 +125,32 @@ class IOUtils extends SpringIOUtils {
             return new URL("$rootPath/")
         }
         throw new IllegalStateException("Root classpath resource not found! Check your disk permissions")
+    }
+
 
+    /**
+     * This method differs from {@link #findRootResource(java.lang.Class)} in that it will find the root URL where to load resources defined in src/main/resources
+     *
+     * At development time this with be build/main/resources, but in production it will be relative to the class.
+     *
+     * @param targetClass
+     * @param path
+     * @return
+     */
+    static URL findRootResourcesURL(Class targetClass) {
+        def pathToClassFile = '/' + targetClass.name.replace(".", "/") + ".class"
+        def classRes = targetClass.getResource(pathToClassFile)
+        if(classRes) {
+            String rootPath = classRes.toString() - pathToClassFile
+            if(rootPath.endsWith(BuildSettings.BUILD_CLASSES_PATH)) {
+                rootPath = rootPath.replace('/build/classes/', '/build/resources/')
+            }
+            else {
+                rootPath = "$rootPath/"
+            }
+            return new URL(rootPath)
+        }
+        return null
     }
 
     /**
@@ -149,6 +174,7 @@ class IOUtils extends SpringIOUtils {
     }
     /**
      * Finds a URL within a JAR relative (from the root) to the given class
+     *
      * @param targetClass
      * @param path
      * @return
@@ -166,6 +192,7 @@ class IOUtils extends SpringIOUtils {
         return null
     }
 
+
     @Memoized
     public static File findApplicationDirectoryFile() {
         def directory = findApplicationDirectory()
@@ -179,6 +206,27 @@ class IOUtils extends SpringIOUtils {
         return null
     }
 
+    /**
+     * Finds the application directory for the given class
+     *
+     * @param targetClass The target class
+     * @return The application directory or null if it can't be found
+     */
+    public static File findApplicationDirectoryFile(Class targetClass) {
+
+        def rootResource = findRootResource(targetClass)
+        if(rootResource != null) {
+
+            def rootFile = new UrlResource(rootResource).file.canonicalFile
+
+            def rootPath = rootFile.path
+            if(rootPath.contains(BuildSettings.BUILD_CLASSES_PATH)) {
+                return new File(rootPath - BuildSettings.BUILD_CLASSES_PATH)
+            }
+        }
+        return null
+    }
+
     @Memoized
     public static String findApplicationDirectory() {
         if(applicationDirectory) {

grails-bootstrap/src/main/groovy/grails/util/Environment.java

@@ -280,7 +280,8 @@ public static boolean isDevelopmentEnvironmentAvailable() {
      * @return True if the development sources are present
      */
     public static boolean isDevelopmentRun() {
-        return BuildSettings.GRAILS_APP_DIR_PRESENT && Boolean.getBoolean(RUN_ACTIVE);
+        Environment env = Environment.getCurrent();
+        return BuildSettings.GRAILS_APP_DIR_PRESENT && Boolean.getBoolean(RUN_ACTIVE) && (env == Environment.DEVELOPMENT || env == Environment.TEST);
     }
     /**
      * Check whether the application is deployed

grails-core/src/main/groovy/org/grails/plugins/BinaryGrailsPlugin.java

@@ -25,6 +25,7 @@
 import org.springframework.core.io.support.ResourcePatternResolver;
 import org.springframework.util.StringUtils;
 
+import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
 import java.net.URL;
@@ -46,9 +47,14 @@ public class BinaryGrailsPlugin extends DefaultGrailsPlugin {
     public static final char UNDERSCORE = '_';
     public static final String PROPERTIES_EXTENSION = ".properties";
 
-    private BinaryGrailsPluginDescriptor descriptor;
+    private final BinaryGrailsPluginDescriptor descriptor;
     private Class[] providedArtefacts = {};
-    private Map<String, Class> precompiledViewMap = new HashMap<String, Class>();
+    private final Map<String, Class> precompiledViewMap = new HashMap<String, Class>();
+    private final Resource baseResource;
+    private final Resource baseResourcesResource;
+    private final String baseResourceString;
+    private final boolean isJar;
+    private final File projectDirectory;
 
     /**
      * Creates a binary plugin instance.
@@ -60,13 +66,36 @@ public class BinaryGrailsPlugin extends DefaultGrailsPlugin {
     public BinaryGrailsPlugin(Class<?> pluginClass, BinaryGrailsPluginDescriptor descriptor, GrailsApplication application) {
         super(pluginClass, application);
         this.descriptor = descriptor;
+        URL rootResource = IOUtils.findRootResource(pluginClass);
+        if(rootResource == null) {
+            throw new PluginException("Cannot evaluate plugin location for plugin " + pluginClass);
+        }
+        this.baseResource = new UrlResource(rootResource);
+        try {
+            this.baseResourceString = baseResource.getURL().toString();
+        } catch (IOException e) {
+            throw new PluginException("Cannot evaluate plugin location for plugin " + pluginClass, e);
+        }
+
+        this.isJar = baseResourceString.startsWith("jar:");
+        this.projectDirectory = isJar ? null : IOUtils.findApplicationDirectoryFile(pluginClass);
+
+        URL rootResourcesURL = IOUtils.findRootResourcesURL(pluginClass);
+        if(rootResourcesURL == null) {
+            throw new PluginException("Cannot evaluate plugin location for plugin " + pluginClass);
+        }
 
+        this.baseResourcesResource= new UrlResource(rootResourcesURL);
         if (descriptor != null) {
             initializeProvidedArtefacts(descriptor.getProvidedlassNames());
             initializeViewMap(descriptor);
         }
     }
 
+    public File getProjectDirectory() {
+        return projectDirectory;
+    }
+
     protected void initializeViewMap(BinaryGrailsPluginDescriptor descriptor) {
         final Resource descriptorResource = descriptor.getResource();
 
@@ -174,7 +203,7 @@ public Resource getResource(String path) {
      * @return The properties or null if non exist
      */
     public Properties getProperties(final Locale locale) {
-        Resource url = findPluginJar();
+        Resource url = this.baseResourcesResource;
         Properties properties = null;
         if(url != null) {
             StaticResourceLoader resourceLoader = new StaticResourceLoader();
@@ -186,6 +215,8 @@ public Properties getProperties(final Locale locale) {
                 resources = filterResources(resources, locale);
                 properties = new Properties();
 
+                // message bundles are locale specific. The more underscores the locale has the more specific the locale
+                // so we order by the number of underscores present so that the most specific appears
                 Arrays.sort(resources, new Comparator<Resource>() {
                     @Override
                     public int compare(Resource o1, Resource o2) {
@@ -212,13 +243,6 @@ public int compare(Resource o1, Resource o2) {
         return properties;
     }
 
-    protected Resource findPluginJar() {
-        URL url = IOUtils.findJarResource(pluginClass);
-        if(url != null) {
-            return new UrlResource(url);
-        }
-        return null;
-    }
 
     private Resource[] filterResources(Resource[] resources, Locale locale) {
         List<Resource> finalResources = new ArrayList<Resource>(resources.length);

grails-gradle-plugin/src/main/groovy/org/grails/gradle/plugin/core/GrailsPluginGradlePlugin.groovy

@@ -193,6 +193,7 @@ class GrailsPluginGradlePlugin extends GrailsGradlePlugin {
             processResources.dependsOn(*processResourcesDependencies)
             project.processResources {
                 exclude "spring/resources.groovy"
+                exclude "**/*.gsp"
             }
         }
 

grails-gsp/src/main/groovy/org/grails/gsp/io/DefaultGroovyPageLocator.java

@@ -32,9 +32,11 @@
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.ApplicationContextAware;
 import org.springframework.context.ResourceLoaderAware;
+import org.springframework.core.io.FileSystemResource;
 import org.springframework.core.io.Resource;
 import org.springframework.core.io.ResourceLoader;
 
+import java.io.File;
 import java.security.PrivilegedAction;
 import java.util.Collection;
 import java.util.List;
@@ -200,15 +202,32 @@ protected GroovyPageScriptSource findBinaryScriptSource(String uri) {
             if (!(plugin instanceof BinaryGrailsPlugin)) {
                 continue;
             }
-            GroovyPageScriptSource scriptSource = resolveViewInBinaryPlugin((BinaryGrailsPlugin) plugin, uri);
+
+            BinaryGrailsPlugin binaryPlugin = (BinaryGrailsPlugin) plugin;
+            GroovyPageScriptSource scriptSource = resolveViewInBinaryPlugin(binaryPlugin, uri);
             if (scriptSource != null) {
                 return scriptSource;
             }
+            else if(binaryPlugin.getProjectDirectory() != null) {
+                scriptSource = resolveViewInPluginProjectDirectory(binaryPlugin, uri);
+                if(scriptSource != null) {
+                    return scriptSource;
+                }
+            }
         }
 
         return null;
     }
 
+    private GroovyPageScriptSource resolveViewInPluginProjectDirectory(BinaryGrailsPlugin binaryPlugin, String uri) {
+        File projectDirectory = binaryPlugin.getProjectDirectory();
+        File f = new File(projectDirectory, "grails-app/views" + uri);
+        if(f.exists()) {
+            return new GroovyPageResourceScriptSource(uri, new FileSystemResource(f));
+        }
+        return null;
+    }
+
     protected GroovyPageScriptSource findResourceScriptSourceInPlugins(String uri) {
         if (pluginManager == null) {
             return null;