Class: RuboCop::Cop::Style::IdenticalConditionalBranches

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/style/identical_conditional_branches.rb

Overview

This cop checks for identical lines at the beginning or end of each branch of a conditional statement.

Examples:

# bad
if condition
  do_x
  do_z
else
  do_y
  do_z
end

# good
if condition
  do_x
else
  do_y
end
do_z

# bad
if condition
  do_z
  do_x
else
  do_z
  do_y
end

# good
do_z
if condition
  do_x
else
  do_y
end

# bad
case foo
when 1
  do_x
when 2
  do_x
else
  do_x
end

# good
case foo
when 1
  do_x
  do_y
when 2
  # nothing
else
  do_x
  do_z
end

Constant Summary collapse

MSG = 
'Move `%<source>s` out of the conditional.'.freeze

Constants included from Util

Util::ASGN_NODES, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

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?, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from AST::Sexp

#s

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 AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

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, operator?, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens

Methods included from PathUtil

absolute?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#on_case(node) ⇒ Object 



80
81
82
83
84
85
86
87
88
 
# File 'lib/rubocop/cop/style/identical_conditional_branches.rb', line 80

def on_case(node)
  return unless node.else? && node.else_branch

  branches = node.when_branches.map(&:body).push(node.else_branch)

  return if branches.any?(&:nil?)

  check_branches(branches)
end

#on_if(node) ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/rubocop/cop/style/identical_conditional_branches.rb', line 68

def on_if(node)
  return if node.elsif?

  branches = expand_elses(node.else_branch).unshift(node.if_branch)

  # return if any branch is empty. An empty branch can be an `if`
  # without an `else`, or a branch that contains only comments.
  return if branches.any?(&:nil?)

  check_branches(branches)
end