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

Lint/UnusedMethodArgument does not correct or mark keyword args as "todo" #7971

Closed
laurmurclar opened this issue May 14, 2020 · 3 comments
Closed
Labels

Comments

@laurmurclar
Copy link
Contributor

@laurmurclar laurmurclar commented May 14, 2020

When using the --safe-auto-correct --disable-uncorrectable flags, Lint/UnusedMethodArgument has some inconsistent behaviour. It auto-corrects methods with standard arguments, but not keyword arguments. It doesn't add rubocop:todo comments to methods with keyword arguments either.


Expected behavior

Auto-correct and disabling uncorrectable offenses works for methods with keyword arguments

Steps to reproduce the problem

example.rb

def ordinary_method(some_arg)
  puts "Ignoring args"
end

def method_with_keyword_arg(some_keyword_arg:)
  puts "Ignoring args"
end
$ bundle exec 'rubocop --safe-auto-correct --disable-uncorrectable --only Lint/UnusedMethodArgument example.rb'
Inspecting 1 file
W

Offenses:

example.rb:1:21: W: [Corrected] Lint/UnusedMethodArgument: Unused method argument - some_arg. If it's necessary, use _ or _some_arg as an argument name to indicate that it won't be used. You can also write as ordinary_method(*) if you want the method to accept any arguments but don't care about them.
def ordinary_method(some_arg)
                    ^^^^^^^^
example.rb:5:29: W: Lint/UnusedMethodArgument: Unused method argument - some_keyword_arg. You can also write as method_with_keyword_arg(*) if you want the method to accept any arguments but don't care about them.
def method_with_keyword_arg(some_keyword_arg:)
                            ^^^^^^^^^^^^^^^^

1 file inspected, 2 offenses detected, 1 offense corrected

RuboCop version

$ bundle exec 'rubocop -V'
0.83.0 (using Parser 2.7.1.2, running on ruby 2.6.5 x86_64-darwin19)
@koic koic added the enhancement label May 15, 2020
@rrosenblum
Copy link
Contributor

@rrosenblum rrosenblum commented May 28, 2020

I've been away from RuboCop development for too long. I didn't know --disable-uncorrectable had been implemented. I'm glad to see this feature around.

Taking a quick look at this issue, I have come across a couple of things. First off, I'm not sure why Lint/UnusedMethodArgument will change an unused argument to _some_arg to show that it is unused, but it will not correct a keyword arg in the same way. My guess is that since a keyword argument with an underscore is still a required argument, then there isn't much use in adding the underscore.

This directly plays into why the comment disable isn't working though. Here is the logic for auto-correction

        def correct(node)
          reason = reason_to_not_correct(node)
          return reason if reason

          @corrected_nodes[node] = true
          if support_autocorrect?
            correction = autocorrect(node)
            return :uncorrected unless correction

            @corrections << Correction.new(correction, node, self)
            :corrected
          elsif disable_uncorrectable?
            disable_uncorrectable(node)
            :corrected_with_todo
          end
        end

With how this has been implemented, a cop can either auto-correct or it can disable, it cannot do both. Since Lint/UnusedMethodArgument can correct some offenses, but not others, it is unable to disable anything.

I think the basic fix is to modify the code inside the support_autocorrect? branch where we are currently doing return :uncorrected unless correction.

@marcandre
Copy link
Contributor

@marcandre marcandre commented May 28, 2020

I think the basic fix is to modify the code inside the support_autocorrect? branch where we are currently doing return :uncorrected unless correction.

Actually knowing if a Cop has done corrections will be automatic once #7868 merges, hopefully in the next few days.

rrosenblum added a commit to rrosenblum/rubocop that referenced this issue May 28, 2020
rrosenblum added a commit to rrosenblum/rubocop that referenced this issue May 29, 2020
bbatsov added a commit that referenced this issue May 31, 2020
…#8054)

Co-authored-by: Bozhidar Batsov <bozhidar@batsov.com>
@laurmurclar
Copy link
Contributor Author

@laurmurclar laurmurclar commented Jun 2, 2020

Thank you so much for taking this on, delighted to see the fix merged!

rrosenblum added a commit to rrosenblum/rubocop that referenced this issue Jun 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

4 participants
You can’t perform that action at this time.