forked from rubocop/rubocop
/
offense.rb
244 lines (212 loc) · 5.81 KB
/
offense.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
# frozen_string_literal: true
module RuboCop
module Cop
# An offense represents a style violation detected by RuboCop.
class Offense
include Comparable
# @api private
COMPARISON_ATTRIBUTES = %i[line column cop_name
message severity].freeze
# @api public
#
# @!attribute [r] severity
#
# @return [RuboCop::Cop::Severity]
attr_reader :severity
# @api public
#
# @!attribute [r] location
#
# @return [Parser::Source::Range]
# the location where the violation is detected.
#
# @see https://www.rubydoc.info/gems/parser/Parser/Source/Range
# Parser::Source::Range
attr_reader :location
# @api public
#
# @!attribute [r] message
#
# @return [String]
# human-readable message
#
# @example
# 'Line is too long. [90/80]'
attr_reader :message
# @api public
#
# @!attribute [r] cop_name
#
# @return [String]
# a cop class name without department.
# i.e. type of the violation.
#
# @example
# 'LineLength'
attr_reader :cop_name
# @api private
attr_reader :status
# @api public
#
# @!attribute [r] corrector
#
# @return [Corrector | nil]
# the autocorrection for this offense, or `nil` when not available
attr_reader :corrector
PseudoSourceRange = Struct.new(:line, :column, :source_line, :begin_pos,
:end_pos) do
alias_method :first_line, :line
alias_method :last_line, :line
alias_method :last_column, :column
def column_range
column...last_column
end
def size
end_pos - begin_pos
end
alias_method :length, :size
end
private_constant :PseudoSourceRange
NO_LOCATION = PseudoSourceRange.new(1, 0, '', 0, 0).freeze
# @api private
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
# @api public
#
# @!attribute [r] correctable?
#
# @return [Boolean]
# whether this offense can be automatically corrected via
# autocorrect or a todo.
def correctable?
@status != :unsupported
end
# @api public
#
# @!attribute [r] corrected?
#
# @return [Boolean]
# whether this offense is automatically corrected via
# autocorrect or a todo.
def corrected?
@status == :corrected || @status == :corrected_with_todo
end
# @api public
#
# @!attribute [r] corrected_with_todo?
#
# @return [Boolean]
# whether this offense is automatically disabled via a todo.
def corrected_with_todo?
@status == :corrected_with_todo
end
# @api public
#
# @!attribute [r] disabled?
#
# @return [Boolean]
# whether this offense was locally disabled with a
# disable or todo where it occurred.
def disabled?
@status == :disabled || @status == :todo
end
# @api public
#
# @return [Parser::Source::Range]
# the range of the code that is highlighted
def highlighted_area
Parser::Source::Range.new(source_line,
column,
column + column_length)
end
# @api private
# This is just for debugging purpose.
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
# @api private
def line
location.line
end
# @api private
def column
location.column
end
# @api private
def source_line
location.source_line
end
# @api private
def column_length
if first_line == last_line
column_range.count
else
source_line.length - column
end
end
# @api private
def first_line
location.first_line
end
# @api private
def last_line
location.last_line
end
# @api private
def last_column
location.last_column
end
# @api private
def column_range
location.column_range
end
# @api private
#
# 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.
def real_column
column + 1
end
# @api public
#
# @return [Boolean]
# returns `true` if two offenses contain same attributes
def ==(other)
COMPARISON_ATTRIBUTES.all? do |attribute|
send(attribute) == other.send(attribute)
end
end
alias eql? ==
def hash
COMPARISON_ATTRIBUTES.reduce(0) do |hash, attribute|
hash ^ send(attribute).hash
end
end
# @api public
#
# Returns `-1`, `0`, or `+1`
# if this offense is less than, equal to, or greater than `other`.
#
# @return [Integer]
# comparison result
def <=>(other)
COMPARISON_ATTRIBUTES.each do |attribute|
result = send(attribute) <=> other.send(attribute)
return result unless result.zero?
end
0
end
end
end
end