class SimpleCov::Result

A simplecov code coverage result, initialized from the Hash Ruby 1.9’s built-in coverage library generates (Coverage.result).

Attributes

command_name[W]

Explicitly set the command name that was used for this coverage result. Defaults to SimpleCov.command_name

created_at[W]

Explicitly set the Time this result has been created

files[R]

Returns all files that are applicable to this result (sans filters!) as instances of SimpleCov::SourceFile. Aliased as :#source_files

original_result[R]

Returns the original Coverage.result used for this instance of SimpleCov::Result

source_files[R]

Returns all files that are applicable to this result (sans filters!) as instances of SimpleCov::SourceFile. Aliased as :#source_files

Public Class Methods

from_hash(hash) click to toggle source

Loads a #to_hash dump

# File lib/simplecov/result.rb, line 111
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
new(original_result) click to toggle source

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

Public Instance Methods

command_name() click to toggle source

The command name that launched this result. Delegated to SimpleCov.command_name if not set manually

# File lib/simplecov/result.rb, line 101
def command_name
  @command_name ||= SimpleCov.command_name
end
covered_lines() click to toggle source

Returns the count of lines that are covered

# File lib/simplecov/result.rb, line 61
def covered_lines
  return @covered_lines if defined? @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
covered_percent() click to toggle source

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
covered_strength() click to toggle source

The multiple of coverage for this result

# File lib/simplecov/result.rb, line 46
def covered_strength
  return 0 if total_lines.zero?
  return @covered_strength if @covered_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
created_at() click to toggle source

Defines when this result has been created. Defaults to Time.now

# File lib/simplecov/result.rb, line 95
def created_at
  @created_at ||= Time.now
end
filenames() click to toggle source

Returns all filenames for source files contained in this result

# File lib/simplecov/result.rb, line 30
def filenames
  files.map(&:filename)
end
format!() click to toggle source

Applies the configured SimpleCov.formatter on this result

# File lib/simplecov/result.rb, line 90
def format!
  SimpleCov.formatter.new.format(self)
end
groups() click to toggle source

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
missed_lines() click to toggle source

Returns the count of missed lines

# File lib/simplecov/result.rb, line 73
def missed_lines
  return @missed_lines if defined? @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
to_hash() click to toggle source

Returns a hash representation of this Result that can be used for marshalling it into YAML

# File lib/simplecov/result.rb, line 106
def to_hash
  {command_name => {"coverage" => original_result.reject {|filename, result| !filenames.include?(filename) }, "timestamp" => created_at.to_i}}
end
total_lines() click to toggle source

Total count of relevant lines (covered + missed)

# File lib/simplecov/result.rb, line 85
def total_lines
  @total_lines ||= (covered_lines + missed_lines)
end