forked from rubocop/rubocop-minitest
-
Notifications
You must be signed in to change notification settings - Fork 0
/
refute_false.rb
75 lines (63 loc) · 2.25 KB
/
refute_false.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
# frozen_string_literal: true
module RuboCop
module Cop
module Minitest
# Enforces the use of `refute(object)` over `assert_equal(false, object)`.
#
# @safety
# This cop is unsafe because it cannot detect failure when second argument is `nil`.
# False positives cannot be prevented when this is a variable or method return value.
#
# [source,ruby]
# ----
# assert_equal(false, nil) # failure
# refute(nil) # success
# ----
#
# @example
# # bad
# assert_equal(false, actual)
# assert_equal(false, actual, 'message')
#
# assert(!test)
# assert(!test, 'message')
#
# # good
# refute(actual)
# refute(actual, 'message')
#
class RefuteFalse < Base
include ArgumentRangeHelper
extend AutoCorrector
MSG_FOR_ASSERT_EQUAL = 'Prefer using `refute(%<arguments>s)`.'
MSG_FOR_ASSERT = 'Prefer using `refute(%<arguments>s)`.'
RESTRICT_ON_SEND = %i[assert_equal assert].freeze
def_node_matcher :assert_equal_with_false, <<~PATTERN
(send nil? :assert_equal false $_ $...)
PATTERN
def_node_matcher :assert_with_bang_argument, <<~PATTERN
(send nil? :assert (send $_ :!) $...)
PATTERN
def on_send(node)
actual, rest_receiver_arg = assert_equal_with_false(node) || assert_with_bang_argument(node)
return unless actual
message_argument = rest_receiver_arg.first
arguments = [actual.source, message_argument&.source].compact.join(', ')
message = node.method?(:assert_equal) ? MSG_FOR_ASSERT_EQUAL : MSG_FOR_ASSERT
add_offense(node, message: format(message, arguments: arguments)) do |corrector|
autocorrect(corrector, node, actual)
end
end
private
def autocorrect(corrector, node, actual)
corrector.replace(node.loc.selector, 'refute')
if node.method?(:assert_equal)
corrector.replace(first_and_second_arguments_range(node), actual.source)
else
corrector.replace(node.first_argument, actual.source)
end
end
end
end
end
end