123456789_123456789_123456789_123456789_123456789_

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

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::RuboCop::Cop::AutoCorrector, ::RuboCop::Cop::Base, ::RuboCop::ExcludeLimit, NodePattern::Macros, RuboCop::AST::Sexp
Instance Chain:
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/lint/safe_navigation_consistency.rb

Overview

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

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

Class Attribute Summary

::RuboCop::Cop::AutoCorrector - Extended

::RuboCop::Cop::Base - Inherited

.gem_requirements, .lint?,
.support_autocorrect?

Returns if class supports autocorrect.

.support_multiple_source?

Override if your cop should be called repeatedly for multiple investigations Between calls to on_new_investigation and on_investigation_end, the result of processed_source will remain constant.

Class Method Summary

::RuboCop::Cop::Base - Inherited

.autocorrect_incompatible_with

List of cops that should not try to autocorrect at the same time as this cop.

.badge

Naming.

.callbacks_needed, .cop_name, .department,
.documentation_url

Returns an url to view this cops documentation online.

.exclude_from_registry

Call for abstract Cop classes.

.inherited,
.joining_forces

Override and return the Force class(es) you need to join.

.match?

Returns true if the cop name or the cop namespace matches any of the given names.

.new,
.requires_gem

Register a version requirement for the given gem name.

.restrict_on_send

::RuboCop::ExcludeLimit - Extended

exclude_limit

Sets up a configuration option to have an exclude limit tracked.

transform

Instance Attribute Summary

Instance Method Summary

::RuboCop::Cop::NilMethods - Included

::RuboCop::Cop::AllowedMethods - Included

::RuboCop::Cop::Base - Inherited

#add_global_offense

Adds an offense that has no particular location.

#add_offense

Adds an offense on the specified range (or node with an expression) Unless that offense is disabled for this range, a corrector will be yielded to provide the cop the opportunity to autocorrect the offense.

#begin_investigation

Called before any investigation.

#callbacks_needed,
#cop_config

Configuration Helpers.

#cop_name, #excluded_file?,
#external_dependency_checksum

This method should be overridden when a cop’s behavior depends on state that lives outside of these locations:

#inspect
#message

Gets called if no message is specified when calling add_offense or add_global_offense Cops are discouraged to override this; instead pass your message directly.

#name

Alias for Base#cop_name.

#offenses,
#on_investigation_end

Called after all on_…​

#on_new_investigation

Called before all on_…​

#on_other_file

Called instead of all on_…​

#parse

There should be very limited reasons for a Cop to do it’s own parsing.

#parser_engine,
#ready

Called between investigations.

#relevant_file?, #target_rails_version, #target_ruby_version, #annotate, #apply_correction, #attempt_correction,
#callback_argument

Reserved for Cop::Cop.

#complete_investigation

Called to complete an investigation.

#correct, #current_corrector,
#current_offense_locations

Reserved for Commissioner:

#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?, #file_name_matches_any?, #find_message, #find_severity, #range_for_original, #range_from_node_or_range,
#reset_investigation

Actually private methods.

#use_corrector

::RuboCop::Cop::AutocorrectLogic - Included

::RuboCop::Cop::IgnoredNode - Included

Constructor Details

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

Instance Method Details

#autocorrect(corrector, node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/safe_navigation_consistency.rb', line 61

def autocorrect(corrector, node)
  return unless node.dot?

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

#check(node)

[ GitHub ]

  
# 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 = location(node, unsafe_method_call)

    add_offense(location) { |corrector| autocorrect(corrector, unsafe_method_call) }

    ignore_node(unsafe_method_call)
  end
end

#location(node, unsafe_method_call) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/safe_navigation_consistency.rb', line 67

def location(node, unsafe_method_call)
  node.source_range.join(unsafe_method_call.source_range)
end

#on_csend(node)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/safe_navigation_consistency.rb', line 36

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

  check(node)
end

#top_conditional_ancestor(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/safe_navigation_consistency.rb', line 71

def top_conditional_ancestor(node)
  parent = node.parent
  unless parent &&
         (parent.operator_keyword? ||
          (parent.begin_type? && parent.parent && parent.parent.operator_keyword?))
    return node
  end

  top_conditional_ancestor(parent)
end

#unsafe_method_calls(method_calls, safe_nav_receiver) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/safe_navigation_consistency.rb', line 82

def unsafe_method_calls(method_calls, safe_nav_receiver)
  method_calls.select do |method_call|
    safe_nav_receiver == method_call.receiver &&
      !nil_methods.include?(method_call.method_name) &&
      !ignored_node?(method_call)
  end
end