Class: Rubocop::Cop::Style::GuardClause

Inherits:
Cop
  • Object
show all
Includes:
CheckMethods, IfNode
Defined in:
lib/rubocop/cop/style/guard_clause.rb

Overview

This cop if/unless expression that can be replace with a guard clause.

It should be extended to handle methods whose body is if/else or a case expression with a default branch.

Examples:


# bad
def test
  if something
    work
    work
    work
  end
end

# good
def test
  return unless something
  work
  work
  work
end

Constant Summary collapse

MSG = 
'Use a guard clause instead of wrapping ' \
'the code inside a conditional expression.'

Constants included from Util

Util::ASGN_NODES, Util::EQUALS_ASGN_NODES, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Method Summary

Methods included from IfNode

#elsif?, #if_else?, #modifier_if?, #ternary_op?

Methods included from CheckMethods

#on_def, #on_defs

Methods inherited from Cop

#add_offense, all, #autocorrect?, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #debug?, #display_cop_names?, #exclude_file?, #include_file?, inherited, #initialize, lint?, #message, non_rails, rails?, #relevant_file?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

block_length, command?, comment_line?, const_name, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, on_node, operator?, parentheses?, proc?, range_with_surrounding_space, source_range, strip_quotes

Methods included from PathUtil

match_path?, relative_path

Constructor Details

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