forked from rubocop/rubocop-rails
-
Notifications
You must be signed in to change notification settings - Fork 0
/
skips_model_validations.rb
87 lines (77 loc) · 2.72 KB
/
skips_model_validations.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
# frozen_string_literal: true
module RuboCop
module Cop
module Rails
# This cop checks for the use of methods which skip
# validations which are listed in
# https://guides.rubyonrails.org/active_record_validations.html#skipping-validations
#
# Methods may be ignored from this rule by configuring a `Whitelist`.
#
# @example
# # bad
# Article.first.decrement!(:view_count)
# DiscussionBoard.decrement_counter(:post_count, 5)
# Article.first.increment!(:view_count)
# DiscussionBoard.increment_counter(:post_count, 5)
# person.toggle :active
# product.touch
# Billing.update_all("category = 'authorized', author = 'David'")
# user.update_attribute(:website, 'example.com')
# user.update_columns(last_request_at: Time.current)
# Post.update_counters 5, comment_count: -1, action_count: 1
#
# # good
# user.update(website: 'example.com')
# FileUtils.touch('file')
#
# @example Whitelist: ["touch"]
# # bad
# DiscussionBoard.decrement_counter(:post_count, 5)
# DiscussionBoard.increment_counter(:post_count, 5)
# person.toggle :active
#
# # good
# user.touch
#
class SkipsModelValidations < Cop
MSG = 'Avoid using `%<method>s` because it skips validations.'
METHODS_WITH_ARGUMENTS = %w[decrement!
decrement_counter
increment!
increment_counter
toggle!
update_all
update_attribute
update_column
update_columns
update_counters].freeze
def_node_matcher :good_touch?, <<~PATTERN
(send (const nil? :FileUtils) :touch ...)
PATTERN
def on_send(node)
return if whitelist.include?(node.method_name.to_s)
return unless blacklist.include?(node.method_name.to_s)
return if allowed_method?(node)
return if good_touch?(node)
add_offense(node, location: :selector)
end
alias on_csend on_send
private
def message(node)
format(MSG, method: node.method_name)
end
def allowed_method?(node)
METHODS_WITH_ARGUMENTS.include?(node.method_name.to_s) &&
!node.arguments?
end
def blacklist
cop_config['Blacklist'] || []
end
def whitelist
cop_config['Whitelist'] || []
end
end
end
end
end