Class: RuboCop::Cop::Style::SafeNavigationChainLength

Inherits:
Base
  • Object
show all
Defined in:
lib/rubocop/cop/style/safe_navigation_chain_length.rb

Overview

Enforces safe navigation chains length to not exceed the configured maximum. The longer the chain is, the harder it becomes to track what on it could be returning nil.

There is a potential interplay with Style/SafeNavigation - if both are enabled and their settings are “incompatible”, one of the cops will complain about what the other proposes.

E.g. if Style/SafeNavigation is configured with ‘MaxChainLength: 2` (default) and this cop is configured with `Max: 1`, then for `foo.bar.baz if foo` the former will suggest `foo&.bar&.baz`, which is an offense for the latter.

Examples:

Max: 2 (default)

# bad
user&.address&.zip&.upcase

# good
user&.address&.zip
user.address.zip if user

Constant Summary collapse

MSG = 
'Avoid safe navigation chains longer than %<max>d calls.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

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_gem_version, #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

#on_csend(node) ⇒ Object 



29
30
31
32
33
34
 
# File 'lib/rubocop/cop/style/safe_navigation_chain_length.rb', line 29

def on_csend(node)
  safe_navigation_chains = safe_navigation_chains(node)
  return if safe_navigation_chains.size < max

  add_offense(safe_navigation_chains.last, message: format(MSG, max: max))
end