Skip to content

Latest commit

 

History

History
252 lines (183 loc) · 6.67 KB

README.md

File metadata and controls

252 lines (183 loc) · 6.67 KB
Raw

Wro4j Grails Plugin

This version is a working SNAPSHOT. You will have to install the plugin using the ZIP archive full path:

wget http://xxx/grails-wro4j-1.3.9-SNAPSHOT.zip
grails install-plugin grails-wro4j-1.3.9-SNAPSHOT.zip

Web Resource Optimizer for Grails

In order to get started with wro4j, you have to follow only 3 simple steps.

Step 1: Install plugin wro4j

grails install-plugin wro4j

Step 2: Create grails-app/conf/Wro.groovy

groups{
  all{
    css(minimize: false, "/css/*.css")
    js "/js/*.js"
  }
}

Step 3: Use optimized resource

<html>
  <head>
    <title>Web Page using wro4j</title>
    <wro:css group="all"/>
    <wro:js group="all"/>
  </head>
  <body>

  </body>
</html>

Step 4: (Optional) Configure Wro in Config.groovy :

import ro.isdc.wro.model.resource.processor.impl.BomStripperPreProcessor
import ro.isdc.wro.model.resource.processor.impl.js.JSMinProcessor
import ro.isdc.wro.model.resource.processor.impl.js.SemicolonAppenderPreProcessor
import ro.isdc.wro.model.resource.processor.impl.css.*
import ro.isdc.wro.model.resource.locator.UrlUriLocator
import ro.isdc.wro.model.resource.locator.ClasspathUriLocator
import ro.isdc.wro.model.resource.locator.ServletContextUriLocator

/**
 * Boolean flag for enable/disable resource gzipping.
 */
wro.gzipResources = true
/**
 * Parameter allowing to turn jmx on or off.
 */
wro.jmxEnabled = true
/**
 * Parameter containing an integer value for specifying how often (in seconds) the cache should be refreshed.
 */
wro.cacheUpdatePeriod = 0
/**
 * Parameter containing an integer value for specifying how often (in seconds) the model should be refreshed.
 */
wro.modelUpdatePeriod = 0
/**
 * Disable cache configuration option. When true, the processed content won't be cached in DEVELOPMENT mode. In
 * DEPLOYMENT mode changing this flag will have no effect.
 */
wro.disableCache = false
/**
 * Instructs wro4j to not throw an exception when a resource is missing.
 */
wro.ignoreMissingResources = true
/**
 * Encoding to use when reading and writing bytes from/to stream
 */
wro.encoding = null
/**
 * The fully qualified class name of the {@link ro.isdc.wro.manager.WroManagerFactory} implementation.
 */
wro.managerFactoryClassName = "wro4j.grails.plugin.GrailsWroManagerFactory"

/** PreProcessor used by wro4j.grails.plugin.GrailsWroManagerFactory  */
wro.grailsWroManagerFactory.preProcessors = [
    new CssUrlRewritingProcessor(),
    new CssImportPreProcessor(),
    new BomStripperPreProcessor(),
    new SemicolonAppenderPreProcessor(),
    new JSMinProcessor(),
    new JawrCssMinifierProcessor(),
]

/** postProcessor used by wro4j.grails.plugin.GrailsWroManagerFactory  */
wro.grailsWroManagerFactory.postProcessors = [
    new CssVariablesProcessor(),
]

/** uriLocator used by wro4j.grails.plugin.GrailsWroManagerFactory  */
wro.grailsWroManagerFactory.uriLocators = [
    new ServletContextUriLocator(),
    new ClasspathUriLocator(),
    new UrlUriLocator(),
]

/**
 * the name of MBean to be used by JMX to configure wro4j.
 */
wro.mbeanName = null
/**
 * The parameter used to specify headers to put into the response, used mainly for caching.
 */
wro.header = null

environments {
  production {
    wro.debug = false
  }
  development {
    wro.debug = true
  }
  test {
    wro.debug = true
  }
}

FAQ

I want to use wro.xml to define my model.

In Config.groovy, just set the Wro4J default ManagerFactory like this :

wro.managerFactoryClassName = null

I want to use CoffeeScript

CoffeeScript is one of the available Resource Processors in Wro4J (others are : Less, Sass, CSSVariables, ...). See the whole list of resource processors here : http://code.google.com/p/wro4j/wiki/AvailableProcessors

In Config.groovy add this :

import ro.isdc.wro.model.resource.processor.impl.*
import ro.isdc.wro.model.resource.processor.impl.js.*
import ro.isdc.wro.model.resource.processor.impl.css.*
import ro.isdc.wro.extensions.processor.css.*
import ro.isdc.wro.extensions.processor.js.*

//your config stuff...

wro.grailsWroManagerFactory.preProcessors = [
    new CssUrlRewritingProcessor(),
    new CssImportPreProcessor(),
    new BomStripperPreProcessor(),
    new SemicolonAppenderPreProcessor(),
    new JSMinProcessor(),
    new JawrCssMinifierProcessor(),
    new CoffeeScriptProcessor(),  //   <------ CoffeeScript is here
]

You see the new CoffeeScriptProcessor() line. This is where you add the special processors.

Other lines are the default preProcessors that are used if you don't override the wro.grailsWroManagerFactory.preProcessors property. You can remove those preProcessors if you don't need them.

Then create your coffeeScript file :

/web-app/js/script.js.coffee

$ ->
  $('<h2>Enhanced with Coffee Script</h2>').insertAfter $('h1')

And register coffee script files in your model :

/grails-app/conf/wro.groovy

groups {
  all {
    css "/css/*.css"
    js "/js/*.js"
    js "/js/*.js.coffee"
  }
}

I want to use LessCss

It is quite similar to CoffeeScript, so look at it first.

Configure your Config.groovy to add this :

import ro.isdc.wro.model.resource.processor.impl.*
import ro.isdc.wro.model.resource.processor.impl.js.*
import ro.isdc.wro.model.resource.processor.impl.css.*
import ro.isdc.wro.extensions.processor.css.*
import ro.isdc.wro.extensions.processor.js.*

//your config stuff...

wro.grailsWroManagerFactory.preProcessors = [
    new CssUrlRewritingProcessor(),
    new CssImportPreProcessor(),
    new BomStripperPreProcessor(),
    new SemicolonAppenderPreProcessor(),
    new JSMinProcessor(),
    new JawrCssMinifierProcessor(),
    new CoffeeScriptProcessor(),  //   <------ Less is here
]

Create your less file :

/web-app/css/style.less

@my-size = 12px
h1 {
  font-size: @my-size
}

And register less files in your model :

/grails-app/conf/wro.groovy

groups {
  all {
    css "/css/*.css"
    css "/css/*.less"

    js "/js/*.js"
  }
}

**Can I change web-app/conf/Wro.groovy at runtime? **

Yes you can. Each time you update the Wro.groovy file, Wro4J is fully reloaded.

**Can I change the wro config in web-app/conf/Config.groovy at runtime? **

Yes, of course !!!