Class: RuboCop::Cop::Lint::Debugger

Inherits:

Cop

• Object
• Cop
• RuboCop::Cop::Lint::Debugger

Defined in:

lib/rubocop/cop/lint/debugger.rb

Overview

This cop checks for calls to debugger or pry.

Constant Summary

MSG =

'Remove debugger entry point `%s`.'

DEBUGGER_NODE =

debugger call node

(send nil :debugger)

s(:send, nil, :debugger)

BYEBUG_NODE =

byebug call node

(send nil :byebug)

s(:send, nil, :byebug)

PRY_NODE =

binding.pry node

(send (send nil :binding) :pry)

s(:send, s(:send, nil, :binding), :pry)

REMOTE_PRY_NODE =

binding.remote_pry node

(send (send nil :binding) :remote_pry)

s(:send, s(:send, nil, :binding), :remote_pry)

PRY_REMOTE_NODE =

binding.pry_remote node

(send (send nil :binding) :pry_remote)

s(:send, s(:send, nil, :binding), :pry_remote)

CAPYBARA_SAVE_PAGE =

save_and_open_page

(send nil :save_and_open_page)

s(:send, nil, :save_and_open_page)

CAPYBARA_SAVE_OPEN_SCREENSHOT =

save_and_open_screenshot

(send nil :save_and_open_screenshot)

s(:send, nil, :save_and_open_screenshot)

CAPYBARA_SAVE_SCREENSHOT =

save_screenshot

(send nil :save_screenshot)

s(:send, nil, :save_screenshot)

DEBUGGER_NODES =

[
  DEBUGGER_NODE,
  BYEBUG_NODE,
  PRY_NODE,
  REMOTE_PRY_NODE,
  PRY_REMOTE_NODE,
  CAPYBARA_SAVE_PAGE,
  CAPYBARA_SAVE_OPEN_SCREENSHOT,
  CAPYBARA_SAVE_SCREENSHOT
]

Constants included from Util

Util::ASGN_NODES, Util::EQUALS_ASGN_NODES, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary

• #on_send(node) ⇒ Object

Methods inherited from Cop

#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #display_cop_names?, #display_style_guide?, #excluded_file?, inherited, #initialize, #join_force?, lint?, match?, #message, non_rails, qualified_cop_name, rails?, #reference_url, #relevant_file?, #style_guide_url

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, block_length, command?, comment_line?, const_name, directions, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

This class inherits a constructor from RuboCop::Cop::Cop

Instance Method Details

#on_send(node) ⇒ Object

# File 'lib/rubocop/cop/lint/debugger.rb', line 64

def on_send(node)
  receiver, method_name, *_args = *node
  node_without_args = self.class.s(:send, receiver, method_name)
  return unless DEBUGGER_NODES.include? node_without_args
  add_offense(node,
              :expression,
              format(MSG, node.loc.expression.source))
end