Coverage предоставляет функцию измерения покрытия для Ruby. Эта функция экспериментальная, поэтому эти API могут быть изменены в будущем.

Использование

1. require “coverage”

2. выполнить Coverage.start

3. загрузить или открыть исходный файл 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=>{}}}