Merge pull request #14474 from lovro-bikic/false-negative-end-alignment

Fix false negative for `Layout/EndAlignment` when `end` is not on a separate line

Author: koic

changelog/change_false_negative_for_layout_end_alignment.md

@@ -0,0 +1 @@
+* [#14474](https://github.com/rubocop/rubocop/pull/14474): Fix false negative for `Layout/EndAlignment` when `end` is not on a separate line. ([@lovro-bikic][])

lib/rubocop/cop/correctors/alignment_corrector.rb

@@ -29,10 +29,13 @@ def correct(corrector, processed_source, node, column_delta)
  def align_end(corrector, processed_source, node, align_to)
  @processed_source = processed_source
  whitespace = whitespace_range(node)
- return false unless whitespace.source.strip.empty?
-
  column = alignment_column(align_to)
- corrector.replace(whitespace, ' ' * column)
+
+ if whitespace.source.strip.empty?
+ corrector.replace(whitespace, ' ' * column)
+ else
+ corrector.insert_after(whitespace, "\n#{' ' * column}")
+ end
  end
 
  private

lib/rubocop/cop/mixin/end_keyword_alignment.rb

@@ -19,8 +19,7 @@ def check_end_kw_in_node(node)
  def check_end_kw_alignment(node, align_ranges)
  return if ignored_node?(node)
 
- end_loc = node.loc.end
- return if accept_end_kw_alignment?(end_loc)
+ return unless (end_loc = node.loc.end)
 
  matching = matching_ranges(end_loc, align_ranges)
 
@@ -57,11 +56,6 @@ def add_offense_for_misalignment(node, align_with)
  add_offense(end_loc, message: msg) { |corrector| autocorrect(corrector, node) }
  end
 
- def accept_end_kw_alignment?(end_loc)
- end_loc.nil? || # Discard modifier forms of if/while/until.
- !/\A[ \t]*end/.match?(processed_source.lines[end_loc.line - 1])
- end
-
  def style_parameter_name
  'EnforcedStyleAlignWith'
  end

spec/rubocop/cli/autocorrect_spec.rb

@@ -1627,7 +1627,8 @@ module A module B
 
  module A
  module B
- end end
+ end
+ end
  RUBY
  uncorrected = $stdout.string.split($RS).select do |line|
  line.include?('example.rb:') && !line.include?('[Corrected]')

spec/rubocop/cop/layout/end_alignment_spec.rb

@@ -503,10 +503,37 @@ class << self
  end
 
  context 'when end is preceded by something else than whitespace' do
- it 'does not register an offense' do
- expect_no_offenses(<<~RUBY)
+ it 'registers an offense and corrects' do
+ expect_offense(<<~RUBY)
  module A
  puts a end
+ ^^^ `end` at 2, 7 is not aligned with `module` at 1, 0.
+ RUBY
+
+ expect_correction(<<~RUBY)
+ module A
+ puts a#{trailing_whitespace}
+ end
+ RUBY
+ end
+ end
+
+ context 'when end is on the same line as `else` body' do
+ it 'registers an offense and corrects' do
+ expect_offense(<<~RUBY)
+ if test
+ foo
+ else
+ bar end
+ ^^^ `end` at 4, 6 is not aligned with `if` at 1, 0.
+ RUBY
+
+ expect_correction(<<~RUBY)
+ if test
+ foo
+ else
+ bar#{trailing_whitespace}
+ end
  RUBY
  end
  end