RubyMine 2026.3 Help

代码覆盖率

使用 RubyMine,您可以通过 SimpleCov 分析工具测量代码的测试覆盖率。 您可以为任何支持的 测试框架 运行带覆盖的测试,分析单独工具窗口和编辑器中覆盖的文件和代码行的百分比,生成 HTML 报告等。

配置覆盖运行选项

RubyMine 允许您使用特定的运行选项运行带覆盖的测试。 例如,您可以从覆盖测量中排除特定文件夹。 要提供特定的覆盖选项,您需要为测试创建运行配置。 运行配置可以通过以下两种方式创建:

为测试创建运行配置后,您可以通过以下方式配置覆盖选项:

  1. 按 Ctrl+Shift+A 并开始输入 编辑配置。 选择 编辑配置 并按 Enter。

    查找操作
  2. 在打开的 运行/调试配置 对话框中,选择所需的配置(例如, Rake、 Test::Unit/Shoulda/Minitest 或 RSpec ),转到 代码覆盖率 选项卡并指定所需的设置。

    运行/调试配置

运行配置的覆盖设置

选项

描述

"添加"按钮

定义代码覆盖分析的范围。 在打开的 添加模式 对话框中,输入以逗号分隔的 Ruby 正则表达式列表。 选择一种模式类型,定义匹配的文件是应包含在代码覆盖分析中还是排除在外。

示例: /配置/、 /bin/,/配置/

"添加"按钮

单击此按钮以从列表中删除选定的模式。

编辑按钮

单击此按钮以更改选定的代码覆盖模式。

在测试文件夹中启用覆盖率

启用此选项以在代码覆盖分析中包含测试文件夹(例如, test 或 规范 )。

启用分支覆盖率(SimpleCov >= 0.18)

使用此选项启用分支覆盖。 启用此选项后,您可以在编辑器中 查看结果 时看到部分覆盖的条件。

启用分叉进程的覆盖率(SimpleCov >= 0.19)

启用此选项以测量分叉进程的覆盖率。

配置覆盖测量

