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 #12309] Add new Style/RedundantSuperArguments cop #12427

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Earlopain
Copy link
Contributor

@Earlopain Earlopain commented Dec 1, 2023

#12309 Implements the following:

def method(a, b, c:, d: &e)
  super(a, b, c:, d:, &e)
  # => super
end

There are 57 offenses of this kind in Rails master.

Looks like I picked quite the doozy for my first cop. I managed but I'm open to feedback on how to write better code here.
I tried to think of all the constellations you can use super in and handling those appropriately in the cop but I'm not certain if I got it all. Let me know if there are other edge-cases that need to be considered, like calling super inside define_singleton_method.

The cop could be more intelligent with keyword arguments when they appear in different orders like in the following example but I'll leave that be for now since the cop seems quite complex already. Something to improve upon in the future.

def test(a:, b:)
  super(b:, a:)
end
  • 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 Dec 1, 2023

There might be users who intentionally write explicit arguments. So, I wonder if the cop name "Redundant" is suitable.
And, it would be beneficial to first suggest a rationale in the style guide for using zero arity super (zsuper) when super can have its arguments omitted:
https://github.com/rubocop/ruby-style-guide

@koic
Copy link
Member

koic commented Dec 1, 2023

It's likely that cop name such as Style/ZeroAritySuper cop may be better appropriate, I think.

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