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

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
CommentsHelp, DigHelp
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)

Constant Summary collapse

MSG = 
'Use `%<replacement>s` instead of chaining.'
RESTRICT_ON_SEND = 
%i[dig].freeze

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods included from DigHelp

#dig?, #single_argument_dig?

Methods included from CommentsHelp

#comments_contain_disables?, #comments_in_range, #contains_comments?, #source_range_with_comment

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, autocorrect_incompatible_with, badge, #begin_investigation, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, #string_literals_frozen_by_default?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

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

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

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

Instance Method Details

#on_send(node) ⇒ Object Also known as: on_csend 



33
34
35
36
37
38
39
40
41
42
43
 
# 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