Class: RuboCop::Formatter::HTMLFormatter
- Inherits:
-
BaseFormatter
- Object
- BaseFormatter
- RuboCop::Formatter::HTMLFormatter
- Defined in:
- lib/rubocop/formatter/html_formatter.rb
Overview
This formatter saves the output as an html file.
Defined Under Namespace
Classes: Color, ERBContext, FileOffenses, Summary
Constant Summary collapse
- ELLIPSES =
'<span class="extra-code">...</span>'
- TEMPLATE_PATH =
File.('../../../assets/output.html.erb', __dir__)
Instance Attribute Summary collapse
-
#files ⇒ Object
readonly
Returns the value of attribute files.
-
#summary ⇒ Object
readonly
Returns the value of attribute summary.
Attributes inherited from BaseFormatter
Instance Method Summary collapse
- #file_finished(file, offenses) ⇒ Object
- #finished(inspected_files) ⇒ Object
-
#initialize(output, options = {}) ⇒ HTMLFormatter
constructor
A new instance of HTMLFormatter.
- #render_html ⇒ Object
- #started(target_files) ⇒ Object
Methods inherited from BaseFormatter
Constructor Details
#initialize(output, options = {}) ⇒ HTMLFormatter
Returns a new instance of HTMLFormatter.
30 31 32 33 34 |
# File 'lib/rubocop/formatter/html_formatter.rb', line 30 def initialize(output, = {}) super @files = [] @summary = Summary.new(offense_count: 0) end |
Instance Attribute Details
#files ⇒ Object (readonly)
Returns the value of attribute files.
28 29 30 |
# File 'lib/rubocop/formatter/html_formatter.rb', line 28 def files @files end |
#summary ⇒ Object (readonly)
Returns the value of attribute summary.
28 29 30 |
# File 'lib/rubocop/formatter/html_formatter.rb', line 28 def summary @summary end |
Instance Method Details
#file_finished(file, offenses) ⇒ Object
40 41 42 43 |
# File 'lib/rubocop/formatter/html_formatter.rb', line 40 def file_finished(file, offenses) files << FileOffenses.new(path: file, offenses: offenses) summary.offense_count += offenses.count end |
#finished(inspected_files) ⇒ Object
45 46 47 48 49 |
# File 'lib/rubocop/formatter/html_formatter.rb', line 45 def finished(inspected_files) summary.inspected_files = inspected_files render_html end |
#render_html ⇒ Object
51 52 53 54 55 56 57 58 59 |
# File 'lib/rubocop/formatter/html_formatter.rb', line 51 def render_html context = ERBContext.new(files, summary) template = File.read(TEMPLATE_PATH, encoding: Encoding::UTF_8) erb = ERB.new(template, trim_mode: '-') html = erb.result(context.binding) output.write html end |
#started(target_files) ⇒ Object
36 37 38 |
# File 'lib/rubocop/formatter/html_formatter.rb', line 36 def started(target_files) summary.target_files = target_files end |