Run/Debug Configuration: Ruby

Name

In this field, specify the name of the current run/debug configuration.

Ruby script

Specify the fully qualified path to a Ruby script to be executed, or click, and select the desired Ruby script in the dialog that opens.

Script arguments

Specify command-line arguments that will be passed after the script's filename. These arguments will be available to your Ruby program in the global ARGV array. For example:

1. Pass the following values as Script arguments: "Jet" "Brains".

2. Run the following Ruby script:

   puts "Hello, #{ARGV.join}! I'm Ruby!"

   A program will return Hello, JetBrains! I'm Ruby!.

Working directory

Specify the working directory used by the running task. For example, this option is in effect when the running script loads other scripts by relative paths.

Environment variables

Specify the list of environment variables as the name-value pairs, separated with semi-colons. Alternatively, click to create variables and specify their values in the Environment Variables dialog.

Ruby arguments

Specify the command-line arguments to be passed to the Ruby interpreter.

Ruby SDK

Specify the desired Ruby interpreter. You can choose the project default Ruby SDK, or select a different one from the list of configured Ruby SDKs.

Execute in the context of Rails

This option is available for scripts in Rails applications. You can enable it to run scratch or project Ruby scripts in the Rails context.

Learn more from Tutorial: Debug a script in Rails context.

Run the script in the context of the bundle ('bundle exec')

Running the script with Bundler ensures that the gem versions specified in the Gemfile will be used. Select one of the options:

• Auto-detection: select this option to run your code with bundle exec when it is possible.

  note

  When the Auto-detection option is enabled, RubyMine checks whether the following conditions are met:

  • Gemfile and Gemfile.lock are present

  • The version of the bundler gem specified in Gemfile.lock is also installed in the run/debug configuration's SDK

  In case either of these conditions isn't met, the executed command will remain without any changes.

• Disabled: select this option to disable the use of bundle exec.

Click this button to define the scope of code coverage analysis. In the Add Pattern dialog that opens, type the comma-delimited list of Ruby regular expressions, and specify whether the matching files should be included into or excluded from code coverage analysis.

The patterns defining files to be included into code coverage analysis, are marked with +; the ones to be excluded are marked with -.

Each pattern can be enabled or disabled. To do that, select or clear the checkbox next to a pattern. By default, all newly created patterns are enabled.

Click this button to delete the selected pattern from the list.

Click this button to change the selected code coverage pattern.

Do not use the optimized C runtime

Select this checkbox to enable the option --no-rcovrt. Use this option with discretion, since it significantly slows down performance.

Enable coverage in test folders

If this checkbox is selected, the folders marked as test are included in the code coverage analysis.

Is Active

Select checkboxes in this column to have the log entries displayed in the corresponding tabs in the Run tool window or Debug tool window.

Log File Entry

The read-only fields in this column list the log files to show. The list can contain:

• Full paths to specific files.

• Aliases to substitute for full paths or patterns. These aliases are also displayed in the headers of the tabs where the corresponding log files are shown.

  If a log entry pattern defines more than one file, the tab header shows the name of the file instead of the log entry alias.

Skip Content

Select this checkbox to have the previous content of the selected log skipped.

Save console output to file

Select this checkbox to save the console output to the specified location. Type the path manually, or click the browse button and point to the desired location in the dialog that opens.

Show console when a message is printed to standard output stream

Select this checkbox to activate the output console and bring it forward if an associated process writes to Standard.out.

Show console when a message is printed to standard error stream

Select this checkbox to activate the output console and bring it forward if an associated process writes to Standard.err.

Click this button to open the Edit Log Files Aliases dialog where you can select a new log entry and specify an alias for it.

Click this button to edit the properties of the selected log file entry in the Edit Log Files Aliases dialog.

Click this button to remove the selected log entry from the list.

Click this button to edit the select log file entry. The button is available only when an entry is selected.

Name

Specify a name for the run configuration to quickly identify it among others when editing or running.

Allow multiple instances

Allow running multiple instances of this run configuration in parallel.

By default, it is disabled, and when you start this configuration while another instance is still running, RubyMine suggests stopping the running instance and starting another one. This is helpful when a run configuration consumes a lot of resources and there is no good reason to run multiple instances.

Store as project file

Save the file with the run configuration settings to share it with other team members. The default location is .idea/runConfigurations. However, if you do not want to share the .idea directory, you can save the configuration to any other directory within the project.

By default, it is disabled, and RubyMine stores run configuration settings in .idea/workspace.xml.

AltInsert

Create a run/debug configuration.

AltDelete

Delete the selected run/debug configuration. Note that you cannot delete default configurations.

Ctrl0D

Create a copy of the selected run/debug configuration. Note that you create copies of default configurations.

The button is displayed only when you select a temporary configuration. Click this button to save a temporary configuration as permanent.

Move into new folder / Create new folder. You can group run/debug configurations by placing them into folders.

To create a folder, select the configurations within a category, click , and specify the folder name. If only a category is in focus, an empty folder is created.

Then, to move a configuration into a folder, between the folders or out of a folder, use drag or and buttons.

To remove grouping, select a folder and click .

Click this button to sort configurations in the alphabetical order.