Object
A simplecov code coverage result, initialized from the Hash Ruby 1.9’s built-in coverage library generates (Coverage.result).
Explicitly set the command name that was used for this coverage result. Defaults to SimpleCov.command_name
Returns all files that are applicable to this result (sans filters!) as instances of SimpleCov::SourceFile. Aliased as :source_files
Returns all files that are applicable to this result (sans filters!) as instances of SimpleCov::SourceFile. Aliased as :source_files
Loads a SimpleCov::Result#to_hash dump
# File lib/simplecov/result.rb, line 110 def self.from_hash(hash) command_name, data = hash.first result = SimpleCov::Result.new(data["coverage"]) result.command_name = command_name result.created_at = Time.at(data["timestamp"]) result end
Initialize a new SimpleCov::Result from given Coverage.result (a Hash of filenames each containing an array of coverage data)
# File lib/simplecov/result.rb, line 21 def initialize(original_result) @original_result = original_result.freeze @files = SimpleCov::FileList.new(original_result.map do |filename, coverage| SimpleCov::SourceFile.new(filename, coverage) if File.file?(filename) end.compact.sort_by(&:filename)) filter! end
The command name that launched this result. Delegated to SimpleCov.command_name if not set manually
# File lib/simplecov/result.rb, line 100 def command_name @command_name ||= SimpleCov.command_name end
Returns the count of lines that are covered
# File lib/simplecov/result.rb, line 60 def covered_lines return @covered_lines if @covered_lines @covered_lines = 0 @files.each do |file| original_result[file.filename].each do |line_result| @covered_lines += 1 if line_result and line_result > 0 end end @covered_lines end
The overall percentual coverage for this result
# File lib/simplecov/result.rb, line 40 def covered_percent # Make sure that weird rounding error from #15, #23 and #24 does not occur again! total_lines.zero? ? 0 : 100.0 * covered_lines / total_lines end
The multiple of coverage for this result
# File lib/simplecov/result.rb, line 46 def covered_strength return @covered_strength if @convered_strength m = 0 @files.each do |file| original_result[file.filename].each do |line_result| if line_result m += line_result end end end @covered_strength = m.to_f / total_lines end
Defines when this result has been created. Defaults to Time.now
# File lib/simplecov/result.rb, line 94 def created_at @created_at ||= Time.now end
Returns all filenames for source files contained in this result
# File lib/simplecov/result.rb, line 30 def filenames files.map(&:filename) end
Applies the configured SimpleCov.formatter on this result
# File lib/simplecov/result.rb, line 89 def format! SimpleCov.formatter.new.format(self) end
Returns a Hash of groups for this result. Define groups using SimpleCov.add_group ‘Models’, ‘app/models’
# File lib/simplecov/result.rb, line 35 def groups @groups ||= SimpleCov.grouped(files) end
Returns the count of missed lines
# File lib/simplecov/result.rb, line 72 def missed_lines return @missed_lines if @missed_lines @missed_lines = 0 @files.each do |file| original_result[file.filename].each do |line_result| @missed_lines += 1 if line_result == 0 end end @missed_lines end
Returns a hash representation of this Result that can be used for marshalling it into YAML
# File lib/simplecov/result.rb, line 105 def to_hash {command_name => {"coverage" => original_result.reject {|filename, result| !filenames.include?(filename) }, "timestamp" => created_at.to_i}} end
Generated with the Darkfish Rdoc Generator 2.