Class: Rcov::CodeCoverageAnalyzer

Inherits:
DifferentialAnalyzer show all
Defined in:
lib/rcov/code_coverage_analyzer.rb

Overview

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.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ CodeCoverageAnalyzer

Returns a new instance of CodeCoverageAnalyzer.



59
60
61
62
63
 
# 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

Class Method Details

.hook_level ⇒ Object

defined this way instead of attr_accessor so that it’s covered



51
52
53
 
# File 'lib/rcov/code_coverage_analyzer.rb', line 51

def self.hook_level      # :nodoc:
  @hook_level 
end

.hook_level=(x) ⇒ Object

:nodoc:



55
56
57
 
# File 'lib/rcov/code_coverage_analyzer.rb', line 55

def self.hook_level=(x)  # :nodoc: 
  @hook_level = x 
end

Instance Method Details

#analyzed_files ⇒ Object

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.



67
68
69
70
71
72
 
# 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) ⇒ Object

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.



89
90
91
92
93
94
95
96
97
 
# 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) ⇒ Object

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



101
102
103
104
105
106
107
108
109
 
# 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

#dump_coverage_info(formatters) ⇒ Object

:nodoc:



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/rcov/code_coverage_analyzer.rb', line 133

def dump_coverage_info(formatters) # :nodoc:
  correct_script_lines__
  update_script_lines__
  raw_data_relative.each do |file, lines|
    next if @script_lines__.has_key?(file) == false
    lines = @script_lines__[file]
    raw_coverage_array = raw_data_relative[file]

    line_info, marked_info, 
      count_info = refine_coverage_info(lines, raw_coverage_array)
    formatters.each do |formatter|
      formatter.add_file(file, line_info, marked_info, count_info)
    end
  end
  formatters.each{|formatter| formatter.execute}
end

#install_hook ⇒ Object

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.



119
 
# File 'lib/rcov/code_coverage_analyzer.rb', line 119

def install_hook; super end

#marshal_dump ⇒ Object

:nodoc:



271
272
273
274
275
276
277
278
 
# File 'lib/rcov/code_coverage_analyzer.rb', line 271

def marshal_dump # :nodoc:
  # @script_lines__ is updated just before serialization so as to avoid
  # missing files in SCRIPT_LINES__
  ivs = {}
  update_script_lines__
  instance_variables.each{|iv| ivs[iv] = instance_variable_get(iv)}
  ivs
end

#marshal_load(ivs) ⇒ Object

:nodoc:



280
281
282
 
# File 'lib/rcov/code_coverage_analyzer.rb', line 280

def marshal_load(ivs) # :nodoc:
  ivs.each_pair{|iv, val| instance_variable_set(iv, val)}
end

#remove_hook ⇒ Object

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



124
 
# File 'lib/rcov/code_coverage_analyzer.rb', line 124

def remove_hook; super end

#reset ⇒ Object

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.



131
 
# File 'lib/rcov/code_coverage_analyzer.rb', line 131

def reset; super end

#run_hooked ⇒ Object

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



113
 
# File 'lib/rcov/code_coverage_analyzer.rb', line 113

def run_hooked; super end