123456789_123456789_123456789_123456789_123456789_

Class: Bundler::RubygemsIntegration

Relationships & Source Files
Inherits: Object
Defined in: lib/bundler/rubygems_integration.rb

Constant Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.newRubygemsIntegration

[ GitHub ]

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

def initialize
  @replaced_methods = {}
  backport_ext_builder_monitor
end

Instance Attribute Details

#build_args (rw)

[ GitHub ]

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

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

#build_args=(args) (rw)

[ GitHub ]

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

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

#plain_specs (rw)

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 442

def plain_specs
  Gem::Specification._all
end

#plain_specs=(specs) (rw)

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 446

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

#supports_bundler_trampolining?Boolean (readonly)

[ GitHub ]

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

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

#ui=(obj) (writeonly)

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 198

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

Instance Method Details

#add_default_gems_to(specs)

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

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 369

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

#add_to_load_path(paths)

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 46

def add_to_load_path(paths)
  return Gem.add_to_load_path(*paths) if Gem.respond_to?(:add_to_load_path)

  if insert_index = Gem.load_path_insert_index
    # Gem directories must come after -I and ENV['RUBYLIB']
    $LOAD_PATH.insert(insert_index, *paths)
  else
    # We are probably testing in core, -I and RUBYLIB don't apply
    $LOAD_PATH.unshift(*paths)
  end
end

#all_specs

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 515

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

#backport_ext_builder_monitor

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 521

def backport_ext_builder_monitor
  # So we can avoid requiring "rubygems/ext" in its entirety
  Gem.module_eval <<-RUBY, __FILE__, __LINE__ + 1
    module Ext
    end
  RUBY

  require "rubygems/ext/builder"

  Gem::Ext::Builder.class_eval do
    unless const_defined?(:CHDIR_MONITOR)
      const_set(:CHDIR_MONITOR, EXT_LOCK)
    end

    remove_const(:CHDIR_MUTEX) if const_defined?(:CHDIR_MUTEX)
    const_set(:CHDIR_MUTEX, const_get(:CHDIR_MONITOR))
  end
end

#bin_path(gem, bin, ver)

[ GitHub ]

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

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

#build(spec, skip_validation = false)

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 506

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

#build_gem(gem_dir, spec)

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 211

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

#clear_paths

[ GitHub ]

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

def clear_paths
  Gem.clear_paths
end

#correct_for_windows_path(path)

[ GitHub ]

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

def correct_for_windows_path(path)
  if Gem::Util.respond_to?(:correct_for_windows_path)
    Gem::Util.correct_for_windows_path(path)
  elsif path[0].chr == "/" && path[1].chr =~ /[a-z]/i && path[2].chr == ":"
    path[1..-1]
  else
    path
  end
end

#default_stubs

See additional method definition at line 549.

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 553

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

#download_gem(spec, uri, cache_dir)

[ GitHub ]

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

def download_gem(spec, uri, cache_dir)
  require "rubygems/remote_fetcher"
  uri = Bundler.settings.mirror_for(uri)
  fetcher = gem_remote_fetcher
  fetcher.headers = { "X-Gemfile-Source" => spec.remote.original_uri.to_s } if spec.remote.original_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}"
      remote_gem_path = remote_gem_path.to_s if provides?("< 3.2.0.rc.1")

      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

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 202

def ext_lock
  EXT_LOCK
end

#fetch_all_remote_specs(remote)

[ GitHub ]

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

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

  specs.concat(pres)
end

#fetch_specs(remote, name)

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 450

def fetch_specs(remote, name)
  require "rubygems/remote_fetcher"
  path = remote.uri.to_s + "#{name}.#{Gem.marshal_version}.gz"
  fetcher = gem_remote_fetcher
  fetcher.headers = { "X-Gemfile-Source" => remote.original_uri.to_s } if remote.original_uri
  string = fetcher.fetch_path(path)
  Bundler.safe_load_marshal(string)
