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

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector, Util
Includes:
RangeHelp
Defined in:
lib/rubocop/cop/layout/empty_line_after_guard_clause.rb

Overview

Enforces empty line after guard clause.

This cop allows ‘# :nocov:` directive after guard clause because SimpleCov excludes code from the coverage report by wrapping it in `# :nocov:`:

source,ruby

def foo

# :nocov:
return if condition
# :nocov:
bar

end

Refer to SimpleCov’s documentation for more details: github.com/simplecov-ruby/simplecov#ignoringskipping-code

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
SIMPLE_DIRECTIVE_COMMENT_PATTERN = 
/\A# *:nocov:\z/.freeze

Constants included from Util

Util::LITERAL_REGEX

Constants included from PathUtil

PathUtil::HIDDEN_FILE_PATTERN

Constants included from RangeHelp

RangeHelp::BYTE_ORDER_MARK, RangeHelp::NOT_GIVEN

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods included from Util

add_parentheses, any_descendant?, args_begin, args_end, begins_its_line?, comment_line?, comment_lines?, double_quotes_required?, escape_string, first_part_of_call_chain, indent, interpret_string_escapes, line, line_range, needs_escaping?, on_node, parentheses?, parse_regexp, same_line?, to_string_literal, to_supported_styles, trim_string_interpolation_escape_character

Methods included from PathUtil

absolute?, glob?, hidden_dir?, hidden_file?, hidden_file_in_not_hidden_dir?, match_path?, maybe_hidden_file?, relative_path, remote_file?, smart_path

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, autocorrect_incompatible_with, badge, #begin_investigation, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #cop_config, #cop_name, cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, #string_literals_frozen_by_default?, support_autocorrect?, support_multiple_source?, #target_gem_version, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

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

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

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

Instance Method Details

#on_if(node) ⇒ Object

[View source]

63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/rubocop/cop/layout/empty_line_after_guard_clause.rb', line 63

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

  if node.modifier_form? && (heredoc_node = last_heredoc_argument(node))
    if next_line_empty_or_allowed_directive_comment?(heredoc_line(node, heredoc_node))
      return
    end

    add_offense(heredoc_node.loc.heredoc_end) do |corrector|
      autocorrect(corrector, heredoc_node)
    end
  else
    return if next_line_empty_or_allowed_directive_comment?(node.last_line)

    add_offense(offense_location(node)) { |corrector| autocorrect(corrector, node) }
  end
end