Class: RuboCop::Cop::Style::SingleArgumentDig

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Defined in:
lib/rubocop/cop/style/single_argument_dig.rb

Overview

Sometimes using dig method ends up with just a single argument. In such cases, dig should be replaced with [].

Examples:

# bad
{ key: 'value' }.dig(:key)
[1, 2, 3].dig(0)

# good
{ key: 'value' }[:key]
[1, 2, 3][0]

# good
{ key1: { key2: 'value' } }.dig(:key1, :key2)
[1, [2, [3]]].dig(1, 1)

# good
keys = %i[key1 key2]
{ key1: { key2: 'value' } }.dig(*keys)

Constant Summary collapse

MSG =
'Use `%<receiver>s[%<argument>s]` instead of `%<original>s`.'
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 inherited from Base

#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #ready, #relevant_file?, 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?, #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


37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
# File 'lib/rubocop/cop/style/single_argument_dig.rb', line 37

def on_send(node)
  return unless node.receiver

  expression = single_argument_dig?(node)
  return unless expression

  receiver = node.receiver.source
  argument = expression.source

  message = format(MSG, receiver: receiver, argument: argument, original: node.source)
  add_offense(node, message: message) do |corrector|
    correct_access = "#{receiver}[#{argument}]"
    corrector.replace(node, correct_access)
  end
end

#single_argument_dig?(node) ⇒ Object


33
34
35
# File 'lib/rubocop/cop/style/single_argument_dig.rb', line 33

def_node_matcher :single_argument_dig?, <<~PATTERN
  (send _ :dig $!splat)
PATTERN