Class: RuboCop::Formatter::HTMLFormatter::ERBContext
- Inherits:
-
Object
- Object
- RuboCop::Formatter::HTMLFormatter::ERBContext
show all
- Includes:
- TextUtil, PathUtil
- Defined in:
- lib/rubocop/formatter/html_formatter.rb
Overview
This class provides helper methods used in the ERB template.
Constant Summary
collapse
- SEVERITY_COLORS =
{
refactor: Color.new(0xED, 0x9C, 0x28, 1.0),
convention: Color.new(0xED, 0x9C, 0x28, 1.0),
warning: Color.new(0x96, 0x28, 0xEF, 1.0),
error: Color.new(0xD2, 0x32, 0x2D, 1.0),
fatal: Color.new(0xD2, 0x32, 0x2D, 1.0)
}.freeze
- LOGO_IMAGE_PATH =
File.expand_path('../../../assets/logo.png', __dir__)
Instance Attribute Summary collapse
Instance Method Summary
collapse
Methods included from TextUtil
pluralize
Methods included from PathUtil
absolute?, match_path?, pwd, relative_path, reset_pwd, smart_path
Constructor Details
#initialize(files, summary) ⇒ ERBContext
Returns a new instance of ERBContext.
87
88
89
90
|
# File 'lib/rubocop/formatter/html_formatter.rb', line 87
def initialize(files, summary)
@files = files.sort_by(&:path)
@summary = summary
end
|
Instance Attribute Details
#files ⇒ Object
Returns the value of attribute files.
85
86
87
|
# File 'lib/rubocop/formatter/html_formatter.rb', line 85
def files
@files
end
|
#summary ⇒ Object
Returns the value of attribute summary.
85
86
87
|
# File 'lib/rubocop/formatter/html_formatter.rb', line 85
def summary
@summary
end
|
Instance Method Details
#base64_encoded_logo_image ⇒ Object
134
135
136
137
|
# File 'lib/rubocop/formatter/html_formatter.rb', line 134
def base64_encoded_logo_image
image = File.read(LOGO_IMAGE_PATH, binmode: true)
Base64.encode64(image)
end
|
#binding ⇒ Object
Make Kernel#binding public.
93
94
95
|
# File 'lib/rubocop/formatter/html_formatter.rb', line 93
def binding
super
end
|
#decorated_message(offense) ⇒ Object
97
98
99
100
101
|
# File 'lib/rubocop/formatter/html_formatter.rb', line 97
def decorated_message(offense)
offense.message.gsub(/`(.+?)`/) do
"<code>#{Regexp.last_match(1)}</code>"
end
end
|
#escape(string) ⇒ Object
130
131
132
|
# File 'lib/rubocop/formatter/html_formatter.rb', line 130
def escape(string)
CGI.escapeHTML(string)
end
|
#highlighted_source_line(offense) ⇒ Object
103
104
105
106
107
108
|
# File 'lib/rubocop/formatter/html_formatter.rb', line 103
def highlighted_source_line(offense)
source_before_highlight(offense) +
hightlight_source_tag(offense) +
source_after_highlight(offense) +
possible_ellipses(offense.location)
end
|
#hightlight_source_tag(offense) ⇒ Object
110
111
112
113
114
|
# File 'lib/rubocop/formatter/html_formatter.rb', line 110
def hightlight_source_tag(offense)
"<span class=\"highlight #{offense.severity}\">" \
"#{escape(offense.highlighted_area.source)}" \
'</span>'
end
|
#possible_ellipses(location) ⇒ Object
126
127
128
|
# File 'lib/rubocop/formatter/html_formatter.rb', line 126
def possible_ellipses(location)
location.first_line == location.last_line ? '' : " #{ELLIPSES}"
end
|
#source_after_highlight(offense) ⇒ Object
121
122
123
124
|
# File 'lib/rubocop/formatter/html_formatter.rb', line 121
def source_after_highlight(offense)
source_line = offense.location.source_line
escape(source_line[offense.highlighted_area.end_pos..-1])
end
|
#source_before_highlight(offense) ⇒ Object
116
117
118
119
|
# File 'lib/rubocop/formatter/html_formatter.rb', line 116
def source_before_highlight(offense)
source_line = offense.location.source_line
escape(source_line[0...offense.highlighted_area.begin_pos])
end
|