Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix an incorrect auto-correct for Style/SingleLineMethods #9926

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
@@ -0,0 +1 @@
* [#9926](https://github.com/rubocop/rubocop/pull/9926): Fix an incorrect auto-correct for `Style/SingleLineMethods` when method body is enclosed in parentheses. ([@koic][])
23 changes: 14 additions & 9 deletions lib/rubocop/cop/style/single_line_methods.rb
Expand Up @@ -72,17 +72,15 @@ def correct_to_endless?(body_node)
end

def correct_to_multiline(corrector, node)
each_part(node.body) do |part|
LineBreakCorrector.break_line_before(
range: part, node: node, corrector: corrector,
configured_width: configured_indentation_width
)
if (body = node.body) && body.begin_type? && body.parenthesized_call?
break_line_before(corrector, node, body)
else
each_part(body) do |part|
break_line_before(corrector, node, part)
end
end

LineBreakCorrector.break_line_before(
range: node.loc.end, node: node, corrector: corrector,
indent_steps: 0, configured_width: configured_indentation_width
)
break_line_before(corrector, node, node.loc.end, indent_steps: 0)

move_comment(node, corrector)
end
Expand All @@ -96,6 +94,13 @@ def correct_to_endless(corrector, node)
corrector.replace(node, replacement)
end

def break_line_before(corrector, node, range, indent_steps: 1)
LineBreakCorrector.break_line_before(
range: range, node: node, corrector: corrector,
configured_width: configured_indentation_width, indent_steps: indent_steps
)
end

def each_part(body)
return unless body

Expand Down
13 changes: 13 additions & 0 deletions spec/rubocop/cop/style/single_line_methods_spec.rb
Expand Up @@ -32,6 +32,19 @@ def @table.columns;#{trailing_whitespace}
RUBY
end

it 'registers an offense for a single-line method and method body is enclosed in parentheses' do
expect_offense(<<~RUBY)
def foo() (do_something) end
^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Avoid single-line method definitions.
RUBY

expect_correction(<<~RUBY)
def foo()#{trailing_whitespace}
(do_something)#{trailing_whitespace}
end
RUBY
end

context 'when AllowIfMethodIsEmpty is disabled' do
let(:cop_config) { { 'AllowIfMethodIsEmpty' => false } }

Expand Down