Class: Bundler::CompactIndexClient

Inherits:
Object
  • Object
show all
Defined in:
lib/bundler/compact_index_client.rb,
lib/bundler/compact_index_client/cache.rb,
lib/bundler/compact_index_client/parser.rb,
lib/bundler/compact_index_client/updater.rb,
lib/bundler/compact_index_client/cache_file.rb,
lib/bundler/compact_index_client/gem_parser.rb more...

Overview

The CompactIndexClient is responsible for fetching and parsing the compact index.

The compact index is a set of caching optimized files that are used to fetch gem information. The files are:

  • names: a list of all gem names

  • versions: a list of all gem versions

  • info/: a list of all versions of a gem

The client is instantiated with:

  • ‘directory`: the root directory where the cache files are stored.

  • ‘fetcher`: (optional) an object that responds to #call(uri_path, headers) and returns an http response.

If the ‘fetcher` is not provided, the client will only read cached files from disk.

The client is organized into:

  • ‘Updater`: updates the cached files on disk using the fetcher.

  • ‘Cache`: calls the updater, caches files, read and return them from disk

  • ‘Parser`: parses the compact index file data

  • ‘CacheFile`: a concurrency safe file reader/writer that verifies checksums

The client is intended to optimize memory usage and performance. It is called 100s or 1000s of times, parsing files with hundreds of thousands of lines. It may be called concurrently without global interpreter lock in some Rubies. As a result, some methods may look more complex than necessary to save memory or time.

Defined Under Namespace

Classes: Cache, CacheFile, Error, GemParser, Parser, Updater

Constant Summary collapse

SUPPORTED_DIGESTS =

NOTE: MD5 is here not because we expect a server to respond with it, but because we use it to generate the etag on first request during the upgrade to the compact index client that uses opaque etags saved to files. Remove once 2.5.0 has been out for a while.

{ "sha-256" => :SHA256, "md5" => :MD5 }.freeze
DEBUG_MUTEX = 
Thread::Mutex.new
INFO_NAME =

info returns an Array of INFO Arrays. Each INFO Array has the following indices:

0
INFO_VERSION = 
1
INFO_PLATFORM = 
2
INFO_DEPS = 
3
INFO_REQS = 
4

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(directory, fetcher = nil) ⇒ CompactIndexClient

Returns a new instance of CompactIndexClient.

[View source]

57
58
59
60
 
# File 'lib/bundler/compact_index_client.rb', line 57

def initialize(directory, fetcher = nil)
  @cache = Cache.new(directory, fetcher)
  @parser = Parser.new(@cache)
end

Class Method Details

.debug ⇒ Object

[View source]

45
46
47
48
 
# File 'lib/bundler/compact_index_client.rb', line 45

def self.debug
  return unless ENV["DEBUG_COMPACT_INDEX"]
  DEBUG_MUTEX.synchronize { warn("[#{self}] #{yield}") }
end

Instance Method Details

#available? ⇒ Boolean

Returns:

  • (Boolean)
[View source]

87
88
89
90
 
# File 'lib/bundler/compact_index_client.rb', line 87

def available?
  Bundler::CompactIndexClient.debug { "available?" }
  @parser.available?
end

#dependencies(names) ⇒ Object

[View source]

72
73
74
75
 
# File 'lib/bundler/compact_index_client.rb', line 72

def dependencies(names)
  Bundler::CompactIndexClient.debug { "dependencies(#{names})" }
  names.map {|name| info(name) }
end

#info(name) ⇒ Object

[View source]

77
78
79
80
 
# File 'lib/bundler/compact_index_client.rb', line 77

def info(name)
  Bundler::CompactIndexClient.debug { "info(#{name})" }
  @parser.info(name)
end

#latest_version(name) ⇒ Object

[View source]

82
83
84
85
 
# File 'lib/bundler/compact_index_client.rb', line 82

def latest_version(name)
  Bundler::CompactIndexClient.debug { "latest_version(#{name})" }
  @parser.info(name).map {|d| Gem::Version.new(d[INFO_VERSION]) }.max
end

#names ⇒ Object

[View source]

62
63
64
65
 
# File 'lib/bundler/compact_index_client.rb', line 62

def names
  Bundler::CompactIndexClient.debug { "names" }
  @parser.names
end

#reset! ⇒ Object

[View source]

92
93
94
95
 
# File 'lib/bundler/compact_index_client.rb', line 92

def reset!
  Bundler::CompactIndexClient.debug { "reset!" }
  @cache.reset!
end

#versions ⇒ Object

[View source]

67
68
69
70
 
# File 'lib/bundler/compact_index_client.rb', line 67

def versions
  Bundler::CompactIndexClient.debug { "versions" }
  @parser.versions
end