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/SpecialGlobalVars #10541

Conversation

koic
Copy link
Member

@koic koic commented Apr 15, 2022

This PR fixes the following incorrect autocorrect for Style/SpecialGlobalVars when global variable as Perl name is used multiple times.

Example:

% cat example.rb
$*[0]
$*[1]

% bundle exec rubocop --only Style/SpecialGlobalVars -A
Inspecting 3 files
.C.

Offenses:

example.rb:1:1: C: [Corrected] Style/SpecialGlobalVars: Prefer $ARGV
from the stdlib 'English' module (don't forget to require it) or ARGV
over $*.
$*[0]
^^
example.rb:2:1: C: [Corrected] Style/SpecialGlobalVars: Prefer $ARGV
from the stdlib 'English' module (don't forget to require it) or ARGV
over $*.
$*[1]
^^

3 files inspected, 2 offenses detected, 2 offenses corrected

This auto-correction will add require 'English' twice:

% cat example.rb
require 'English'
require 'English'
$ARGV[0]
$ARGV[1]

This PR ensures that require 'English' is added only once:

% cat example.rb
require 'English'
$ARGV[0]
$ARGV[1]

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 autocorrect for `Style/SpecialGlobalVars`
when global variable as Perl name is used multiple times.

Example:

```ruby
% cat example.rb
$*[0]
$*[1]

% bundle exec rubocop --only Style/SpecialGlobalVars -A
Inspecting 3 files
.C.

Offenses:

example.rb:1:1: C: [Corrected] Style/SpecialGlobalVars: Prefer $ARGV
from the stdlib 'English' module (don't forget to require it) or ARGV
over $*.
$*[0]
^^
example.rb:2:1: C: [Corrected] Style/SpecialGlobalVars: Prefer $ARGV
from the stdlib 'English' module (don't forget to require it) or ARGV
over $*.
$*[1]
^^

3 files inspected, 2 offenses detected, 2 offenses corrected
```

This auto-correction will add `require 'English'` twice:

```ruby
% cat example.rb
require 'English'
require 'English'
$ARGV[0]
$ARGV[1]
```

This PR ensures that `require 'English'` is added only once:

```ruby
% cat example.rb
require 'English'
$ARGV[0]
$ARGV[1]
```
@bbatsov bbatsov merged commit a2cfdc1 into rubocop:master Apr 20, 2022
@bbatsov
Copy link
Collaborator

bbatsov commented Apr 20, 2022

Thanks!

@koic koic deleted the fix_an_incorrect_autocorrect_for_style_special_global_vars branch April 20, 2022 07:51
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