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

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/lint/debugger.rb

Overview

This cop checks for calls to debugger or pry.

Examples:


# bad (ok during development)

# using pry
def some_method
  binding.pry
  do_something
end

# bad (ok during development)

# using byebug
def some_method
  byebug
  do_something
end

# good

def some_method
  do_something
end

Constant Summary collapse

MSG = 
'Remove debugger entry point `%s`.'.freeze

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_ruby_version

Methods included from AST::Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

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, comment_line?, compatible_external_encoding_for?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, hard_to_type?, interpret_string_escapes, line_distance, line_range, move_pos, needs_escaping?, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, preceed?, range_between, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, to_string_literal, to_supported_styles, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, match_path?, relative_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/rubocop/cop/lint/debugger.rb', line 59

def autocorrect(node)
  lambda do |corrector|
    if pry_rescue?(node)
      block = node.parent
      body  = block.children[2] # (block <send> <parameters> <body>)
      corrector.replace(block.source_range, body.source)
    else
      range = node.source_range
      range = range_with_surrounding_space(range, :left, false)
      range = range_with_surrounding_space(range, :right, true)
      corrector.remove(range)
    end
  end
end

#binding_irb?(node) ⇒ Boolean

Returns:

  • (Boolean) 


74
75
76
 
# File 'lib/rubocop/cop/lint/debugger.rb', line 74

def binding_irb?(node)
  target_ruby_version >= 2.4 && binding_irb_call?(node)
end

#on_send(node) ⇒ Object 



54
55
56
57
 
# File 'lib/rubocop/cop/lint/debugger.rb', line 54

def on_send(node)
  return unless debugger_call?(node) || binding_irb?(node)
  add_offense(node, :expression, format(MSG, node.source))
end