Class: SimpleCov::Result

Inherits:
Object
  • Object
show all
Defined in:
lib/simplecov/result.rb

Overview

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(original_result) ⇒ Result

Initialize a new SimpleCov::Result from given Coverage.result (a Hash of filenames each containing an array of coverage data)


21
22
23
24
25
26
27
# 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

Instance Attribute Details

#command_nameObject

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


100
101
102
# File 'lib/simplecov/result.rb', line 100

def command_name
  @command_name ||= SimpleCov.command_name
end

#created_atObject

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


94
95
96
# File 'lib/simplecov/result.rb', line 94

def created_at
  @created_at ||= Time.now
end

#filesObject (readonly) Also known as: source_files

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


12
13
14
# File 'lib/simplecov/result.rb', line 12

def files
  @files
end

#original_resultObject (readonly)

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


10
11
12
# File 'lib/simplecov/result.rb', line 10

def original_result
  @original_result
end

Class Method Details

.from_hash(hash) ⇒ Object

Loads a SimpleCov::Result#to_hash dump


110
111
112
113
114
115
116
# 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

Instance Method Details

#covered_linesObject

Returns the count of lines that are covered


60
61
62
63
64
65
66
67
68
69
# 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

#covered_percentObject

The overall percentual coverage for this result


40
41
42
43
# 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_strengthObject

The multiple of coverage for this result


46
47
48
49
50
51
52
53
54
55
56
57
# File 'lib/simplecov/result.rb', line 46

def covered_strength
  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

#filenamesObject

Returns all filenames for source files contained in this result


30
31
32
# File 'lib/simplecov/result.rb', line 30

def filenames
  files.map(&:filename)
end

#format!Object

Applies the configured SimpleCov.formatter on this result


89
90
91
# File 'lib/simplecov/result.rb', line 89

def format!
  SimpleCov.formatter.new.format(self)
end

#groupsObject

Returns a Hash of groups for this result. Define groups using SimpleCov.add_group 'Models', 'app/models'


35
36
37
# File 'lib/simplecov/result.rb', line 35

def groups
  @groups ||= SimpleCov.grouped(files)
end

#missed_linesObject

Returns the count of missed lines


72
73
74
75
76
77
78
79
80
81
# 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

#to_hashObject

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


105
106
107
# 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

#total_linesObject

Total count of relevant lines (covered + missed)


84
85
86
# File 'lib/simplecov/result.rb', line 84

def total_lines
  @total_lines ||= (covered_lines + missed_lines)
end