Parent

Rcov::CodeCoverageAnalyzer

A CodeCoverageAnalyzer is responsible for tracing code execution and returning code coverage and execution count information.

Note that you must require 'rcov' before the code you want to analyze is parsed (i.e. before it gets loaded or required). You can do that by either invoking ruby with the -rrcov command-line option or just:

require 'rcov'
require 'mycode'
# ....

Example

analyzer = Rcov::CodeCoverageAnalyzer.new
analyzer.run_hooked do 
  do_foo  
  # all the code executed as a result of this method call is traced
end
# ....

analyzer.run_hooked do 
  do_bar
  # the code coverage information generated in this run is aggregated
  # to the previously recorded one
end

analyzer.analyzed_files   # => ["foo.rb", "bar.rb", ... ]
lines, marked_info, count_info = analyzer.data("foo.rb")

In this example, two pieces of code are monitored, and the data generated in both runs are aggregated. lines is an array of strings representing the source code of foo.rb. marked_info is an array holding false, true values indicating whether the corresponding lines of code were reported as executed by Ruby. count_info is an array of integers representing how many times each line of code has been executed (more precisely, how many events where reported by Ruby --- a single line might correspond to several events, e.g. many method calls).

You can have several CodeCoverageAnalyzer objects at a time, and it is possible to nest the run_hooked / install_hook/remove_hook blocks: each analyzer will manage its data separately. Note however that no special provision is taken to ignore code executed "inside" the CodeCoverageAnalyzer class. At any rate this will not pose a problem since it's easy to ignore it manually: just don't do

lines, coverage, counts = analyzer.data("/path/to/lib/rcov.rb")

if you're not interested in that information.

Public Class Methods

new() click to toggle source
# File lib/rcov/code_coverage_analyzer.rb, line 59
def initialize
  @script_lines__ = SCRIPT_LINES__
  super(:install_coverage_hook, :remove_coverage_hook,
        :reset_coverage)
end

Public Instance Methods

analyzed_files() click to toggle source

Return an array with the names of the files whose code was executed inside the block given to run_hooked or between install_hook and remove_hook.

# File lib/rcov/code_coverage_analyzer.rb, line 67
def analyzed_files
  update_script_lines__
  raw_data_relative.select do |file, lines|
    @script_lines__.has_key?(file)
  end.map{|fname,| fname}
end
data(filename) click to toggle source

Return the available data about the requested file, or nil if none of its code was executed or it cannot be found. The return value is an array with three elements:

lines, marked_info, count_info = analyzer.data("foo.rb")

lines is an array of strings representing the source code of foo.rb. marked_info is an array holding false, true values indicating whether the corresponding lines of code were reported as executed by Ruby. count_info is an array of integers representing how many times each line of code has been executed (more precisely, how many events where reported by Ruby --- a single line might correspond to several events, e.g. many method calls).

The returned data corresponds to the aggregation of all the statistics collected in each run_hooked or install_hook/remove_hook runs. You can reset the data at any time with reset to start from scratch.

# File lib/rcov/code_coverage_analyzer.rb, line 89
def data(filename)
  raw_data = raw_data_relative
  update_script_lines__
  unless @script_lines__.has_key?(filename) && 
         raw_data.has_key?(filename)
    return nil 
  end
  refine_coverage_info(@script_lines__[filename], raw_data[filename])
end
data_matching(filename_re) click to toggle source

Data for the first file matching the given regexp. See data.

# File lib/rcov/code_coverage_analyzer.rb, line 101
def data_matching(filename_re)
  raw_data = raw_data_relative
  update_script_lines__

  match = raw_data.keys.sort.grep(filename_re).first
  return nil unless match

  refine_coverage_info(@script_lines__[match], raw_data[match])
end
install_hook() click to toggle source

Start monitoring execution to gather code coverage and execution count information. Such data will be collected until remove_hook is called.

Use run_hooked instead if possible.

# File lib/rcov/code_coverage_analyzer.rb, line 119
def install_hook; super end
remove_hook() click to toggle source

Stop collecting code coverage and execution count information. remove_hook will also stop collecting info if it is run inside a run_hooked block.

# File lib/rcov/code_coverage_analyzer.rb, line 124
def remove_hook; super end
reset() click to toggle source

Remove the data collected so far. The coverage and execution count "history" will be erased, and further collection will start from scratch: no code is considered executed, and therefore all execution counts are 0. Right after reset, analyzed_files will return an empty array, and data(filename) will return nil.

# File lib/rcov/code_coverage_analyzer.rb, line 131
def reset; super end
run_hooked() click to toggle source

Execute the code in the given block, monitoring it in order to gather information about which code was executed.

# File lib/rcov/code_coverage_analyzer.rb, line 113
def run_hooked; super end

[Validate]

Generated with the Darkfish Rdoc Generator 2.