Coverage 模块

Coverage 为 Ruby 提供覆盖率测量功能。此功能为实验性功能，因此这些 API 可能会在未来发生变化。

警告：目前仅支持进程全局覆盖率测量。您无法测量每个线程的覆盖率。

用法 ↑

  1. require “coverage”

  2. do Coverage.start

  3. require 或加载 Ruby 源文件

  4. Coverage.result 将返回一个哈希，其中包含文件名作为键，覆盖率数组作为值。覆盖率数组为每行提供解释器执行的行数。nil 值表示此行已禁用覆盖率（如 else 和 end 等行）。

示例 ↑

[foo.rb]
s = 0
10.times do |x|
  s += x
end

if s == 45
  p :ok
else
  p :ng
end
[EOF]

require "coverage"
Coverage.start
require "foo.rb"
p Coverage.result  #=> {"foo.rb"=>[1, 1, 10, nil, nil, 1, 1, nil, 0, nil]}

行 Coverage ↑

如果在启动覆盖率时未明确指定覆盖率模式，则将运行行覆盖率。它报告每行的行执行次数。

require "coverage"
Coverage.start(lines: true)
require "foo.rb"
p Coverage.result #=> {"foo.rb"=>{:lines=>[1, 1, 10, nil, nil, 1, 1, nil, 0, nil]}}

行覆盖率结果的值是一个数组，其中包含每行执行的次数。此数组中的顺序很重要。例如，此数组中的第一个项目（在索引 0 处）报告在运行覆盖率期间此文件中的第 1 行执行了多少次（在此示例中，为一次）。

nil 值表示此行已禁用覆盖率（如 else 和 end 等行）。

一次性行 Coverage ↑

一次性行覆盖率跟踪并报告在运行覆盖率期间执行的行。它不会报告某行执行了多少次，只会报告它已执行。

require "coverage"
Coverage.start(oneshot_lines: true)
require "foo.rb"
p Coverage.result #=> {"foo.rb"=>{:oneshot_lines=>[1, 2, 3, 6, 7]}}

一次性行覆盖率结果的值是一个数组，其中包含已执行的行号。

分支 Coverage ↑

分支覆盖率报告每个条件中每个分支执行的次数。

require "coverage"
Coverage.start(branches: true)
require "foo.rb"
p Coverage.result #=> {"foo.rb"=>{:branches=>{[:if, 0, 6, 0, 10, 3]=>{[:then, 1, 7, 2, 7, 7]=>1, [:else, 2, 9, 2, 9, 7]=>0}}}}

分支哈希中的每个条目都是一个条件，其值是另一个哈希，其中每个条目都是该条件中的一个分支。这些值是该方法执行的次数，而键是有关分支的识别信息。

构成识别分支或条件的每个键的信息如下，从左到右

  1. 分支或条件类型的标签。

  2. 唯一标识符。

  3. 它在文件中出现的起始行号。

  4. 它在文件中出现的起始列号。

  5. 它在文件中出现的结束行号。

  6. 它在文件中出现的结束列号。

方法 Coverage ↑

方法覆盖率报告每个方法执行的次数。

[foo_method.rb]
class Greeter
  def greet
    "welcome!"
  end
end

def hello
  "Hi"
end

hello()
Greeter.new.greet()
[EOF]

require "coverage"
Coverage.start(methods: true)
require "foo_method.rb"
p Coverage.result #=> {"foo_method.rb"=>{:methods=>{[Object, :hello, 7, 0, 9, 3]=>1, [Greeter, :greet, 2, 2, 4, 5]=>1}}}

方法哈希中的每个条目都表示一个方法。此哈希中的值是该方法执行的次数，而键是有关该方法的识别信息。

构成识别方法的每个键的信息如下，从左到右

  1. 类。

  2. 方法名称。

  3. 该方法在文件中出现的起始行号。

  4. 该方法在文件中出现的起始列号。

  5. 该方法在文件中出现的结束行号。

  6. 该方法在文件中出现的结束列号。

所有 Coverage 模式 ↑

您还可以使用此快捷方式同时运行所有覆盖率模式。请注意，运行所有覆盖率模式不会同时运行行和一次性行。这些模式无法同时运行。在这种情况下，将运行行覆盖率，因为您仍然可以使用它来确定是否执行了某行。

require "coverage"
Coverage.start(:all)
require "foo.rb"
p Coverage.result #=> {"foo.rb"=>{:lines=>[1, 1, 10, nil, nil, 1, 1, nil, 0, nil], :branches=>{[:if, 0, 6, 0, 10, 3]=>{[:then, 1, 7, 2, 7, 7]=>1, [:else, 2, 9, 2, 9, 7]=>0}}, :methods=>{}}}

