Class: Bundler::RubygemsIntegration

Inherits:
Object
  • Object
show all
Defined in:
lib/bundler/rubygems_integration.rb

Constant Summary collapse

EXT_LOCK = 
Monitor.new

Instance Method Summary collapse

Constructor Details

#initialize ⇒ RubygemsIntegration

Returns a new instance of RubygemsIntegration.



11
12
13
 
# File 'lib/bundler/rubygems_integration.rb', line 11

def initialize
  @replaced_methods = {}
end

Instance Method Details

#add_default_gems_to(specs) ⇒ Object

Add default gems not already present in specs, and return them as a hash.



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/bundler/rubygems_integration.rb', line 334

def add_default_gems_to(specs)
  specs_by_name = specs.reduce({}) do |h, s|
    h[s.name] = s
    h
  end

  Bundler.rubygems.default_stubs.each do |stub|
    default_spec = stub.to_spec
    default_spec_name = default_spec.name
    next if specs_by_name.key?(default_spec_name)

    specs << default_spec
    specs_by_name[default_spec_name] = default_spec
  end

  specs_by_name
end

#all_specs ⇒ Object 



471
472
473
474
475
476
477
 
# File 'lib/bundler/rubygems_integration.rb', line 471

def all_specs
  SharedHelpers.major_deprecation 2, "Bundler.rubygems.all_specs has been removed in favor of Bundler.rubygems.installed_specs"

  Gem::Specification.stubs.map do |stub|
    StubSpecification.from_stub(stub)
  end
end

#bin_path(gem, bin, ver) ⇒ Object 



150
151
152
 
# File 'lib/bundler/rubygems_integration.rb', line 150

def bin_path(gem, bin, ver)
  Gem.bin_path(gem, bin, ver)
end

#build(spec, skip_validation = false) ⇒ Object 



462
463
464
465
 
# File 'lib/bundler/rubygems_integration.rb', line 462

def build(spec, skip_validation = false)
  require "rubygems/package"
  Gem::Package.build(spec, skip_validation)
end

#build_args ⇒ Object 



27
28
29
30
 
# File 'lib/bundler/rubygems_integration.rb', line 27

def build_args
  require "rubygems/command"
  Gem::Command.build_args
end

#build_args=(args) ⇒ Object 



32
33
34
35
 
# File 'lib/bundler/rubygems_integration.rb', line 32

def build_args=(args)
  require "rubygems/command"
  Gem::Command.build_args = args
end

#build_gem(gem_dir, spec) ⇒ Object 



172
173
174
 
# File 'lib/bundler/rubygems_integration.rb', line 172

def build_gem(gem_dir, spec)
  build(spec)
end

#clear_paths ⇒ Object 



146
147
148
 
# File 'lib/bundler/rubygems_integration.rb', line 146

def clear_paths
  Gem.clear_paths
end

#default_specs ⇒ Object 



485
486
487
488
489
 
# File 'lib/bundler/rubygems_integration.rb', line 485

def default_specs
  Gem::Specification.default_stubs.map do |stub|
    StubSpecification.from_stub(stub)
  end
end

#default_stubs ⇒ Object 



499
500
501
 
# File 'lib/bundler/rubygems_integration.rb', line 499

def default_stubs
  Gem::Specification.default_stubs("*.gemspec")
end

#download_gem(spec, uri, cache_dir, fetcher) ⇒ Object 



434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/bundler/rubygems_integration.rb', line 434

def download_gem(spec, uri, cache_dir, fetcher)
  require "rubygems/remote_fetcher"
  uri = Bundler.settings.mirror_for(uri)
  Bundler::Retry.new("download gem from #{uri}").attempts do
    gem_file_name = spec.file_name
    local_gem_path = File.join cache_dir, gem_file_name
    return if File.exist? local_gem_path

    begin
      remote_gem_path = uri + "gems/#{gem_file_name}"

      SharedHelpers.filesystem_access(local_gem_path) do
        fetcher.cache_update_path remote_gem_path, local_gem_path
      end
    rescue Gem::RemoteFetcher::FetchError
      raise if spec.original_platform == spec.platform

      original_gem_file_name = "#{spec.original_name}.gem"
      raise if gem_file_name == original_gem_file_name

      gem_file_name = original_gem_file_name
      retry
    end
  end
rescue Gem::RemoteFetcher::FetchError => e
  raise Bundler::HTTPError, "Could not download gem from #{uri} due to underlying error <#{e.message}>"
