[Fix #2044] Fix unintended document changes caused by default Rake task #2047
Conversation
This file contains 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
koic
force-pushed
the
fix_unintended_document_changes_caused_by_default_rake_task
branch
from
9315b20 to
a70e104
Compare
…Rake task This PR fixes unintended document changes caused by default Rake task. ## Problem The default task causes `RuboCop::Config` to end up in an unexpected state when `internal_investigation` task is executed before `generate_cops_documentation` task. This is due to the fact that plugins are already loaded when RuboCop is executed as part of `internal_investigation`. ## Solution This change preemptively determines whether configuration adjustments are necessary based on whether `rubocop-rspec` plugin has already been loaded. ## Additional Information Since this logic should ideally be encapsulated within `CopsDocumentationGenerator`, it is expected to become unnecessary in the future once the API design and implementation of `CopsDocumentationGenerator` class are complete. For now, this serves as a temporary workaround. Fixes rubocop#2044.
koic
force-pushed
the
fix_unintended_document_changes_caused_by_default_rake_task
branch
from
a70e104 to
30b09a3
Compare
bquorning
approved these changes
Feb 18, 2025
koic
deleted the
fix_unintended_document_changes_caused_by_default_rake_task
branch
koic
added a commit
to koic/rubocop
that referenced
this pull request
Feb 25, 2025
`CopsDocumentationGenerator` is a private API used primarily for generating documentation for extension gems managed by RuboCop HQ. With the plugin migration in rubocop#13792, the implementation was changed to use `RuboCop::ConfigLoader.inject_defaults!` instead of `Inject`, as shown below: ```diff - RuboCop::Performance::Inject.defaults! + RuboCop::ConfigLoader.inject_defaults!("#{__dir__}/../config/default.yml") ``` However, switching to this API caused issues in rubocop/rubocop-rspec#2047. This PR addresses those issues in a centralized manner within `CopsDocumentationGenerator`. As a result, the changes in extension gems will look like this: ```diff - RuboCop::ConfigLoader.inject_defaults!("#{__dir__}/../config/default.yml") - - CopsDocumentationGenerator.new(departments: deps).call + CopsDocumentationGenerator.new(departments: deps, plugin_name: 'rubocop-performance').call ``` One of the benefits of this change is that it reduces the need to use the `RuboCop::ConfigLoader.inject_defaults!` API.
8 tasks
bbatsov
pushed a commit
to rubocop/rubocop
that referenced
this pull request
Feb 26, 2025
`CopsDocumentationGenerator` is a private API used primarily for generating documentation for extension gems managed by RuboCop HQ. With the plugin migration in #13792, the implementation was changed to use `RuboCop::ConfigLoader.inject_defaults!` instead of `Inject`, as shown below: ```diff - RuboCop::Performance::Inject.defaults! + RuboCop::ConfigLoader.inject_defaults!("#{__dir__}/../config/default.yml") ``` However, switching to this API caused issues in rubocop/rubocop-rspec#2047. This PR addresses those issues in a centralized manner within `CopsDocumentationGenerator`. As a result, the changes in extension gems will look like this: ```diff - RuboCop::ConfigLoader.inject_defaults!("#{__dir__}/../config/default.yml") - - CopsDocumentationGenerator.new(departments: deps).call + CopsDocumentationGenerator.new(departments: deps, plugin_name: 'rubocop-performance').call ``` One of the benefits of this change is that it reduces the need to use the `RuboCop::ConfigLoader.inject_defaults!` API.
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 PR fixes unintended document changes caused by default Rake task.
Problem
The default task causes
RuboCop::Configto end up in an unexpected state wheninternal_investigationtask is executed beforegenerate_cops_documentationtask. This is due to the fact that plugins are already loaded when RuboCop is executed as part ofinternal_investigation.Solution
This change preemptively determines whether configuration adjustments are necessary based on whether
rubocop-rspecplugin has already been loaded.Additional Information
Since this logic should ideally be encapsulated within
CopsDocumentationGenerator, it is expected to become unnecessary in the future once the API design and implementation ofCopsDocumentationGeneratorclass are complete. For now, this serves as a temporary workaround.Fixes #2044.
Before submitting the PR make sure the following are checked:
master(if not - rebase it).CHANGELOG.mdif the new code introduces user-observable changes.bundle exec rake) passes (be sure to run this locally, since it may produce updated documentation that you will need to commit).If you have created a new cop:
config/default.yml.Enabled: pendinginconfig/default.yml.Enabled: truein.rubocop.yml.VersionAdded: "<<next>>"indefault/config.yml.If you have modified an existing cop's configuration options:
VersionChanged: "<<next>>"inconfig/default.yml.