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, 1).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.


72
73
74
75
76
77
78
79
80
81
# File 'lib/rubocop/cop/offense.rb', line 72

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_nameString (readonly)

Returns a cop class name without department. i.e. type of the violation.

Examples:

'LineLength'

Returns:

  • (String)

    a cop class name without department. i.e. type of the violation.


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

def cop_name
  @cop_name
end

#correctable?Boolean (readonly)

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

Returns:

  • (Boolean)

    whether this offense can be automatically corrected via autocorrect or a todo.


90
91
92
# File 'lib/rubocop/cop/offense.rb', line 90

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.


101
102
103
# File 'lib/rubocop/cop/offense.rb', line 101

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.


111
112
113
# File 'lib/rubocop/cop/offense.rb', line 111

def corrected_with_todo?
  @status == :corrected_with_todo
end

#correctorCorrector | 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


63
64
65
# File 'lib/rubocop/cop/offense.rb', line 63

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.


122
123
124
# File 'lib/rubocop/cop/offense.rb', line 122

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

#locationParser::Source::Range (readonly)

Returns the location where the violation is detected.

Returns:

  • (Parser::Source::Range)

    the location where the violation is detected.

See Also:


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

def location
  @location
end

#messageString (readonly)

Returns human-readable message.

Examples:

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

Returns:

  • (String)

    human-readable message


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

def message
  @message
end

#severityRuboCop::Cop::Severity (readonly)


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

def severity
  @severity
end

#statusObject (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.


55
56
57
# File 'lib/rubocop/cop/offense.rb', line 55

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


222
223
224
225
226
227
228
# File 'lib/rubocop/cop/offense.rb', line 222

def <=>(other)
  COMPARISON_ATTRIBUTES.each do |attribute|
    result = send(attribute) <=> other.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


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

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

#columnObject

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.


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

def column
  location.column
end

#column_lengthObject

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.


160
161
162
163
164
165
166
# File 'lib/rubocop/cop/offense.rb', line 160

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

#column_rangeObject

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.


184
185
186
# File 'lib/rubocop/cop/offense.rb', line 184

def column_range
  location.column_range
end

#first_lineObject

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.


169
170
171
# File 'lib/rubocop/cop/offense.rb', line 169

def first_line
  location.first_line
end

#hashObject


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

def hash
  COMPARISON_ATTRIBUTES.reduce(0) do |hash, attribute|
    hash ^ send(attribute).hash
  end
end

#highlighted_areaParser::Source::Range

Returns the range of the code that is highlighted.

Returns:

  • (Parser::Source::Range)

    the range of the code that is highlighted


130
131
132
133
134
# File 'lib/rubocop/cop/offense.rb', line 130

def highlighted_area
  Parser::Source::Range.new(source_line,
                            column,
                            column + column_length)
end

#last_columnObject

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.


179
180
181
# File 'lib/rubocop/cop/offense.rb', line 179

def last_column
  location.last_column
end

#last_lineObject

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.


174
175
176
# File 'lib/rubocop/cop/offense.rb', line 174

def last_line
  location.last_line
end

#lineObject

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.


145
146
147
# File 'lib/rubocop/cop/offense.rb', line 145

def line
  location.line
end

#real_columnObject

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.


193
194
195
# File 'lib/rubocop/cop/offense.rb', line 193

def real_column
  column + 1
end

#source_lineObject

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.


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

def source_line
  location.source_line
end

#to_sObject

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.


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

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