123456789_123456789_123456789_123456789_123456789_

Class: Gem::Resolver::APISet

Relationships & Source Files
Namespace Children
Classes:
GemParser
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Set
Instance Chain:
self, Set
Inherits: Gem::Resolver::Set
Defined in: lib/rubygems/resolver/api_set.rb

Overview

The global rubygems pool, available via the Compact Index API. Returns instances of APISpecification.

Class Method Summary

Set - Inherited

.new

Instance Attribute Summary

  • #source readonly

    The ::Gem::Source that gems are fetched from.

  • #uri readonly

    The corresponding place to fetch gems.

  • #dep_uri readonly Internal use only

    The URI for the Compact Index API this APISet uses.

Set - Inherited

#errors

Errors encountered when resolving gems.
#prerelease

When true, allows matching of requests to prerelease gems.
#remote

Set to true to disable network access for this set.
#remote?

When true, this set is allowed to access the network when looking up specifications or dependencies.

Instance Method Summary

Set - Inherited

#find_all

The find_all method must be implemented.
#prefetch

The #prefetch method may be overridden, but this is not necessary.

Constructor Details

.new(dep_uri = "https://index.rubygems.org/info/") ⇒ APISet

Creates a new APISet that will retrieve gems from #uri using the Compact Index API URL #dep_uri which is described at https://guides.rubygems.org/rubygems-org-compact-index-api

[ GitHub ] 

  


# File 'lib/rubygems/resolver/api_set.rb', line 30



def initialize(dep_uri = "https://index.rubygems.org/info/")
  super()

  dep_uri = Gem::URI dep_uri unless Gem::URI === dep_uri

  @dep_uri = dep_uri
  @uri     = dep_uri + ".."

  @client = nil
  @data   = Hash.new {|h,k| h[k] = [] }
  @source = Gem::Source.new @uri

  @to_fetch = []
end


  







Instance Attribute Details



  

    #dep_uri   (readonly)
  

  

    This method is for internal use only.
  



  

    
The URI for the Compact Index API this APISet uses.

  



  [ GitHub ]


  

  


# File 'lib/rubygems/resolver/api_set.rb', line 13



attr_reader :dep_uri # :nodoc:


  








  

    #source   (readonly)
  



  

    
The ::Gem::Source that gems are fetched from

  



  [ GitHub ]


  

  


# File 'lib/rubygems/resolver/api_set.rb', line 18



attr_reader :source


  








  

    #uri   (readonly)
  



  

    
The corresponding place to fetch gems.

  



  [ GitHub ]


  

  


# File 'lib/rubygems/resolver/api_set.rb', line 23



attr_reader :uri


  







Instance Method Details



  

    #client   (private)
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/rubygems/resolver/api_set.rb', line 124



def client # :nodoc:
  @client ||= @source.compact_index_client
end


  








  

    #find_all(req)  
  



  

    
Return an array of APISpecification objects matching
DependencyRequest req.

  



  [ GitHub ]


  

  


# File 'lib/rubygems/resolver/api_set.rb', line 49



def find_all(req)
  res = []

  return res unless @remote

  if @to_fetch.include?(req.name)
    prefetch_now
  end

  versions(req.name).each do |ver|
    if req.dependency.match? req.name, ver[:number], @prerelease
      res << Gem::Resolver::APISpecification.new(self, ver)
    end
  end

  res
end


  








  

    #prefetch(reqs)  
  



  

    
A hint run by the resolver to allow the Set to fetch
data for DependencyRequests reqs.

  



  [ GitHub ]


  

  


# File 'lib/rubygems/resolver/api_set.rb', line 71



def prefetch(reqs)
  return unless @remote
  names = reqs.map {|r| r.dependency.name }
  needed = names - @data.keys - @to_fetch

  @to_fetch += needed
end


  








  

    #prefetch_now  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/rubygems/resolver/api_set.rb', line 79



def prefetch_now # :nodoc:
  needed = @to_fetch
  @to_fetch = []

  needed.sort.each do |name|
    versions(name)
  end
end


  








  

    #pretty_print(q)  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/rubygems/resolver/api_set.rb', line 88



def pretty_print(q) # :nodoc:
  q.group 2, "[APISet", "]" do
    q.breakable
    q.text "URI: #{@dep_uri}"

    q.breakable
    q.text "gem names:"
    q.pp @data.keys
  end
end


  








  

    #versions(name)  
  

  

    This method is for internal use only.
  



  

    
Return data for all versions of the gem name.

  



  [ GitHub ]


  

  


# File 'lib/rubygems/resolver/api_set.rb', line 102



def versions(name) # :nodoc:
  return @data[name] if @data.key?(name)

  infos = begin
    client.fetch_info(name)
  rescue Gem::RemoteFetcher::FetchError, Gem::CompactIndexClient::Error
    []
  end

  infos.each do |_, number, platform, dependencies, requirements|
    platform ||= "ruby"
    dependencies = dependencies.map {|dep_name, reqs| [dep_name, reqs.join(", ")] }
    requirements = requirements.map {|req_name, reqs| [req_name.to_sym, reqs] }.to_h

    @data[name] << { name: name, number: number, platform: platform, dependencies: dependencies, requirements: requirements }
  end

  @data[name]
end