Class: Gem::Resolver::InstallerSet

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

Overview

A set of gems for installation sourced from remote sources and local .gem files

Instance Attribute Summary collapse

Attributes inherited from Set

#prerelease, #remote

Instance Method Summary collapse

Methods inherited from Set

#remote?

Constructor Details

#initialize(domain) ⇒ InstallerSet

Creates a new InstallerSet that will look for gems in domain.



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/rubygems/resolver/installer_set.rb', line 38

def initialize(domain)
  super()

  @domain = domain

  @f = Gem::SpecFetcher.fetcher

  @always_install      = []
  @ignore_dependencies = false
  @ignore_installed    = false
  @local               = {}
  @local_source        = Gem::Source::Local.new
  @remote_set          = Gem::Resolver::BestSet.new
  @force               = false
  @specs               = {}
end

Instance Attribute Details

#always_install ⇒ Object (readonly)

List of Gem::Specification objects that must always be installed.



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

def always_install
  @always_install
end

#force ⇒ Object

Ignore ruby & rubygems specification constraints.



33
34
35
 
# File 'lib/rubygems/resolver/installer_set.rb', line 33

def force
  @force
end

#ignore_dependencies ⇒ Object

Only install gems in the always_install list



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

def ignore_dependencies
  @ignore_dependencies
end

#ignore_installed ⇒ Object

Do not look in the installed set when finding specifications. This is used by the –install-dir option to ‘gem install`



22
23
24
 
# File 'lib/rubygems/resolver/installer_set.rb', line 22

def ignore_installed
  @ignore_installed
end

#remote_set ⇒ Object (readonly)

The remote_set looks up remote gems for installation.



27
28
29
 
# File 'lib/rubygems/resolver/installer_set.rb', line 27

def remote_set
  @remote_set
end

Instance Method Details

#add_always_install(dependency) ⇒ Object

Looks up the latest specification for dependency and adds it to the always_install list.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/rubygems/resolver/installer_set.rb', line 59

def add_always_install(dependency)
  request = Gem::Resolver::DependencyRequest.new dependency, nil

  found = find_all request

  found.delete_if do |s|
    s.version.prerelease? && !s.local?
  end unless dependency.prerelease?

  found = found.select do |s|
    Gem::Source::SpecificFile === s.source ||
      Gem::Platform.match_spec?(s)
  end

  found = found.sort_by do |s|
    [s.version, Gem::Platform.sort_priority(s.platform)]
  end

  newest = found.last

  unless newest
    exc = Gem::UnsatisfiableDependencyError.new request
    exc.errors = errors

    raise exc
  end

  unless @force
    found_matching_metadata = found.reverse.find do |spec|
      metadata_satisfied?(spec)
    end

    if found_matching_metadata.nil?
      ensure_required_ruby_version_met(newest.spec)
      ensure_required_rubygems_version_met(newest.spec)
    else
      newest = found_matching_metadata
    end
  end

  @always_install << newest.spec
end

#add_local(dep_name, spec, source) ⇒ Object

Adds a local gem requested using dep_name with the given spec that can be loaded and installed using the source.



106
107
108
 
# File 'lib/rubygems/resolver/installer_set.rb', line 106

def add_local(dep_name, spec, source)
  @local[dep_name] = [spec, source]
end

#consider_local? ⇒ Boolean

Should local gems should be considered?

Returns:

  • (Boolean) 


113
114
115
 
# File 'lib/rubygems/resolver/installer_set.rb', line 113

def consider_local? # :nodoc:
  @domain == :both || @domain == :local
end

#consider_remote? ⇒ Boolean

Should remote gems should be considered?

Returns:

  • (Boolean) 


120
121
122
 
# File 'lib/rubygems/resolver/installer_set.rb', line 120

def consider_remote? # :nodoc:
  @domain == :both || @domain == :remote
end

#errors ⇒ Object

Errors encountered while resolving gems



127
128
129
 
# File 'lib/rubygems/resolver/installer_set.rb', line 127

def errors
  @errors + @remote_set.errors
end

#find_all(req) ⇒ Object

Returns an array of IndexSpecification objects matching DependencyRequest req.



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/rubygems/resolver/installer_set.rb', line 135

def find_all(req)
  res = []

  dep = req.dependency

  return res if @ignore_dependencies &&
                @always_install.none? {|spec| dep.match? spec }

  name = dep.name

  dep.matching_specs.each do |gemspec|
    next if @always_install.any? {|spec| spec.name == gemspec.name }

    res << Gem::Resolver::InstalledSpecification.new(self, gemspec)
  end unless @ignore_installed

  matching_local = []

  if consider_local?
    matching_local = @local.values.select do |spec, _|
      req.match? spec
    end.map do |spec, source|
      Gem::Resolver::LocalSpecification.new self, spec, source
    end

    res.concat matching_local

    begin
      if local_spec = @local_source.find_gem(name, dep.requirement)
        res << Gem::Resolver::IndexSpecification.new(
          self, local_spec.name, local_spec.version,
          @local_source, local_spec.platform
        )
      end
    rescue Gem::Package::FormatError
      # ignore
    end
  end

  res.concat @remote_set.find_all req if consider_remote? && matching_local.empty?

  res
end

#inspect ⇒ Object

:nodoc:



189
190
191
192
193
 
# File 'lib/rubygems/resolver/installer_set.rb', line 189

def inspect # :nodoc:
  always_install = @always_install.map(&:full_name)

  format("#<%s domain: %s specs: %p always install: %p>", self.class, @domain, @specs.keys, always_install)
end

#load_spec(name, ver, platform, source) ⇒ Object

Called from IndexSpecification to get a true Specification object.



199
200
201
202
203
204
205
206
207
 
# File 'lib/rubygems/resolver/installer_set.rb', line 199

def load_spec(name, ver, platform, source) # :nodoc:
  key = "#{name}-#{ver}-#{platform}"

  @specs.fetch key do
    tuple = Gem::NameTuple.new name, ver, platform

    @specs[key] = source.fetch_spec tuple
  end
end

#local?(dep_name) ⇒ Boolean

Has a local gem for dep_name been added to this set?

Returns:

  • (Boolean) 


212
213
214
215
216
 
# File 'lib/rubygems/resolver/installer_set.rb', line 212

def local?(dep_name) # :nodoc:
  spec, _ = @local[dep_name]

  spec
end

#prefetch(reqs) ⇒ Object 



179
180
181
 
# File 'lib/rubygems/resolver/installer_set.rb', line 179

def prefetch(reqs)
  @remote_set.prefetch(reqs) if consider_remote?
end

#prerelease=(allow_prerelease) ⇒ Object 



183
184
185
186
187
 
# File 'lib/rubygems/resolver/installer_set.rb', line 183

def prerelease=(allow_prerelease)
  super

  @remote_set.prerelease = allow_prerelease
end

#pretty_print(q) ⇒ Object

:nodoc:



218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/rubygems/resolver/installer_set.rb', line 218

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

    q.breakable
    q.text "specs: "
    q.pp @specs.keys

    q.breakable
    q.text "always install: "
    q.pp @always_install
  end
end

#remote=(remote) ⇒ Object

:nodoc:



233
234
235
236
237
238
239
240
241
242
 
# File 'lib/rubygems/resolver/installer_set.rb', line 233

def remote=(remote) # :nodoc:
  case @domain
  when :local then
    @domain = :both if remote
  when :remote then
    @domain = nil unless remote
  when :both then
    @domain = :local unless remote
  end
end