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 #10202] Add new Lint/Ruby2Keywords cop #10205

Merged
merged 1 commit into from Nov 9, 2021

Conversation

dvandersluis
Copy link
Member

Looks for instances of ruby2_keywords for methods that do not need it.

ruby2_keywords is only needed for methods that have a splat (*args) and no keyword args (regular, optional or keyword splat).

Can handle three forms:

ruby2_keywords def foo(arg)
end
def foo(arg)
end
ruby2_keywords :foo
define_method(:foo) { |arg| }
ruby2_keywords :foo

Fixes #10202.


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.

@koic
Copy link
Member

koic commented Nov 1, 2021

I think the cop name UselessRuby2Keywords cop is better.

lib/rubocop/cop/lint/ruby2_keywords.rb Outdated Show resolved Hide resolved
lib/rubocop/cop/lint/ruby2_keywords.rb Outdated Show resolved Hide resolved
lib/rubocop/cop/lint/ruby2_keywords.rb Outdated Show resolved Hide resolved
@dvandersluis
Copy link
Member Author

dvandersluis commented Nov 3, 2021

@koic I renamed the cop and changed the examples. I still think it's not a bad thing to have separate @example blocks for different use cases (I understand that we usually do this for configuration examples, but still), but I rewrote it to be more like you were suggesting.

@dvandersluis dvandersluis merged commit 0a80ac5 into rubocop:master Nov 9, 2021
@dvandersluis dvandersluis deleted the issue/10202 branch November 9, 2021 19:38
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.

Cop idea: useless ruby2_keywords
2 participants