forked from rubocop/rubocop
/
debugger.rb
125 lines (113 loc) · 3.06 KB
/
debugger.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
# frozen_string_literal: true
module RuboCop
module Cop
module Lint
# Checks for debug calls (such as `debugger` or `binding.pry`) that should
# not be kept for production code.
#
# The cop can be configured using `DebuggerMethods`. By default, a number of gems
# debug entrypoints are configured (`Kernel`, `Byebug`, `Capybara`, `debug.rb`,
# `Pry`, `Rails`, `RubyJard`, and `WebConsole`). Additional methods can be added.
#
# Specific default groups can be disabled if necessary:
#
# [source,yaml]
# ----
# Lint/Debugger:
# DebuggerMethods:
# WebConsole: ~
# ----
#
# You can also add your own methods by adding a new category:
#
# [source,yaml]
# ----
# Lint/Debugger:
# DebuggerMethods:
# MyDebugger:
# MyDebugger.debug_this
# ----
#
# @example
#
# # bad (ok during development)
#
# # using pry
# def some_method
# binding.pry
# do_something
# end
#
# @example
#
# # bad (ok during development)
#
# # using byebug
# def some_method
# byebug
# do_something
# end
#
# @example
#
# # good
#
# def some_method
# do_something
# end
#
# @example DebuggerMethods: [my_debugger]
#
# # bad (ok during development)
#
# def some_method
# my_debugger
# end
class Debugger < Base
MSG = 'Remove debugger entry point `%<source>s`.'
def on_send(node)
return unless debugger_method?(node)
add_offense(node)
end
private
def message(node)
format(MSG, source: node.source)
end
def debugger_methods
@debugger_methods ||= begin
config = cop_config.fetch('DebuggerMethods', [])
values = config.is_a?(Array) ? config : config.values.flatten
values.map do |v|
next unless v
*receiver, method_name = v.split('.')
{
receiver: receiver.empty? ? nil : receiver.map(&:to_sym),
method_name: method_name.to_sym
}
end.compact
end
end
def debugger_method?(send_node)
debugger_methods.any? do |method|
next unless method[:method_name] == send_node.method_name
if method[:receiver].nil?
send_node.receiver.nil?
else
method[:receiver] == receiver_chain(send_node)
end
end
end
def receiver_chain(send_node)
receivers = []
receiver = send_node.receiver
while receiver
name = receiver.send_type? ? receiver.method_name : receiver.const_name&.to_sym
receivers.unshift(name)
receiver = receiver.receiver
end
receivers
end
end
end
end
end