Class: RuboCop::Server::Cache Private
- Inherits:
-
Object
- Object
- RuboCop::Server::Cache
- Defined in:
- lib/rubocop/server/cache.rb
Overview
This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.
Caches the states of server process.
Constant Summary collapse
- GEMFILE_NAMES =
This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.
%w[Gemfile gems.rb].freeze
- LOCKFILE_NAMES =
This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.
%w[Gemfile.lock gems.locked].freeze
Class Attribute Summary collapse
- .cache_root_path ⇒ Object private
Class Method Summary collapse
- .acquire_lock ⇒ Object private
- .cache_path ⇒ Object private
-
.cache_root_dir_from_config ⇒ Object
private
rubocop:disable Metrics/MethodLength.
- .dir ⇒ Object private
- .lock_path ⇒ Object private
- .pid_path ⇒ Object private
- .pid_running? ⇒ Boolean private
-
.port_path ⇒ Object
private
rubocop:enable Metrics/MethodLength.
-
.project_dir ⇒ Object
private
Searches for Gemfile or gems.rb in the current dir or any parent dirs.
- .project_dir_cache_key ⇒ Object private
- .restart_key ⇒ Object private
- .status_path ⇒ Object private
- .stderr_path ⇒ Object private
- .token_path ⇒ Object private
- .version_path ⇒ Object private
- .write_pid_file ⇒ Object private
- .write_port_and_token_files(port:, token:) ⇒ Object private
- .write_status_file(status) ⇒ Object private
- .write_version_file(version) ⇒ Object private
Class Attribute Details
.cache_root_path ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
26 27 28 |
# File 'lib/rubocop/server/cache.rb', line 26 def cache_root_path @cache_root_path end |
Class Method Details
.acquire_lock ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
133 134 135 136 137 138 139 140 141 |
# File 'lib/rubocop/server/cache.rb', line 133 def acquire_lock lock_file = File.open(lock_path, File::CREAT) # flock returns 0 if successful, and false if not. flock_result = lock_file.flock(File::LOCK_EX | File::LOCK_NB) yield flock_result != false ensure lock_file.flock(File::LOCK_UN) lock_file.close end |
.cache_path ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
60 61 62 63 64 65 66 67 68 |
# File 'lib/rubocop/server/cache.rb', line 60 def cache_path cache_root_dir = if cache_root_path File.join(cache_root_path, 'rubocop_cache') else cache_root_dir_from_config end File.(File.join(cache_root_dir, 'server')) end |
.cache_root_dir_from_config ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
rubocop:disable Metrics/MethodLength
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 |
# File 'lib/rubocop/server/cache.rb', line 71 def cache_root_dir_from_config CacheConfig.root_dir do # `RuboCop::ConfigStore` has heavy dependencies, this is a lightweight implementation # so that only the necessary `CacheRootDirectory` can be obtained. config_path = ConfigFinder.find_config_path(Dir.pwd) file_contents = File.read(config_path) # Returns early if `CacheRootDirectory` is not used before requiring `erb` or `yaml`. next unless file_contents.include?('CacheRootDirectory') require 'erb' yaml_code = ERB.new(file_contents).result require 'yaml' config_yaml = YAML.safe_load( yaml_code, permitted_classes: [Regexp, Symbol], aliases: true ) # For compatibility with Ruby 3.0 or lower. if Gem::Version.new(Psych::VERSION) < Gem::Version.new('4.0.0') config_yaml == false ? nil : config_yaml end config_yaml&.dig('AllCops', 'CacheRootDirectory') end end |
.dir ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
54 55 56 57 58 |
# File 'lib/rubocop/server/cache.rb', line 54 def dir Pathname.new(File.join(cache_path, project_dir_cache_key)).tap do |d| d.mkpath unless d.exist? end end |
.lock_path ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
111 112 113 |
# File 'lib/rubocop/server/cache.rb', line 111 def lock_path dir.join('lock') end |
.pid_path ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
107 108 109 |
# File 'lib/rubocop/server/cache.rb', line 107 def pid_path dir.join('pid') end |
.pid_running? ⇒ Boolean
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
127 128 129 130 131 |
# File 'lib/rubocop/server/cache.rb', line 127 def pid_running? Process.kill(0, pid_path.read.to_i) == 1 rescue Errno::ESRCH, Errno::ENOENT, Errno::EACCES, Errno::EROFS false end |
.port_path ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
rubocop:enable Metrics/MethodLength
99 100 101 |
# File 'lib/rubocop/server/cache.rb', line 99 def port_path dir.join('port') end |
.project_dir ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Searches for Gemfile or gems.rb in the current dir or any parent dirs
29 30 31 32 33 34 35 36 37 38 39 40 |
# File 'lib/rubocop/server/cache.rb', line 29 def project_dir current_dir = Dir.pwd while current_dir != '/' return current_dir if GEMFILE_NAMES.any? do |gemfile| File.exist?(File.join(current_dir, gemfile)) end current_dir = File.('..', current_dir) end # If we can't find a Gemfile, just use the current directory Dir.pwd end |
.project_dir_cache_key ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
42 43 44 |
# File 'lib/rubocop/server/cache.rb', line 42 def project_dir_cache_key @project_dir_cache_key ||= project_dir[1..].tr('/', '+') end |
.restart_key ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
46 47 48 49 50 51 52 |
# File 'lib/rubocop/server/cache.rb', line 46 def restart_key lockfile_path = LOCKFILE_NAMES.map do |lockfile_name| Pathname(project_dir).join(lockfile_name) end.find(&:exist?) Digest::SHA1.hexdigest(lockfile_path&.read || RuboCop::Version::STRING) end |
.status_path ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
115 116 117 |
# File 'lib/rubocop/server/cache.rb', line 115 def status_path dir.join('status') end |
.stderr_path ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
123 124 125 |
# File 'lib/rubocop/server/cache.rb', line 123 def stderr_path dir.join('stderr') end |
.token_path ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
103 104 105 |
# File 'lib/rubocop/server/cache.rb', line 103 def token_path dir.join('token') end |
.version_path ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
119 120 121 |
# File 'lib/rubocop/server/cache.rb', line 119 def version_path dir.join('version') end |
.write_pid_file ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
148 149 150 151 152 153 |
# File 'lib/rubocop/server/cache.rb', line 148 def write_pid_file pid_path.write(Process.pid) yield ensure dir.rmtree end |
.write_port_and_token_files(port:, token:) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
143 144 145 146 |
# File 'lib/rubocop/server/cache.rb', line 143 def write_port_and_token_files(port:, token:) port_path.write(port) token_path.write(token) end |
.write_status_file(status) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
155 156 157 |
# File 'lib/rubocop/server/cache.rb', line 155 def write_status_file(status) status_path.write(status) end |
.write_version_file(version) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
159 160 161 |
# File 'lib/rubocop/server/cache.rb', line 159 def write_version_file(version) version_path.write(version) end |