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 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 %d, %d should be on its own line.'.freeze

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, 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, 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_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?, block_length, comment_line?, compatible_external_encoding_for?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, hard_to_type?, interpret_string_escapes, line_distance, line_range, move_pos, needs_escaping?, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, preceed?, range_between, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, to_string_literal, to_supported_styles, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, 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)
  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 end_loc.source_line =~ /^\s*#{end_loc.source}/

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