RubyMine 2016.2 Help

Configuring Ruby SDK

In this section:


In RubyMine, you can define several Ruby SDKs. So doing, you can choose the one to be used in your project, from the list of the interpreters available on your machine.

RubyMine supports:

  • Standard Ruby SDKs
  • IronRuby
  • MacRuby

Ruby SDKs can be configured on the following levels:

  • Current project: selected Ruby interpreter will be used for the current project.

    Configuring Ruby SDK on this level is described below.

  • New project: selected Ruby interpreter will be used for the new project instead of the default one.

    Refer to the section Creating Rails-Based Projects for details.

Configuring Ruby SDK for the selected project

To configure Ruby SDK for the current project, follow these steps:

  1. Open the Settings dialog box, and click Ruby SDK and Gems.
  2. If there is more than one project opened in the same window, select the one you want to define a Ruby SDK for.
  3. If all the desired Ruby SDKs are already installed and added to your project, select one from the list of Ruby SDKs, using the check button.

    If the desired Ruby SDK is missing from the list of available SDKs, click add:

    • For the *nix platforms, select from the available rvm SDK's and their gem sets, which enables you to switch between the various independent sandboxes. To do that, select the desired interpreter - gem set pair from the list of Ruby SDKs. Refer to RVM Support for the details of creating the interpreter - gem set pairs, and to the descriptions of *nix-specific controls.

      For the non-*nix platforms, choose one from the Select Interpreter Path list, which shows the SDKs that are included in the PATH variable, but has not yet been added to your project.

    • The name of the Ruby interpreter should contain ruby or ir substring. Otherwise, the selected file will not be recognized as the proper Ruby SDK, and RubyMine will display the following error message:
      The selected file is not a valid home for Ruby SDK.
  4. If you are using JRuby, select version from the Language level drop-down list:

    Important notes for JRuby users:

    • jruby.bat is no longer supported, since it causes erratic behaviour for tools that try to spawn new ruby instance (e.g. Rake)
    • Language level cannot be selected for JRuby versions 9.0 and higher.
  5. In the Installed Gems section, RubyMine displays the list of gems that are currently installed on your computer. For each of the installed gems, you can view its version and description.

    Note that RubyMine smartly renders gems' documentation.

    If some gems are missing, or outdated, click add or refresh buttons. Refer to the section Resolving References to Missing Gems.

  6. Apply changes.

See Also

Last modified: 30 November 2016