forked from rubocop/rubocop-rails
-
Notifications
You must be signed in to change notification settings - Fork 0
/
enum_hash.rb
64 lines (55 loc) · 1.6 KB
/
enum_hash.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
# frozen_string_literal: true
module RuboCop
module Cop
module Rails
# This cop looks for enums written with array syntax.
#
# When using array syntax, adding an element in a
# position other than the last causes all previous
# definitions to shift. Explicitly specifying the
# value for each key prevents this from happening.
#
# @example
# # bad
# enum status: [:active, :archived]
#
# # good
# enum status: { active: 0, archived: 1 }
#
class EnumHash < Cop
MSG = 'Enum defined as an array found in `%<enum>s` enum declaration. '\
'Use hash syntax instead.'
def_node_matcher :enum?, <<~PATTERN
(send nil? :enum (hash $...))
PATTERN
def_node_matcher :array_pair?, <<~PATTERN
(pair $_ $array)
PATTERN
def on_send(node)
enum?(node) do |pairs|
pairs.each do |pair|
key, array = array_pair?(pair)
next unless key
add_offense(array, message: format(MSG, enum: enum_name(key)))
end
end
end
def autocorrect(node)
hash = node.children.each_with_index.map do |elem, index|
"#{elem.source} => #{index}"
end.join(', ')
->(corrector) { corrector.replace(node.loc.expression, "{#{hash}}") }
end
private
def enum_name(key)
case key.type
when :sym, :str
key.value
else
key.source
end
end
end
end
end
end