singleton method Coverage.setup

カバレッジの測定の準備をします。

このメソッド自体は測定を開始しません。測定を開始するには Coverage.resume を使います。準備と開始を同時に行いたい場合は Coverage.start を使ってください。

[PARAM] mode:

:all を指定すると、lines、branches、methods、eval の全てを計測対象にします。省略した場合は行カバレッジのみが対象になります。

[PARAM] lines:

真を指定すると行カバレッジを計測対象にします。

[PARAM] branches:

真を指定すると分岐カバレッジを計測対象にします。

[PARAM] methods:

真を指定するとメソッドカバレッジを計測対象にします。

[PARAM] eval:

真を指定すると eval カバレッジを計測対象にします。(Ruby 3.2 で追加されたキーワード引数です)

[PARAM] oneshot_lines:

真を指定すると、行カバレッジを 1 度でも実行されたかどうかだけを記録するモード(coverage ライブラリ参照)で計測対象にします。lines と同時には指定できません。

[EXCEPTION] RuntimeError:

既に Coverage.setup 済みの状態で、対象とするモードが異なる引数で呼び出した場合に発生します。

require "coverage"
Coverage.setup(lines: true)
p Coverage.state  # => :suspended
Coverage.resume

[SEE_ALSO] Coverage.resume, Coverage.start