class SimpleCov::Formatter::HTMLFormatter

Constants

CONTENT_TYPES

Only have a few content types, just hardcode them

VERSION

Public Class Methods

new() click to toggle source
# File lib/simplecov-html.rb, line 19
def initialize
  @branchable_result = SimpleCov.branch_coverage?
  @templates = {}
  @inline_assets = !ENV["SIMPLECOV_INLINE_ASSETS"].nil?
  @public_assets_dir = File.join(File.dirname(__FILE__), "../public/")
end

Public Instance Methods

format(result) click to toggle source
# File lib/simplecov-html.rb, line 26
def format(result)
  unless @inline_assets
    Dir[File.join(@public_assets_dir, "*")].each do |path|
      FileUtils.cp_r(path, asset_output_path, remove_destination: true)
    end
  end

  File.open(File.join(output_path, "index.html"), "wb") do |file|
    file.puts template("layout").result(binding)
  end
  puts output_message(result)
end

Private Instance Methods

asset_inline(name) click to toggle source
# File lib/simplecov-html.rb, line 94
def asset_inline(name)
  path = File.join(@public_assets_dir, name)
  # Equivalent to `Base64.strict_encode64(File.read(path))` but without depending on Base64
  base64_content = [File.read(path)].pack("m0")

  content_type = CONTENT_TYPES[File.extname(name)]

  "data:#{content_type};base64,#{base64_content}"
end
asset_output_path() click to toggle source
# File lib/simplecov-html.rb, line 72
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 80
def assets_path(name)
  return asset_inline(name) if @inline_assets

  File.join("./assets", SimpleCov::Formatter::HTMLFormatter::VERSION, name)
end
branchable_result?() click to toggle source
# File lib/simplecov-html.rb, line 41
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
coverage_css_class(covered_percent) click to toggle source
# File lib/simplecov-html.rb, line 125
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 121
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 112
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 # rubocop:disable Lint/SelfAssignment
  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 105
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 146
def id(source_file)
  Digest::SHA1.hexdigest(source_file.filename)
end
line_status?(source_file, line) click to toggle source
# File lib/simplecov-html.rb, line 48
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 56
def output_message(result)
  output = "Coverage report generated for #{result.command_name} to #{output_path}."
  output += "\nLine Coverage: #{result.covered_percent.round(2)}% (#{result.covered_lines} / #{result.total_lines})"
  output += "\nBranch Coverage: #{result.coverage_statistics[:branch].percent.round(2)}% (#{result.covered_branches} / #{result.total_branches})" if branchable_result?
  output
end
output_path() click to toggle source
# File lib/simplecov-html.rb, line 68
def output_path
  SimpleCov.coverage_path
end
shortened_filename(source_file) click to toggle source
# File lib/simplecov-html.rb, line 154
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 135
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 64
def template(name)
  @templates[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 150
def timeago(time)
  "<abbr class=\"timeago\" title=\"#{time.iso8601}\">#{time.iso8601}</abbr>"
end