jruby-gradle
/
jruby-gradle-plugin
mirror of https://github.com/jruby-gradle/jruby-gradle-plugin
1
0
Fork 0
Code Issues Releases Wiki Activity
jruby-gradle-plugin/README.adoc

9.3 KiB
Raw Blame History

<html lang="en"> <head> </head>

JRuby/Gradle plugin

Join us on the [jruby-gradle mailing list](https://groups.google.com/forum/#!forum/jruby-gradle)!

The purpose of plugin is to encapsulate useful [Gradle](http://www.gradle.org/) functionality for JRuby projects. Use of this plugin replaces the need for both [Bundler](http://bundler.io/) and [Warbler](https://github.com/jruby/warbler) in JRuby projects.

The Ruby gem dependency code for this project relies on the link::http://rubygems.lasagna.io/proxy/releases[Rubygems Maven proxy] operated by link::https://github.com/rtyler[R. Tyler Croy]

This repository contains the:

  • base (in jruby-gradle-base-plugin/): dependency resolution, executing Ruby, etc.

  • jar (in jruby-gradle-jar-plugin/): packaging JRuby-based .jar files

  • war (in jruby-gradle-war-plugin/): packaging JRuby-based .war files

Compatilibity

This plugin requires Gradle 2.0 or better

Getting Started

buildscript {
    repositories { jcenter() }

    dependencies {
      classpath group: 'com.github.jruby-gradle', name: 'jruby-gradle-plugin', version: '0.1.2'
    }
}

apply plugin: 'com.github.jruby-gradle.base'

Adding gems

You can also add Ruby gem dependencies in your build.gradle file under the gem configuration, e.g.:

dependencies {
    gems group: 'rubygems', name: 'sinatra', version: '1.4.5'
    gems group: 'rubygems', name: 'rake', version: '10.3.+'
}

Default Tasks

The base plugin provides the following tasks:

  • jrubyPrepare - Prepares the necessary .gem and .jar dependencies for future use

JRubyExec - Task for Executing a Ruby Script

In a similar vein to JavaExec and RhinoShellExec, the JRubyExec allows for Ruby scripts to be executed in a Gradle script using JRuby.

import com.github.jrubygradle.JRubyExec

dependencies {
    jrubyExec 'rubygems:credit_card_validator:1.2.0'
}

task runMyScript( type: JRubyExec ) {
    script 'scripts/runme.rb'
    scriptArgs '-x', '-y'
}

Common methods for JRubyExec for executing a script

  • script - Object (Usually File or String). Path to the script.

  • scriptArgs - List. List of arguments to pass to script.

  • workingDir - Object (Usually File or String). Working directory for script.

  • environment - Map. Environment to be set. Do not set GEM_HOME or GEM_PATH with this method.

  • standardInput - InputStream. Set an input stream to be read by the script.

  • standardOutput - OutputStream. Capture the output of the script.

  • errorOutput - OutputStream. Capture the error output of the script.

  • ignoreExitValue - Boolean. Ignore the JVm exit value. Exit values are only effective if the exit value of the Ruby script is correctly communicated back to the JVM.

  • configuration - String. Configuration to copy gems from. (*)

  • classpath - List. Additional Jars/Directories to place on classpath.

  • jrubyVersion - String. JRuby version to use if not the same as project.jruby.execVersion.

  • gemWorkDir - File. Provide a custom working directory for unpacking GEMs. By default each JRubyExec task uses it’s own work directory. Use this to set a common work directory for a number of tasks.

(*) If jRubyVersion has not been set, jrubyExec will used as configuration. However, if jRubyVersion has been set, no gems will be used unless an explicit configuration has been provided

Additional JRubyExec methods for controlling the JVM instance

jrubyexec extension

Similar to javaexec and exec it is possible to add the execution of a jruby script within another task

task needSomeRubyLove {
  jrubyexec {
    script 'scripts/runme.rb'
    scriptArgs '-x', '-y'
  }
}

The behaviour of project.jrubyexec is slightly different to that of JRubyExec.

  • The version of jruby-complete is strictly tied to the jruby.execVersion. Therefore trying to set jrubyVersion in the jrubyexec closure will cause a failure

  • GEMs and additional JARs are only taken from the jrubyExec configuration.

  • It is not possible to supply a configuration parameter to the jrubyexec closure.

  • GEMs will be installed to jruby.gemInstallDir. Existing gems will not be overwritten.

As with JRubyExec, args, setArgs and main are illegal within the jrubyexec closure. All other methods should work.

Running a Ruby PATH command

Because JRubyExec checks for the existence of the script, it might look at first whether running Ruby commands from PATH could be difficult. However, this is totally possible by utilising jrubyArgs and passing -S as one would do when using ruby or jruby on the command-line. Here is an example of running rake as task.

task rake( type : JRubyExec ) {
    jrubyArgs '-S'
    script 'rake'
    scriptArgs '/path/to/Rakefile', 'target1', 'target2'
}

or even

ext {
    rake = { String target ->
        jrubyexec {
            jrubyArgs '-S'
            script 'rake'
            scriptArgs '/path/to/Rakefile', target
        }
    }
}

JRubyPrepare - A task for unpacking Gems

Unpacking occurs using the default jruby version as set by jruby.execVersion.

import com.github.jrubygradle.JRubyPrepare

task unpackMyGems( type : JRubyPrepare ) {

  // Parent directory for unpacking GEMs.
  // Gems will end up in a subdirectory 'gems/GemName-GemVersion'
  outputDir buildDir

  // Add one or more gems
  // Can be String(s), File(s), FileCollection(s) or Configuration(s)
  gems project.configuration.gems

}

Advanced Usage

Using a custom Gem repository

By default the jruby plugin will use [rubygems-proxy.torquebox.org](http://rubygems-proxy.torquebox.org) as its source of Ruby gems. This is a server operated by the Torquebox project which presents [rubygems.org](https://rubygems.org) as a Maven repository.

If you do not wish to use this repository, you can run your own Maven proxy repository for either rubygems.org or your own gem repository by running the [rubygems-servlets](https://github.com/torquebox/rubygems-servlets) server.

You can then use that custom Gem repository with:

jruby {
    defaultRepositories = false
}

repositories {
    maven { url : 'http://localhost:8989/releases' }
}

dependencies {
    gems group: 'com.lookout', name: 'custom-gem', version: '1.0.+'
}

Using the Ruby interpreter

There are still plenty of cases, such as for local development, when you might not want to create a full .war file to run some tests. In order to use the same gems and .jar based dependencies, add the following to the entry point for your application:

# Hack our GEM_HOME to make sure that the `rubygems` support can find our
# unpacked gems in build/gems/
vendored_gems = File.expand_path(File.dirname(__FILE__) + '/build/gems')
if File.exists?(vendored_gems)
  ENV['GEM_HOME'] = vendored_gems
end

Note: in the example above, the .rb file is assuming it’s in the top level of the source tree, i.e. where build.gradle is located

Last updated 2024-05-16 23:07:01 UTC
</html>