1 Overview

fibonacci.js.gsp

<% fib = {n ->; return n <= 1 ? n : fib(n-1) + fib(n-2)} %>
var fibonacci = [<%= (0..10).collect{ fib.call(it) }.join(',') %>];

This is then cacheable and serveable as a javascript file as:

fibonacci.js

var fibonacci = [0,1,1,2,3,5,8,13,21,34,55];

2 Installation

plugins {
    // Other plugin dependencies here
    // . . .
    // . . .
    runtime ':gsp-resources:latest.integration'
}

Alternatively, you can install manually with the following command:

grails install-plugin gsp-resources

3 Usage

'style' {
    resource url:'css/test.css.gsp'
}

The GSP will be compiled to a file with exactly the same URI, but minus the '.gsp' extension. The type of the compiled file (i.e. in this case 'css') will be automatically detected from the filename. Should you wish to name your file with a file extension that is not recognised by the resources plugin, you can optionally explicitly define the file type of the compiled resource using the following example configuration:

'style' {
    resource url:'somefile.gsp', attrs:[rel: 'stylesheet/css', type:'css']
}

Note the additional attrs parameter, which is used to tell the resources plugin the type of the resource being generated. (In this example, the compiled file will simply be named 'somefile' with no extension.)

4 Limitations

5 Advanced Configuration

5.1 Delayed Processing

In fact, the processing could take place before a lot of the core grails infrastructure has been loaded. If your GSP resources contain <g:include /> tags, for example, it is possible the grails support for loading other groovy pages will not yet have been loaded when the resources plugin starts processing your GSP. This will result in errors!

To get around this, the gsp-resources plugin provides an additional configuration option, for delaying the start of resources processing during server startup. The following configuration option should be placed in grails-app/conf/Config.groovy:

grails.resources.processing.startup = "delayed"

This will delay resources processing until the bootstrap phase - by which point all required plugins and artefacts should be fully loaded.

For even finer control, you can disable resources processing during server startup entirely, with the following configuration:

grails.resources.processing.startup = false

You can then manually trigger the initial resources processing by adding the following code to your project's Bootstrap.groovy:

class BootStrap {
    // Automatically injected
    def grailsResourceProcessor
    def init = { servletContext ->
        // Do whatever preparation you need first
        // E.g. create some objects that your GSPs will need
        // . . .
        // . . .
        // Finally, start resources processing
        grailsResourceProcessor.start()
    }
    def destroy = {
    }
}

If no grails.resources.processing.startup configuration option is found in Config.groovy, or an invalid value is used, then the resources plugin defaults to its normal startup.

5.2 Simple HTML Cache

Example

We are going to cache the output of http://localhost:8080/myapp/about/me

1. Create a new directory under web-app

We will use web-app/cache in this example, but any directory name is fine.

2. Configure resources plugin to include new directory

Make the following change to grails-app/conf/Config.groovy

// Note we have added '/cache/*' to the existing list
grails.resources.adhoc.patterns = ['/images/*', '/css/*', '/js/*', '/plugins/*', '/cache/*']

3. Configure resources plugin to delay processing

Make the following change to grails-app/conf/Config.groovy

grails.resources.processing.startup = "delayed"

4. Create GSP to cache controller output

Add the below content to web-app/cache/aboutme.html.gsp

<g:include controller="about" action="me"/>

5. Add new GSP to resources plugin configuration

Make the following change to grails-app/conf/ApplicationResources.groovy

modules = {
    aboutme {
        resource url:'/cache/aboutme.html.gsp'
    }
}

6. Check results

You should now be able to view the cached file at http://localhost:8080/myapp/cache/aboutme.html

You will need to restart your server first, so that the resources plugin incorporates the config change setting made in Step #2. Unfortunately, the current version of resources (v1.2) cannot hotload changes to this setting.

Note, this server restart is only required once - i.e. when first adding the new /cache/* adhoc pattern to the resources config. From then on, the resources plugin will automatically intercept URLs of the form myapp/cache and map them to the actual URL of the requested resource.

6 Version History

7 Special Thanks

Marc Palmer for the excellent resources plugin, without which this plugin would not be possible.