Class: Bundler::Source::Rubygems

Inherits:
Bundler::Source show all
Defined in:
lib/bundler/source/rubygems.rb,
lib/bundler/source/rubygems/remote.rb

Direct Known Subclasses

Plugin::Installer::Rubygems

Defined Under Namespace

Classes: Remote

Constant Summary collapse

API_REQUEST_SIZE =

Ask for X gems per API request

100
REQUIRE_MUTEX = 
Mutex.new

Instance Attribute Summary collapse

Attributes inherited from Bundler::Source

#checksum_store, #dependency_names

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Bundler::Source

#add_dependency_names, #extension_cache_path, #inspect, #path?, #version_message

Constructor Details

#initialize(options = {}) ⇒ Rubygems

Returns a new instance of Rubygems.



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/bundler/source/rubygems.rb', line 16

def initialize(options = {})
  @options = options
  @remotes = []
  @remote_cooldowns = {}
  @dependency_names = []
  @allow_remote = false
  @allow_cached = false
  @allow_local = options["allow_local"] || false
  @prefer_local = false
  @checksum_store = Checksum::Store.new
  @gem_installers = {}
  @gem_installers_mutex = Mutex.new
  @remote_specs_mutex = Mutex.new

  cooldown = options["cooldown"]
  Array(options["remotes"]).reverse_each {|r| add_remote(r, cooldown: cooldown) }

  @lockfile_remotes = @remotes if options["from_lockfile"]
end

Instance Attribute Details

#remote_cooldowns ⇒ Object

Returns the value of attribute remote_cooldowns.



14
15
16
 
# File 'lib/bundler/source/rubygems.rb', line 14

def remote_cooldowns
  @remote_cooldowns
end

#remotes ⇒ Object

Returns the value of attribute remotes.



14
15
16
 
# File 'lib/bundler/source/rubygems.rb', line 14

def remotes
  @remotes
end

Class Method Details

.from_lock(options) ⇒ Object 



109
110
111
112
 
# File 'lib/bundler/source/rubygems.rb', line 109

def self.from_lock(options)
  options["remotes"] = Array(options.delete("remote")).reverse
  new(options.merge("from_lockfile" => true))
end

Instance Method Details

#add_remote(source, cooldown: nil) ⇒ Object 



258
259
260
261
262
 
# File 'lib/bundler/source/rubygems.rb', line 258

def add_remote(source, cooldown: nil)
  uri = normalize_uri(source)
  @remotes.unshift(uri) unless @remotes.include?(uri)
  @remote_cooldowns[uri] = cooldown if cooldown
end

#cache(spec, custom_path = nil) ⇒ Object 



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

def cache(spec, custom_path = nil)
  cached_path = Bundler.settings[:cache_all_platforms] ? fetch_gem_if_possible(spec) : cached_gem(spec)
  raise GemNotFound, "Missing gem file '#{spec.file_name}'." unless cached_path
  return if File.dirname(cached_path) == Bundler.app_cache.to_s
  Bundler.ui.info "  * #{File.basename(cached_path)}"
  FileUtils.cp(cached_path, Bundler.app_cache(custom_path))
rescue Errno::EACCES => e
  Bundler.ui.debug(e)
  raise InstallError, e.message
end

#cached! ⇒ Object 



69
70
71
72
73
74
75
76
 
# File 'lib/bundler/source/rubygems.rb', line 69

def cached!
  return unless File.exist?(cache_path)

  return if @allow_cached

  @specs = nil
  @allow_cached = true
end

#cached_built_in_gem(spec, local: false) ⇒ Object 



244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/bundler/source/rubygems.rb', line 244

def cached_built_in_gem(spec, local: false)
  cached_path = cached_gem(spec)
  if cached_path.nil? && !local
    remote_spec = remote_spec_for(spec)
    if remote_spec
      cached_path = fetch_gem(remote_spec)
      spec.remote = remote_spec.remote
    else
      Bundler.ui.warn "#{spec.full_name} is built in to Ruby, and can't be cached because your Gemfile doesn't have any sources that contain it."
    end
  end
  cached_path
end

#caches ⇒ Object 



36
37
38
 
# File 'lib/bundler/source/rubygems.rb', line 36

def caches
  @caches ||= [cache_path, *Bundler.rubygems.gem_cache]
end

#can_lock?(spec) ⇒ Boolean

Returns:

  • (Boolean) 


100
101
102
103
 
# File 'lib/bundler/source/rubygems.rb', line 100

def can_lock?(spec)
  return super unless multiple_remotes?
  include?(spec.source)
end

#clear_cache ⇒ Object 



334
335
336
337
338
339
 
# File 'lib/bundler/source/rubygems.rb', line 334

def clear_cache
  @specs = nil
  @installed_specs = nil
  @default_specs = nil
  @cached_specs = nil
end

#cooldown_for(uri) ⇒ Object 



264
265
266
 
# File 'lib/bundler/source/rubygems.rb', line 264

def cooldown_for(uri)
  @remote_cooldowns[uri]
end

#dependency_api_available? ⇒ Boolean

Returns:

  • (Boolean) 


330
331
332
 
# File 'lib/bundler/source/rubygems.rb', line 330

def dependency_api_available?
  @allow_remote && api_fetchers.any?
end

#dependency_names_to_double_check ⇒ Object 



315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/bundler/source/rubygems.rb', line 315

def dependency_names_to_double_check
  names = []
  remote_specs.each do |spec|
    case spec
    when EndpointSpecification, Gem::Specification, StubSpecification, LazySpecification
      names.concat(spec.runtime_dependencies.map(&:name))
    when RemoteSpecification # from the full index
      return nil
    else
      raise "unhandled spec type (#{spec.inspect})"
    end
  end
  names
end

#double_check_for(unmet_dependency_names) ⇒ Object 



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/bundler/source/rubygems.rb', line 295

def double_check_for(unmet_dependency_names)
  return unless dependency_api_available?

  unmet_dependency_names = unmet_dependency_names.call
  unless unmet_dependency_names.nil?
    if api_fetchers.size <= 1
      # can't do this when there are multiple fetchers because then we might not fetch from _all_
      # of them
      unmet_dependency_names -= remote_specs.spec_names # avoid re-fetching things we've already gotten
    end
    return if unmet_dependency_names.empty?
  end

  Bundler.ui.debug "Double checking for #{unmet_dependency_names || "all specs (due to the size of the request)"} in #{self}"

  fetch_names(api_fetchers, unmet_dependency_names, remote_specs)

  specs.use remote_specs
end

#download(spec, options = {}) ⇒ Object 



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/bundler/source/rubygems.rb', line 180

def download(spec, options = {})
  if (spec.default_gem? && !cached_built_in_gem(spec, local: options[:local])) || (installed?(spec) && !options[:force])
    return true
  end

  installer = rubygems_gem_installer(spec, options)

  if spec.remote
    s = begin
      installer.spec
    rescue Gem::Package::FormatError
      Bundler.rm_rf(installer.gem)
      raise
    rescue Gem::Security::Exception => e
      raise SecurityError,
       "The gem #{installer.gem} can't be installed because " \
       "the security policy didn't allow it, with the message: #{e.message}"
    end

    spec.__swap__(s)
  end

  spec
end

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

Returns:

  • (Boolean) 


82
83
84
 
# File 'lib/bundler/source/rubygems.rb', line 82

def eql?(other)
  other.is_a?(Rubygems) && other.credless_remotes == credless_remotes
end

#fetchers ⇒ Object 



291
292
293
 
# File 'lib/bundler/source/rubygems.rb', line 291

def fetchers
  @fetchers ||= remote_fetchers.values.freeze
end

#hash ⇒ Object 



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

def hash
  @remotes.hash
end

#identifier ⇒ Object Also known as: name, to_gemfile 



138
139
140
141
142
143
144
 
# File 'lib/bundler/source/rubygems.rb', line 138

def identifier
  if remotes.empty?
    "locally installed gems"
  else
    "rubygems repository #{remote_names}"
  end
end

#include?(o) ⇒ Boolean

Returns:

  • (Boolean) 


88
89
90
 
# File 'lib/bundler/source/rubygems.rb', line 88

def include?(o)
  o.is_a?(Rubygems) && (o.credless_remotes - credless_remotes).empty?
end

#install(spec, options = {}) ⇒ Object 



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/bundler/source/rubygems.rb', line 205

def install(spec, options = {})
  if (spec.default_gem? && !cached_built_in_gem(spec, local: options[:local])) || (installed?(spec) && !options[:force])
    print_using_message "Using #{version_message(spec, options[:previous_spec])}"
    return nil # no post-install message
  end

  return if Bundler.settings[:no_install]

  installer = rubygems_gem_installer(spec, options)
  spec.source.checksum_store.register(spec, installer.gem_checksum)

  message = "Installing #{version_message(spec, options[:previous_spec])}"
  message += " with native extensions" if spec.extensions.any?
  Bundler.ui.confirm message

  installed_spec = nil

  Gem.time("Installed #{spec.name} in", 0, true) do
    installed_spec = installer.install
  end

  spec.full_gem_path = installed_spec.full_gem_path
  spec.loaded_from = installed_spec.loaded_from
  spec.base_dir = installed_spec.base_dir

  spec.post_install_message
end

#local! ⇒ Object 



55
56
57
58
59
60
 
# File 'lib/bundler/source/rubygems.rb', line 55

def local!
  return if @allow_local

  @specs = nil
  @allow_local = true
end

#local_only! ⇒ Object 



44
45
46
47
48
49
 
# File 'lib/bundler/source/rubygems.rb', line 44

def local_only!
  @specs = nil
  @allow_local = true
  @allow_cached = false
  @allow_remote = false
end

#local_only? ⇒ Boolean

Returns:

  • (Boolean) 


51
52
53
 
# File 'lib/bundler/source/rubygems.rb', line 51

def local_only?
  @allow_local && !@allow_remote
end

#multiple_remotes? ⇒ Boolean

Returns:

  • (Boolean) 


92
93
94
 
# File 'lib/bundler/source/rubygems.rb', line 92

def multiple_remotes?
  @remotes.size > 1
end

#no_remotes? ⇒ Boolean

Returns:

  • (Boolean) 


96
97
98
 
# File 'lib/bundler/source/rubygems.rb', line 96

def no_remotes?
  @remotes.size == 0
end

#options ⇒ Object 



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

def options
  { "remotes" => @remotes.map(&:to_s) }
end

#prefer_local! ⇒ Object 



40
41
42
 
# File 'lib/bundler/source/rubygems.rb', line 40

def prefer_local!
  @prefer_local = true
end

#release_resolution_memory! ⇒ Object 



341
342
343
344
345
 
# File 'lib/bundler/source/rubygems.rb', line 341

def release_resolution_memory!
  @specs = nil
  @remote_specs_mutex.synchronize { @remote_specs = nil }
  @fetchers&.each(&:release_resolution_memory!)
end

#remote! ⇒ Object 



62
63
64
65
66
67
 
# File 'lib/bundler/source/rubygems.rb', line 62

def remote!
  return if @allow_remote

  @specs = nil
  @allow_remote = true
end

#remote_fetchers ⇒ Object 



284
285
286
287
288
289
 
# File 'lib/bundler/source/rubygems.rb', line 284

def remote_fetchers
  @remote_fetchers ||= remotes.to_h do |uri|
    remote = Source::Rubygems::Remote.new(uri, cooldown: cooldown_for(uri))
    [remote, Bundler::Fetcher.new(remote)]
  end.freeze
end

#spec_names ⇒ Object 



268
269
270
271
272
273
274
 
# File 'lib/bundler/source/rubygems.rb', line 268

def spec_names
  if dependency_api_available?
    remote_specs.spec_names
  else
    []
  end
end

#specs ⇒ Object 



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
178
 
# File 'lib/bundler/source/rubygems.rb', line 148

def specs
  @specs ||= begin
    # remote_specs usually generates a way larger Index than the other
    # sources, and large_idx.merge! small_idx is way faster than
    # small_idx.merge! large_idx.
    index = @allow_remote ? remote_specs.dup : Index.new

    # Snapshot per-version `created_at` from the remote info before installed
    # / cached specs overwrite the EndpointSpecification objects that carry
    # it. The cooldown filter consults `created_at` on every candidate, so
    # local stubs need the published date back-filled to participate.
    remote_created_at = collect_remote_created_at(index)

    index.merge!(cached_specs) if @allow_cached
    index.merge!(installed_specs) if @allow_local

    if @allow_local
      if @prefer_local
        index.merge!(default_specs)
      else
        # complete with default specs, only if not already available in the
        # index through remote, cached, or installed specs
        index.use(default_specs)
      end
    end

    backfill_created_at(index, remote_created_at) unless remote_created_at.empty?

    index
  end
end

#to_lock ⇒ Object 



114
115
116
117
118
119
120
 
# File 'lib/bundler/source/rubygems.rb', line 114

def to_lock
  out = String.new("GEM\n")
  lockfile_remotes.reverse_each do |remote|
    out << "  remote: #{remote}\n"
  end
  out << "  specs:\n"
end

#to_s ⇒ Object 



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/bundler/source/rubygems.rb', line 122

def to_s
  if remotes.empty?
    "locally installed gems"
  elsif @allow_remote && @allow_cached && @allow_local
    "rubygems repository #{remote_names}, cached gems or installed locally"
  elsif @allow_remote && @allow_local
    "rubygems repository #{remote_names} or installed locally"
  elsif @allow_remote
    "rubygems repository #{remote_names}"
  elsif @allow_cached && @allow_local
    "cached gems or installed locally"
  else
    "locally installed gems"
  end
end

#unmet_deps ⇒ Object 



276
277
278
279
280
281
282
 
# File 'lib/bundler/source/rubygems.rb', line 276

def unmet_deps
  if dependency_api_available?
    remote_specs.unmet_dependency_names
  else
    []
  end
end