class Bundler::RubygemsIntegration

Constants

EXT_LOCK

Public Class Methods

new() click to toggle source
# File lib/bundler/rubygems_integration.rb, line 21
def initialize
  @replaced_methods = {}
end
provides?(req_str) click to toggle source
# File lib/bundler/rubygems_integration.rb, line 17
def self.provides?(req_str)
  Gem::Requirement.new(req_str).satisfied_by?(version)
end
version() click to toggle source
# File lib/bundler/rubygems_integration.rb, line 13
def self.version
  @version ||= Gem::Version.new(Gem::VERSION)
end

Public Instance Methods

backport_base_dir() click to toggle source

This backports base_dir which replaces installation path RubyGems 1.8+

# File lib/bundler/rubygems_integration.rb, line 555
def backport_base_dir
  redefine_method(Gem::Specification, :base_dir) do
    return Gem.dir unless loaded_from
    File.dirname File.dirname loaded_from
  end
end
backport_cache_file() click to toggle source
# File lib/bundler/rubygems_integration.rb, line 562
def backport_cache_file
  redefine_method(Gem::Specification, :cache_dir) do
    @cache_dir ||= File.join base_dir, "cache"
  end

  redefine_method(Gem::Specification, :cache_file) do
    @cache_file ||= File.join cache_dir, "#{full_name}.gem"
  end
end
backport_segment_generation() click to toggle source

This backports the correct segment generation code from RubyGems 1.4+ by monkeypatching it into the method in RubyGems 1.3.6 and 1.3.7.

# File lib/bundler/rubygems_integration.rb, line 536
def backport_segment_generation
  redefine_method(Gem::Version, :segments) do
    @segments ||= @version.scan(/[0-9]+|[a-z]+/i).map do |s|
      /^\d+$/ =~ s ? s.to_i : s
    end
  end
end
backport_spec_file() click to toggle source
# File lib/bundler/rubygems_integration.rb, line 572
def backport_spec_file
  redefine_method(Gem::Specification, :spec_dir) do
    @spec_dir ||= File.join base_dir, "specifications"
  end

  redefine_method(Gem::Specification, :spec_file) do
    @spec_file ||= File.join spec_dir, "#{full_name}.gemspec"
  end
end
backport_yaml_initialize() click to toggle source

This backport fixes the marshaling of @segments.

# File lib/bundler/rubygems_integration.rb, line 545
def backport_yaml_initialize
  redefine_method(Gem::Version, :yaml_initialize) do |_, map|
    @version = map["version"]
    @segments = nil
    @hash = nil
  end
end
bin_path(gem, bin, ver) click to toggle source
# File lib/bundler/rubygems_integration.rb, line 209
def bin_path(gem, bin, ver)
  Gem.bin_path(gem, bin, ver)
end
binstubs_call_gem?() click to toggle source
# File lib/bundler/rubygems_integration.rb, line 360
def binstubs_call_gem?
  true
end
build(spec, skip_validation = false) click to toggle source
# File lib/bundler/rubygems_integration.rb, line 320
def build(spec, skip_validation = false)
  require "rubygems/builder"
  Gem::Builder.new(spec).build
end
build_args() click to toggle source
# File lib/bundler/rubygems_integration.rb, line 33
def build_args
  Gem::Command.build_args
end
build_args=(args) click to toggle source
# File lib/bundler/rubygems_integration.rb, line 37
def build_args=(args)
  Gem::Command.build_args = args
end
build_gem(gem_dir, spec) click to toggle source
# File lib/bundler/rubygems_integration.rb, line 325
def build_gem(gem_dir, spec)
  build(spec)
end
clear_paths() click to toggle source
# File lib/bundler/rubygems_integration.rb, line 205
def clear_paths
  Gem.clear_paths
end
config_map() click to toggle source
# File lib/bundler/rubygems_integration.rb, line 197
def config_map
  Gem::ConfigMap
end
configuration() click to toggle source
# File lib/bundler/rubygems_integration.rb, line 112
def configuration
  require "bundler/psyched_yaml"
  Gem.configuration
rescue Gem::SystemExitException, LoadError => e
  Bundler.ui.error "#{e.class}: #{e.message}"
  Bundler.ui.trace e
  raise
rescue YamlLibrarySyntaxError => e
  raise YamlSyntaxError.new(e, "Your RubyGems configuration, which is " \
    "usually located in ~/.gemrc, contains invalid YAML syntax.")
end
download_gem(spec, uri, path) click to toggle source
# File lib/bundler/rubygems_integration.rb, line 329
def download_gem(spec, uri, path)
  uri = Bundler.settings.mirror_for(uri)
  fetcher = Gem::RemoteFetcher.new(configuration[:http_proxy])
  Bundler::Retry.new("download gem from #{uri}").attempts do
    fetcher.download(spec, uri, path)
  end
end
ext_lock() click to toggle source
# File lib/bundler/rubygems_integration.rb, line 247
def ext_lock
  EXT_LOCK
end
fetch_all_remote_specs(remote) click to toggle source

TODO: This is for older versions of RubyGems… should we support the X-Gemfile-Source header on these old versions? Maybe the newer implementation will work on older RubyGems? It seems difficult to keep this implementation and still send the header.

# File lib/bundler/rubygems_integration.rb, line 268
def fetch_all_remote_specs(remote)
  old_sources = Bundler.rubygems.sources
  Bundler.rubygems.sources = [remote.uri.to_s]
  # Fetch all specs, minus prerelease specs
  spec_list = fetch_specs(true, false)
  # Then fetch the prerelease specs
  fetch_prerelease_specs.each {|k, v| spec_list[k].concat(v) }

  spec_list.values.first
ensure
  Bundler.rubygems.sources = old_sources
end
fetch_prerelease_specs() click to toggle source
# File lib/bundler/rubygems_integration.rb, line 258
def fetch_prerelease_specs
  fetch_specs(false, true)
rescue Gem::RemoteFetcher::FetchError
  {} # if we can't download them, there aren't any
end
fetch_specs(all, pre) { || ... } click to toggle source
# File lib/bundler/rubygems_integration.rb, line 251
def fetch_specs(all, pre, &blk)
  require "rubygems/spec_fetcher"
  specs = Gem::SpecFetcher.new.list(all, pre)
  specs.each { yield } if block_given?
  specs
end
gem_bindir() click to toggle source
# File lib/bundler/rubygems_integration.rb, line 157
def gem_bindir
  Gem.bindir
end
gem_cache() click to toggle source
# File lib/bundler/rubygems_integration.rb, line 181
def gem_cache
  gem_path.map {|p| File.expand_path("cache", p) }
end
gem_dir() click to toggle source
# File lib/bundler/rubygems_integration.rb, line 153
def gem_dir
  Gem.dir
end
gem_from_path(path, policy = nil) click to toggle source
# File lib/bundler/rubygems_integration.rb, line 297
def gem_from_path(path, policy = nil)
  require "rubygems/format"
  Gem::Format.from_file_by_path(path, policy)
end
gem_path() click to toggle source
# File lib/bundler/rubygems_integration.rb, line 165
def gem_path
  Gem.path
end
inflate(obj) click to toggle source
# File lib/bundler/rubygems_integration.rb, line 132
def inflate(obj)
  if defined?(Gem::Util)
    Gem::Util.inflate(obj)
  else
    Gem.inflate(obj)
  end
end
install_with_build_args(args) { || ... } click to toggle source
# File lib/bundler/rubygems_integration.rb, line 293
def install_with_build_args(args)
  with_build_args(args) { yield }
end
load_path_insert_index() click to toggle source
# File lib/bundler/rubygems_integration.rb, line 41
def load_path_insert_index
  Gem.load_path_insert_index
end
load_plugin_files(files) click to toggle source
# File lib/bundler/rubygems_integration.rb, line 239
def load_plugin_files(files)
  Gem.load_plugin_files(files) if Gem.respond_to?(:load_plugin_files)
end
load_plugins() click to toggle source
# File lib/bundler/rubygems_integration.rb, line 235
def load_plugins
  Gem.load_plugins if Gem.respond_to?(:load_plugins)