公共类方法

line_stub(file) 单击以切换源 
# File ext/coverage/lib/coverage.rb, line 4
def self.line_stub(file)
  lines = File.foreach(file).map { nil }
  iseqs = [RubyVM::InstructionSequence.compile_file(file)]
  until iseqs.empty?
    iseq = iseqs.pop
    iseq.trace_points.each {|n, type| lines[n - 1] = 0 if type == :line }
    iseq.each_child {|child| iseqs << child }
  end
  lines
end
peek_result → 哈希 单击以切换源

返回一个哈希，其中包含文件名作为键，覆盖率数组作为值。这与“Coverage.result(stop: false, clear: false)”相同。

{
  "file.rb" => [1, 2, nil],
  ...
}
static VALUE
rb_coverage_peek_result(VALUE klass)
{
    VALUE coverages = rb_get_coverages();
    VALUE ncoverages = rb_hash_new();
    if (!RTEST(coverages)) {
        rb_raise(rb_eRuntimeError, "coverage measurement is not enabled");
    }
    OBJ_WB_UNPROTECT(coverages);
    st_foreach(RHASH_TBL_RAW(coverages), coverage_peek_result_i, ncoverages);

    if (current_mode & COVERAGE_TARGET_METHODS) {
        rb_objspace_each_objects(method_coverage_i, &ncoverages);
    }

    rb_hash_freeze(ncoverages);
    return ncoverages;
}
result(stop: true, clear: true) → 哈希 单击以切换源

返回一个哈希，其中包含文件名作为键，覆盖率数组作为值。如果clear为 true，则将计数器清零。如果stop为 true，则禁用覆盖率测量。

static VALUE
rb_coverage_result(int argc, VALUE *argv, VALUE klass)
{
    VALUE ncoverages;
    VALUE opt;
    int stop = 1, clear = 1;

    if (current_state == IDLE) {
        rb_raise(rb_eRuntimeError, "coverage measurement is not enabled");
    }

    rb_scan_args(argc, argv, "01", &opt);

    if (argc == 1) {
        opt = rb_convert_type(opt, T_HASH, "Hash", "to_hash");
        stop = RTEST(rb_hash_lookup(opt, ID2SYM(rb_intern("stop"))));
        clear = RTEST(rb_hash_lookup(opt, ID2SYM(rb_intern("clear"))));
    }

    ncoverages = rb_coverage_peek_result(klass);
    if (stop && !clear) {
        rb_warn("stop implies clear");
        clear = 1;
    }
    if (clear) {
        rb_clear_coverages();
        if (!NIL_P(me2counter)) rb_hash_foreach(me2counter, clear_me2counter_i, Qnil);
    }
    if (stop) {
        if (current_state == RUNNING) {
            rb_coverage_suspend(klass);
        }
        rb_reset_coverages();
        me2counter = Qnil;
        current_state = IDLE;
    }
    return ncoverages;
}
resume → nil 单击以切换源

启动/恢复覆盖率测量。

警告：目前，仅支持进程全局覆盖率测量。您无法测量每个线程的覆盖率。如果您的进程有多个线程，使用 Coverage.resume/suspend 来捕获仅从有限代码块执行的代码覆盖率，可能会产生误导性结果。

VALUE
rb_coverage_resume(VALUE klass)
{
    if (current_state == IDLE) {
        rb_raise(rb_eRuntimeError, "coverage measurement is not set up yet");
    }
    if (current_state == RUNNING) {
        rb_raise(rb_eRuntimeError, "coverage measurement is already running");
    }
    rb_resume_coverages();
    current_state = RUNNING;
    return Qnil;
}
running? → bool 点击切换源代码

如果当前正在收集覆盖率统计信息（在调用 Coverage.start 之后，在调用 Coverage.result 之前），则返回 true

static VALUE
rb_coverage_running(VALUE klass)
{
    return current_state == RUNNING ? Qtrue : Qfalse;
}
setup → nil 点击切换源代码
setup(:all) → nil
setup(lines: bool, branches: bool, methods: bool, eval: bool) → nil
setup(oneshot_lines: true) → nil

Set 设置覆盖率测量。

请注意，此方法本身不会启动测量。使用 Coverage.resume 启动测量。

您可能需要使用 Coverage.start 设置，然后启动测量。

