Ruby plugin¶

The Ruby plugin manages Ruby gems and the Ruby interpreter. It can build and bundle different variants of the interpreter, build gems with tools like rake or Bundler, and install gems.

Keys¶

This plugin provides the following unique keys.

ruby-gems¶

Type: list of strings

The gems to install.

ruby-use-bundler¶

Type: boolean

Default: False

Whether to use Bundler to build the gems.

ruby-flavor¶

Type: string

Default: None

The Ruby interpreter to build and include. The supported interpreters are:

ruby
jruby
truffleruby
mruby

ruby-version¶

Type: string

Default: None

The version of the Ruby interpreter to build.

ruby-shared¶

Type: boolean

Default: False

When set to true, the plugin builds libruby.so, a shared library that other binaries can link against.

ruby-use-jemalloc¶

Type: boolean

Default: False

Whether to build Ruby with support for jemalloc.

ruby-configure-options¶

Type: list of strings

Extra arguments to pass to the configure script when building the Ruby interpreter.

Dependencies¶

The Ruby plugin needs a Ruby interpreter to run Ruby programs but does not provide it by default, to give you flexibility in the choice of interpreter flavor and version.

A common means of including Ruby is to declare the ruby Ubuntu package, or any ruby-<gem_name> Ubuntu package, as a stage-package.

Alternatively, if ruby-flavor and ruby-version are declared, this plugin downloads and runs the ruby-install <https://github.com/postmodern/ruby-install> tool.

If a special Ruby part named ruby-deps is defined, it creates a shared interpreter and shared gems that the other Ruby parts can use. For a Ruby part to use these shared files, it must list ruby-deps in its after key.

parts:
  ruby-deps:
    plugin: ruby
    ruby-flavor: mruby
    ruby-version: "3.4"
    ruby-gems:
      - bundler
      - rackup
  my-project:
    plugin: ruby
    source: .
    ruby-use-bundler: true
    after: [ruby-deps]