-
-
Notifications
You must be signed in to change notification settings - Fork 269
/
create_list.rb
207 lines (170 loc) · 6.08 KB
/
create_list.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
# frozen_string_literal: true
module RuboCop
module Cop
module RSpec
module FactoryBot
# Checks for create_list usage.
#
# This cop can be configured using the `EnforcedStyle` option
#
# @example `EnforcedStyle: create_list`
# # bad
# 3.times { create :user }
#
# # good
# create_list :user, 3
#
# # good
# 3.times { |n| create :user, created_at: n.months.ago }
#
# @example `EnforcedStyle: n_times`
# # bad
# create_list :user, 3
#
# # good
# 3.times { create :user }
class CreateList < Cop
extend AutoCorrector
include ConfigurableEnforcedStyle
MSG_CREATE_LIST = 'Prefer create_list.'
MSG_N_TIMES = 'Prefer %<number>s.times.'
def_node_matcher :n_times_block_without_arg?, <<-PATTERN
(block
(send (int _) :times)
(args)
...
)
PATTERN
def_node_matcher :factory_call, <<-PATTERN
(send ${(const nil? {:FactoryGirl :FactoryBot}) nil?} :create (sym $_) $...)
PATTERN
def_node_matcher :factory_list_call, <<-PATTERN
(send {(const nil? {:FactoryGirl :FactoryBot}) nil?} :create_list (sym _) (int $_) ...)
PATTERN
def on_block(node)
return unless style == :create_list
return unless n_times_block_without_arg?(node)
return unless contains_only_factory?(node.body)
add_offense(node.send_node, message: MSG_CREATE_LIST) do |corrector|
CreateListCorrector.new(node.send_node).call(corrector)
end
end
def on_send(node)
return unless style == :n_times
factory_list_call(node) do |count|
message = format(MSG_N_TIMES, number: count)
add_offense(node.loc.selector, message: message) do |corrector|
TimesCorrector.new(node).call(corrector)
end
end
end
private
def contains_only_factory?(node)
if node.block_type?
factory_call(node.send_node)
else
factory_call(node)
end
end
# :nodoc
class Corrector
private
def build_options_string(options)
options.map(&:source).join(', ')
end
def format_method_call(node, method, arguments)
if node.block_type? || node.parenthesized?
"#{method}(#{arguments})"
else
"#{method} #{arguments}"
end
end
def format_receiver(receiver)
return '' unless receiver
"#{receiver.source}."
end
end
# :nodoc
class TimesCorrector < Corrector
def initialize(node)
@node = node
end
def call(corrector)
replacement = generate_n_times_block(node)
corrector.replace(node, replacement)
end
private
attr_reader :node
def generate_n_times_block(node)
factory, count, *options = node.arguments
arguments = factory.source
options = build_options_string(options)
arguments += ", #{options}" unless options.empty?
replacement = format_receiver(node.receiver)
replacement += format_method_call(node, 'create', arguments)
"#{count.source}.times { #{replacement} }"
end
end
# :nodoc:
class CreateListCorrector < Corrector
def initialize(node)
@node = node.parent
end
def call(corrector)
replacement = if node.body.block_type?
call_with_block_replacement(node)
else
call_replacement(node)
end
corrector.replace(node, replacement)
end
private
attr_reader :node
def call_with_block_replacement(node)
block = node.body
arguments = build_arguments(block, node.receiver.source)
replacement = format_receiver(block.send_node.receiver)
replacement += format_method_call(block, 'create_list', arguments)
replacement += format_block(block)
replacement
end
def build_arguments(node, count)
factory, *options = *node.send_node.arguments
arguments = ":#{factory.value}, #{count}"
options = build_options_string(options)
arguments += ", #{options}" unless options.empty?
arguments
end
def call_replacement(node)
block = node.body
factory, *options = *block.arguments
arguments = "#{factory.source}, #{node.receiver.source}"
options = build_options_string(options)
arguments += ", #{options}" unless options.empty?
replacement = format_receiver(block.receiver)
replacement += format_method_call(block, 'create_list', arguments)
replacement
end
def format_block(node)
if node.body.begin_type?
format_multiline_block(node)
else
format_singeline_block(node)
end
end
def format_multiline_block(node)
indent = ' ' * node.body.loc.column
indent_end = ' ' * node.parent.loc.column
" do #{node.arguments.source}\n" \
"#{indent}#{node.body.source}\n" \
"#{indent_end}end"
end
def format_singeline_block(node)
" { #{node.arguments.source} #{node.body.source} }"
end
end
end
end
end
end
end