static VALUE
rb_coverage_setup(int argc, VALUE *argv, VALUE klass)
{
    VALUE coverages, opt;
    int mode;

    if (current_state != IDLE) {
        rb_raise(rb_eRuntimeError, "coverage measurement is already setup");
    }

    rb_scan_args(argc, argv, "01", &opt);

    if (argc == 0) {
        mode = 0; /* compatible mode */
    }
    else if (opt == ID2SYM(rb_intern("all"))) {
        mode = COVERAGE_TARGET_LINES | COVERAGE_TARGET_BRANCHES | COVERAGE_TARGET_METHODS | COVERAGE_TARGET_EVAL;
    }
    else {
        mode = 0;
        opt = rb_convert_type(opt, T_HASH, "Hash", "to_hash");

        if (RTEST(rb_hash_lookup(opt, ID2SYM(rb_intern("lines")))))
            mode |= COVERAGE_TARGET_LINES;
        if (RTEST(rb_hash_lookup(opt, ID2SYM(rb_intern("branches")))))
            mode |= COVERAGE_TARGET_BRANCHES;
        if (RTEST(rb_hash_lookup(opt, ID2SYM(rb_intern("methods")))))
            mode |= COVERAGE_TARGET_METHODS;
        if (RTEST(rb_hash_lookup(opt, ID2SYM(rb_intern("oneshot_lines"))))) {
            if (mode & COVERAGE_TARGET_LINES)
                rb_raise(rb_eRuntimeError, "cannot enable lines and oneshot_lines simultaneously");
            mode |= COVERAGE_TARGET_LINES;
            mode |= COVERAGE_TARGET_ONESHOT_LINES;
        }
        if (RTEST(rb_hash_lookup(opt, ID2SYM(rb_intern("eval")))))
            mode |= COVERAGE_TARGET_EVAL;
    }

    if (mode & COVERAGE_TARGET_METHODS) {
        me2counter = rb_ident_hash_new();
    }
    else {
        me2counter = Qnil;
    }

    coverages = rb_get_coverages();
    if (!RTEST(coverages)) {
        coverages = rb_hash_new();
        rb_obj_hide(coverages);
        current_mode = mode;
        if (mode == 0) mode = COVERAGE_TARGET_LINES;
        rb_set_coverages(coverages, mode, me2counter);
        current_state = SUSPENDED;
    }
    else if (current_mode != mode) {
        rb_raise(rb_eRuntimeError, "cannot change the measuring target during coverage measurement");
    }

    return Qnil;
}
start → nil 点击切换源代码
start(:all) → nil
start(lines: bool, branches: bool, methods: bool, eval: bool) → nil
start(oneshot_lines: true) → nil

启用覆盖率测量。请详细参阅 Coverage 类的文档。这等同于 Coverage.setup 和 Coverage.resume。

static VALUE
rb_coverage_start(int argc, VALUE *argv, VALUE klass)
{
    rb_coverage_setup(argc, argv, klass);
    rb_coverage_resume(klass);
    return Qnil;
}
state → :idle, :suspended, :running 点击切换源代码

返回覆盖率测量的状态。

static VALUE
rb_coverage_state(VALUE klass)
{
    switch (current_state) {
        case IDLE: return ID2SYM(rb_intern("idle"));
        case SUSPENDED: return ID2SYM(rb_intern("suspended"));
        case RUNNING: return ID2SYM(rb_intern("running"));
    }
    return Qnil;
}
supported?(mode) → true or false 点击切换源代码

如果给定模式支持覆盖率测量，则返回 true。

模式应该是以下符号之一：:lines、:oneshot_lines、:branches、:methods、:eval。

示例

Coverage.supported?(:lines)  #=> true
Coverage.supported?(:all)    #=> false

static VALUE
rb_coverage_supported(VALUE self, VALUE _mode)
{
    ID mode = RB_SYM2ID(_mode);

    return RBOOL(
        mode == rb_intern("lines") ||
        mode == rb_intern("oneshot_lines") ||
        mode == rb_intern("branches") ||
        mode == rb_intern("methods") ||
        mode == rb_intern("eval")
    );
}
suspend → nil 点击切换源代码

暂停覆盖率测量。您可以使用 Coverage.resume 重新启动测量。

VALUE
rb_coverage_suspend(VALUE klass)
{
    if (current_state != RUNNING) {
        rb_raise(rb_eRuntimeError, "coverage measurement is not running");
    }
    rb_suspend_coverages();
    current_state = SUSPENDED;
    return Qnil;
}