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.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#offenses

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, #corrections, #find_location, #highlights, joining_forces, #messages, #on_investigation_end, #on_new_investigation, #parse, qualified_cop_name, registry, support_autocorrect?, #support_autocorrect?

Methods inherited from Base

#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, callbacks_needed, #callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from AutocorrectLogic

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

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

add_parentheses, 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_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, trim_string_interporation_escape_character

Methods included from PathUtil

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

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object 



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

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

#on_block(node) ⇒ Object 



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

def on_block(node)
  return if node.single_line?

  # If the end is on its own line, there is no offense
  return if begins_its_line?(node.loc.end)

  add_offense(node, location: :end)
end