Class: RuboCop::Formatter::HTMLFormatter::ERBContext

Inherits:
Object
  • Object
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', __FILE__)

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from PathUtil

absolute?, match_path?, relative_path

Methods included from TextUtil

pluralize

Constructor Details

#initialize(files, summary) ⇒ ERBContext

Returns a new instance of ERBContext.


80
81
82
83
# File 'lib/rubocop/formatter/html_formatter.rb', line 80

def initialize(files, summary)
  @files = files.sort_by(&:path)
  @summary = summary
end

Instance Attribute Details

#filesObject (readonly)

Returns the value of attribute files


78
79
80
# File 'lib/rubocop/formatter/html_formatter.rb', line 78

def files
  @files
end

#summaryObject (readonly)

Returns the value of attribute summary


78
79
80
# File 'lib/rubocop/formatter/html_formatter.rb', line 78

def summary
  @summary
end

Instance Method Details

#base64_encoded_logo_imageObject


113
114
115
116
# File 'lib/rubocop/formatter/html_formatter.rb', line 113

def base64_encoded_logo_image
  image = File.read(LOGO_IMAGE_PATH, binmode: true)
  Base64.encode64(image)
end

#bindingObject

Make Kernel#binding public.


86
87
88
# File 'lib/rubocop/formatter/html_formatter.rb', line 86

def binding
  super
end

#decorated_message(offense) ⇒ Object


90
91
92
93
94
# File 'lib/rubocop/formatter/html_formatter.rb', line 90

def decorated_message(offense)
  offense.message.gsub(/`(.+?)`/) do
    "<code>#{Regexp.last_match(1)}</code>"
  end
end

#escape(s) ⇒ Object


108
109
110
111
# File 'lib/rubocop/formatter/html_formatter.rb', line 108

def escape(s)
  # Single quotes not escaped in Ruby 1.9, so add extra substitution.
  CGI.escapeHTML(s).gsub(/'/, '&#39;')
end

#highlighted_source_line(offense) ⇒ Object


96
97
98
99
100
101
102
103
104
105
106
# File 'lib/rubocop/formatter/html_formatter.rb', line 96

def highlighted_source_line(offense)
  location = offense.location
  source_line = location.source_line

  escape(source_line[0...offense.highlighted_area.begin_pos]) +
    "<span class=\"highlight #{offense.severity}\">" +
    escape(offense.highlighted_area.source) +
    '</span>' +
    escape(source_line[offense.highlighted_area.end_pos..-1]) +
    (location.first_line == location.last_line ? '' : " #{ELLIPSES}")
end