Class: RuboCop::Cop::Style::BlockEndNewline

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

Overview

This cop checks whether the end statement of a do end blocks 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 %d, %d should be on its own line.'

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

Instance Method Summary collapse

Methods inherited from Cop

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

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

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

Methods included from PathUtil

issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object


42
43
44
45
46
47
# File 'lib/rubocop/cop/style/block_end_newline.rb', line 42

def autocorrect(node)
  @corrections << lambda do |corrector|
    indentation = indentation_of_block_start_line(node)
    corrector.insert_before(node.loc.end, "\n" + (' ' * indentation))
  end
end

#indentation_of_block_start_line(node) ⇒ Object


49
50
51
52
# File 'lib/rubocop/cop/style/block_end_newline.rb', line 49

def indentation_of_block_start_line(node)
  match = /\S.*/.match(node.loc.begin.source_line)
  match.begin(0)
end

#on_block(node) ⇒ Object


30
31
32
33
34
35
36
37
38
39
40
# File 'lib/rubocop/cop/style/block_end_newline.rb', line 30

def on_block(node)
  end_loc = node.loc.end
  do_loc = node.loc.begin # Actually it's either do or {.
  return if do_loc.line == end_loc.line # Ignore one-liners.

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

  msg = format(MSG, end_loc.line, end_loc.column + 1)
  add_offense(node, end_loc, msg)
end