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 Lint/OrAssignmentToConstant #11659

Conversation

koic
Copy link
Member

@koic koic commented Mar 3, 2023

This PR fixes the following incorrect autocorrect for Lint/OrAssignmentToConstant when using or-assignment to a constant in method definition.

def foo
  M::N ||= 42
end
$ ruby -v
ruby 3.2.1 (2023-02-08 revision 31819e82c8) [x86_64-darwin19]
$ ruby -c example.rb
Syntax OK
$ bundle exec rubocop --only Lint/OrAssignmentToConstant -a
(snip)

Offenses:

example.rb:2:8: W: Lint/OrAssignmentToConstant: Avoid using or-assignment with constants.
  M::N ||= 42
       ^^^

1 file inspected, 1 offense detected
def foo
  M::N = 42
end
$ ruby -c example.rb
example.rb: example.rb:2: dynamic constant assignment (SyntaxError)
  M::N = 42
  ^~~~

It's reasonable to display the offense, but it wouldn't be reasonable to have this syntax error caused by autocorrection.


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 `Lint/OrAssignmentToConstant`
when using or-assignment to a constant in method definition.

```ruby
def foo
  M::N ||= 42
end
```

```console
$ ruby -v
ruby 3.2.1 (2023-02-08 revision 31819e82c8) [x86_64-darwin19]
$ ruby -c example.rb
Syntax OK
$ bundle exec rubocop --only Lint/OrAssignmentToConstant -a
(snip)

Offenses:

example.rb:2:8: W: Lint/OrAssignmentToConstant: Avoid using or-assignment with constants.
  M::N ||= 42
       ^^^

1 file inspected, 1 offense detected
```

```ruby
def foo
  M::N = 42
end
```

```console
$ ruby -c example.rb
example.rb: example.rb:2: dynamic constant assignment (SyntaxError)
  M::N = 42
  ^~~~
```

It's reasonable to display the offense, but it wouldn't be reasonable to have this syntax error
caused by autocorrection.
@koic koic merged commit 7f96a01 into rubocop:master Mar 4, 2023
@koic koic deleted the fix_incorrect_autocorrect_for_lint_or_assignment_to_constant branch March 4, 2023 13:26
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