123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::InternalAffairs::OnSendWithoutOnCSend

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/internal_affairs/on_send_without_on_csend.rb

Overview

Checks for cops that define #on_send without define on_csend.

Although in some cases it can be predetermined that safe navigation will never be used with the code checked by a specific cop, in general it is good practice to handle safe navigation methods if handling any send node.

Note
 It is expected to disable this cop for cops that check for method calls on receivers that cannot be nil (self, a literal, a constant), and method calls that will never have a receiver (ruby keywords like raise, macros like attr_reader, DSL methods, etc.), and other checks that wouldn’t make sense to support safe navigation.

Examples:

# bad
class MyCop < RuboCop::Cop:Base
  def on_send(node)
    # ...
  end
end

# good - explicit method definition
class MyCop < RuboCop::Cop:Base
  def on_send(node)
    # ...
  end

  def on_csend(node)
    # ...
  end
end

# good - alias
class MyCop < RuboCop::Cop:Base
  def on_send(node)
    # ...
  end
  alias on_csend on_send
end

# good - alias_method
class MyCop < RuboCop::Cop:Base
  def on_send(node)
    # ...
  end
  alias_method :on_csend, :on_send
end

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, #eol_comment, #eol_comment_would_be_inside_literal?, #heredoc_range, #line_with_eol_comment_too_long?, #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, #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

#on_alias(node)

[ GitHub ] 

  


# File 'lib/rubocop/cop/internal_affairs/on_send_without_on_csend.rb', line 73



def on_alias(node)
  @on_send_definition = node if node.new_identifier.value == :on_send
  @on_csend_definition = node if node.new_identifier.value == :on_csend
end


  








  

    #on_def(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/internal_affairs/on_send_without_on_csend.rb', line 68



def on_def(node)
  @on_send_definition = node if node.method?(:on_send)
  @on_csend_definition = node if node.method?(:on_csend)
end


  








  

    #on_investigation_end  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/internal_affairs/on_send_without_on_csend.rb', line 62



def on_investigation_end
  return unless @on_send_definition && !@on_csend_definition

  add_offense(@on_send_definition)
end


  








  

    #on_new_investigation  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/internal_affairs/on_send_without_on_csend.rb', line 57



def on_new_investigation
  @on_send_definition = nil
  @on_csend_definition = nil
end


  








  

    #on_send(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/internal_affairs/on_send_without_on_csend.rb', line 78



def on_send(node) # rubocop:disable InternalAffairs/OnSendWithoutOnCSend
  return unless (new_identifier = node.first_argument)
  return unless new_identifier.basic_literal?

  new_identifier = new_identifier.value

  @on_send_definition = node if new_identifier == :on_send
  @on_csend_definition = node if new_identifier == :on_csend
end