Call JRuby, Jython or other JVM scripting language from Maven

Ever been frustrated trying to extend maven? Yeah me too. So here’s a trick I finally pounded out a couple weeks ago that I thought I’d share here.

It’s pretty common place to use the maven antrun plugin to perform some extra build work that you couldn’t otherwise do without writing a full-blown maven plugin. You might even already use it to call scripts that move files around, compress CSS, or whatever. But wouldn’t it be nice if maven could download the script’s runtime for you? It can. Just throw these chunks into the plugins sections of your pom.xml file.

<plugin>
  <artifactId>maven-antrun-plugin</artifactId>
  <dependencies>
    <dependency>
      <groupId>org.jruby</groupId>
      <artifactId>jruby-complete</artifactId>
      <version>1.4.0</version>
    </dependency>
  </dependencies>
  <executions>
    <execution>
      <id>my_script</id>
      <phase>compile</phase>
      <configuration>
        <tasks>
          <java classname="org.jruby.Main" failonerror="yes">
            <arg value="${basedir}/src/main/ruby/myscript.rb" />
          </java>
        </tasks>
      </configuration>
    </execution>
  </executions>
</plugin>

And of course the same technique should work for any language that you can run as an argument java class (jython, rhino, clojure).

Now some of you might be asking “why not use the maven jruby plugin?”. Well because as best I can tell it still runs against JRuby 0.9.9. A bit too far behind the curve if you ask me. I expect you’ll find the same with Jython. So there.

Hope that helps some folks. I know it made wrangling my builds a world easier.

Update (11/13): Thanks to Brian Fox (via irc.codehaus.org#maven) for guiding me toward a much more graceful method of doing this. And for bonus points, the updated method (above) also allows you to load in gems as jar dependencies. Just add them to your dependency list (and maven repository), then require 'rubygems'; require '#{gem_name}' as usual. Hot!

Want to be notified about new posts? Just submit your email here!