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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(severity, location, message, cop_name, status = :uncorrected) ⇒ 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.



58
59
60
61
62
63
64
65
66
 
# File 'lib/rubocop/cop/offense.rb', line 58

def initialize(severity, location, message, cop_name,
               status = :uncorrected)
  @severity = RuboCop::Cop::Severity.new(severity)
  @location = location
  @message = message.freeze
  @cop_name = cop_name.freeze
  @status = status
  freeze
end

Instance Attribute Details

#cop_name ⇒ String (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

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



75
76
77
 
# File 'lib/rubocop/cop/offense.rb', line 75

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.



85
86
87
 
# File 'lib/rubocop/cop/offense.rb', line 85

def corrected_with_todo?
  @status == :corrected_with_todo
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.



96
97
98
 
# File 'lib/rubocop/cop/offense.rb', line 96

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:



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

def location
  @location
end

#message ⇒ String (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

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

Returns:



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

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. 



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



196
197
198
199
200
201
202
 
# File 'lib/rubocop/cop/offense.rb', line 196

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



175
176
177
178
179
 
# File 'lib/rubocop/cop/offense.rb', line 175

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



124
125
126
 
# File 'lib/rubocop/cop/offense.rb', line 124

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. 



134
135
136
137
138
139
140
 
# File 'lib/rubocop/cop/offense.rb', line 134

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. 



158
159
160
 
# File 'lib/rubocop/cop/offense.rb', line 158

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. 



143
144
145
 
# File 'lib/rubocop/cop/offense.rb', line 143

def first_line
  location.first_line
end

#hash ⇒ Object 



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

def hash
  COMPARISON_ATTRIBUTES.reduce(0) do |hash, attribute|
    hash ^ send(attribute).hash
  end
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



104
105
106
107
108
 
# File 'lib/rubocop/cop/offense.rb', line 104

def highlighted_area
  Parser::Source::Range.new(source_line,
                            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. 



153
154
155
 
# File 'lib/rubocop/cop/offense.rb', line 153

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. 



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

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. 



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

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.



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

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. 



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

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.



112
113
114
115
116
 
# File 'lib/rubocop/cop/offense.rb', line 112

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