Run/Debug Configuration: Rails
Rails run/debug configurations enable you to execute Rails applications in the selected environment.
In this section:
- Configuration tab
- Trinidad and Torquebox notes
- Unicorn note
- Bundler tab
- Code Coverage tab
- Nailgun tab
- Logs tab
- Common options
- Before Launch options
Before you start working with Ruby, make sure that Ruby plugin is installed and enabled.
Also make sure that the following prerequisites are met:
Ruby SDK is downloaded and installed on your machine.
The required framework SDKs are downloaded and installed on your machine.
Refer to their respective download and installation pages for details:
|Select the Rails server to run or debug your Rails application on. |
The list of available servers includes:
Trinidad and Torquebox notes
Note that unicorn kills worker processes that are taking too long to respond. To avoid error messages, add the following lines to the unicorn configuration file
Specify the IP address where the Rails server will be accessible.
Specify the port to listen to.
Type optional server arguments.
Select one of the Rails environments from the drop-down list (development, production, or test).
This field is only enabled for the Rails mountable engine projects. Specify here the absolute path to the
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 box.
|Specify the arguments to be passed to the Ruby interpreter. |
Classpath property is added to Nailgun settings.
Specify 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.
If this checkbox is selected, a new tab will be added to your system default browser, where the application will be run or debugged. You can specify the required URL in the text field below, or use the one suggested by IntelliJ IDEA. Note that the default URL is automatically composed on the base of the IP address and port specified above.
Run the script in the context of the bundle
If this check box is selected, the script in question will be executed as specified in the
Code Coverage tab
Use this tab to configure code coverage monitoring options.
Choose coverage runner
Select the desired code coverage runner.
Select this option to measure code coverage with minimal slow-down.
Select this option to collect accurate branch coverage. This mode is available for the IntelliJ IDEA code coverage runner only.
Track per test coverage
Select this check box to detect lines covered by one test and all tests covering line. If this check box is selected, becomes available on the toolbar of the coverage statistic pop-up window.
Refer to the section : view JUnit tests that cover the line at caret. .
Packages and classes to record code coverage data
Click and buttons to specify classes and packages to be measured. You can also remove classes and packages from the list by selecting them in the list and clicking the button.
Enable coverage in test folders.
If this check box is selected, the folders marked as test are included in the code coverage analysis.
Run new instance of the Nailgun server, or use already started one
|This check box is only available for JRuby used as the project interpreter. |
When a run/debug configuration, with this check box selected, is launched, IntelliJ IDEA analyzes the running processes, and does one of the following, depending on the presence of the running Nailgun server:
If this check box is not selected, then the script is launched in a usual way, without Nailgun.
Log File Entry
The read-only fields in this column list the log files to show. The list can contain:
Select this check box to have the previous content of the selected log skipped.
Save console output to file
Select 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 a message is printed to standard output stream
Select this check box 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 check box 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.
When you edit a run configuration (but not a run configuration template), you can specify the following options for it:
In this text box, 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).
| Select this check box to make the run/debug configuration available to other team members. |
If the directory-based project format is used, the settings for a run/debug configuration are stored in a separate .xml file in the
If the file-based format is used, the settings are stored in the
Single instance only
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.
Create a run/debug configuration.
Delete the selected run/debug configuration. Note that you cannot delete default configurations.
Create a copy of the selected run/debug configuration. Note that you create copies of default configurations.
View and edit the default template for the selected run/debug configuration. The templates are used for newly created configurations.
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 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-and-drop or and buttons.
To remove grouping, select a folder and click .
Click this button to sort configurations in the alphabetical order.
Under the Templates node in the tree view of run configurations, you can select a run configuration template and edit its default settings. This will not affect the configurations that are already created, but will be used as defaults when creating new configurations of the corresponding type.
When you select the Templates node itself, you will be able to adjust general settings that apply to all run/debug configurations:
Configurations available in Run Dashboard
In this section you can create a list of run configurations available in the Run Dashboard — a tool window that helps you execute and manage multiple run/debug configurations.
Note that the dashboard will only display the configuration types for which you have created one ore more configurations.
Confirm rerun with process termination
|The behavior of this checkbox depends on whether the Single instance only option is selected for a particular run/debug configuration. |
Temporary configurations limit
Specify the maximum number of temporary configurations to be stored and shown in the Select Run/Debug Configuration drop-down list.
Before Launch options
In this area you can specify tasks that must be be performed before starting the selected run/debug configuration. The tasks are performed in the order they appear in the list.
Click this icon to add one of the following available tasks:
Click this icon to remove the selected task from the list.
Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.
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
Otherwise, 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.