123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Style::IfInsideElse

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:
self, ::RuboCop::Cop::RangeHelp, ::RuboCop::Cop::Base, ::RuboCop::Cop::AutocorrectLogic, ::RuboCop::Cop::IgnoredNode, ::RuboCop::Util, RuboCop::AST::Sexp
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/style/if_inside_else.rb

Overview

If the else branch of a conditional consists solely of an if node, it can be combined with the else to become an elsif. This helps to keep the nesting level from getting too deep.

Examples:

# bad
if condition_a
  action_a
else
  if condition_b
    action_b
  else
    action_c
  end
end

# good
if condition_a
  action_a
elsif condition_b
  action_b
else
  action_c
end

AllowIfModifier: false (default)

# bad
if condition_a
  action_a
else
  action_b if condition_b
end

# good
if condition_a
  action_a
elsif condition_b
  action_b
end

AllowIfModifier: true

# good
if condition_a
  action_a
else
  action_b if condition_b
end

# good
if condition_a
  action_a
elsif condition_b
  action_b
end

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

::RuboCop::Cop::RangeHelp - Included

BYTE_ORDER_MARK, NOT_GIVEN

Class Attribute Summary

::RuboCop::Cop::AutoCorrector - Extended

support_autocorrect?

::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 a 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

::RuboCop::Cop::Base - Inherited

#active_support_extensions_enabled?, #always_autocorrect?, #config, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #processed_source, #string_literals_frozen_by_default?, #target_satisfies_all_gem_version_requirements?

::RuboCop::Cop::AutocorrectLogic - Included

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Instance Method Summary

::RuboCop::Cop::RangeHelp - Included

#add_range,
#arguments_range

A range containing the first to the last argument of a method call or method definition.
#column_offset_between,
#contents_range

A range containing only the contents of a literal with delimiters (e.g.
#directions,
#effective_column

Returns the column attribute of the range, except if the range is on the first line and there’s a byte order mark at the beginning of that line, in which case 1 is subtracted from the column value.
#final_pos, #move_pos, #move_pos_str, #range_between, #range_by_whole_lines, #range_with_comments, #range_with_comments_and_lines, #range_with_surrounding_comma, #range_with_surrounding_space, #source_range

::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_gem_version

Returns a gems locked versions (i.e.
#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

#disable_offense, #disable_offense_at_end_of_line, #disable_offense_before_and_after, #disable_offense_with_eol_or_surround_comment, #eol_comment, #eol_comment_would_be_inside_literal?, #heredoc_range, #line_with_eol_comment_too_long?, #max_line_length, #multiline_ranges, #multiline_string?,
#range_by_lines

Expand the given range to include all of any lines it covers.
#range_of_first_line, #string_continuation?, #surrounding_heredoc?, #surrounding_percent_array?

::RuboCop::Cop::IgnoredNode - Included

#ignore_node, #ignored_node?, #part_of_ignored_node?, #ignored_nodes

Constructor Details

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

Instance Attribute Details

#allow_if_modifier? ⇒ Boolean (readonly, private)

[ GitHub ] 

  


# File 'lib/rubocop/cop/style/if_inside_else.rb', line 146



def allow_if_modifier?
  cop_config['AllowIfModifier']
end


  







Instance Method Details



  

    #allow_if_modifier_in_else_branch?(else_branch)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/if_inside_else.rb', line 142



def allow_if_modifier_in_else_branch?(else_branch)
  allow_if_modifier? && else_branch&.modifier_form?
end


  








  

    #autocorrect(corrector, node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/if_inside_else.rb', line 87



def autocorrect(corrector, node)
  if then?(node)
    # If the nested `if` is a then node, correct it first,
    # then the next pass will use `correct_to_elsif_from_if_inside_else_form`
    IfThenCorrector.new(node, indentation: 0).call(corrector)
    return
  end

  if node.modifier_form?
    correct_to_elsif_from_modifier_form(corrector, node)
  else
    correct_to_elsif_from_if_inside_else_form(corrector, node, node.condition)
  end
end


  








  

    #correct_to_elsif_from_if_inside_else_form(corrector, node, condition)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/if_inside_else.rb', line 111



def correct_to_elsif_from_if_inside_else_form(corrector, node, condition) # rubocop:disable Metrics/AbcSize
  corrector.replace(node.parent.loc.else, "elsif #{condition.source}")

  if_condition_range = if_condition_range(node, condition)

  if (if_branch = node.if_branch)
    corrector.replace(if_condition_range, range_with_comments(if_branch).source)
    corrector.remove(range_with_comments_and_lines(if_branch))
  else
    corrector.remove(range_by_whole_lines(if_condition_range, include_final_newline: true))
  end

  corrector.remove(condition)
  corrector.remove(range_by_whole_lines(find_end_range(node), include_final_newline: true))
end


  








  

    #correct_to_elsif_from_modifier_form(corrector, node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/if_inside_else.rb', line 102



def correct_to_elsif_from_modifier_form(corrector, node)
  corrector.replace(node.parent.loc.else, "elsif #{node.condition.source}")

  condition_range = range_between(
    node.if_branch.source_range.end_pos, node.condition.source_range.end_pos
  )
  corrector.remove(condition_range)
end


  








  

    #find_end_range(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/if_inside_else.rb', line 131



def find_end_range(node)
  end_range = node.loc.end
  return end_range if end_range

  find_end_range(node.parent)
end


  








  

    #if_condition_range(node, condition)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/if_inside_else.rb', line 138



def if_condition_range(node, condition)
  range_between(node.loc.keyword.begin_pos, condition.source_range.end_pos)
end


  








  

    #on_if(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/if_inside_else.rb', line 68



def on_if(node)
  return if node.ternary? || node.unless?

  else_branch = node.else_branch

  return unless else_branch&.if_type? && else_branch.if?
  return if allow_if_modifier_in_else_branch?(else_branch)

  add_offense(else_branch.loc.keyword) do |corrector|
    next if part_of_ignored_node?(node)

    autocorrect(corrector, else_branch)
    ignore_node(node)
  end
end


  








  

    #then?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/if_inside_else.rb', line 127



def then?(node)
  node.loc.begin&.source == 'then'
end