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 #9740

Merged

Conversation

koic
Copy link
Member

@koic koic commented Apr 26, 2021

This PR fixes the following incorrect auto-correct for Style/SingleLineMethods when defining setter method.

% cat example.rb
def foo=(other) @foo == foo end

% bundle exec rubocop --only Style/SingleLineMethods -a
(snip)

Inspecting 1 file
C

Offenses:

example.rb:1:1: C: [Corrected] Style/SingleLineMethods: Avoid
single-line method definitions.
def foo=(other) @foo == foo end
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

1 file inspected, 1 offense detected, 1 offense corrected

Before

Auto-corrected to invalid syntax because setter method cannot be defined in
an endless method definition.

% cat example.rb
def foo=(other) = @foo == foo

% ruby -c example.rb
example.rb:1: setter method cannot be defined in an endless method definition
def foo=(other) = @foo == foo

After

% cat example.rb
def foo=(other)
  @foo == foo
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 incorrect auto-correct for `Style/SingleLineMethods`
when defining setter method.

```console
% cat example.rb
def foo=(other) @foo == foo end

% bundle exec rubocop --only Style/SingleLineMethods -a
(snip)

Inspecting 1 file
C

Offenses:

example.rb:1:1: C: [Corrected] Style/SingleLineMethods: Avoid
single-line method definitions.
def foo=(other) @foo == foo end
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

1 file inspected, 1 offense detected, 1 offense corrected
```

### Before

Auto-corrected to invalid syntax because setter method cannot be defined in
an endless method definition.

```ruby
% cat example.rb
def foo=(other) = @foo == foo

% ruby -c example.rb
example.rb:1: setter method cannot be defined in an endless method definition
def foo=(other) = @foo == foo
```

### After

```ruby
% cat example.rb
def foo=(other)
  @foo == foo
end
```
@koic koic merged commit 74377b0 into rubocop:master Apr 27, 2021
@koic koic deleted the fix_incorrect_autocorrect_for_single_line_methods branch April 27, 2021 15:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant