Class: RuboCop::Cop::Style::SoleNestedConditional

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
RangeHelp
Defined in:
lib/rubocop/cop/style/sole_nested_conditional.rb

Overview

If the branch of a conditional consists solely of a conditional node, its conditions can be combined with the conditions of the outer branch. This helps to keep the nesting level from getting too deep.

Examples:

# bad
if condition_a
  if condition_b
    do_something
  end
end

# bad
if condition_b
  do_something
end if condition_a

# good
if condition_a && condition_b
  do_something
end

AllowModifier: false (default)

# bad
if condition_a
  do_something if condition_b
end

# bad
if condition_b
  do_something
end if condition_a

AllowModifier: true

# good
if condition_a
  do_something if condition_b
end

# good
if condition_b
  do_something
end if condition_a

Constant Summary collapse

MSG = 
'Consider merging nested conditions into outer `%<conditional_type>s` conditions.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Class Method Summary collapse

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, 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

Class Method Details

.autocorrect_incompatible_with ⇒ Object 



55
56
57
 
# File 'lib/rubocop/cop/style/sole_nested_conditional.rb', line 55

def self.autocorrect_incompatible_with
  [Style::NegatedIf, Style::NegatedUnless]
end

Instance Method Details

#on_if(node) ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/rubocop/cop/style/sole_nested_conditional.rb', line 59

def on_if(node)
  return if node.ternary? || node.else? || node.elsif?

  if_branch = node.if_branch
  return if use_variable_assignment_in_condition?(node.condition, if_branch)
  return unless offending_branch?(node, if_branch)

  message = format(MSG, conditional_type: node.keyword)
  add_offense(if_branch.loc.keyword, message: message) do |corrector|
    autocorrect(corrector, node, if_branch)
  end
end