123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Style::DigChain

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

Overview

Check for chained dig calls that can be collapsed into a single dig.

Examples:

# bad
x.dig(:foo).dig(:bar).dig(:baz)
x.dig(:foo, :bar).dig(:baz)
x.dig(:foo, :bar)&.dig(:baz)

# good
x.dig(:foo, :bar, :baz)

# good - `dig`s cannot be combined
x.dig(:foo).bar.dig(:baz)

Cop Safety Information:

  • This cop is unsafe because it cannot be guaranteed that the receiver is an Enumerable or does not have a nonstandard implementation of dig.

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

Class Attribute Summary

::RuboCop::Cop::AutoCorrector - Extended

support_autocorrect?

::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::DigHelp - Included

#dig_chain_enabled?

::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::DigHelp - Included

#dig?, #single_argument_dig?

::RuboCop::Cop::CommentsHelp - Included

#comments_contain_disables?, #comments_in_range, #contains_comments?, #source_range_with_comment, #begin_pos_with_comment, #buffer, #end_position_for,
#find_end_line

Returns the end line of a node, which might be a comment and not part of the AST End line is considered either the line at which another node starts, or the line at which the parent node ends.
#start_line_position

::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

#inspect_chain(node) (private)

Walk up the method chain while the receiver is dig with arguments.

[ GitHub ] 

  


# File 'lib/rubocop/cop/style/dig_chain.rb', line 49



def inspect_chain(node)
  arguments = node.arguments.dup
  end_range = node.source_range.end

  while dig?(node = node.receiver)
    begin_range = node.loc.selector
    arguments.unshift(*node.arguments)
    ignore_node(node)
  end

  return unless begin_range

  [begin_range.join(end_range), arguments]
end


  








  

    #invalid_arguments?(arguments)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/dig_chain.rb', line 64



def invalid_arguments?(arguments)
  # If any of the arguments are arguments forwarding (`...`), it can only be the
  # first argument, or else the resulting code will have a syntax error.

  return false unless arguments&.any?

  forwarded_args_index = arguments.index(&:forwarded_args_type?)
  forwarded_args_index && forwarded_args_index < (arguments.size - 1)
end


  








  

    #on_csend(node)  
  



  

    


Alias for #on_send.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/dig_chain.rb', line 44



alias on_csend on_send


  








  

    #on_send(node)  
    Also known as: #on_csend
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/dig_chain.rb', line 33



def on_send(node)
  return if ignored_node?(node)
  return unless node.loc.dot
  return unless dig?(node)

  range, arguments = inspect_chain(node)
  return if invalid_arguments?(arguments)
  return unless range

  register_offense(node, range, arguments)
end


  








  

    #register_offense(node, range, arguments)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/dig_chain.rb', line 74



def register_offense(node, range, arguments)
  arguments = arguments.map(&:source).join(', ')
  replacement = "dig(#{arguments})"

  add_offense(range, message: format(MSG, replacement: replacement)) do |corrector|
    corrector.replace(range, replacement)

    comments_in_range(node).reverse_each do |comment|
      corrector.insert_before(node, "#{comment.source}\n")
    end
  end
end