class Coverage

要約

カバレッジを測定する機能を提供するクラスです。

実験的な機能のため、APIは将来変更になる可能性があります。

目次

特異メソッド

• peek_result
• result
• running?
• start

特異メソッド

peek_result -> Hash[permalink][rdoc][edit]

測定途中結果をファイル名をキー、各行の実行回数を配列にした値のハッシュを返します。空行やコメントのみの行などの測定結果は nil になります。

[RETURN]

測定途中結果を表すハッシュ

[EXCEPTION] RuntimeError:

Coverage.start を実行する前に実行された場合に発生します。

[SEE_ALSO] Coverage.result

result -> Hash[permalink][rdoc][edit]

測定結果をファイル名をキー、各行の実行回数を配列にした値のハッシュを返します。空行やコメントのみの行などの測定結果は nil になります。result メソッドが実行された後はカバレッジの測定を行いません。

[RETURN]

測定結果を表すハッシュ

[EXCEPTION] RuntimeError:

Coverage.start を実行する前に実行された場合に発生します。

[SEE_ALSO] Coverage.peek_result

running? -> bool[permalink][rdoc][edit]

カバレッジ測定中かどうかを返します。

require 'coverage'
p Coverage.running?    #=> false
Coverage.start
p Coverage.running?    #=> true
p Coverage.peek_result #=> {}
p Coverage.running?    #=> true
p Coverage.result      #=> {}
p Coverage.running?    #=> false

start -> nil[permalink][rdoc][edit]

カバレッジの測定を開始します。既に実行されていた場合には何も起こりません。