Class: Gem::Source
Relationships & Source Files | |
Namespace Children | |
Classes:
| |
Extension / Inclusion / Inheritance Descendants | |
Subclasses:
|
|
Super Chains via Extension / Inclusion / Inheritance | |
Instance Chain:
self,
Comparable
|
|
Inherits: | Object |
Defined in: | lib/rubygems/source.rb |
Overview
A Source knows how to list and fetch gems from a RubyGems marshal index.
There are other Source
subclasses for installed gems, local gems, the bundler dependency API and so-forth.
Class Method Summary
-
.new(uri) ⇒ Source
constructor
Creates a new
Source
which will use the index located at #uri.
Instance Attribute Summary
-
#update_cache? ⇒ Boolean
readonly
Returns true when it is possible and safe to update the cache directory.
-
#uri
readonly
The URI this source will fetch gems from.
Instance Method Summary
-
#<=>(other)
Sources are ordered by installation preference.
-
#cache_dir(uri)
Returns the local directory to write #uri to.
-
#download(spec, dir = Dir.pwd)
Downloads
spec
and writes it to dir. -
#fetch_spec(name_tuple)
Fetches a specification for the given
name_tuple
. -
#load_specs(type)
Loads
type
kind of specs fetching from @uri if the on-disk cache is out of date.
Constructor Details
.new(uri) ⇒ Source
Creates a new Source
which will use the index located at #uri.
Instance Attribute Details
#update_cache? ⇒ Boolean
(readonly)
Returns true when it is possible and safe to update the cache directory.
#uri (readonly)
The URI this source will fetch gems from.
# File 'lib/rubygems/source.rb', line 24
attr_reader :uri
Instance Method Details
#<=>(other)
Sources are ordered by installation preference.
# File 'lib/rubygems/source.rb', line 53
def <=>(other) case other when Gem::Source::Installed, Gem::Source::Local, Gem::Source::Lock, Gem::Source::SpecificFile, Gem::Source::Git, Gem::Source::Vendor then -1 when Gem::Source then if !@uri return 0 unless other.uri return 1 end return -1 if !other.uri @uri.to_s <=> other.uri.to_s else nil end end
#cache_dir(uri)
Returns the local directory to write #uri to.
#download(spec, dir = Dir.pwd)
Downloads spec
and writes it to Gem.dir. See also RemoteFetcher#download.
#fetch_spec(name_tuple)
Fetches a specification for the given name_tuple
.
# File 'lib/rubygems/source.rb', line 134
def fetch_spec name_tuple fetcher = Gem::RemoteFetcher.fetcher spec_file_name = name_tuple.spec_name uri = api_uri + "#{Gem::MARSHAL_SPEC_DIR}#{spec_file_name}" cache_dir = cache_dir uri local_spec = File.join cache_dir, spec_file_name if File.exist? local_spec then spec = Gem.read_binary local_spec spec = Marshal.load(spec) rescue nil return spec if spec end uri.path << '.rz' spec = fetcher.fetch_path uri spec = Gem.inflate spec if update_cache? then FileUtils.mkdir_p cache_dir open local_spec, 'wb' do |io| io.write spec end end # TODO: Investigate setting Gem::Specification#loaded_from to a URI Marshal.load spec end
#load_specs(type)
Loads type
kind of specs fetching from @uri if the on-disk cache is out of date.
type
is one of the following:
:released
=> Return the list of all released specs :latest
=> Return the list of only the highest version of each gem :prerelease
=> Return the list of all prerelease only specs
# File 'lib/rubygems/source.rb', line 179
def load_specs(type) file = FILES[type] fetcher = Gem::RemoteFetcher.fetcher file_name = "#{file}.#{Gem.marshal_version}" spec_path = api_uri + "#{file_name}.gz" cache_dir = cache_dir spec_path local_file = File.join(cache_dir, file_name) retried = false FileUtils.mkdir_p cache_dir if update_cache? spec_dump = fetcher.cache_update_path spec_path, local_file, update_cache? begin Gem::NameTuple.from_list Marshal.load(spec_dump) rescue ArgumentError if update_cache? && !retried FileUtils.rm local_file retried = true retry else raise Gem::Exception.new("Invalid spec cache file in #{local_file}") end end end