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 error for Style/MultilineMethodSignature #9644

Merged

Conversation

@koic
Copy link
Member

@koic koic commented Mar 26, 2021

This PR fixes the following error and the incorrect auto-correct for Style/MultilineMethodSignature when line break after opening parenthesis.

% cat example.rb
class Foo
  def foo(
    arg
)
  end
end

Before

% rubocop -a --only Style/MultilineMethodSignature example.rb
(snip)

Inspecting 1 file
C

Offenses:

example.rb:2:3: C: [Corrected] Style/MultilineMethodSignature: Avoid
multi-line method signatures.
def foo( ...
^^^^^^^^

0 files inspected, 1 offense detected, 1 offense corrected
Infinite loop detected in /private/tmp/example.rb and caused by Style/MultilineMethodSignature
/Users/koic/.rbenv/versions/3.0.0/lib/ruby/gems/3.0.0/gems/rubocop-1.12.0/lib/rubocop/runner.rb:304:in
`check_for_infinite_loop'
/Users/koic/.rbenv/versions/3.0.0/lib/ruby/gems/3.0.0/gems/rubocop-1.12.0/lib/rubocop/runner.rb:287:in
`block in iterate_until_no_changes'
/Users/koic/.rbenv/versions/3.0.0/lib/ruby/gems/3.0.0/gems/rubocop-1.12.0/lib/rubocop/runner.rb:286:in
`loop'
(snip)

% cat example.rb
class Foo
  def foo(
    arg)
  end
end

After

% rubocop -a --only Style/MultilineMethodSignature example.rb
(snip)

class Foo
  def foo(arg)
  end
end

Before submitting the PR make sure the following are checked:

  • The PR relates to only one subject with a clear title and description in grammatically correct, complete sentences.
  • Wrote good commit messages.
  • Commit message starts with [Fix #issue-number] (if the related issue exists).
  • Feature branch is up-to-date with master (if not - rebase it).
  • Squashed related commits together.
  • Added tests.
  • Ran bundle exec rake default. It executes all tests and runs RuboCop on its own code.
  • Added an entry (file) to the changelog folder named {change_type}_{change_description}.md if the new code introduces user-observable changes. See changelog entry format for details.
This PR fixes the following error and the incorrect auto-correct for
`Style/MultilineMethodSignature` when line break after opening parenthesis.

```ruby
% cat example.rb
class Foo
  def foo(
    arg
)
  end
end
```

## Before

```console
% rubocop -a --only Style/MultilineMethodSignature example.rb
(snip)

Inspecting 1 file
C

Offenses:

example.rb:2:3: C: [Corrected] Style/MultilineMethodSignature: Avoid
multi-line method signatures.
def foo( ...
^^^^^^^^

0 files inspected, 1 offense detected, 1 offense corrected
Infinite loop detected in /private/tmp/example.rb and caused by Style/MultilineMethodSignature
/Users/koic/.rbenv/versions/3.0.0/lib/ruby/gems/3.0.0/gems/rubocop-1.12.0/lib/rubocop/runner.rb:304:in
`check_for_infinite_loop'
/Users/koic/.rbenv/versions/3.0.0/lib/ruby/gems/3.0.0/gems/rubocop-1.12.0/lib/rubocop/runner.rb:287:in
`block in iterate_until_no_changes'
/Users/koic/.rbenv/versions/3.0.0/lib/ruby/gems/3.0.0/gems/rubocop-1.12.0/lib/rubocop/runner.rb:286:in
`loop'
(snip)

% cat example.rb
class Foo
  def foo(
    arg)
  end
end
```

## After

```console
% rubocop -a --only Style/MultilineMethodSignature example.rb
(snip)

class Foo
  def foo(arg)
  end
end
```
@koic koic merged commit 43b26a6 into rubocop:master Mar 27, 2021
31 checks passed
31 checks passed
@github-actions
windows 2.4
Details
@github-actions
windows 2.5
Details
@github-actions
windows 2.6
Details
@github-actions
windows 2.7
Details
@github-actions
windows 3.0
Details
@github-actions
windows mingw
Details
@mergify
Summary 2 potential rules
Details
ci/circleci: cc-setup Your tests passed on CircleCI!
Details
ci/circleci: cc-upload-coverage Your tests passed on CircleCI!
Details
ci/circleci: documentation-checks Your tests passed on CircleCI!
Details
ci/circleci: jruby-9.2-ascii_spec Your tests passed on CircleCI!
Details
ci/circleci: jruby-9.2-rubocop Your tests passed on CircleCI!
Details
ci/circleci: jruby-9.2-spec Your tests passed on CircleCI!
Details
ci/circleci: ruby-2.4-ascii_spec Your tests passed on CircleCI!
Details
ci/circleci: ruby-2.4-rubocop Your tests passed on CircleCI!
Details
ci/circleci: ruby-2.4-spec Your tests passed on CircleCI!
Details
ci/circleci: ruby-2.5-ascii_spec Your tests passed on CircleCI!
Details
ci/circleci: ruby-2.5-rubocop Your tests passed on CircleCI!
Details
ci/circleci: ruby-2.5-spec Your tests passed on CircleCI!
Details
ci/circleci: ruby-2.6-ascii_spec Your tests passed on CircleCI!
Details
ci/circleci: ruby-2.6-rubocop Your tests passed on CircleCI!
Details
ci/circleci: ruby-2.6-spec Your tests passed on CircleCI!
Details
ci/circleci: ruby-2.7-ascii_spec Your tests passed on CircleCI!
Details
ci/circleci: ruby-2.7-rubocop Your tests passed on CircleCI!
Details
ci/circleci: ruby-2.7-spec Your tests passed on CircleCI!
Details
ci/circleci: ruby-3.0-ascii_spec Your tests passed on CircleCI!
Details
ci/circleci: ruby-3.0-rubocop Your tests passed on CircleCI!
Details
ci/circleci: ruby-3.0-spec Your tests passed on CircleCI!
Details
ci/circleci: ruby-head-ascii_spec Your tests passed on CircleCI!
Details
ci/circleci: ruby-head-rubocop Your tests passed on CircleCI!
Details
ci/circleci: ruby-head-spec Your tests passed on CircleCI!
Details
@koic koic deleted the koic:fix_error_for_style_multiline_method_signature branch Mar 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

1 participant