rescue Gem::RemoteFetcher::FetchError
  # it's okay for prerelease to fail
  raise unless name == "prerelease_specs"
end

#find_bundler(version)

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 540

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

#find_name(name)

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 544

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

#gem_bindir

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 133

def gem_bindir
  Gem.bindir
end

#gem_cache

[ GitHub ]

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

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

#gem_dir

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 129

def gem_dir
  Gem.dir
end

#gem_path

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 141

def gem_path
  Gem.path
end

#gem_remote_fetcher

[ GitHub ]

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

def gem_remote_fetcher
  require "rubygems/remote_fetcher"
  proxy = Gem.configuration[:http_proxy]
  Gem::RemoteFetcher.new(proxy)
end

#inflate(obj)

[ GitHub ]

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

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

#load_env_plugins

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 194

def load_env_plugins
  Gem.load_env_plugins if Gem.respond_to?(:load_env_plugins)
end

#load_plugin_files(files)

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 190

def load_plugin_files(files)
  Gem.load_plugin_files(files) if Gem.respond_to?(:load_plugin_files)
end

#load_plugins

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 186

def load_plugins
  Gem.load_plugins if Gem.respond_to?(:load_plugins)
end

#loaded_gem_paths

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 181

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

#loaded_specs(name)

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 42

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

#mark_loaded(spec)

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 58

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

[ GitHub ]

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

def marshal_spec_dir
  Gem::MARSHAL_SPEC_DIR
end

#method_visibility(klass, method)

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 420

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)

[ GitHub ]

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

def path(obj)
  obj.to_s
end

#path_separator

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 511

def path_separator
  Gem.path_separator
end

#post_reset_hooks

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 149

def post_reset_hooks
  Gem.post_reset_hooks
end

#provides?(req_str) ⇒ Boolean

[ GitHub ]

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

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

#read_binary(path)

[ GitHub ]

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

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

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

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 399

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)

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

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 291

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)

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

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 358

def replace_entrypoints(specs)
  specs_by_name = add_default_gems_to(specs)

  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)

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 242

def replace_gem(specs, specs_by_name)
  reverse_rubygems_kernel_mixin

  executables = nil

  kernel = (class << ::Kernel; self; end)
  [kernel, ::Kernel].each do |kernel_class|
    redefine_method(kernel_class, :gem) do |dep, *reqs|
      if executables&.include?(File.basename(caller.first.split(":").first))
        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

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 145

def reset
  Gem::Specification.reset
end

#reverse_rubygems_kernel_mixin

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 228

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 = (class << ::Kernel; self; end)
    [kernel, ::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

[ GitHub ]

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

def ruby_engine
  Gem.ruby_engine
end

#security_policies

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 219

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

#security_policy_keys

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 215

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)

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 77

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

[ GitHub ]

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

def spec_cache_dirs
  @spec_cache_dirs ||= begin
    dirs = gem_path.map {|dir| File.join(dir, "specifications") }
    dirs << Gem.spec_cache_dir if Gem.respond_to?(:spec_cache_dir) # Not in RubyGems 2.0.3 or earlier
    dirs.uniq.select {|dir| File.directory? dir }
  end
end

#spec_from_gem(path)

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 206

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

#spec_matches_for_glob(spec, glob)

[ GitHub ]

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

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

  spec.load_paths.map do |lp|
    Dir["#{lp}/#{glob}#{suffix_pattern}"]
  end.flatten(1)
end

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

[ GitHub ]

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

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)

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 430

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)

[ GitHub ]

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

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

#suffix_pattern

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 153

def suffix_pattern
  Gem.suffix_pattern
end

#undo_replacements

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 387

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

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 137

def user_home
  Gem.user_home
end

#validate(spec)

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 67

def validate(spec)
  Bundler.ui.silence { spec.validate(false) }
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

[ GitHub ]

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

def version
  @version ||= Gem.rubygems_version
end