RubyMine 5.4.0 Web Help

5.0+

Use this dialog box to define run/debug configuration for executing a custom Ruby gem.

The dialog box consists of the following tabs:

Click here for the description of the options that are common for all run/debug configurations.

Configuration tab

ItemDescription
Gem nameIn this field, type the name of the gem whose executable script will be run.
Note that basic code completion is available in this field:
Press Ctrl+SpaceCtrl+Space to show the available gems.
Executable nameIn this field, type the name of the script to be run.
Note that basic code completion is available in this field:
Press Ctrl+SpaceCtrl+Space to show the available gem executables.
ArgumentsIn this field, type the command line arguments of the script.
Working directorySpecify the current directory to be used by the running task. By default, the project directory is used as a working directory.
Environment variablesSpecify 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 box.
Ruby argumentsSpecify the arguments to be passed to the Ruby interpreter.
Path mappingsClick the browse button to define mapping between your local paths and the remote servers defined in advance.
Ruby SDKSpecify the desired Ruby interpreter. You can opt to choose the project default Ruby SDK, or select a different one from the drop-down list of configured Ruby SDKs.

Bundler tab

ItemDescription
Run the script in the context of the bundleIf this check box is selected, the script in question will be executed as specified in the gemfile.

Code Coverage tab

Use this tab to configure code coverage monitoring options.

ItemDescription
add Click this button to define the scope of code coverage analysis. In the Add Pattern dialog box 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 check box next to a pattern. By default, all newly created patterns are enabled.

deleteClick this button to delete the selected pattern from the list.
edit1Click this button to change the selected code coverage pattern.
Do not use the optimized C runtimeSelect this check box to enable the option --no-rcovrt. Use this option with discretion, since it significantly slows down performance.
Enable coverage in test folders.If this check box is selected, the folders marked as test rootTest are included in the code coverage analysis.

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.

ItemDescription
Is ActiveSelect check boxes in this column to have the log entries displayed in the corresponding tabs in the Run tool window or Debug tool window.
Log File EntryThe 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.

    Note

    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 ContentSelect this check box to have the previous content of the selected log skipped.
Save console output to fileSelect this check box 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 standard out changesSelect this check box to activate output console and bring it forward, if associated process writes to Standard.out.
Show console when standard error changesSelect this check box to activate output console and bring it forward, if associated process writes to Standard.err.
add 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.
edit1Click this button to edit the properties of the selected log file entry in the Edit Log Files Aliases dialog.
deleteClick this button to remove the selected log entry from the list.
browseButton.png Click this button to edit the select log file entry.

Note

The button is available only when an entry is selected.

Toolbar

ItemShortcutDescription
add InsertInsert Click this button to add new configuration to the list.
delete DeleteDelete Click this button to remove the selected configuration from the list.
copy Ctrl+DCtrl+D Click this button to create a copy of the selected configuration.
settings Edit defaultsClick this button to edit the default configuration templates. The defaults are used for the newly created configurations.
arrowUp or arrowDown Alt+UpAlt+Up or Alt+DownAlt+Down Use these buttons to move the selected configuration or group of configurations (folder) up and down in the list.

The order of configurations or folders in the list defines the order, in which configurations appear in the Run/Debug drop-down list on the main toolbar.

folder Use this button to create a new folder.

If one or more run/debug configurations have the focus, then the selected run/debug configurations 0 are automatically moved to the newly created folder. If only a category has the focus, then an empty folder is created.

Common options

ItemDescription
NameIn this text box, specify the name of the current run/debug configuration. This field does not appear for the default run/debug configurations.
Defaults This node in the left-hand pane of the dialog box contains the default run/debug configuration settings. Select the desired configuration to change its default settings in the right-hand pane. The defaults are applied to all newly created run/debug configurations.
Temporary configurations limit Specify here the maximum number of temporary configurations to be stored and shown in the Select Run/Debug Configuration drop-down list.
Share

This check box is not available when editing the run/debug configuration defaults.

Single instance onlyIf this check box is selected, this run/debug configuration cannot be launched more than once.

Every time a new run/debug configuration is launched, RubyMine checks the presence of the other instances of the same run/debug configuration, and displays a confirmation dialog box. If you click OK in the confirmation dialog box, the first instance of the runner will be stopped, and the next one will take its place.

This make sense, when usage of certain resources can cause conflicts, or when launching two run/debug configurations of the same type consumes too much of the CPU and memory resources.

If this check box is not selected, it is possible to launch as many instances of the runner as required. So doing, each runner will start in its own tab of the Run tool window.

Before launchIn this area, specify the actions to be performed prior to executing the current run/debug configuration.
ItemKeyboard shortcutDescription
addAlt+InsertAlt+Insert Click this button to add one of the tasks to be executed prior to launching the application. The possible tasks are:
  • 5.0+Run External tool: Add this task to have RubyMine launch the specified third-party tool prior to running or debugging. To appoint a tool to launch, select it in the External Tools dialog box that opens.
  • Run Rake task:Add a Rake task to be executed prior to running or debugging. To choose a Rake task, click the browse button browseButton, and select the desired task from the list of available tasks.

    Note that code completion is available here.

    runConfigRakeTask

    To learn more about Rake support, refer to Rake section.
  • 5.0+Run JRuby compiler: choose this option to execute JRuby compiler with the specified target path, compiler process heap size, and command line parameters (if any).
deleteAlt+DeleteAlt+Delete Click this button to remove selected task from the list.
edit1EnterEnter Click this button to open the selected task for editing.
arrowUp or arrowDownAlt+UpAlt+Up or Alt+DownAlt+Down Click these buttons to move the selected task one line up or down.

Note that Before launch actions are performed in the order they are specified in the run/debug configuration dialog.

Show this pageSelect this check box to always show the Edit Run/Debug Configuration dialog prior to launching the current run/debug configuration.
If this check box is not selected, run/debug configuration will be launched silently.

See Also

Concepts:

Procedures:

Web Resources: