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.


32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# File 'lib/rubygems/resolver/installer_set.rb', line 32

def initialize(domain)
  super()

  @domain = domain
  @remote = consider_remote?

  @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
  @specs               = {}
end

Instance Attribute Details

#always_installObject (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

#ignore_dependenciesObject

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_installedObject

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_setObject (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.


53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
# File 'lib/rubygems/resolver/installer_set.rb', line 53

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

  found = find_all request

  found.delete_if do |s|
    s.version.prerelease? and not s.local?
  end unless dependency.prerelease?

  found = found.select do |s|
    Gem::Source::SpecificFile === s.source or
      Gem::Platform::RUBY == s.platform or
      Gem::Platform.local === s.platform
  end

  if found.empty?
    exc = Gem::UnsatisfiableDependencyError.new request
    exc.errors = errors

    raise exc
  end

  newest = found.max_by do |s|
    [s.version, s.platform == Gem::Platform::RUBY ? -1 : 1]
  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.


86
87
88
# File 'lib/rubygems/resolver/installer_set.rb', line 86

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

#consider_local?Boolean

Should local gems should be considered?

Returns:

  • (Boolean)

93
94
95
# File 'lib/rubygems/resolver/installer_set.rb', line 93

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

#consider_remote?Boolean

Should remote gems should be considered?

Returns:

  • (Boolean)

100
101
102
# File 'lib/rubygems/resolver/installer_set.rb', line 100

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

#errorsObject

Errors encountered while resolving gems


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

def errors
  @errors + @remote_set.errors
end

#find_all(req) ⇒ Object

Returns an array of IndexSpecification objects matching DependencyRequest req.


115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
# File 'lib/rubygems/resolver/installer_set.rb', line 115

def find_all(req)
  res = []

  dep = req.dependency

  return res if @ignore_dependencies and
            @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

  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.delete_if do |spec|
    spec.version.prerelease? and not dep.prerelease?
  end

  res.concat @remote_set.find_all req if consider_remote?

  res
end

#inspectObject

:nodoc:


170
171
172
173
174
175
176
# File 'lib/rubygems/resolver/installer_set.rb', line 170

def inspect # :nodoc:
  always_install = @always_install.map { |s| s.full_name }

  '#<%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.


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

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)

195
196
197
198
199
# File 'lib/rubygems/resolver/installer_set.rb', line 195

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

  spec
end

#prefetch(reqs) ⇒ Object


160
161
162
# File 'lib/rubygems/resolver/installer_set.rb', line 160

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

#prerelease=(allow_prerelease) ⇒ Object


164
165
166
167
168
# File 'lib/rubygems/resolver/installer_set.rb', line 164

def prerelease=(allow_prerelease)
  super

  @remote_set.prerelease = allow_prerelease
end

#pretty_print(q) ⇒ Object

:nodoc:


201
202
203
204
205
206
207
208
209
210
211
212
213
214
# File 'lib/rubygems/resolver/installer_set.rb', line 201

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:


216
217
218
219
220
221
222
223
224
225
# File 'lib/rubygems/resolver/installer_set.rb', line 216

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