class SimpleCov::Formatter::HTMLFormatter
Constants
- VERSION
Public Class Methods
new()
click to toggle source
# File lib/simplecov-html.rb, line 19 def initialize @branchable_result = SimpleCov.branch_coverage? end
Public Instance Methods
branchable_result?()
click to toggle source
# File lib/simplecov-html.rb, line 38 def branchable_result? # cached in initialize because we truly look it up a whole bunch of times # and it's easier to cache here then in SimpleCov because there we might # still enable/disable branch coverage criterion @branchable_result end
format(result)
click to toggle source
# File lib/simplecov-html.rb, line 23 def format(result) Dir[File.join(File.dirname(__FILE__), "../public/*")].each do |path| FileUtils.cp_r(path, asset_output_path) end File.open(File.join(output_path, "index.html"), "wb") do |file| file.puts template("layout").result(binding) end puts output_message(result) end
line_status?(source_file, line)
click to toggle source
# File lib/simplecov-html.rb, line 45 def line_status?(source_file, line) if branchable_result? && source_file.line_with_missed_branch?(line.number) "missed-branch" else line.status end end
output_message(result)
click to toggle source
# File lib/simplecov-html.rb, line 34 def output_message(result) "Coverage report generated for #{result.command_name} to #{output_path}. #{result.covered_lines} / #{result.total_lines} LOC (#{result.covered_percent.round(2)}%) covered." end
Private Instance Methods
asset_output_path()
click to toggle source
# File lib/simplecov-html.rb, line 64 def asset_output_path return @asset_output_path if defined?(@asset_output_path) && @asset_output_path @asset_output_path = File.join(output_path, "assets", SimpleCov::Formatter::HTMLFormatter::VERSION) FileUtils.mkdir_p(@asset_output_path) @asset_output_path end
assets_path(name)
click to toggle source
# File lib/simplecov-html.rb, line 72 def assets_path(name) File.join("./assets", SimpleCov::Formatter::HTMLFormatter::VERSION, name) end
coverage_css_class(covered_percent)
click to toggle source
# File lib/simplecov-html.rb, line 97 def coverage_css_class(covered_percent) if covered_percent > 90 "green" elsif covered_percent > 80 "yellow" else "red" end end
covered_percent(percent)
click to toggle source
# File lib/simplecov-html.rb, line 93 def covered_percent(percent) template("covered_percent").result(binding) end
formatted_file_list(title, source_files)
click to toggle source
Returns a table containing the given source files
# File lib/simplecov-html.rb, line 84 def formatted_file_list(title, source_files) title_id = title.gsub(/^[^a-zA-Z]+/, "").gsub(/[^a-zA-Z0-9\-\_]/, "") # Silence a warning by using the following variable to assign to itself: # "warning: possibly useless use of a variable in void context" # The variable is used by ERB via binding. title_id = title_id template("file_list").result(binding) end
formatted_source_file(source_file)
click to toggle source
Returns the html for the given source_file
# File lib/simplecov-html.rb, line 77 def formatted_source_file(source_file) template("source_file").result(binding) rescue Encoding::CompatibilityError => e puts "Encoding problems with file #{source_file.filename}. Simplecov/ERB can't handle non ASCII characters in filenames. Error: #{e.message}." end
id(source_file)
click to toggle source
Return a (kind of) unique id for the source file given. Uses SHA1 on path for the id
# File lib/simplecov-html.rb, line 118 def id(source_file) Digest::SHA1.hexdigest(source_file.filename) end
link_to_source_file(source_file)
click to toggle source
# File lib/simplecov-html.rb, line 130 def link_to_source_file(source_file) %(<a href="##{id source_file}" class="src_link" title="#{shortened_filename source_file}">#{shortened_filename source_file}</a>) end
output_path()
click to toggle source
# File lib/simplecov-html.rb, line 60 def output_path SimpleCov.coverage_path end
shortened_filename(source_file)
click to toggle source
# File lib/simplecov-html.rb, line 126 def shortened_filename(source_file) source_file.filename.sub(SimpleCov.root, ".").gsub(/^\.\//, "") end
strength_css_class(covered_strength)
click to toggle source
# File lib/simplecov-html.rb, line 107 def strength_css_class(covered_strength) if covered_strength > 1 "green" elsif covered_strength == 1 "yellow" else "red" end end
template(name)
click to toggle source
Returns the an erb instance for the template of given name
# File lib/simplecov-html.rb, line 56 def template(name) ERB.new(File.read(File.join(File.dirname(__FILE__), "../views/", "#{name}.erb"))) end
timeago(time)
click to toggle source
# File lib/simplecov-html.rb, line 122 def timeago(time) "<abbr class=\"timeago\" title=\"#{time.iso8601}\">#{time.iso8601}</abbr>" end