Class: Gem::Resolver::APISet

Inherits:
Set
  • Object
show all
Defined in:
lib/rubygems/resolver/api_set.rb

Overview

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

Instance Attribute Summary collapse

Attributes inherited from Set

#errors, #prerelease, #remote

Instance Method Summary collapse

Methods inherited from Set

#remote?

Constructor Details

#initialize(dep_uri = 'https://rubygems.org/api/v1/dependencies') ⇒ APISet

Creates a new APISet that will retrieve gems from uri using the RubyGems API URL dep_uri which is described at guides.rubygems.org/rubygems-org-api


28
29
30
31
32
33
34
35
36
37
38
39
40
# File 'lib/rubygems/resolver/api_set.rb', line 28

def initialize(dep_uri = 'https://rubygems.org/api/v1/dependencies')
  super()

  dep_uri = URI dep_uri unless URI === dep_uri # for ruby 1.8

  @dep_uri = dep_uri
  @uri     = dep_uri + '../..'

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

  @to_fetch = []
end

Instance Attribute Details

#dep_uriObject (readonly)

The URI for the dependency API this APISet uses.


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

def dep_uri
  @dep_uri
end

#sourceObject (readonly)

The Gem::Source that gems are fetched from


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

def source
  @source
end

#uriObject (readonly)

The corresponding place to fetch gems.


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

def uri
  @uri
end

Instance Method Details

#find_all(req) ⇒ Object

Return an array of APISpecification objects matching DependencyRequest req.


46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
# File 'lib/rubygems/resolver/api_set.rb', line 46

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]
      res << Gem::Resolver::APISpecification.new(self, ver)
    end
  end

  res
end

#prefetch(reqs) ⇒ Object

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


68
69
70
71
72
73
74
# File 'lib/rubygems/resolver/api_set.rb', line 68

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

  @to_fetch += needed
end

#prefetch_nowObject

:nodoc:


76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
# File 'lib/rubygems/resolver/api_set.rb', line 76

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

  uri = @dep_uri + "?gems=#{needed.sort.join ','}"
  str = Gem::RemoteFetcher.fetcher.fetch_path uri

  loaded = []

  Marshal.load(str).each do |ver|
    name = ver[:name]

    @data[name] << ver
    loaded << name
  end

  (needed - loaded).each do |missing|
    @data[missing] = []
  end
end

#pretty_print(q) ⇒ Object

:nodoc:


96
97
98
99
100
101
102
103
104
105
# File 'lib/rubygems/resolver/api_set.rb', line 96

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) ⇒ Object

Return data for all versions of the gem name.


110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'lib/rubygems/resolver/api_set.rb', line 110

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

  uri = @dep_uri + "?gems=#{name}"
  str = Gem::RemoteFetcher.fetcher.fetch_path uri

  Marshal.load(str).each do |ver|
    @data[ver[:name]] << ver
  end

  @data[name]
end