配置代码覆盖行为

  1. 按 Ctrl+Alt+S 打开设置,然后选择 构建、执行、部署 | 覆盖率。

  2. 定义如何处理收集的覆盖数据:

    • 在将覆盖应用到编辑器之前显示选项。 :每次运行新的带代码覆盖的运行配置时显示 代码覆盖率 对话框。

    • 不应用收集到的覆盖结果。},{ :丢弃新的代码覆盖结果。

    • 用新套件替换活动套件。 :丢弃活动套件,并在每次启动新的带代码覆盖的运行配置时使用新的套件。

    • 添加到活动套件中。 :每次启动新的带代码覆盖的运行配置时,将新的代码覆盖套件添加到活动套件中。

  3. 选中 激活覆盖视图。 复选框以自动打开 覆盖 工具窗口。

更改覆盖率高亮的颜色

  1. 按 Ctrl+Alt+S 打开设置,然后选择 编辑器 | 颜色方案 | 常规。

  2. 或者,在点击边距中的覆盖指示线时打开的弹出窗口中单击 编辑覆盖率颜色按钮。

  3. 在组件列表中,展开 行覆盖率 节点并选择一种覆盖类型:例如, 完全、 部分覆盖 或 未涵盖。

  4. 点击 前景色 字段以打开 选择颜色 对话框。

  5. 选择颜色,应用更改,然后关闭对话框。

配置代码覆盖率颜色

运行测试并生成覆盖率报告

RubyMine 允许您通过以下方式运行带覆盖的测试:

使用预定义配置运行带覆盖的测试

要使用已创建的 运行配置 运行带覆盖的测试,请执行以下操作之一:

  • 按 Alt+Shift+F10 ,选择所需的配置,按右箭头键,选择 覆盖 ,然后按 Enter。

  • 从主工具栏运行带覆盖的测试:

    1. 从主工具栏的列表中选择所需的运行配置。

    2. 单击 更多操作 在 运行小部件 中,然后选择 带覆盖运行。

      带覆盖运行

从项目视图运行带覆盖的测试

要从 Project 视图运行一个或多个带覆盖的测试,请执行以下操作:

  1. 右键单击特定的测试文件或包含所需测试的目录(例如, test 、 规范 或 功能 )。

  2. 从上下文菜单中选择相应的运行命令,例如, 运行“所有测试位于:<directory name>”并启用覆盖率。

从编辑器运行带覆盖的测试

要从编辑器运行测试,请执行以下步骤:

  1. 单击所需测试或测试类左侧边距中的 运行 按钮。

    运行特定测试
  2. 从上下文菜单中选择所需的运行命令,例如, 运行“<test name>”并启用覆盖率。

查看覆盖结果

在 运行测试 带覆盖后,RubyMine 以以下方式显示结果:

  • 在 Project 视图中。

    项目视图中的覆盖结果

    在这里,您可以浏览项目并检查覆盖的文件和代码行的百分比。

  • 在 覆盖 工具窗口中。

    专用工具窗口中的覆盖结果

    您可以启用 单击导航 选项以自动在编辑器中打开选定的文件。 生成覆盖报告 按钮允许您基于覆盖结果生成 HTML 报告。

  • 在编辑器中.

    使用边距中的颜色指示器检测未覆盖的代码行。

    编辑器中的覆盖结果

    要了解某行被命中多少次,请单击相应的颜色指示器。

    编辑器中的覆盖设置

    在打开的弹出窗口中,您可以单击 编辑覆盖颜色按钮 配置代码覆盖颜色,或通过单击 隐藏覆盖率 链接隐藏覆盖结果。 有关显示隐藏覆盖结果的更多信息,请参阅 覆盖套件。

覆盖套件

覆盖率套件是特定运行中的代码覆盖率数据集合。 每个覆盖率套件都会存储来自单个运行配置(如果该配置 使用覆盖率运行 )或 导入的覆盖率数据文件的数据。

RubyMine 将覆盖套件存储在 覆盖 文件夹中,该文件夹位于 IDE 系统目录:

%LOCALAPPDATA%\JetBrains\RubyMine%instance-version%\coverage

~/Library/Caches/JetBrains/RubyMine%instance-version%/coverage

~/.cache/JetBrains/RubyMine%instance-version%/coverage

RubyMine 可以同时显示一个或多个覆盖率套件的结果,您也可以选择要显示哪些套件。 如果选择了多个套件,IDE 会显示它们的合并结果: 这意味着,如果某一行至少在其中一个套件中被执行过,就会被视为已覆盖。

选择要显示的覆盖套件

至少执行一次 使用覆盖率运行后,覆盖率套件列表才会可用。

  1. 在主菜单中,转到 运行 | 管理覆盖率报告…… (Ctrl+Alt+F6)。

  2. 在打开的 选择要显示的覆盖率套件 对话框中,选择要显示其结果的套件。

    • 如果要隐藏所有代码覆盖率结果,请改为点击 无覆盖率。 这会取消选择所有覆盖率套件并关闭对话框。

    选择要显示的覆盖套件对话框
  3. 点击 显示所选项。

RubyMine 会加载所选套件的代码覆盖率结果。

添加和移除覆盖率套件

如果要查看在 RubyMine 外部生成的文件中的代码覆盖率结果(例如由构建服务器或其他开发者生成),可以将该文件添加为单独的覆盖率套件。

您还可以从 IDE 中移除套件,或从磁盘中彻底删除它们。

  1. 在主菜单中,转到 运行 | 管理覆盖率报告…… (Ctrl+Alt+F6)。

  2. 在打开的 选择要显示的覆盖率套件 对话框中,从工具栏中选择一个操作:

    • 要导入外部覆盖率文件,请点击 Add 并浏览查找该文件。

      默认情况下,由 RubyMine 生成的覆盖数据文件会保存到 覆盖 文件夹中,该文件夹位于 IDE 系统目录。

    • 要从 IDE 中移除覆盖率套件但将其保留在磁盘上,请选择该套件并点击 "移除"按钮移除。

    • 要从 IDE 和磁盘中删除覆盖率套件,请选择该套件并点击 删除按钮删除。

生成 HTML 报告

RubyMine 允许您为 收集的覆盖结果 生成 HTML 报告。

  1. 在主菜单中,转到 运行 | 生成覆盖率报告 ,或单击 生成覆盖率报告按钮 在 覆盖 工具窗口中。

  2. 在 生成覆盖报告 对话框中,指定生成的报告将存储的目录。 可选地,选择 在浏览器中打开生成的 HTML。 点击 保存。

2026年 11月 9日