Class: RuboCop::Cop::Layout::EmptyLineAfterGuardClause

Inherits:
Cop
  • Object
show all
Includes:
RangeHelp
Defined in:
lib/rubocop/cop/layout/empty_line_after_guard_clause.rb

Overview

This cop enforces empty line after guard clause

Examples:


# bad
def foo
  return if need_return?
  bar
end

# good
def foo
  return if need_return?

  bar
end

# good
def foo
  return if something?
  return if something_different?

  bar
end

# also good
def foo
  if something?
    do_something
    return if need_return?
  end
end

Constant Summary collapse

MSG =
'Add empty line after guard clause.'
END_OF_HEREDOC_LINE =
1

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, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #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?, #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

#autocorrect(node) ⇒ Object



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

def autocorrect(node)
  lambda do |corrector|
    node_range = if node.respond_to?(:heredoc?) && node.heredoc?
                   range_by_whole_lines(node.loc.heredoc_body)
                 else
                   range_by_whole_lines(node.source_range)
                 end

    corrector.insert_after(node_range, "\n")
  end
end

#on_if(node) ⇒ Object



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
# File 'lib/rubocop/cop/layout/empty_line_after_guard_clause.rb', line 44

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

  if node.modifier_form? && last_argument_is_heredoc?(node)
    heredoc_node = last_argument(node)

    return if next_line_empty?(heredoc_line(node, heredoc_node))

    add_offense(heredoc_node, location: :heredoc_end)
  else
    return if next_line_empty?(node.last_line)

    add_offense(node, location: offense_location(node))
  end
end