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/RedundantReturn #9631

Merged

Conversation

@koic
Copy link
Member

@koic koic commented Mar 22, 2021

Fixes testdouble/standard#277.

This PR fixes the following false positive for Style/RedundantReturn when using return with splat argument.

% cat example.rb
class MyClass
  def something
    data = [1, 2, 3]
    return *data
  end
end

Before

Auto-corrected to invalid code.

% rubocop --only Style/RedundantReturn -a
(snip)

% cat example.rb
class MyClass
  def something
    data = [1, 2, 3]
    *data
  end
end

% ruby -c example.rb
example.rb:4: syntax error, unexpected '\n', expecting '='

After

Auto-corrected to valid code.

% rubocop --only Style/RedundantReturn -a
(snip)

% cat example.rb
class MyClass
  def something
    data = [1, 2, 3]
    data
  end
end

% 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.
Fixes testdouble/standard#277.

This PR fixes the following false positive for `Style/RedundantReturn`
when using `return` with splat argument.

```console
% cat example.rb
class MyClass
  def something
    data = [1, 2, 3]
    return *data
  end
end
```

## Before

Auto-corrected to invalid code.

```console
% rubocop --only Style/RedundantReturn -a
(snip)

% cat example.rb
class MyClass
  def something
    data = [1, 2, 3]
    *data
  end
end

% ruby -c example.rb
example.rb:4: syntax error, unexpected '\n', expecting '='
```

## After

Auto-corrected to valid code.

```console
% rubocop --only Style/RedundantReturn -a
(snip)

% cat example.rb
class MyClass
  def something
    data = [1, 2, 3]
    data
  end
end

% ruby -c example.rb
Syntax OK
```
@koic koic force-pushed the koic:fix_false_positive_for_style_redundant_return branch from 64d4c13 to 978578a Mar 22, 2021
@searls
Copy link

@searls searls commented Mar 22, 2021

Your responsiveness is truly amazing, @koic!

@bbatsov bbatsov merged commit 8535e32 into rubocop:master Mar 22, 2021
7 of 23 checks passed
7 of 23 checks passed
@github-actions
windows 2.4
Details
@github-actions
windows 2.5
Details
@github-actions
windows 2.6
Details
@github-actions
windows 2.7
Details
@github-actions
windows 3.0
Details
@github-actions
windows mingw
Details
ci/circleci: cc-setup Your tests are queued behind your running builds
Details
ci/circleci: documentation-checks Your tests are queued behind your running builds
Details
ci/circleci: jruby-9.2-ascii_spec Your tests are queued behind your running builds
Details
ci/circleci: jruby-9.2-rubocop Your tests are queued behind your running builds
Details
ci/circleci: ruby-2.4-ascii_spec Your tests are queued behind your running builds
Details
ci/circleci: ruby-2.4-rubocop Your tests are queued behind your running builds
Details
ci/circleci: ruby-2.5-ascii_spec Your tests are queued behind your running builds
Details
ci/circleci: ruby-2.5-rubocop Your tests are queued behind your running builds
Details
ci/circleci: ruby-2.6-ascii_spec Your tests are queued behind your running builds
Details
ci/circleci: ruby-2.6-rubocop Your tests are queued behind your running builds
Details
ci/circleci: ruby-2.7-ascii_spec Your tests are queued behind your running builds
Details
ci/circleci: ruby-2.7-rubocop Your tests are queued behind your running builds
Details
ci/circleci: ruby-3.0-ascii_spec Your tests are queued behind your running builds
Details
ci/circleci: ruby-3.0-rubocop Your tests are queued behind your running builds
Details
ci/circleci: ruby-head-ascii_spec Your tests are queued behind your running builds
Details
ci/circleci: ruby-head-rubocop Your tests are queued behind your running builds
Details
@mergify
Summary 2 potential rules
Details
@bbatsov
Copy link
Collaborator

@bbatsov bbatsov commented Mar 22, 2021

Yep, @koic is a legend! Thanks! 🙇‍♂️

@koic koic deleted the koic:fix_false_positive_for_style_redundant_return branch Mar 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

3 participants