Class: RuboCop::Cop::Lint::SafeNavigationConsistency

Inherits:
Cop
  • Object
show all
Includes:
IgnoredNode, NilMethods
Defined in:
lib/rubocop/cop/lint/safe_navigation_consistency.rb

Overview

This cop check to make sure that if safe navigation is used for a method call in an `&&` or `||` condition that safe navigation is used for all method calls on that same object.

Examples:

# bad
foo&.bar && foo.baz

# bad
foo.bar || foo&.baz

# bad
foo&.bar && (foobar.baz || foo.baz)

# good
foo.bar && foo.baz

# good
foo&.bar || foo&.baz

# good
foo&.bar && (foobar.baz || foo&.baz)

Constant Summary collapse

MSG =
'Ensure that safe navigation is used consistently ' \
'inside of `&&` and `||`.'.freeze

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

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, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #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?, #support_autocorrect?

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

Methods included from PathUtil

absolute?, 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

#autocorrect(node) ⇒ Object



61
62
63
64
65
66
67
# File 'lib/rubocop/cop/lint/safe_navigation_consistency.rb', line 61

def autocorrect(node)
  return unless node.dot?

  lambda do |corrector|
    corrector.insert_before(node.loc.dot, '&')
  end
end

#check(node) ⇒ Object



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# File 'lib/rubocop/cop/lint/safe_navigation_consistency.rb', line 42

def check(node)
  ancestor = top_conditional_ancestor(node)
  conditions = ancestor.conditions
  safe_nav_receiver = node.receiver

  method_calls = conditions.select(&:send_type?)
  unsafe_method_calls =
    unsafe_method_calls(method_calls, safe_nav_receiver)

  unsafe_method_calls.each do |unsafe_method_call|
    location =
      node.loc.expression.join(unsafe_method_call.loc.expression)
    add_offense(unsafe_method_call,
                location: location)

    ignore_node(unsafe_method_call)
  end
end

#on_csend(node) ⇒ Object



36
37
38
39
40
# File 'lib/rubocop/cop/lint/safe_navigation_consistency.rb', line 36

def on_csend(node)
  return unless node.parent && node.parent.operator_keyword?

  check(node)
end