Update to support a plugin.groovy in grails plugins

Author: jameskleeh

grails-core/src/main/groovy/org/grails/core/cfg/GroovyConfigPropertySourceLoader.groovy

@@ -41,7 +41,11 @@ class GroovyConfigPropertySourceLoader implements PropertySourceLoader {
     final String[] fileExtensions = ['groovy'] as String[]
 
     @Override
-    PropertySource<?> load(String name, Resource resource, String profile) throws IOException {
+    PropertySource<?> load(String name, Resource resource, String profile) {
+        load(name, resource, profile, [])
+    }
+
+    PropertySource<?> load(String name, Resource resource, String profile, List<String> filteredKeys) throws IOException {
         def env = Environment.current.name
         if(profile == null || env == profile) {
 
@@ -55,6 +59,11 @@ class GroovyConfigPropertySourceLoader implements PropertySourceLoader {
                         appVersion: Metadata.getCurrent().getApplicationVersion() )
                 try {
                     def configObject = configSlurper.parse(resource.URL)
+
+                    filteredKeys?.each { key ->
+                        configObject.remove(key)
+                    }
+
                     def propertySource = new NavigableMap()
                     propertySource.merge(configObject, false)
                     return new NavigableMapPropertySource(name, propertySource)

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

@@ -20,10 +20,13 @@
 import grails.io.IOUtils;
 import grails.plugins.GrailsPlugin;
 import grails.plugins.GrailsPluginManager;
+import grails.util.Environment;
 import grails.util.GrailsNameUtils;
 import groovy.lang.GroovyObjectSupport;
+import groovy.util.ConfigSlurper;
 import org.grails.config.yaml.YamlPropertySourceLoader;
 import org.grails.core.AbstractGrailsClass;
+import org.grails.core.cfg.GroovyConfigPropertySourceLoader;
 import org.grails.core.legacy.LegacyGrailsApplication;
 import org.grails.plugins.support.WatchPattern;
 import org.slf4j.Logger;
@@ -49,6 +52,8 @@ public abstract class AbstractGrailsPlugin extends GroovyObjectSupport implement
 
     public static final String PLUGIN_YML = "plugin.yml";
     public static final String PLUGIN_YML_PATH = "/" + PLUGIN_YML;
+    public static final String PLUGIN_GROOVY = "plugin.groovy";
+    public static final String PLUGIN_GROOVY_PATH = "/" + PLUGIN_GROOVY;
     private static final List<String> DEFAULT_CONFIG_IGNORE_LIST = Arrays.asList("dataSource", "hibernate");
     private static Resource basePluginResource = null;
     protected PropertySource<?> propertySource;
@@ -84,12 +89,19 @@ public AbstractGrailsPlugin(Class<?> pluginClass, GrailsApplication application)
         this.grailsApplication = application;
         this.pluginClass = pluginClass;
         Resource resource = readPluginConfiguration(pluginClass);
+
         if(resource != null && resource.exists()) {
-            YamlPropertySourceLoader propertySourceLoader = new YamlPropertySourceLoader();
+            final String filename = resource.getFilename();
             try {
-                this.propertySource = propertySourceLoader.load(GrailsNameUtils.getLogicalPropertyName(pluginClass.getSimpleName(), "GrailsPlugin") + "-plugin.yml", resource, null, false, DEFAULT_CONFIG_IGNORE_LIST);
+                if (filename.equals(PLUGIN_YML)) {
+                    YamlPropertySourceLoader propertySourceLoader = new YamlPropertySourceLoader();
+                    this.propertySource = propertySourceLoader.load(GrailsNameUtils.getLogicalPropertyName(pluginClass.getSimpleName(), "GrailsPlugin") + "-" + PLUGIN_YML, resource, null, true, DEFAULT_CONFIG_IGNORE_LIST);
+                } else if (filename.equals(PLUGIN_GROOVY)) {
+                    GroovyConfigPropertySourceLoader propertySourceLoader = new GroovyConfigPropertySourceLoader();
+                    this.propertySource = propertySourceLoader.load(GrailsNameUtils.getLogicalPropertyName(pluginClass.getSimpleName(), "GrailsPlugin") + "-" + PLUGIN_GROOVY, resource, null, DEFAULT_CONFIG_IGNORE_LIST);
+                }
             } catch (IOException e) {
-                LOG.warn("Error loading plugin.yml for plugin: " + pluginClass.getName() +": " + e.getMessage(), e);
+                LOG.warn("Error loading " + filename + " for plugin: " + pluginClass.getName() +": " + e.getMessage(), e);
             }
         }
     }
@@ -114,10 +126,21 @@ public boolean isEnabled(String[] profiles) {
 
     protected Resource readPluginConfiguration(Class<?> pluginClass) {
         final URL urlToPluginYml = IOUtils.findResourceRelativeToClass(pluginClass, PLUGIN_YML_PATH);
+        final URL urlToPluginGroovy = IOUtils.findResourceRelativeToClass(pluginClass, PLUGIN_GROOVY_PATH);
+
+        Resource ymlUrlResource = urlToPluginYml != null ? new UrlResource(urlToPluginYml) : null;
+        Resource groovyUrlResource = urlToPluginGroovy != null ? new UrlResource(urlToPluginGroovy) : null;
+
+        Boolean groovyUrlResourceExists = groovyUrlResource != null && groovyUrlResource.exists();
 
-        Resource urlResource = urlToPluginYml != null ? new UrlResource(urlToPluginYml) : null;
-        if(urlResource != null && urlResource.exists()) {
-            return urlResource;
+        if(ymlUrlResource != null && ymlUrlResource.exists()) {
+            if (groovyUrlResourceExists) {
+                throw new RuntimeException("A plugin may define a plugin.yml or a plugin.groovy, but not both");
+            }
+            return ymlUrlResource;
+        }
+        if(groovyUrlResourceExists) {
+            return groovyUrlResource;
         }
         return null;
     }