end

#ext_lock ⇒ Object 



163
164
165
 
# File 'lib/bundler/rubygems_integration.rb', line 163

def ext_lock
  EXT_LOCK
end

#fetch_all_remote_specs(remote, gem_remote_fetcher) ⇒ Object 



427
428
429
430
431
432
 
# File 'lib/bundler/rubygems_integration.rb', line 427

def fetch_all_remote_specs(remote, gem_remote_fetcher)
  specs = fetch_specs(remote, "specs", gem_remote_fetcher)
  pres = fetch_specs(remote, "prerelease_specs", gem_remote_fetcher) || []

  specs.concat(pres)
end

#fetch_specs(remote, name, fetcher) ⇒ Object 



415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/bundler/rubygems_integration.rb', line 415

def fetch_specs(remote, name, fetcher)
  require "rubygems/remote_fetcher"
  path = remote.uri.to_s + "#{name}.#{Gem.marshal_version}.gz"
  string = fetcher.fetch_path(path)
  specs = Bundler.safe_load_marshal(string)
  raise MarshalError, "Specs #{name} from #{remote} is expected to be an Array but was unexpected class #{specs.class}" unless specs.is_a?(Array)
  specs
rescue Gem::RemoteFetcher::FetchError
  # it's okay for prerelease to fail
  raise unless name == "prerelease_specs"
end

#find_bundler(version) ⇒ Object 



491
492
493
 
# File 'lib/bundler/rubygems_integration.rb', line 491

def find_bundler(version)
  find_name("bundler").find {|s| s.version.to_s == version }
end

#find_name(name) ⇒ Object 



495
496
497
 
# File 'lib/bundler/rubygems_integration.rb', line 495

def find_name(name)
  Gem::Specification.stubs_for(name).map(&:to_spec)
end

#gem_bindir ⇒ Object 



106
107
108
 
# File 'lib/bundler/rubygems_integration.rb', line 106

def gem_bindir
  Gem.bindir
end

#gem_cache ⇒ Object 



130
131
132
 
# File 'lib/bundler/rubygems_integration.rb', line 130

def gem_cache
  gem_path.map {|p| File.expand_path("cache", p) }
end

#gem_dir ⇒ Object 



102
103
104
 
# File 'lib/bundler/rubygems_integration.rb', line 102

def gem_dir
  Gem.dir
end

#gem_path ⇒ Object 



114
115
116
 
# File 'lib/bundler/rubygems_integration.rb', line 114

def gem_path
  Gem.path
end

#inflate(obj) ⇒ Object 



98
99
100
 
# File 'lib/bundler/rubygems_integration.rb', line 98

def inflate(obj)
  Gem::Util.inflate(obj)
end

#installed_specs ⇒ Object 



479
480
481
482
483
 
# File 'lib/bundler/rubygems_integration.rb', line 479

def installed_specs
  Gem::Specification.stubs.reject(&:default_gem?).map do |stub|
    StubSpecification.from_stub(stub)
  end
end

#loaded_gem_paths ⇒ Object 



154
155
156
157
 
# File 'lib/bundler/rubygems_integration.rb', line 154

def loaded_gem_paths
  loaded_gem_paths = Gem.loaded_specs.map {|_, s| s.full_require_paths }
  loaded_gem_paths.flatten
end

#loaded_specs(name) ⇒ Object 



37
38
39
 
# File 'lib/bundler/rubygems_integration.rb', line 37

def loaded_specs(name)
  Gem.loaded_specs[name]
end

#mark_loaded(spec) ⇒ Object 



41
42
43
44
45
46
47
48
 
# File 'lib/bundler/rubygems_integration.rb', line 41

def mark_loaded(spec)
  if spec.respond_to?(:activated=)
    current = Gem.loaded_specs[spec.name]
    current.activated = false if current
    spec.activated = true
  end
  Gem.loaded_specs[spec.name] = spec
end

#marshal_spec_dir ⇒ Object 



142
143
144
 
# File 'lib/bundler/rubygems_integration.rb', line 142

def marshal_spec_dir
  Gem::MARSHAL_SPEC_DIR
end

#method_visibility(klass, method) ⇒ Object 



385
386
387
388
389
390
391
392
393
 
# File 'lib/bundler/rubygems_integration.rb', line 385

def method_visibility(klass, method)
  if klass.private_method_defined?(method)
    :private
  elsif klass.protected_method_defined?(method)
    :protected
  else
    :public
  end
end

#path(obj) ⇒ Object 



86
87
88
 
# File 'lib/bundler/rubygems_integration.rb', line 86

def path(obj)
  obj.to_s
end

#path_separator ⇒ Object 



467
468
469
 
# File 'lib/bundler/rubygems_integration.rb', line 467

def path_separator
  Gem.path_separator
end

#plain_specs ⇒ Object 



407
408
409
 
# File 'lib/bundler/rubygems_integration.rb', line 407

def plain_specs
  Gem::Specification._all
end

#plain_specs=(specs) ⇒ Object 



411
412
413
 
# File 'lib/bundler/rubygems_integration.rb', line 411

def plain_specs=(specs)
  Gem::Specification.all = specs
end

#post_reset_hooks ⇒ Object 



122
123
124
 
# File 'lib/bundler/rubygems_integration.rb', line 122

def post_reset_hooks
  Gem.post_reset_hooks
end

#provides?(req_str) ⇒ Boolean

Returns:

  • (Boolean) 


19
20
21
 
# File 'lib/bundler/rubygems_integration.rb', line 19

def provides?(req_str)
  Gem::Requirement.new(req_str).satisfied_by?(version)
end

#read_binary(path) ⇒ Object 



94
95
96
 
# File 'lib/bundler/rubygems_integration.rb', line 94

def read_binary(path)
  Gem.read_binary(path)
end

#redefine_method(klass, method, unbound_method = nil, &block) ⇒ Object 



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/bundler/rubygems_integration.rb', line 364

def redefine_method(klass, method, unbound_method = nil, &block)
  visibility = method_visibility(klass, method)
  begin
    if (instance_method = klass.instance_method(method)) && method != :initialize
      # doing this to ensure we also get private methods
      klass.send(:remove_method, method)
    end
  rescue NameError
    # method isn't defined
    nil
  end
  @replaced_methods[[method, klass]] = instance_method
  if unbound_method
    klass.send(:define_method, method, unbound_method)
    klass.send(visibility, method)
  elsif block
    klass.send(:define_method, method, &block)
    klass.send(visibility, method)
  end
end

#replace_bin_path(specs_by_name) ⇒ Object

Used to make bin stubs that are not created by bundler work under bundler. The new Gem.bin_path only considers gems in specs



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/bundler/rubygems_integration.rb', line 248

def replace_bin_path(specs_by_name)
  gem_class = (class << Gem; self; end)

  redefine_method(gem_class, :find_spec_for_exe) do |gem_name, *args|
    exec_name = args.first
    raise ArgumentError, "you must supply exec_name" unless exec_name

    spec_with_name = specs_by_name[gem_name]
    matching_specs_by_exec_name = specs_by_name.values.select {|s| s.executables.include?(exec_name) }
    spec = matching_specs_by_exec_name.delete(spec_with_name)

    unless spec || !matching_specs_by_exec_name.empty?
      message = "can't find executable #{exec_name} for gem #{gem_name}"
      if spec_with_name.nil?
        message += ". #{gem_name} is not currently included in the bundle, " \
                   "perhaps you meant to add it to your #{Bundler.default_gemfile.basename}?"
      end
      raise Gem::Exception, message
    end

    unless spec
      spec = matching_specs_by_exec_name.shift
      warn \
        "Bundler is using a binstub that was created for a different gem (#{spec.name}).\n" \
        "You should run `bundle binstub #{gem_name}` " \
        "to work around a system/bundle conflict."
    end

    unless matching_specs_by_exec_name.empty?
      conflicting_names = matching_specs_by_exec_name.map(&:name).join(", ")
      warn \
        "The `#{exec_name}` executable in the `#{spec.name}` gem is being loaded, but it's also present in other gems (#{conflicting_names}).\n" \
        "If you meant to run the executable for another gem, make sure you use a project specific binstub (`bundle binstub <gem_name>`).\n" \
        "If you plan to use multiple conflicting executables, generate binstubs for them and disambiguate their names."
    end

    spec
  end

  redefine_method(gem_class, :activate_bin_path) do |name, *args|
    exec_name = args.first
    return ENV["BUNDLE_BIN_PATH"] if exec_name == "bundle"

    # Copy of Rubygems activate_bin_path impl
    requirement = args.last
    spec = find_spec_for_exe name, exec_name, [requirement]

    gem_bin = File.join(spec.full_gem_path, spec.bindir, exec_name)
    gem_from_path_bin = File.join(File.dirname(spec.loaded_from), spec.bindir, exec_name)
    File.exist?(gem_bin) ? gem_bin : gem_from_path_bin
  end

  redefine_method(gem_class, :bin_path) do |name, *args|
    exec_name = args.first
    return ENV["BUNDLE_BIN_PATH"] if exec_name == "bundle"

    spec = find_spec_for_exe(name, *args)
    exec_name ||= spec.default_executable

    gem_bin = File.join(spec.full_gem_path, spec.bindir, exec_name)
    gem_from_path_bin = File.join(File.dirname(spec.loaded_from), spec.bindir, exec_name)
    File.exist?(gem_bin) ? gem_bin : gem_from_path_bin
  end
end

#replace_entrypoints(specs) ⇒ Object

Replace or hook into RubyGems to provide a bundlerized view of the world.



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

def replace_entrypoints(specs)
  specs_by_name = add_default_gems_to(specs)

  reverse_rubygems_kernel_mixin
  begin
    # bundled_gems only provide with Ruby 3.3 or later
    require "bundled_gems"
  rescue LoadError
  else
    Gem::BUNDLED_GEMS.replace_require(specs) if Gem::BUNDLED_GEMS.respond_to?(:replace_require)
  end
  replace_gem(specs, specs_by_name)
  stub_rubygems(specs)
  replace_bin_path(specs_by_name)

  Gem.clear_paths
end

#replace_gem(specs, specs_by_name) ⇒ Object 



202
203
204
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
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/bundler/rubygems_integration.rb', line 202

def replace_gem(specs, specs_by_name)
  executables = nil

  [::Kernel.singleton_class, ::Kernel].each do |kernel_class|
    redefine_method(kernel_class, :gem) do |dep, *reqs|
      if executables&.include?(File.basename(caller_locations(1, 1).first.path))
        break
      end

      reqs.pop if reqs.last.is_a?(Hash)

      unless dep.respond_to?(:name) && dep.respond_to?(:requirement)
        dep = Gem::Dependency.new(dep, reqs)
      end

      if spec = specs_by_name[dep.name]
        return true if dep.matches_spec?(spec)
      end

      message = if spec.nil?
        target_file = begin
                        Bundler.default_gemfile.basename
                      rescue GemfileNotFound
                        "inline Gemfile"
                      end
        "#{dep.name} is not part of the bundle." \
        " Add it to your #{target_file}."
      else
        "can't activate #{dep}, already activated #{spec.full_name}. " \
        "Make sure all dependencies are added to Gemfile."
      end

      e = Gem::LoadError.new(message)
      e.name = dep.name
      e.requirement = dep.requirement
      raise e
    end

    # backwards compatibility shim, see https://github.com/rubygems/bundler/issues/5102
    kernel_class.send(:public, :gem) if Bundler.feature_flag.setup_makes_kernel_gem_public?
  end
end

#reset ⇒ Object 



118
119
120
 
# File 'lib/bundler/rubygems_integration.rb', line 118

def reset
  Gem::Specification.reset
end

#reverse_rubygems_kernel_mixin ⇒ Object 



189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/bundler/rubygems_integration.rb', line 189

def reverse_rubygems_kernel_mixin
  # Disable rubygems' gem activation system
  if Gem.respond_to?(:discover_gems_on_require=)
    Gem.discover_gems_on_require = false
  else
    [::Kernel.singleton_class, ::Kernel].each do |k|
      if k.private_method_defined?(:gem_original_require)
        redefine_method(k, :require, k.instance_method(:gem_original_require))
      end
    end
  end
end

#ruby_engine ⇒ Object 



90
91
92
 
# File 'lib/bundler/rubygems_integration.rb', line 90

def ruby_engine
  Gem.ruby_engine
end

#security_policies ⇒ Object 



180
181
182
183
184
185
186
187
 
# File 'lib/bundler/rubygems_integration.rb', line 180

def security_policies
  @security_policies ||= begin
    require "rubygems/security"
    Gem::Security::Policies
  rescue LoadError, NameError
    {}
  end
end

#security_policy_keys ⇒ Object 



176
177
178
 
# File 'lib/bundler/rubygems_integration.rb', line 176

def security_policy_keys
  %w[High Medium Low AlmostNo No].map {|level| "#{level}Security" }
end

#set_installed_by_version(spec, installed_by_version = Gem::VERSION) ⇒ Object 



60
61
62
63
 
# File 'lib/bundler/rubygems_integration.rb', line 60

def set_installed_by_version(spec, installed_by_version = Gem::VERSION)
  return unless spec.respond_to?(:installed_by_version=)
  spec.installed_by_version = Gem::Version.create(installed_by_version)
end

#spec_cache_dirs ⇒ Object 



134
135
136
137
138
139
140
 
# File 'lib/bundler/rubygems_integration.rb', line 134

def spec_cache_dirs
  @spec_cache_dirs ||= begin
    dirs = gem_path.map {|dir| File.join(dir, "specifications") }
    dirs << Gem.spec_cache_dir
    dirs.uniq.select {|dir| File.directory? dir }
  end
end

#spec_from_gem(path) ⇒ Object 



167
168
169
170
 
# File 'lib/bundler/rubygems_integration.rb', line 167

def spec_from_gem(path)
  require "rubygems/package"
  Gem::Package.new(path).spec
end

#spec_matches_for_glob(spec, glob) ⇒ Object 



74
75
76
77
78
79
80
 
# File 'lib/bundler/rubygems_integration.rb', line 74

def spec_matches_for_glob(spec, glob)
  return spec.matches_for_glob(glob) if spec.respond_to?(:matches_for_glob)

  spec.load_paths.flat_map do |lp|
    Dir["#{lp}/#{glob}#{suffix_pattern}"]
  end
end

#spec_missing_extensions?(spec, default = true) ⇒ Boolean

Returns:

  • (Boolean) 


65
66
67
68
69
70
71
72
 
# File 'lib/bundler/rubygems_integration.rb', line 65

def spec_missing_extensions?(spec, default = true)
  return spec.missing_extensions? if spec.respond_to?(:missing_extensions?)

  return false if spec.default_gem?
  return false if spec.extensions.empty?

  default
end

#stub_rubygems(specs) ⇒ Object 



395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/bundler/rubygems_integration.rb', line 395

def stub_rubygems(specs)
  Gem::Specification.all = specs

  Gem.post_reset do
    Gem::Specification.all = specs
  end

  redefine_method((class << Gem; self; end), :finish_resolve) do |*|
    []
  end
end

#stub_set_spec(stub, spec) ⇒ Object 



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

def stub_set_spec(stub, spec)
  stub.instance_variable_set(:@spec, spec)
end

#suffix_pattern ⇒ Object 



126
127
128
 
# File 'lib/bundler/rubygems_integration.rb', line 126

def suffix_pattern
  Gem.suffix_pattern
end

#supports_bundler_trampolining? ⇒ Boolean

Returns:

  • (Boolean) 


23
24
25
 
# File 'lib/bundler/rubygems_integration.rb', line 23

def supports_bundler_trampolining?
  provides?(">= 3.3.0.a")
end

#ui=(obj) ⇒ Object 



159
160
161
 
# File 'lib/bundler/rubygems_integration.rb', line 159

def ui=(obj)
  Gem::DefaultUserInteraction.ui = obj
end

#undo_replacements ⇒ Object 



352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/bundler/rubygems_integration.rb', line 352

def undo_replacements
  @replaced_methods.each do |(sym, klass), method|
    redefine_method(klass, sym, method)
  end
  if Binding.public_method_defined?(:source_location)
    post_reset_hooks.reject! {|proc| proc.binding.source_location[0] == __FILE__ }
  else
    post_reset_hooks.reject! {|proc| proc.binding.eval("__FILE__") == __FILE__ }
  end
  @replaced_methods.clear
end

#user_home ⇒ Object 



110
111
112
 
# File 'lib/bundler/rubygems_integration.rb', line 110

def user_home
  Gem.user_home
end

#validate(spec) ⇒ Object 



50
51
52
53
54
55
56
57
58
 
# File 'lib/bundler/rubygems_integration.rb', line 50

def validate(spec)
  Bundler.ui.silence { spec.validate_for_resolution }
rescue Gem::InvalidSpecificationException => e
  error_message = "The gemspec at #{spec.loaded_from} is not valid. Please fix this gemspec.\n" \
    "The validation error was '#{e.message}'\n"
  raise Gem::InvalidSpecificationException.new(error_message)
rescue Errno::ENOENT
  nil
end

#version ⇒ Object 



15
16
17
 
# File 'lib/bundler/rubygems_integration.rb', line 15

def version
  @version ||= Gem.rubygems_version
end