Class: RuboCop::Cop::Style::GuardClause

Inherits:
Cop
  • Object
show all
Includes:
MinBodyLength, RuboCop::Cop::StatementModifier
Defined in:
lib/rubocop/cop/style/guard_clause.rb

Overview

Use a guard clause instead of wrapping the code inside a conditional expression

Examples:

# bad
def test
  if something
    work
  end
end

# good
def test
  return unless something
  work
end

# also good
def test
  work if something
end

# bad
if something
  raise 'exception'
else
  ok
end

# good
raise 'exception' if something
ok

Constant Summary collapse

MSG = 
'Use a guard clause (`%<example>s`) instead of wrapping the ' \
'code inside a conditional expression.'

Constants included from Util

Util::LITERAL_REGEX

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, #disable_uncorrectable, #duplicate_location?, #excluded_file?, #external_dependency_checksum, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, #parse, qualified_cop_name, #reason_to_not_correct, #relevant_file?, #target_rails_version, #target_ruby_version

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 AST::Sexp

#s

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_offense, #disable_uncorrectable?, #safe_autocorrect?, #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, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#on_def(node) ⇒ Object Also known as: on_defs 


45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/rubocop/cop/style/guard_clause.rb', line 45

def on_def(node)
  body = node.body

  return unless body

  if body.if_type?
    check_ending_if(body)
  elsif body.begin_type?
    final_expression = body.children.last
    check_ending_if(final_expression) if final_expression&.if_type?
  end
end

#on_if(node) ⇒ Object 


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

def on_if(node)
  return if accepted_form?(node)

  guard_clause_in_if = node.if_branch&.guard_clause?
  guard_clause_in_else = node.else_branch&.guard_clause?
  guard_clause = guard_clause_in_if || guard_clause_in_else
  return unless guard_clause

  kw = if guard_clause_in_if
         node.loc.keyword.source
       else
         opposite_keyword(node)
       end
  register_offense(node, guard_clause.source, kw)
end