[Fix #10842] Make server mode aware of CacheRootDirectory and two env vars
#10852
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
make_server_mode_aware_of_cache_root_directory
branch
5 times, most recently
from
e2aeaf4
to
66b8845
Compare
koic
changed the title
CacheRootDirectory and two env varsCacheRootDirectory and two env vars
koic
force-pushed
the
make_server_mode_aware_of_cache_root_directory
branch
from
66b8845
to
e3c05aa
Compare
bbatsov
reviewed
Aug 3, 2022
lib/rubocop/config_path_finder.rb
Outdated
| module RuboCop | ||
| # This class has methods related to finding configuration path. | ||
| # @api private | ||
| class ConfigPathFinder |
There was a problem hiding this comment.
Perhaps just ConfigFinder?
There was a problem hiding this comment.
Thanks for the suggestion! I've update this class name.
bbatsov
reviewed
Aug 3, 2022
lib/rubocop/cache_root.rb
Outdated
| module RuboCop | ||
| # This class represents the cache root of the caching RuboCop runs. | ||
| # @api private | ||
| class CacheRoot |
There was a problem hiding this comment.
CacheRoot seems a bit too specific to me to warrant a class - maybe this should be CacheConfig or something like this?
There was a problem hiding this comment.
CacheConfig looks good! Also changed the class method name from CacheRoot.dir to CacheConfig.root_dir.
…d two env vars Fixes rubocop#10842 and follow up rubocop#10849. This PR makes server mode aware of `CacheRootDirectory` config option value, `RUBOCOP_CACHE_ROOT`, and `XDG_CACHE_HOME` environment variables. `RuboCop::ConfigLoader` and `RuboCop::ResultCache` classes to get these values has many dependencies. So, it is not suitable for use in server mode where speed is required. This solution is to extract `ConfigPathFinder` class from `ConfigLoader` class and `CacheRoot` class from `ResultCache` class. This allows server mode to depend on lightweight `ConfigPathFinder` and `CacheRoot` classes.
koic
force-pushed
the
make_server_mode_aware_of_cache_root_directory
branch
from
e3c05aa
to
651ba56
Compare
|
Thanks! |
WJWH
pushed a commit
to WJWH/rubocop
that referenced
this pull request
Aug 8, 2022
…d two env vars (rubocop#10852) Fixes rubocop#10842 and follow up rubocop#10849. This PR makes server mode aware of `CacheRootDirectory` config option value, `RUBOCOP_CACHE_ROOT`, and `XDG_CACHE_HOME` environment variables. `RuboCop::ConfigLoader` and `RuboCop::ResultCache` classes to get these values has many dependencies. So, it is not suitable for use in server mode where speed is required. This solution is to extract `ConfigFinder` class from `ConfigLoader` class and `CacheConfig` class from `ResultCache` class. This allows server mode to depend on lightweight `ConfigFinder` and `CacheConfig` classes.
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.
Fixes #10842 and follow up #10849.
This PR makes server mode aware of
CacheRootDirectoryconfig option value,RUBOCOP_CACHE_ROOT, andXDG_CACHE_HOMEenvironment variables.RuboCop::ConfigLoaderandRuboCop::ResultCacheclasses to get these values has many dependencies. So, it is not suitable for use in server mode where speed is required.This solution is to extract
ConfigPathFinderclass fromConfigLoaderclass andCacheRootclass fromResultCacheclass. This allows server mode to depend on lightweightConfigPathFinderandCacheRootclasses.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.