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 autocorrect for Style/Alias #12099

Merged

Conversation

koic
Copy link
Member

@koic koic commented Aug 6, 2023

This PR fixes the following incorrect autocorrection for Style/Alias when EncforcedStyle: prefer_alias_method and using alias with interpolated symbol argument:

$ cat example.rb
alias :"string#{interpolation}" :symbol

$ cat .rubocop.yml
Style/Alias:
  EnforcedStyle: prefer_alias_method
$ bundle exec rubocop -a --only Style/Alias
(snip)

Offenses:

example.rb:1:1: C: [Corrected] Style/Alias: Use alias_method instead of alias.
alias :"string#{interpolation}" :symbol
^^^^^
example.rb:1:14: F: Lint/Syntax: unexpected token tCOLON
(Using Ruby 3.2 parser; configure using TargetRubyVersion parameter, under AllCops)
alias_method :, :symbol
             ^

1 file inspected, 2 offenses detected, 1 offense corrected
$ cat example.rb
alias_method :, :symbol

$ ruby -c example.rb
example.rb: example.rb:1: syntax error, unexpected ',', expecting literal content or terminator or tSTRING_DBEG or tSTRING_DVAR (SyntaxError)
alias_method :, :symbol
              ^

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 autocorrection for `Style/Alias`
when `EncforcedStyle: prefer_alias_method` and using `alias` with interpolated symbol argument:

```console
$ cat example.rb
alias :"string#{interpolation}" :symbol

$ cat .rubocop.yml
Style/Alias:
  EnforcedStyle: prefer_alias_method
```

```console
$ bundle exec rubocop -a --only Style/Alias
(snip)

Offenses:

example.rb:1:1: C: [Corrected] Style/Alias: Use alias_method instead of alias.
alias :"string#{interpolation}" :symbol
^^^^^
example.rb:1:14: F: Lint/Syntax: unexpected token tCOLON
(Using Ruby 3.2 parser; configure using TargetRubyVersion parameter, under AllCops)
alias_method :, :symbol
             ^

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

```console
$ cat example.rb
alias_method :, :symbol

$ ruby -c example.rb
example.rb: example.rb:1: syntax error, unexpected ',', expecting literal content or terminator or tSTRING_DBEG or tSTRING_DVAR (SyntaxError)
alias_method :, :symbol
              ^
```
@koic koic merged commit 56b4edf into rubocop:master Aug 6, 2023
28 checks passed
@koic koic deleted the fix_an_incorrect_autocorrect_for_style_alias branch August 6, 2023 15:04
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