Improve access and documentation of static resources

Details

Type: Improvement
Status: Open
Priority: Major
Resolution: Unresolved
Affects Version/s: None
Fix Version/s: 3.0
Component/s: None
Labels:
None

Description

There seems to be a lot of confusion on how to go about access static resources within various classes in a grails application. Searching the net for topics such as 'grails classpath resource' or 'grails getResource' reveals some of the issues (see the many references below). It is a frequent topic on the grails-user mailing list.

There does not seem to be good documentation on the classpath within the grails user guide.

There are various ways of accessing files, all seem to have various pros and cons and it would be nice to have the grails authors/designers make some decisions on the right 'grails-way' of doing this.

This requirement does NOT refer to web-accessible static resources, this is referring to data files uses for other purposes such as watermark files when dynamically serving images, templates used to create emails, etc.

After reading lots of posts the main requirement seems to be that static resources must be available using the same code using any of the following grails goals: test-app, run-app, run-war and that is must be documented in the grails user guide.

Additionally people need to be able to have 'test-app'-only resources that are not packaged into a war file.

People, myself included, like to have separate 'resource' folders for resources, see the maven standard directory layout - http://maven.apache.org/guides/introduction/introduction-to-the-standard-directory-layout.html

Ideally, something like the snippet below should work from within at least bootstrap.groovy and any controller class, service class, unit test and integration test. An IDE JUnit test-runner should also be able to be configured so that it works too.

import java.net.URL
URL url = ???.getResource("emailTemplates/someTemplate.txt")

??? should be documented for each of the cases above, if 'this.class.getResource()' is not sufficient

There should be some documented scheme for placing resource files within the grails app file structure, suggestions as follows:

/
 test/
      resources/
                myTestOnlyResource.txt
 grails-app/
           resources/
                     myAccessableFromEverywhereResource.txt

Given the example snippet above, the relative path to the root of the grails project for the resource file would be:

/grails-app/resources/emailTemplates/someTemplate.txt

A class specific resource for the class com.example.SomeService could be stored at:

/grails-app/resources/com/example/someservice/someResource.txt

Accessible in code via something like:

package com.example

class SomeService {
    void doStuff() {
        URL url = getResource("com/example/someservice/someResource.txt")
        String content = new File(url).text
    }
}

References: