class SimpleCov::SourceFile
Representation of a source file including it’s coverage data, source code, source lines and featuring helpers to interpret that data.
Attributes
The array of coverage data received from the Coverage.result
The full path to this source file (e.g. /User/colszowka/projects/simplecov/lib/simplecov/source_file.rb)
Public Class Methods
Source
# File lib/simplecov/source_file.rb, line 78 def initialize(filename, coverage) @filename = filename @coverage = coverage end
Public Instance Methods
Source
# File lib/simplecov/source_file.rb, line 146 def covered_lines @covered_lines ||= lines.select(&:covered?) end
Returns all covered lines as SimpleCov::SourceFile::Line
Source
# File lib/simplecov/source_file.rb, line 117 def covered_percent return 100.0 if lines.length.zero? || lines.length == never_lines.count relevant_lines = lines.count - never_lines.count - skipped_lines.count if relevant_lines.zero? 0.0 else Float(covered_lines.count * 100.0 / relevant_lines.to_f) end end
The coverage for this file in percent. 0 if the file has no relevant lines
Source
# File lib/simplecov/source_file.rb, line 127 def covered_strength return 0.0 if lines.length.zero? || lines.length == never_lines.count lines_strength = 0 lines.each do |c| lines_strength += c.coverage if c.coverage end effective_lines_count = Float(lines.count - never_lines.count - skipped_lines.count) if effective_lines_count.zero? 0.0 else strength = lines_strength / effective_lines_count round_float(strength, 1) end end
Source
# File lib/simplecov/source_file.rb, line 112 def line(number) lines[number - 1] end
Access SimpleCov::SourceFile::Line
source lines by line number
Source
# File lib/simplecov/source_file.rb, line 93 def lines return @lines if defined? @lines # Warning to identify condition from Issue #56 if coverage.size > src.size $stderr.puts "Warning: coverage data provided by Coverage [#{coverage.size}] exceeds number of lines in #{filename} [#{src.size}]" end # Initialize lines @lines = [] src.each_with_index do |src, i| @lines << SimpleCov::SourceFile::Line.new(src, i + 1, coverage[i]) end process_skipped_lines! @lines end
Returns all source lines for this file as instances of SimpleCov::SourceFile::Line
, and thus including coverage data. Aliased as :source_lines
Source
# File lib/simplecov/source_file.rb, line 168 def lines_of_code covered_lines.count + missed_lines.count end
Returns the number of relevant lines (covered + missed)
Source
# File lib/simplecov/source_file.rb, line 152 def missed_lines @missed_lines ||= lines.select(&:missed?) end
Returns all lines that should have been, but were not covered as instances of SimpleCov::SourceFile::Line
Source
# File lib/simplecov/source_file.rb, line 158 def never_lines @never_lines ||= lines.select(&:never?) end
Returns all lines that are not relevant for coverage as SimpleCov::SourceFile::Line
instances
Source
# File lib/simplecov/source_file.rb, line 174 def process_skipped_lines! skipping = false lines.each do |line| if line.src =~ /^([\s]*)#([\s]*)(\:#{SimpleCov.nocov_token}\:)/ skipping = !skipping elsif skipping line.skipped! end end end
Will go through all source files and mark lines that are wrapped within # :nocov: comment blocks as skipped.
Source
# File lib/simplecov/source_file.rb, line 163 def skipped_lines @skipped_lines ||= lines.select(&:skipped?) end
Returns all lines that were skipped as SimpleCov::SourceFile::Line
instances
Private Instance Methods
Source
# File lib/simplecov/source_file.rb, line 189 def round_float(float, places) factor = Float(10 * places) Float((float * factor).round / factor) end
ruby 1.9 could use Float#round(places) instead @return [Float]