Class: RuboCop::Cop::Offense

Inherits:
Object
  • Object
show all
Includes:
Comparable
Defined in:
lib/rubocop/cop/offense.rb

Overview

An offense represents a style violation detected by RuboCop.

Constant Summary collapse

COMPARISON_ATTRIBUTES =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future. 

%i[line column cop_name message severity].freeze
NO_LOCATION = 
PseudoSourceRange.new(1, 0, '', 0, 0).freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(severity, location, message, cop_name, status = :uncorrected, corrector = nil) ⇒ Offense

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Offense.



90
91
92
93
94
95
96
97
98
99
 
# File 'lib/rubocop/cop/offense.rb', line 90

def initialize(severity, location, message, cop_name, # rubocop:disable Metrics/ParameterLists
               status = :uncorrected, corrector = nil)
  @severity = RuboCop::Cop::Severity.new(severity)
  @location = location
  @message = message.freeze
  @cop_name = cop_name.freeze
  @status = status
  @corrector = corrector
  freeze
end

Instance Attribute Details

#cop_name ⇒ String (readonly)

Returns the cop name as a String for which this offense is for.

Examples:

'Layout/LineLength'

Returns:

  • (String) —

    the cop name as a String for which this offense is for.



50
51
52
 
# File 'lib/rubocop/cop/offense.rb', line 50

def cop_name
  @cop_name
end

#correctable? ⇒ Boolean (readonly)

Returns whether this offense can be automatically corrected via autocorrect. This includes todo comments, for example when requested with --disable-uncorrectable.

Returns:

  • (Boolean) —

    whether this offense can be automatically corrected via autocorrect. This includes todo comments, for example when requested with --disable-uncorrectable.



108
109
110
 
# File 'lib/rubocop/cop/offense.rb', line 108

def correctable?
  @status != :unsupported
end

#corrected? ⇒ Boolean (readonly)

Returns whether this offense is automatically corrected via autocorrect or a todo.

Returns:

  • (Boolean) —

    whether this offense is automatically corrected via autocorrect or a todo.



119
120
121
 
# File 'lib/rubocop/cop/offense.rb', line 119

def corrected?
  @status == :corrected || @status == :corrected_with_todo
end

#corrected_with_todo? ⇒ Boolean (readonly)

Returns whether this offense is automatically disabled via a todo.

Returns:

  • (Boolean) —

    whether this offense is automatically disabled via a todo.



129
130
131
 
# File 'lib/rubocop/cop/offense.rb', line 129

def corrected_with_todo?
  @status == :corrected_with_todo
end

#corrector ⇒ Corrector | nil (readonly)

Returns the autocorrection for this offense, or nil when not available.

Returns:

  • (Corrector | nil) —

    the autocorrection for this offense, or nil when not available



61
62
63
 
# File 'lib/rubocop/cop/offense.rb', line 61

def corrector
  @corrector
end

#disabled? ⇒ Boolean (readonly)

Returns whether this offense was locally disabled with a disable or todo where it occurred.

Returns:

  • (Boolean) —

    whether this offense was locally disabled with a disable or todo where it occurred.



140
141
142
 
# File 'lib/rubocop/cop/offense.rb', line 140

def disabled?
  @status == :disabled || @status == :todo
end

#location ⇒ Parser::Source::Range (readonly)

Returns the location where the violation is detected.

Returns:

  • (Parser::Source::Range) —

    the location where the violation is detected.

See Also:



28
29
30
 
# File 'lib/rubocop/cop/offense.rb', line 28

def location
  @location
end

#message ⇒ String (readonly)

Returns human-readable message.

Examples:

'Line is too long. [90/80]'

Returns:

  • (String) —

    human-readable message



39
40
41
 
# File 'lib/rubocop/cop/offense.rb', line 39

def message
  @message
end

#severity ⇒ RuboCop::Cop::Severity (readonly)

Returns:



17
18
19
 
# File 'lib/rubocop/cop/offense.rb', line 17

def severity
  @severity
end

#status ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



53
54
55
 
# File 'lib/rubocop/cop/offense.rb', line 53

def status
  @status
end

Instance Method Details

#<=>(other) ⇒ Integer

Returns -1, 0, or ‘+1` if this offense is less than, equal to, or greater than other.

Returns:

  • (Integer) —

    comparison result



237
238
239
240
241
242
243
 
# File 'lib/rubocop/cop/offense.rb', line 237

def <=>(other)
  COMPARISON_ATTRIBUTES.each do |attribute|
    result = public_send(attribute) <=> other.public_send(attribute)
    return result unless result.zero?
  end
  0
end

#==(other) ⇒ Boolean Also known as: eql?

Returns true if two offenses contain same attributes

Returns:

  • (Boolean) —

    returns true if two offenses contain same attributes



218
219
220
221
222
 
# File 'lib/rubocop/cop/offense.rb', line 218

def ==(other)
  COMPARISON_ATTRIBUTES.all? do |attribute|
    public_send(attribute) == other.public_send(attribute)
  end
end

#column ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



167
168
169
 
# File 'lib/rubocop/cop/offense.rb', line 167

def column
  location.column
end

#column_length ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



177
178
179
180
181
182
183
 
# File 'lib/rubocop/cop/offense.rb', line 177

def column_length
  if first_line == last_line
    column_range.count
  else
    source_line.length - column
  end
end

#column_range ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



201
202
203
 
# File 'lib/rubocop/cop/offense.rb', line 201

def column_range
  location.column_range
end

#first_line ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



186
187
188
 
# File 'lib/rubocop/cop/offense.rb', line 186

def first_line
  location.first_line
end

#hash ⇒ Object 



226
227
228
 
# File 'lib/rubocop/cop/offense.rb', line 226

def hash
  COMPARISON_ATTRIBUTES.map { |attribute| public_send(attribute) }.hash
end

#highlighted_area ⇒ Parser::Source::Range

Returns the range of the code that is highlighted.

Returns:

  • (Parser::Source::Range) —

    the range of the code that is highlighted



148
149
150
151
 
# File 'lib/rubocop/cop/offense.rb', line 148

def highlighted_area
  source_buffer = Parser::Source::Buffer.new(location.source_buffer.name, source: source_line)
  Parser::Source::Range.new(source_buffer, column, column + column_length)
end

#last_column ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



196
197
198
 
# File 'lib/rubocop/cop/offense.rb', line 196

def last_column
  location.last_column
end

#last_line ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



191
192
193
 
# File 'lib/rubocop/cop/offense.rb', line 191

def last_line
  location.last_line
end

#line ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



162
163
164
 
# File 'lib/rubocop/cop/offense.rb', line 162

def line
  location.line
end

#real_column ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Internally we use column number that start at 0, but when outputting column numbers, we want them to start at 1. One reason is that editors, such as Emacs, expect this.



210
211
212
 
# File 'lib/rubocop/cop/offense.rb', line 210

def real_column
  column + 1
end

#source_line ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



172
173
174
 
# File 'lib/rubocop/cop/offense.rb', line 172

def source_line
  location.source_line
end

#to_s ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This is just for debugging purpose.



155
156
157
158
159
 
# File 'lib/rubocop/cop/offense.rb', line 155

def to_s
  format('%<severity>s:%3<line>d:%3<column>d: %<message>s',
         severity: severity.code, line: line,
         column: real_column, message: message)
end