Emit a deprecation when custom cops inherit from RuboCop::Cop::Cop
#13253
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This has been long-marked as deprecated but not everyone has gotten the memo: https://github.com/search?q=%2F%3C+RuboCop%3A%3ACop%3A%3ACop%2F+lang%3Aruby+-is%3Afork&type=code Some methods _are_ deprecated but its perfectly possible to just not use any of them.
jeromedalbert
added a commit
to jeromedalbert/rubocop-obsession
that referenced
this pull request
Oct 28, 2024
Rubocop 1.67.0 warns that `RuboCop::Cop::Cop` is deprecated, and `RuboCop::Cop::Base` should be used instead. See rubocop/rubocop#13253. Fixes #2
2 tasks
juliantrueflynn
added a commit
to ezcater/ezcater_rubocop
that referenced
this pull request
Dec 4, 2024
What did we change? Refactor following the [V1 Upgrade Guide](https://docs.rubocop.org/rubocop/v1_upgrade_notes.html). I broke down the upgrade into commits to make it easier to review. The main overview though is: - Replace custom cops inheriting from `RuboCop::Cop::Cop` to inherit from `RuboCop::Cop::Base` - Refactor to new `#add_offense` API, which removes `:location` argument - Refactor tests to now recommended matchers `#expect_offense`, `#expect_no_offenses`, `#expect_correction`, `#expect_no_corrections` (this is the biggest code change). This had to be done because the existing use of `#inspect_source` was tied to `RuboCop::Cop::Cop`. - Replace `#autocorrect` to new API that yields it from `#add_offense` NOTE: Based on docs linked, this is all backwards compatible and not a breaking change for clients. Why are we doing this? With [rubocop v1.67](https://github.com/rubocop/rubocop/releases/tag/v1.67.0) it now logs deprecation warnings in console for Cops inheriting from `RuboCop::Cop::Cop` instead of `RuboCop::Cop::Base` (see relevant PR [here](rubocop/rubocop#13253)). While doing this fix I followed the rest of the v1 upgrade steps.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This has been long-marked as deprecated but not everyone has gotten the memo: https://github.com/search?q=%2F%3C+RuboCop%3A%3ACop%3A%3ACop%2F+lang%3Aruby+-is%3Afork&type=code
Some methods are deprecated but its perfectly possible to just not use any of them.
Followup to #13032 and #13244
Before submitting the PR make sure the following are checked:
[Fix #issue-number](if the related issue exists).master(if not - rebase it).bundle exec rake default. It executes all tests and runs RuboCop on its own code.{change_type}_{change_description}.mdif the new code introduces user-observable changes. See changelog entry format for details.