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

Inherits:
Cop
  • Object
show all
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.'

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, #correct, department, #disable_uncorrectable, #duplicate_location?, #excluded_file?, #external_dependency_checksum, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, #parse, qualified_cop_name, #reason_to_not_correct, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AST::Sexp

#s

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_offense, #disable_uncorrectable?, #safe_autocorrect?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#on_send(node) ⇒ Object 


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

def on_send(node)
  bad_method?(node) do |safe_nav, method|
    return if nil_methods.include?(method)

    method_chain = method_chain(node)
    location =
      Parser::Source::Range.new(node.source_range.source_buffer,
                                safe_nav.source_range.end_pos,
                                method_chain.source_range.end_pos)
    add_offense(node, location: location)
  end
end