class RuboCop::RemoteConfig
@api private
Common methods and behaviors for dealing with remote config files.
def cache_name_from_uri
def cache_name_from_uri uri = cloned_url uri.query = nil uri.to_s.gsub!(/[^0-9A-Za-z]/, '-') end
def cache_path
def cache_path File.expand_path(".rubocop-#{cache_name_from_uri}", @base_dir) end
def cache_path_exists?
def cache_path_exists? @cache_path_exists ||= File.exist?(cache_path) end
def cache_path_expired?
def cache_path_expired? return true unless cache_path_exists? @cache_path_expired ||= begin file_age = (Time.now - File.stat(cache_path).mtime).to_f (file_age / CACHE_LIFETIME) > 1 end end
def cloned_url
def cloned_url uri = @uri.clone uri.user = nil if uri.user uri.password = nil if uri.password uri end
def file
def file return cache_path unless cache_path_expired? request do |response| next if response.is_a?(Net::HTTPNotModified) next if response.is_a?(SocketError) File.write(cache_path, response.body) end cache_path end
def generate_request(uri)
def generate_request(uri) request = Net::HTTP::Get.new(uri.request_uri) request.basic_auth(uri.user, uri.password) if uri.user request['If-Modified-Since'] = File.stat(cache_path).mtime.rfc2822 if cache_path_exists? yield request end
def handle_response(response, limit, &block)
def handle_response(response, limit, &block) case response when Net::HTTPSuccess, Net::HTTPNotModified, SocketError yield response when Net::HTTPRedirection request(URI.parse(response['location']), limit - 1, &block) else begin response.error! rescue StandardError => e message = "#{e.message} while downloading remote config file #{cloned_url}" raise e, message end end end
def inherit_from_remote(file, path)
def inherit_from_remote(file, path) new_uri = @uri.dup new_uri.path.gsub!(%r{/[^/]*$}, "/#{file.delete_prefix('./')}") RemoteConfig.new(new_uri.to_s, File.dirname(path)) end
def initialize(url, base_dir)
def initialize(url, base_dir) @uri = URI.parse(url) @base_dir = base_dir end
def request(uri = @uri, limit = 10, &block)
def request(uri = @uri, limit = 10, &block) raise ArgumentError, 'HTTP redirect too deep' if limit.zero? http = Net::HTTP.new(uri.hostname, uri.port) http.use_ssl = uri.instance_of?(URI::HTTPS) generate_request(uri) do |request| handle_response(http.request(request), limit, &block) rescue SocketError => e handle_response(e, limit, &block) end end