Installs a system-wide RVM and manages installed rubies.

For the moment this is targeted at Ubuntu, other platforms to be tested.

TBD

The default ruby for RVM. If the RVM ruby is not installed, it will be built as a pre-requisite. The value can also contain a gemset in the form of ruby-1.8.7-p330@awesome.

Note: a fully qualified RVM string name needs to be used, which can be found when running rvm list known.

The default is ruby-1.9.2-p136.

A list of RVM rubies to be built and installed. If this list is emptied then no rubies (not even the default) will be built and installed, like so:

node[:rvm][:rubies] = []

Note: a fully qualified RVM string name needs to be used, which can be found when running rvm list known.

The default is the value of node[:rvm][:default_ruby].

A list of gem hashes to be installed into the global gemset in each installed RVM ruby. The RVM global.gems files will be added to and all installed rubies will be iterated over to ensure full installation coverage. See the rvm_gem resource for more details about the options for each gem hash. The default puts bundler in each ruby:

node[:rvm][:global_gems] = [
  { :name => "bundler" }
]

A list of gem hashes to be installed into arbitrary RVM rubies and gemsets. See the rvm_gem resource for more details about the options for each gem hash and target ruby environment. The default is an empty hash.

A hash of system-wide rvmrc options. The key is the RVM setting name (in String or Symbol form) and the value is the desired setting value. An example used on a build box might be:

node[:rvm][:rvmrc] = {
  'rvm_gemset_create_on_use_flag' => 1,
  'rvm_trus_rvmrcs_flag'          => 1
}

The default is an empty hash.

The path prefix to RVM in a system-wide installation. The default is /usr/local/rvm.

A list of users that will be added to the rvm group. These users will then be able to manage RVM in a system-wide installation. The default is an empty list.

rvm_ruby "ree-1.8.7-2011.01" do
  action :install
end

rvm_ruby "jruby-1.5.6"

Note: the install action is default, so the second example is a more common usage.

rvm_ruby "ree-1.8.7-2011.01" do
  action :remove
end

Note: the RVM documentation mentions that this method is far preferred to using uninstall since it purges almost everything.

rvm_ruby "ree-1.8.7-2011.01" do
  action :uninstall
end

This resource sets the default RVM ruby, optionally with gemset. The given ruby will be installed if it isn't already and a gemset will be created in none currently exist. If multiple declarations are used then the last executed one "wins".

rvm_default_ruby "ree-1.8.7-2011.01" do
  action :create
end

rvm_default_ruby "jruby-1.5.6"

Note: the create action is default, so the second example is a more common usage.

This resource ensures that the specified RVM ruby is installed and the optional gemset is created. It is a convenience resource which wraps rvm_ruby and rvm_gemset so it can be used as a sort of über ruby resource which parallels the rvm_default_ruby resource.

rvm_environment "ree-1.8.7-2011.01@passenger"

See RVM gemsets for more background concerning gemsets.

rvm_gemset "rails" do
  ruby_string "ruby-1.9.2-p136"
  action      :create
end

rvm_gemset "ruby-1.9.2-p136@rails"

Note: the create action is default, so the second example is a more common usage.

rvm_gemset "jruby-1.6.0.RC2@development" do
  action :update
end

rvm_gemset "development" do
  ruby_string "jruby-1.6.0.RC2"
  action      :empty
end

rvm_gemset "ruby-1.9.2-p136@rails" do
  action :delete
end

This resource is a wrapper for the gem_package provider/resource which hijacks the gem_binary attribute to be RVM-aware. See the Opscode package resource and gem package options pages for more details.

rvm_gem "thor" do
  ruby_string "ruby-1.8.7-p330"
  action      :install
end

rvm_gem "json" do
  ruby_string "ruby-1.8.7-p330@awesome"
end

rvm_gem "nokogiri" do
  ruby_string "jruby-1.5.6"
  version     "1.5.0.beta.4"
  action      :install
end

Note: the install action is default, so the second example is a more common usage. Gemsets can also be specified.

rvm_gem "homesick" do
  action :upgrade
end

Note: the default RVM ruby will be targetted if no ruby_string attribute is given.

rvm_gem "nokogiri" do
  ruby_string "jruby-1.5.6"
  version     "1.4.4.2"
  action      :remove
end

This resource creates a wrapper script for a binary or list of binaries in a given RVM ruby (and optional gemset). The given ruby will be installed if it isn't already and a gemset will be created in none currently exist.

Note: only binary or binaries should be used by themselves (never at the same time).

rvm_wrapper "sys" do
  ruby_string   "jruby-1.5.6@utils"
  binary        "thor"
end

This will create a wrapper script called sys_thor in the bin directory under node[:rvm][:root_path].

rvm_wrapper "test" do
  ruby_string   "default@testing"
  binaries      [ "rspec", "cucumber" ]
  action        :create
end

Author:: Fletcher Nichol (fnichol@nichol.ca)

Contributors:: Bram Swenson (bram@craniumisajar.com)

Contributors:: Phil Cohen (http://phlippers.net/)

Copyright:: 2010, 2011, Fletcher Nichol

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.