Class: RuboCop::Cop::Layout::BlockEndNewline

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

Overview

This cop checks whether the end statement of a do..end block is on its own line.

Examples:

# bad
blah do |i|
  foo(i) end

# good
blah do |i|
  foo(i)
end

# bad
blah { |i|
  foo(i) }

# good
blah { |i|
  foo(i)
}

Constant Summary collapse

MSG = 
'Expression at %<line>d, %<column>d should be on its own line.'
.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

#autocorrect(node) ⇒ Object 



44
45
46
47
48
49
 
# File 'lib/rubocop/cop/layout/block_end_newline.rb', line 44

def autocorrect(node)
  lambda do |corrector|
    corrector.replace(delimiter_range(node),
                      "\n#{node.loc.end.source}#{offset(node)}")
  end
end

#on_block(node) ⇒ Object 



33
34
35
36
37
38
39
40
41
42
 
# File 'lib/rubocop/cop/layout/block_end_newline.rb', line 33

def on_block(node)
  return if node.single_line?

  end_loc = node.loc.end

  # If the end is on its own line, there is no offense
  return if end_loc.source_line =~ /^\s*#{end_loc.source}/

  add_offense(node, location: end_loc)
end