class RuboCop::Server::Cache
Caches the states of server process. @api private
Constants
- GEMFILE_NAMES
- LOCKFILE_NAMES
Attributes
Public Class Methods
Source
# File lib/rubocop/server/cache.rb, line 137 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
Source
# File lib/rubocop/server/cache.rb, line 72 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.expand_path(File.join(cache_root_dir, 'server')) end
Source
# File lib/rubocop/server/cache.rb, line 82 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') config_yaml = load_erb_templated_yaml(file_contents) # 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
Source
# File lib/rubocop/server/cache.rb, line 66 def dir Pathname.new(File.join(cache_path, project_dir_cache_key)).tap do |d| d.mkpath unless d.exist? end end
rubocop:enable Metrics/AbcSize
Source
# File lib/rubocop/server/cache.rb, line 167 def inherit_from_data(yaml) return '' unless (inherit_from_paths = yaml['inherit_from']) Array(inherit_from_paths).map do |path| next if PathUtil.remote_file?(path) path = Pathname(path) path.exist? ? path.read : '' end.join end
Source
# File lib/rubocop/server/cache.rb, line 131 def pid_running? Process.kill(0, pid_path.read.to_i) == 1 rescue Errno::ESRCH, Errno::ENOENT, Errno::EACCES, Errno::EROFS, Errno::ENAMETOOLONG false end
Source
# File lib/rubocop/server/cache.rb, line 31 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.expand_path('..', current_dir) end # If we can't find a Gemfile, just use the current directory Dir.pwd end
Searches for Gemfile or gems.rb in the current dir or any parent dirs
Source
# File lib/rubocop/server/cache.rb, line 44 def project_dir_cache_key @project_dir_cache_key ||= project_dir[1..].tr('/', '+') end
Source
# File lib/rubocop/server/cache.rb, line 179 def require_data(yaml) return '' unless (require_paths = yaml['require']) Array(require_paths).map do |path| # NOTE: This targets only relative or absolute path specifications. # For example, specifications like `require: rubocop-performance`, # which can be loaded from `$LOAD_PATH`, are ignored. next unless path.start_with?('.', '/') # NOTE: `.so` files are not typically specified, so only `.rb` files are targeted. path = "#{path}.rb" unless path.end_with?('.rb') path = Pathname(path) path.exist? ? path.read : '' end.join end
Source
# File lib/rubocop/server/cache.rb, line 49 def restart_key(args_config_file_path: nil) lockfile_path = LOCKFILE_NAMES.map do |lockfile_name| Pathname(project_dir).join(lockfile_name) end.find(&:exist?) version_data = lockfile_path&.read || RuboCop::Version::STRING config_data = Pathname( args_config_file_path || ConfigFinder.find_config_path(Dir.pwd) ).read yaml = load_erb_templated_yaml(config_data) inherit_from_data = inherit_from_data(yaml) require_data = require_data(yaml) Digest::SHA1.hexdigest(version_data + config_data + inherit_from_data + require_data) end
rubocop:disable Metrics/AbcSize
Source
# File lib/rubocop/server/cache.rb, line 119 def status_path dir.join('status') end
Source
# File lib/rubocop/server/cache.rb, line 127 def stderr_path dir.join('stderr') end
Source
# File lib/rubocop/server/cache.rb, line 107 def token_path dir.join('token') end
Source
# File lib/rubocop/server/cache.rb, line 123 def version_path dir.join('version') end
Source
# File lib/rubocop/server/cache.rb, line 152 def write_pid_file pid_path.write(Process.pid) yield ensure dir.rmtree end
Source
# File lib/rubocop/server/cache.rb, line 147 def write_port_and_token_files(port:, token:) port_path.write(port) token_path.write(token) end
Source
# File lib/rubocop/server/cache.rb, line 159 def write_status_file(status) status_path.write(status) end
Source
# File lib/rubocop/server/cache.rb, line 163 def write_version_file(version) version_path.write(version) end
Private Class Methods
Source
# File lib/rubocop/server/cache.rb, line 198 def load_erb_templated_yaml(content) require 'erb' yaml_code = ERB.new(content).result require 'yaml' YAML.safe_load(yaml_code, permitted_classes: [Regexp, Symbol], aliases: true) end