class RuboCop::Cop::Lint::Debugger

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

Constants

MSG

Public Instance Methods

on_send(node) click to toggle source
# File lib/rubocop/cop/lint/debugger.rb, line 70
def on_send(node)
  return unless debugger_method?(node)

  add_offense(node)
end

Private Instance Methods

debugger_method?(send_node) click to toggle source
# File lib/rubocop/cop/lint/debugger.rb, line 98
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
debugger_methods() click to toggle source
# File lib/rubocop/cop/lint/debugger.rb, line 82
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
message(node) click to toggle source
# File lib/rubocop/cop/lint/debugger.rb, line 78
def message(node)
  format(MSG, source: node.source)
end
receiver_chain(send_node) click to toggle source
# File lib/rubocop/cop/lint/debugger.rb, line 110
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