class RuboCop::Formatter::HTMLFormatter

This formatter saves the output as an html file.

Constants

CSS_PATH
Color
ELLIPSES
FileOffenses
Summary
TEMPLATE_PATH

Attributes

files[R]
summary[R]

Public Class Methods

new(output, options = {}) click to toggle source
Calls superclass method RuboCop::Formatter::BaseFormatter::new
# File lib/rubocop/formatter/html_formatter.rb, line 29
def initialize(output, options = {})
  super
  @files = []
  @summary = Summary.new(offense_count: 0)
end

Public Instance Methods

file_finished(file, offenses) click to toggle source
# File lib/rubocop/formatter/html_formatter.rb, line 39
def file_finished(file, offenses)
  files << FileOffenses.new(path: file, offenses: offenses)
  summary.offense_count += offenses.count
end
finished(inspected_files) click to toggle source
# File lib/rubocop/formatter/html_formatter.rb, line 44
def finished(inspected_files)
  summary.inspected_files = inspected_files

  render_html
end
render_html() click to toggle source
# File lib/rubocop/formatter/html_formatter.rb, line 50
def render_html
  context = ERBContext.new(files, summary)

  template = File.read(TEMPLATE_PATH, encoding: Encoding::UTF_8)
  erb = ERB.new(template)
  html = erb.result(context.binding).lines.map do |line|
    line.match?(/\A\s*\z/) ? "\n" : line
  end.join

  output.write html
end
started(target_files) click to toggle source
# File lib/rubocop/formatter/html_formatter.rb, line 35
def started(target_files)
  summary.target_files = target_files
end