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

Conversation

koic
Copy link
Member

@koic koic commented Apr 17, 2021

This PR fixes the following incorrect auto-correct for Style/SingleLineMethods when single line method call without parentheses.

% ruby -v
ruby 3.0.1p64 (2021-04-05 revision 0fb782ee38) [x86_64-darwin19]

% cat example.rb
def index() head :ok 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 index() head :ok end
^^^^^^^^^^^^^^^^^^^^^^^^

1 file inspected, 1 offense detected, 1 offense corrected

Before

Auto-correctd to invalid endless method definition syntax.

% cat example.rb
def index() = head :ok

% ruby -c example.rb
example.rb:1: syntax error, unexpected symbol literal, expecting `do' or
'{' or '('
def index() = head :ok

After

Auto-correctd to valid endless method definition syntax.

% cat example.rb
def index() = head(:ok)

% ruby -c example.rb
Syntax OK

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 single line method call without parentheses.

```console
% ruby -v
ruby 3.0.1p64 (2021-04-05 revision 0fb782ee38) [x86_64-darwin19]

% cat example.rb
def index() head :ok 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 index() head :ok end
^^^^^^^^^^^^^^^^^^^^^^^^

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

## Before

Auto-correctd to invalid endless method definition syntax.

```ruby
% cat example.rb
def index() = head :ok

% ruby -c example.rb
example.rb:1: syntax error, unexpected symbol literal, expecting `do' or
'{' or '('
def index() = head :ok
```

## After

Auto-correctd to valid endless method definition syntax.

```ruby
% cat example.rb
def index() = head(:ok)

% ruby -c example.rb
Syntax OK
```
@bbatsov bbatsov merged commit f504a4e into rubocop:master Apr 17, 2021
@bbatsov
Copy link
Collaborator

bbatsov commented Apr 17, 2021

Looks good. Thanks!

@koic koic deleted the fix_an_incorrect_autocorrect_for_style_single_line_methods branch April 17, 2021 16:29
koic added a commit to koic/rubocop that referenced this pull request Apr 17, 2021
This PR fixes the following error for `Style/SingleLineMethods`.

```console
% cat  example.rb
def some_method; 42 end

% bundle exec rubocop --only Style/SingleLineMethods -d

(snip)

undefined method `arguments' for s(:int, 42):RuboCop::AST::IntNode
Did you mean?  argument?
/Users/koic/src/github.com/rubocop/rubocop/lib/rubocop/cop/style/single_line_methods.rb:118:in `method_body_source'
```

This is a regression of rubocop#9704.
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

2 participants