end
loaded_gem_paths() click to toggle source
# File lib/bundler/rubygems_integration.rb, line 222
def loaded_gem_paths
  # RubyGems 2.2+ can put binary extension into dedicated folders,
  # therefore use RubyGems facilities to obtain their load paths.
  if Gem::Specification.method_defined? :full_require_paths
    loaded_gem_paths = Gem.loaded_specs.map {|_, s| s.full_require_paths }
    loaded_gem_paths.flatten
  else
    $LOAD_PATH.select do |p|
      Bundler.rubygems.gem_path.any? {|gp| p =~ /^#{Regexp.escape(gp)}/ }
    end
  end
end
loaded_specs(name) click to toggle source
# File lib/bundler/rubygems_integration.rb, line 45
def loaded_specs(name)
  Gem.loaded_specs[name]
end
mark_loaded(spec) click to toggle source
# File lib/bundler/rubygems_integration.rb, line 49
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() click to toggle source
# File lib/bundler/rubygems_integration.rb, line 193
def marshal_spec_dir
  Gem::MARSHAL_SPEC_DIR
end
method_visibility(klass, method) click to toggle source
# File lib/bundler/rubygems_integration.rb, line 615
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) click to toggle source
# File lib/bundler/rubygems_integration.rb, line 103
def path(obj)
  obj.to_s
end
path_separator() click to toggle source
# File lib/bundler/rubygems_integration.rb, line 213
def path_separator
  File::PATH_SEPARATOR
end
platforms() click to toggle source
# File lib/bundler/rubygems_integration.rb, line 107
def platforms
  return [Gem::Platform::RUBY] if Bundler.settings[:force_ruby_platform]
  Gem.platforms
end
post_reset_hooks() click to toggle source
# File lib/bundler/rubygems_integration.rb, line 173
def post_reset_hooks
  Gem.post_reset_hooks
end
preserve_paths() { || ... } click to toggle source
# File lib/bundler/rubygems_integration.rb, line 217
def preserve_paths
  # this is a no-op outside of RubyGems 1.8
  yield
end
provides?(req_str) click to toggle source
# File lib/bundler/rubygems_integration.rb, line 29
def provides?(req_str)
  self.class.provides?(req_str)
end
read_binary(path) click to toggle source
# File lib/bundler/rubygems_integration.rb, line 128
def read_binary(path)
  Gem.read_binary(path)
end
redefine_method(klass, method, unbound_method = nil, &block) click to toggle source
# File lib/bundler/rubygems_integration.rb, line 594
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) click to toggle source

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

# File lib/bundler/rubygems_integration.rb, line 437
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) click to toggle source

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

# File lib/bundler/rubygems_integration.rb, line 511
def replace_entrypoints(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

  replace_gem(specs, specs_by_name)
  stub_rubygems(specs)
  replace_bin_path(specs_by_name)
  replace_refresh

  Gem.clear_paths
end
replace_gem(specs, specs_by_name) click to toggle source
# File lib/bundler/rubygems_integration.rb, line 368
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|
      executables ||= specs.map(&:executables).flatten if ::Bundler.rubygems.binstubs_call_gem?
      if executables && 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?
        "#{dep.name} is not part of the bundle." \
        " Add it to your #{Bundler.default_gemfile.basename}."
      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
      if e.respond_to?(:requirement=)
        e.requirement = dep.requirement
      elsif e.respond_to?(:version_requirement=)
        e.version_requirement = dep.requirement
      end
      raise e
    end

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

Because Bundler has a static view of what specs are available, we don't refresh, so stub it out.

# File lib/bundler/rubygems_integration.rb, line 504
def replace_refresh
  gem_class = (class << Gem; self; end)
  redefine_method(gem_class, :refresh) {}
end
repository_subdirectories() click to toggle source
# File lib/bundler/rubygems_integration.rb, line 201
def repository_subdirectories
  %w[cache doc gems specifications]
end
reset() click to toggle source
# File lib/bundler/rubygems_integration.rb, line 169
def reset
  Gem::Specification.reset
end
reverse_rubygems_kernel_mixin() click to toggle source
# File lib/bundler/rubygems_integration.rb, line 350
def reverse_rubygems_kernel_mixin
  # Disable rubygems' gem activation system
  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
ruby_engine() click to toggle source
# File lib/bundler/rubygems_integration.rb, line 124
def ruby_engine
  Gem.ruby_engine
end
security_policies() click to toggle source
# File lib/bundler/rubygems_integration.rb, line 341
def security_policies
  @security_policies ||= begin
    require "rubygems/security"
    Gem::Security::Policies
  rescue LoadError, NameError
    {}
  end
end
security_policy_keys() click to toggle source
# File lib/bundler/rubygems_integration.rb, line 337
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) click to toggle source
# File lib/bundler/rubygems_integration.rb, line 68
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
sources() click to toggle source
# File lib/bundler/rubygems_integration.rb, line 149
def sources
  Gem.sources
