Class: SimpleCov::CoverageStatistics

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

Overview

Holds the individual data of a coverage result.

This is uniform across coverage criteria as they all have:

  • total - how many things to cover there are (total relevant loc/branches)

  • covered - how many of the coverables are hit

  • missed - how many of the coverables are missed

  • percent - percentage as covered/missed

  • strength - average hits per/coverable (will not exist for one shot lines format)

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(covered:, missed:, total_strength: 0.0) ⇒ CoverageStatistics

Requires only covered, missed and strength to be initialized.

Other values are computed by this class.



34
35
36
37
38
39
40
 
# File 'lib/simplecov/coverage_statistics.rb', line 34

def initialize(covered:, missed:, total_strength: 0.0)
  @covered  = covered
  @missed   = missed
  @total    = covered + missed
  @percent  = compute_percent(covered, missed, total)
  @strength = compute_strength(total_strength, total)
end

Instance Attribute Details

#covered ⇒ Object (readonly)

Returns the value of attribute covered.



14
15
16
 
# File 'lib/simplecov/coverage_statistics.rb', line 14

def covered
  @covered
end

#missed ⇒ Object (readonly)

Returns the value of attribute missed.



14
15
16
 
# File 'lib/simplecov/coverage_statistics.rb', line 14

def missed
  @missed
end

#percent ⇒ Object (readonly)

Returns the value of attribute percent.



14
15
16
 
# File 'lib/simplecov/coverage_statistics.rb', line 14

def percent
  @percent
end

#strength ⇒ Object (readonly)

Returns the value of attribute strength.



14
15
16
 
# File 'lib/simplecov/coverage_statistics.rb', line 14

def strength
  @strength
end

#total ⇒ Object (readonly)

Returns the value of attribute total.



14
15
16
 
# File 'lib/simplecov/coverage_statistics.rb', line 14

def total
  @total
end

Class Method Details

.from(coverage_statistics) ⇒ Object 



16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/simplecov/coverage_statistics.rb', line 16

def self.from(coverage_statistics)
  sum_covered, sum_missed, sum_total_strength =
    coverage_statistics.reduce([0, 0, 0.0]) do |(covered, missed, total_strength), file_coverage_statistics|
      [
        covered + file_coverage_statistics.covered,
        missed + file_coverage_statistics.missed,
        # gotta remultiply with loc because files have different strength and loc
        # giving them a different "weight" in total
        total_strength + (file_coverage_statistics.strength * file_coverage_statistics.total)
      ]
    end

  new(covered: sum_covered, missed: sum_missed, total_strength: sum_total_strength)
end