With RubyMine, you can measure how much of your code is covered with tests using the SimpleCov analysis tool. You can run tests with coverage for any supported testing framework, analyze the percentage of covered files and lines in a separate tool window and editor, generate HTML reports, and so on.
Before using code coverage in RubyMine, make sure that:
Configure coverage run options
RubyMine allows you to run tests with coverage using specific run options. For example, you can exclude particular folders from coverage measurement. To provide specific coverage options, you need to have a run configuration for tests. A run configuration can be created in two ways:
After creating a run configuration for tests, you can configure coverage options in the following way:
Press Ctrl+Shift+A and start typing edit configurations. Select Edit Configurations and press Enter.
In the opened Run/Debug Configurations dialog, select the required configuration (for example, Rake, Test::Unit/Shoulda/Minitest, or RSpec), go to the Code Coverage tab and specify the desired settings.
The following settings are available:
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.
Click this button to delete the selected pattern from the list.
Click this button to change the selected code coverage pattern.
Enable coverage in test folders.
Enable this option to include test folders (for example, test or spec) in code coverage analysis.
Run tests with coverage
RubyMine allows you to run tests with coverage in the following ways:
Run tests with coverage using a predefined configuration
To run the tests with coverage using the already created run configuration, do one of the following:
Press Shift+Alt+F10, select the required configuration, press the right arrow key, select Cover, and press Enter.
To run tests with coverage from the main toolbar:
Select the required run configuration from the list on the main toolbar.
Click the button on the right.
Run tests with coverage from the Project view
To run a test or multiple tests with coverage from the Project view, do the following:
Right-click a specific test file or a directory containing the required tests (for example, test, spec, or features).
From the context menu, select the corresponding run command, for example,.
Run tests with coverage from the editor
To run tests from the editor, perform the following steps:
Click the Run button on the left gutter next to the required test or test class.
From the context menu, select the required run command, for example,.
RubyMine will run tests and display results in the Run tool window. Coverage results will be displayed in several places: the Coverage tool window, editor, and Project view. Learn more at View coverage results.
View coverage results
After running tests with coverage, RubyMine displays results in the following ways:
In the Project view.
Here you can navigate through a project and examine the percentage of covered files and lines.
In the Coverage tool window.
You can enable the option to open a selected file in the editor automatically. The button allows you to generate an HTML report based on coverage results.
In the editor.
Use the color indicators in the left gutter to detect the uncovered lines of code.
To find out how many times a line has been hit, click the corresponding color indicator.
In the opened popup, you can click to configure code coverage colors or hide coverage results by clicking the Hide coverage link. To learn how to display hidden coverage results, see Manage coverage results.
Manage coverage results
After you run tests with coverage, RubyMine saves the results in a coverage suite. Coverage suites allow you to display or hide specific coverage results, merge several reports, and remove unnecessary results.
View coverage results from specific suites
From the main menu, selectCtrl+Alt+F6.
In the Choose Coverage Suite to Display dialog, select or deselect the desired suites, and click Show selected.
RubyMine opens coverage results for the selected test suites.
Add the coverage suite from a file
Consider a situation when a file that contains code coverage information has been obtained from another computer. You can load this file from disk and review coverage results.
From the main menu, selectCtrl+Alt+F6.
Click and select the necessary .rcov file in the dialog that opens.
Generate HTML report
RubyMine allows you to generate an HTML report for the collected coverage results.
To do this, follow the steps below:
From the main menu, select Coverage tool window., or click in the
In the Generate Coverage Report dialog, specify the directory where the generated report will be stored. Optionally, select Open generated HTML in browser. Click Save.