123456789_123456789_123456789_123456789_123456789_

Class: Gem::Source

Relationships & Source Files
Namespace Children
Classes:
Git, Installed, Local, Lock, SpecificFile, Vendor
Extension / Inclusion / Inheritance Descendants
Subclasses:
Git, Installed, Local, Lock, SpecificFile, Vendor
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.

Constant Summary

Class Method Summary

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

Constructor Details

.new(uri) ⇒ Source

Creates a new Source which will use the index located at #uri.

[ GitHub ] 

  


# File 'lib/rubygems/source.rb', line 29



def initialize(uri)
  begin
    unless uri.kind_of? URI
      uri = URI.parse(uri.to_s)
    end
  rescue URI::InvalidURIError
    raise if Gem::Source == self.class
  end

  @uri = uri
end


  







Instance Attribute Details



  

    #update_cache?  ⇒ Boolean  (readonly)
  



  

    

Returns true when it is possible and safe to update the cache directory.


  





  


  [ GitHub ]


  

  


# File 'lib/rubygems/source.rb', line 117



def update_cache?
  @update_cache ||=
    begin
      File.stat(Gem.user_home).uid == Process.uid
    rescue Errno::ENOENT
      false
    end
end


  








  

    #uri   (readonly)
  



  

    

The URI this source will fetch gems from.


  



  [ GitHub ]


  

  


# File 'lib/rubygems/source.rb', line 24



attr_reader :uri


  







Instance Method Details



  

    #<=>(other)  
  



  

    

Sources are ordered by installation preference.


  



  [ GitHub ]


  

  


# File 'lib/rubygems/source.rb', line 44



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

    # Returning 1 here ensures that when sorting a list of sources, the
    # original ordering of sources supplied by the user is preserved.
    return 1 unless @uri.to_s == other.uri.to_s

    0
  else
    nil
  end
end


  








  

    #==(other)  
    Also known as: #eql?
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/rubygems/source.rb', line 71



def ==(other) # :nodoc:
  self.class === other and @uri == other.uri
end


  








  

    #cache_dir(uri)  
  



  

    

Returns the local directory to write #uri to.


  



  [ GitHub ]


  

  


# File 'lib/rubygems/source.rb', line 106



def cache_dir(uri)
  # Correct for windows paths
  escaped_path = uri.path.sub(/^\/([a-z]):\//i, '/\\1-/')
  escaped_path.untaint

  File.join Gem.spec_cache_dir, "#{uri.host}%#{uri.port}", File.dirname(escaped_path)
end


  








  

    #dependency_resolver_set  
  

  

    This method is for internal use only.
  



  

    

Returns a Set that can fetch specifications from this source.


  



  [ GitHub ]


  

  


# File 'lib/rubygems/source.rb', line 80



def dependency_resolver_set # :nodoc:
  return Gem::Resolver::IndexSet.new self if 'file' == uri.scheme

  bundler_api_uri = uri + './api/v1/dependencies'

  begin
    fetcher = Gem::RemoteFetcher.fetcher
    response = fetcher.fetch_path bundler_api_uri, nil, true
  rescue Gem::RemoteFetcher::FetchError
    Gem::Resolver::IndexSet.new self
  else
    if response.respond_to? :uri
      Gem::Resolver::APISet.new response.uri
    else
      Gem::Resolver::APISet.new bundler_api_uri
    end
  end
end


  








  

    #download(spec, dir = Dir.pwd)  
  



  

    

Downloads spec and writes it to Gem.dir.  See also RemoteFetcher#download.


  



  [ GitHub ]


  

  


# File 'lib/rubygems/source.rb', line 204



def download(spec, dir=Dir.pwd)
  fetcher = Gem::RemoteFetcher.fetcher
  fetcher.download spec, uri.to_s, dir
end


  








  

    #eql?(other)  
  

  

    This method is for internal use only.
  



  

    

Alias for #==.


  



  [ GitHub ]


  

  


# File 'lib/rubygems/source.rb', line 75



alias_method :eql?, :== # :nodoc:


  








  

    #fetch_spec(name_tuple)  
  



  

    

Fetches a specification for the given name_tuple.


  



  [ GitHub ]


  

  


# File 'lib/rubygems/source.rb', line 129



def fetch_spec(name_tuple)
  fetcher = Gem::RemoteFetcher.fetcher

  spec_file_name = name_tuple.spec_name

  source_uri = uri + "#{Gem::MARSHAL_SPEC_DIR}#{spec_file_name}"

  cache_dir = cache_dir source_uri

  local_spec = File.join cache_dir, spec_file_name

  if File.exist? local_spec
    spec = Gem.read_binary local_spec
    spec = Marshal.load(spec) rescue nil
    return spec if spec
  end

  source_uri.path << '.rz'

  spec = fetcher.fetch_path source_uri
  spec = Gem::Util.inflate spec

  if update_cache?
    FileUtils.mkdir_p cache_dir

    File.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


  








  

    #hash  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/rubygems/source.rb', line 99



def hash # :nodoc:
  @uri.hash
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


  



  [ GitHub ]


  

  


# File 'lib/rubygems/source.rb', line 174



def load_specs(type)
  file       = FILES[type]
  fetcher    = Gem::RemoteFetcher.fetcher
  file_name  = "#{file}.#{Gem.marshal_version}"
  spec_path  = 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


  








  

    #pretty_print(q)  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/rubygems/source.rb', line 209



def pretty_print(q) # :nodoc:
  q.group 2, '[Remote:', ']' do
    q.breakable
    q.text @uri.to_s

    if api = uri
      q.breakable
      q.text 'API URI: '
      q.text api.to_s
    end
  end
end