Run/Debug Configuration: Ruby
Use this dialog box to define run/debug configuration for a Ruby script.
In this section:
- Configuration tab
- Bundler tab
- Code Coverage tab
- Nailgun tab
- Logs tab
- Common options
- Toolbar
- Before Launch options
Configuration tab
Item | Description |
---|---|
Name | In this text box, 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 and select the desired Ruby script in the dialog that opens. |
Script arguments | Type the optional arguments to be passed to the Ruby script. |
Working directory | Specify the current directory to be used by the running task. By default, the project directory is used as a working directory. |
Environment variables | Specify the list of environment variables as the name-value pairs, separated with semi-colons. Alternatively, click the ellipsis button to create variables and specify their values in the Environment Variables dialog. |
Ruby arguments | Specify the arguments to be passed to the Ruby interpreter. Note that when JRuby is used as the project interpreter, the list of Ruby arguments can include Nailgun argument
Classpath property is added to Nailgun settings. |
Ruby SDK | Specify the desired Ruby interpreter. You can opt to choose the project default Ruby SDK, or select a different one from the list of configured Ruby SDKs. |
Bundler tab
Item | Description |
---|---|
Run the script in the context of the bundle | If this checkbox is selected, the script will be executed as specified in the Gemfile. |
Code Coverage tab
Use this tab to configure code coverage monitoring options.
Item | Description |
---|---|
| 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 |
Enable coverage in test folders. | If this checkbox is selected, the folders marked as test are included in the code coverage analysis. |
Nailgun tab
Item | Description |
---|---|
Run new instance of the Nailgun server, or use already started one | This checkbox is only available for JRuby used as the project interpreter. When a run/debug configuration, with this checkbox selected, is launched, RubyMine analyzes the running processes, and does one of the following, depending on the presence of the running Nailgun server:
If this checkbox is not selected, then the script is launched in a usual way, without Nailgun. |
Logs tab
Use this tab to specify which log files generated while running or debugging should be displayed in the console, that is, on the dedicated tabs of the Run or Debug tool window.
Item | Description |
---|---|
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:
|
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. |
Common options
When you edit a run configuration (but not a run configuration template), you can specify the following options:
Item | Description |
---|---|
Name | In this field, specify the name for the run/debug configuration. The name will help you identify the created configuration when you choose to edit it later, or when you invoke it, for example, from the Run popup (Shift+Alt+F10). |
Share | Select this checkbox to make the run/debug configuration available to other team members. The shared run/debug configurations are kept in separate xml files under .idea\runConfigurations folder, while the local run/debug configurations are kept in the .idea\workspace.xml. |
Allow running in parallel | If this checkbox is selected, it is possible to launch a run configuration multiple times in parallel instead of rerunning it. Each runner will start in its own tab of the Run Tool Window or Debug Tool Window. When disabled, every time a new instance of the run/debug configuration is launched, RubyMine checks the presence of the other instances of the same run/debug configuration, and displays a confirmation dialog. If you click OK in the confirmation dialog, the first instance of the runner will be stopped, and the next one will take its place. This makes sense when launching two instances of run/debug configurations of the same type consumes too much of the CPU and memory resources.. |
Toolbar
The tree view of run/debug configurations has a toolbar that helps you manage configurations available in your project as well as adjust default configurations templates.
Item | Shortcut | Description |
---|---|---|
Alt+Insert | Create a run/debug configuration. | |
Alt+Delete | Delete the selected run/debug configuration. Note that you cannot delete default configurations. | |
| Ctrl+D | Create a copy of the selected run/debug configuration. Note that you create copies of default configurations. |
| Edit Templates | View and edit the default template for the selected run/debug configuration. The templates are used for newly created configurations. |
/ | Alt+Up/Alt+Down | Move the selected run/debug configuration up and down in the list. The order of configurations in the list defines the order, in which the configurations appear when you choose a run/debug configuration. Default templates of run/debug configurations are always sorted alphabetically. |
| 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 . |
| Sort configurations | Click this button to sort configurations in the alphabetical order. |
Before Launch options
In this area you can specify tasks that must be performed before starting the selected run/debug configuration. The tasks are performed in the order they appear in the list.
Item | Shortcut | Description |
---|---|---|
Alt+Insert | Click this icon to add one of the following available tasks:
| |
Alt+Delete | Click this icon to remove the selected task from the list. | |
| Enter | Click this icon to edit the selected task. Make the necessary changes in the dialog that opens. |
/ | Alt+Up/Alt+Down | Click these icons to move the selected task one line up or down in the list. (The tasks are performed in the order that they appear in the list.) |
Show this page | Select this checkbox to show the run/debug configuration settings prior to actually starting the run/debug configuration. | |
Activate tool window | By default this checkbox is selected and the Run or the Debug tool window opens when you start the run/debug configuration. Otherwise, if the checkbox is cleared, the tool window isn't shown. However, when the configuration is running, you can open the corresponding tool window for it yourself by pressing Alt+4 or Alt+5. |