Unification of IgnoredMethods

[dvandersluis]

As mentioned by @bbatsov at #9058 (comment)

1. The two cops that were configured using ExcludedMethods instead of IgnoredMethods (Metrics/BlockLength and Metrics/MethodLength) have been changed to use IgnoredMethods going forward. I changed the IgnoredMethods mixin so that it can be configured to allow for those two cops to continue accepting ExcludedMethods without adding that config key to the reset of the cops.
2. All cops that use the IgnoredMethods mixin now can accept an array of both strings and regexes, and both are applied.

Questions:

• Is there a good way to document this so that users will know they can use regexes for IgnoredMethods everywhere now? I added a new section to configuration.adoc.
• Is there a way to add a deprecation warning when running rubocop with ExcludedMethods in the configuration so that users can update their config?

---

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.

[dvandersluis]

Metrics/BlockLength has a special case for IgnoredMethods, where it allows for values to be fully qualified methods, and it uses this to test receivers. I kept this logic of course, but this is now an exception from how all the other IgnoredMethods cops work.

[bbatsov]

Is there a good way to document this so that users will know they can use regexes for IgnoredMethods everywhere now?

Can't think of anything other than something in the "Configuration" part of the docs.

Is there a way to add a deprecation warning when running rubocop with ExcludedMethods in the configuration so that users can update their config?

Yes - look for ConfigObsoletion.

[dvandersluis]

Yes - look for ConfigObsoletion.

Looks like OBSOLETE_PARAMETERS from ConfigObsoletion gives an error instead of allowing it, which makes my configuration to still be able to use ExcludedMethods not very useful since rubocop won't run anyways. What do you suggest @bbatsov?

$ rubocop
Error: obsolete parameter ExcludedMethods (for Metrics/BlockLength) found in .rubocop.yml
`ExcludedMethods` has been renamed to `IgnoredMethods`.
obsolete parameter ExcludedMethods (for Metrics/MethodLength) found in .rubocop.yml
`ExcludedMethods` has been renamed to `IgnoredMethods`.

[dvandersluis]

spec/rubocop/config_loader_spec.rb:740 is failing in CI but not via bundle exec rake default. Anyone have any ideas?

[bbatsov]

I'm assuming some dep got updated on the CI.

which makes my configuration to still be able to use ExcludedMethods not very useful since rubocop won't run anyways. What do you suggest @bbatsov?

Damn, I had forgotten that in the past we already raised error. I guess we should make the code there a bit more flexible and make it show errors or warnings.

[dvandersluis]

Damn, I had forgotten that in the past we already raised error. I guess we should make the code there a bit more flexible and make it show errors or warnings.

I'll take a look at it!

[dvandersluis]

@bbatsov I think everything has been taken care of now. I've added to the documentation and the deprecation message is now set up.

[dvandersluis]

One other thing -- I needed to keep ExcludedMethods in config/default.yml or rubocop will complain about unsupported parameters. However, this will add it to the doc for the cop. I added a note for both cops to explain why there's both, hopefully that will be sufficient.

[bbatsov]

Fantastic work! 🙇‍♂️