end
sources=(val) click to toggle source
# File lib/bundler/rubygems_integration.rb, line 140
def sources=(val)
  # Gem.configuration creates a new Gem::ConfigFile, which by default will read ~/.gemrc
  # If that file exists, its settings (including sources) will overwrite the values we
  # are about to set here. In order to avoid that, we force memoizing the config file now.
  configuration

  Gem.sources = val
end
spec_cache_dirs() click to toggle source
# File lib/bundler/rubygems_integration.rb, line 185
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_default_gem?(spec) click to toggle source
# File lib/bundler/rubygems_integration.rb, line 82
def spec_default_gem?(spec)
  spec.respond_to?(:default_gem?) && spec.default_gem?
end
spec_extension_dir(spec) click to toggle source
# File lib/bundler/rubygems_integration.rb, line 94
def spec_extension_dir(spec)
  return unless spec.respond_to?(:extension_dir)
  spec.extension_dir
end
spec_from_gem(path, policy = nil) click to toggle source
# File lib/bundler/rubygems_integration.rb, line 302
def spec_from_gem(path, policy = nil)
  require "rubygems/security"
  require "bundler/psyched_yaml"
  gem_from_path(path, security_policies[policy]).spec
rescue Gem::Package::FormatError
  raise GemspecError, "Could not read gem at #{path}. It may be corrupted."
rescue Exception, Gem::Exception, Gem::Security::Exception => e # rubocop:disable Lint/RescueException
  if e.is_a?(Gem::Security::Exception) ||
      e.message =~ /unknown trust policy|unsigned gem/i ||
      e.message =~ /couldn't verify (meta)?data signature/i
    raise SecurityError,
      "The gem #{File.basename(path, ".gem")} can't be installed because " \
      "the security policy didn't allow it, with the message: #{e.message}"
  else
    raise e
  end
end
spec_matches_for_glob(spec, glob) click to toggle source
# File lib/bundler/rubygems_integration.rb, line 86
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) click to toggle source
# File lib/bundler/rubygems_integration.rb, line 73
def spec_missing_extensions?(spec, default = true)
  return spec.missing_extensions? if spec.respond_to?(:missing_extensions?)

  return false if spec_default_gem?(spec)
  return false if spec.extensions.empty?

  default
end
stub_set_spec(stub, spec) click to toggle source
# File lib/bundler/rubygems_integration.rb, line 99
def stub_set_spec(stub, spec)
  stub.instance_variable_set(:@spec, spec)
end
stub_source_index(specs) click to toggle source
# File lib/bundler/rubygems_integration.rb, line 414
def stub_source_index(specs)
  Gem::SourceIndex.send(:alias_method, :old_initialize, :initialize)
  redefine_method(Gem::SourceIndex, :initialize) do |*args|
    @gems = {}
    # You're looking at this thinking: Oh! This is how I make those
    # rubygems deprecations go away!
    #
    # You'd be correct BUT using of this method in production code
    # must be approved by the rubygems team itself!
    #
    # This is your warning. If you use this and don't have approval
    # we can't protect you.
    #
    Deprecate.skip_during do
      self.spec_dirs = *args
      add_specs(*specs)
    end
  end
end
stubs_provide_full_functionality?() click to toggle source
# File lib/bundler/rubygems_integration.rb, line 364
def stubs_provide_full_functionality?
  false
end
suffix_pattern() click to toggle source
# File lib/bundler/rubygems_integration.rb, line 177
def suffix_pattern
  Gem.suffix_pattern
end
ui=(obj) click to toggle source
# File lib/bundler/rubygems_integration.rb, line 243
def ui=(obj)
  Gem::DefaultUserInteraction.ui = obj
end
undo_replacements() click to toggle source
# File lib/bundler/rubygems_integration.rb, line 582
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() click to toggle source
# File lib/bundler/rubygems_integration.rb, line 161
def user_home
  Gem.user_home
end
validate(spec) click to toggle source
# File lib/bundler/rubygems_integration.rb, line 58
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() click to toggle source
# File lib/bundler/rubygems_integration.rb, line 25
def version
  self.class.version
end
with_build_args(args) { || ... } click to toggle source
# File lib/bundler/rubygems_integration.rb, line 281
def with_build_args(args)
  ext_lock.synchronize do
    old_args = build_args
    begin
      self.build_args = args
      yield
    ensure
      self.build_args = old_args
    end
  end
end