123456789_123456789_123456789_123456789_123456789_

Class: SimpleCov::CoverageStatistics

Relationships & Source Files
Inherits: Object
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
  • omitted - how many lines cannot be covered (blank lines/comments); only meaningful for line coverage
  • percent - percentage as covered/missed
  • strength - average hits per/coverable (will not exist for one shot lines format)

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(covered:, missed:, omitted: 0, total_strength: 0.0, percent: nil) ⇒ CoverageStatistics

Requires only covered, missed and strength to be initialized.

Other values are computed by this class.

[ GitHub ] 

  


# File 'lib/simplecov/coverage_statistics.rb', line 36



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


  







Class Method Details



  

    .from(coverage_statistics)  
  

  [ GitHub ]


  

  


# File 'lib/simplecov/coverage_statistics.rb', line 17



def self.from(coverage_statistics)
  sum_covered, sum_missed, sum_omitted, sum_total_strength =
    coverage_statistics.reduce([0, 0, 0, 0.0]) do |(covered, missed, omitted, total_strength), file_coverage_statistics|
      [
        covered + file_coverage_statistics.covered,
        missed + file_coverage_statistics.missed,
        omitted + file_coverage_statistics.omitted,
        # 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, omitted: sum_omitted, total_strength: sum_total_strength)
end


  







Instance Attribute Details



  

    #covered   (readonly)
  

  [ GitHub ]


  

  


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



attr_reader :total, :covered, :missed, :omitted, :strength, :percent


  








  

    #missed   (readonly)
  

  [ GitHub ]


  

  


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



attr_reader :total, :covered, :missed, :omitted, :strength, :percent


  








  

    #omitted   (readonly)
  

  [ GitHub ]


  

  


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



attr_reader :total, :covered, :missed, :omitted, :strength, :percent


  








  

    #percent   (readonly)
  

  [ GitHub ]


  

  


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



attr_reader :total, :covered, :missed, :omitted, :strength, :percent


  








  

    #strength   (readonly)
  

  [ GitHub ]


  

  


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



attr_reader :total, :covered, :missed, :omitted, :strength, :percent


  








  

    #total   (readonly)
  

  [ GitHub ]


  

  


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



attr_reader :total, :covered, :missed, :omitted, :strength, :percent


  







Instance Method Details



  

    #compute_percent(covered, missed, total)   (private)
  

  [ GitHub ]


  

  


# File 'lib/simplecov/coverage_statistics.rb', line 47



def compute_percent(covered, missed, total)
  return 100.0 if missed.zero?

  covered * 100.0 / total
end


  








  

    #compute_strength(total_strength, total)   (private)
  

  [ GitHub ]


  

  


# File 'lib/simplecov/coverage_statistics.rb', line 53



def compute_strength(total_strength, total)
  return 0.0 if total.zero?

  total_strength.to_f / total
end