Class: RuboCop::Cop::Lint::SafeNavigationChain

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector, TargetRubyVersion
Includes:
NilMethods
Defined in:
lib/rubocop/cop/lint/safe_navigation_chain.rb

Overview

The safe navigation operator returns nil if the receiver is nil. If you chain an ordinary method call after a safe navigation operator, it raises NoMethodError. We should use a safe navigation operator after a safe navigation operator. This cop checks for the problem outlined above.

Examples:


# bad
x&.foo.bar
x&.foo + bar
x&.foo[bar]

# good
x&.foo&.bar
x&.foo || bar

Constant Summary collapse

MSG = 
'Do not chain ordinary method call after safe navigation operator.'
PLUS_MINUS_METHODS = 
%i[+@ -@].freeze

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods included from TargetRubyVersion

minimum_target_ruby_version, required_minimum_ruby_version, support_target_ruby_version?

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

#bad_method?(node) ⇒ Object 



33
34
35
36
37
38
 
# File 'lib/rubocop/cop/lint/safe_navigation_chain.rb', line 33

def_node_matcher :bad_method?, <<~PATTERN
  {
    (send $(csend ...) $_ ...)
    (send $({block numblock} (csend ...) ...) $_ ...)
  }
PATTERN

#on_send(node) ⇒ Object 



40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/rubocop/cop/lint/safe_navigation_chain.rb', line 40

def on_send(node)
  return unless require_safe_navigation?(node)

  bad_method?(node) do |safe_nav, method|
    return if nil_methods.include?(method) || PLUS_MINUS_METHODS.include?(node.method_name)

    begin_range = node.loc.dot || safe_nav.source_range.end
    location = begin_range.join(node.source_range.end)

    add_offense(location) do |corrector|
      autocorrect(corrector, offense_range: location, send_node: node)
    end
  end
end