123456789_123456789_123456789_123456789_123456789_

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

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::RuboCop::Cop::Base, ::RuboCop::ExcludeLimit, NodePattern::Macros, RuboCop::AST::Sexp
Instance Chain:
self, ::RuboCop::Cop::Base, ::RuboCop::Cop::AutocorrectLogic, ::RuboCop::Cop::IgnoredNode, ::RuboCop::Util, RuboCop::AST::Sexp
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/lint/debugger.rb

Overview

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:

Lint/Debugger:
  DebuggerMethods:
    WebConsole: ~

You can also add your own methods by adding a new category:

Lint/Debugger:
  DebuggerMethods:
    MyDebugger:
      MyDebugger.debug_this

Some gems also ship files that will start a debugging session when required, for example require 'debug/start' from ruby/debug. These requires can be configured through DebuggerRequires. It has the same structure as DebuggerMethods, which you can read about above.

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

DebuggerMethods: [my_debugger]

# bad (ok during development)

def some_method
  my_debugger
end

DebuggerRequires: [my_debugger/start]

# bad (ok during development)

require 'my_debugger/start'

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

Class Attribute Summary

::RuboCop::Cop::Base - Inherited

.gem_requirements, .lint?,
.support_autocorrect?

Returns if class supports autocorrect.
.support_multiple_source?

Override if your cop should be called repeatedly for multiple investigations Between calls to on_new_investigation and on_investigation_end, the result of processed_source will remain constant.

Class Method Summary

::RuboCop::Cop::Base - Inherited

.autocorrect_incompatible_with

List of cops that should not try to autocorrect at the same time as this cop.
.badge

Naming.
.callbacks_needed, .cop_name, .department,
.documentation_url

Returns a url to view this cops documentation online.
.exclude_from_registry

Call for abstract Cop classes.
.inherited,
.joining_forces

Override and return the Force class(es) you need to join.
.match?

Returns true if the cop name or the cop namespace matches any of the given names.
.new,
.requires_gem

Register a version requirement for the given gem name.
.restrict_on_send

::RuboCop::ExcludeLimit - Extended

exclude_limit

Sets up a configuration option to have an exclude limit tracked.
transform

Instance Attribute Summary

::RuboCop::Cop::Base - Inherited

#active_support_extensions_enabled?, #always_autocorrect?, #config, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #processed_source, #string_literals_frozen_by_default?, #target_satisfies_all_gem_version_requirements?

::RuboCop::Cop::AutocorrectLogic - Included

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Instance Method Summary

::RuboCop::Cop::Base - Inherited

#add_global_offense

Adds an offense that has no particular location.
#add_offense

Adds an offense on the specified range (or node with an expression) Unless that offense is disabled for this range, a corrector will be yielded to provide the cop the opportunity to autocorrect the offense.
#begin_investigation

Called before any investigation.
#callbacks_needed,
#cop_config

Configuration Helpers.
#cop_name, #excluded_file?,
#external_dependency_checksum

This method should be overridden when a cop’s behavior depends on state that lives outside of these locations:
#inspect,
#message

Gets called if no message is specified when calling add_offense or add_global_offense Cops are discouraged to override this; instead pass your message directly.
#name

Alias for Base#cop_name.
#offenses,
#on_investigation_end

Called after all on_…​
#on_new_investigation

Called before all on_…​
#on_other_file

Called instead of all on_…​
#parse

There should be very limited reasons for a Cop to do it’s own parsing.
#parser_engine,
#ready

Called between investigations.
#relevant_file?,
#target_gem_version

Returns a gems locked versions (i.e.
#target_rails_version, #target_ruby_version, #annotate, #apply_correction, #attempt_correction,
#callback_argument

Reserved for Cop::Cop.
#complete_investigation

Called to complete an investigation.
#correct, #current_corrector,
#current_offense_locations

Reserved for Commissioner:
#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?, #file_name_matches_any?, #find_message, #find_severity, #range_for_original, #range_from_node_or_range,
#reset_investigation

Actually private methods.
#use_corrector

::RuboCop::Cop::AutocorrectLogic - Included

#disable_offense, #disable_offense_at_end_of_line, #disable_offense_before_and_after, #disable_offense_with_eol_or_surround_comment, #heredoc_range, #max_line_length, #multiline_ranges, #multiline_string?,
#range_by_lines

Expand the given range to include all of any lines it covers.
#range_of_first_line, #range_overlaps_offense?, #string_continuation?, #surrounding_heredoc?, #surrounding_percent_array?

::RuboCop::Cop::IgnoredNode - Included

#ignore_node, #ignored_node?, #part_of_ignored_node?, #ignored_nodes

Constructor Details

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

Instance Method Details

#assumed_argument?(node) ⇒ Boolean (private)

[ GitHub ] 

  


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



def assumed_argument?(node)
  parent = node.parent

  parent.call_type? || parent.literal? || parent.pair_type?
end


  








  

    #assumed_usage_context?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


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



def assumed_usage_context?(node)
  # Basically, debugger methods are not used as a method argument without arguments.
  return false unless node.arguments.empty? && node.each_ancestor(:send, :csend).any?
  return true if assumed_argument?(node)

  node.each_ancestor.none? do |ancestor|
    BLOCK_TYPES.include?(ancestor.type) || ancestor.lambda_or_proc?
  end
end


  








  

    #chained_method_name(send_node)   (private)
  

  [ GitHub ]


  

  


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



def chained_method_name(send_node)
  chained_method_name = send_node.method_name.to_s
  receiver = send_node.receiver
  while receiver
    name = receiver.send_type? ? receiver.method_name : receiver.const_name
    chained_method_name = "#{name}.#{chained_method_name}"
    receiver = receiver.receiver
  end
  chained_method_name
end


  








  

    #debugger_method?(send_node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


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



def debugger_method?(send_node)
  return false if send_node.parent&.send_type? && send_node.parent.receiver == send_node

  debugger_methods.include?(chained_method_name(send_node))
end


  








  

    #debugger_methods   (private)
  

  [ GitHub ]


  

  


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



def debugger_methods
  @debugger_methods ||= begin
    config = cop_config.fetch('DebuggerMethods', [])
    config.is_a?(Array) ? config : config.values.flatten
  end
end


  








  

    #debugger_require?(send_node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


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



def debugger_require?(send_node)
  return false unless send_node.method?(:require) && send_node.arguments.one?
  return false unless (argument = send_node.first_argument).str_type?

  debugger_requires.include?(argument.value)
end


  








  

    #debugger_requires   (private)
  

  [ GitHub ]


  

  


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



def debugger_requires
  @debugger_requires ||= begin
    config = cop_config.fetch('DebuggerRequires', [])
    config.is_a?(Array) ? config : config.values.flatten
  end
end


  








  

    #message(node)   (private)
  

  [ GitHub ]


  

  


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



def message(node)
  format(MSG, source: node.source)
end


  








  

    #on_send(node)  
  

  [ GitHub ]


  

  


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



def on_send(node)
  return if assumed_usage_context?(node)

  add_offense(node) if debugger_method?(node) || debugger_require?(node)
end