Module: Gem

# File 'lib/rubygems.rb', line 350

def self.configuration=(config)
  @configuration = config
end

# File 'lib/rubygems/defaults.rb', line 153

def self.default_gems_use_full_paths?
  ruby_engine != 'ruby'
end

# File 'lib/rubygems.rb', line 1283

attr_reader :done_installing_hooks

# File 'lib/rubygems.rb', line 1207

attr_reader :gemdeps

# File 'lib/rubygems.rb', line 636

def self.host
  # TODO: move to utils
  @host ||= Gem::DEFAULT_HOST
end

# File 'lib/rubygems.rb', line 643

def self.host= host
  # TODO: move to utils
  @host = host
end

# File 'lib/rubygems.rb', line 1201

attr_reader :loaded_specs

# File 'lib/rubygems.rb', line 376

def self.paths
  @paths ||= Gem::PathSupport.new(ENV)
end

# File 'lib/rubygems.rb', line 386

def self.paths=(env)
  clear_paths
  target = {}
  env.each_pair do |k,v|
    case k
    when 'GEM_HOME', 'GEM_PATH', 'GEM_SPEC_CACHE'
      case v
      when nil, String
        target[k] = v
      when Array
        unless Gem::Deprecate.skip
          warn <<-eowarn
Array values in the parameter to `Gem.paths=` are deprecated.
Please use a String or nil.
An Array (#{env.inspect}) was passed in from #{caller[3]}
          eowarn
        end
        target[k] = v.join File::PATH_SEPARATOR
      end
    else
      target[k] = v
    end
  end
  @paths = Gem::PathSupport.new ENV.to_hash.merge(target)
  Gem::Specification.dirs = @paths.path
end

# File 'lib/rubygems.rb', line 745

def self.platforms
  @platforms ||= []
  if @platforms.empty?
    @platforms = [Gem::Platform::RUBY, Gem::Platform.local]
  end
  @platforms
end

# File 'lib/rubygems.rb', line 738

def self.platforms=(platforms)
  @platforms = platforms
end

# File 'lib/rubygems.rb', line 1271

attr_reader :post_build_hooks

# File 'lib/rubygems.rb', line 1277

attr_reader :post_install_hooks

# File 'lib/rubygems.rb', line 1288

attr_reader :post_reset_hooks

# File 'lib/rubygems.rb', line 1294

attr_reader :post_uninstall_hooks

# File 'lib/rubygems.rb', line 1299

attr_reader :pre_install_hooks

# File 'lib/rubygems.rb', line 1304

attr_reader :pre_reset_hooks

# File 'lib/rubygems.rb', line 1310

attr_reader :pre_uninstall_hooks

# File 'lib/rubygems.rb', line 891

def self.ruby
  if @ruby.nil? then
    @ruby = File.join(RbConfig::CONFIG['bindir'],
                      "#{RbConfig::CONFIG['ruby_install_name']}#{RbConfig::CONFIG['EXEEXT']}")

    @ruby = "\"#{@ruby}\"" if @ruby =~ /\s/
  end

  @ruby
end

# File 'lib/rubygems/test_case.rb', line 65

def self.ruby= ruby
  @ruby = ruby
end

# File 'lib/rubygems/test_case.rb', line 49

def self.searcher=(searcher)
  @searcher = searcher
end

# File 'lib/rubygems.rb', line 975

def self.sources
  source_list = configuration.sources || default_sources
  @sources ||= Gem::SourceList.from(source_list)
end

# File 'lib/rubygems.rb', line 987

def self.sources= new_sources
  if !new_sources
    @sources = nil
  else
    @sources = Gem::SourceList.from(new_sources)
  end
end

# File 'lib/rubygems/test_case.rb', line 57

def self.win_platform=(val)
  @@win_platform = val
end

# File 'lib/rubygems.rb', line 1063

def self.win_platform?
  if @@win_platform.nil? then
    ruby_platform = RbConfig::CONFIG['host_os']
    @@win_platform = !!WIN_PATTERNS.find { |r| ruby_platform =~ r }
  end

  @@win_platform
end

# File 'lib/rubygems.rb', line 307

def self.binary_mode
  'rb'
end

# File 'lib/rubygems.rb', line 314

def self.bindir(install_dir=Gem.dir)
  return File.join install_dir, 'bin' unless
    install_dir.to_s == Gem.default_dir.to_s
  Gem.default_bindir
end

# File 'lib/rubygems.rb', line 1263

def clear_default_specs
  @path_to_default_spec_map.clear
end

# File 'lib/rubygems.rb', line 325

def self.clear_paths
  @paths         = nil
  @user_home     = nil
  Gem::Specification.reset
  Gem::Security.reset if defined?(Gem::Security)
end

# File 'lib/rubygems.rb', line 335

def self.config_file
  @config_file ||= File.join Gem.user_home, '.gemrc'
end

# File 'lib/rubygems.rb', line 358

def self.datadir(gem_name)
# TODO: deprecate
  spec = @loaded_specs[gem_name]
  return nil if spec.nil?
  spec.datadir
end

# File 'lib/rubygems/defaults.rb', line 117

def self.default_bindir
  if defined? RUBY_FRAMEWORK_VERSION then # mac framework support
    '/usr/bin'
  else # generic install
    RbConfig::CONFIG['bindir']
  end
end

# File 'lib/rubygems/defaults.rb', line 146

def self.default_cert_path
  File.join Gem.user_home, ".gem", "gem-public_cert.pem"
end

# File 'lib/rubygems/defaults.rb', line 30

def self.default_dir
  path = if defined? RUBY_FRAMEWORK_VERSION then
           [
             File.dirname(RbConfig::CONFIG['sitedir']),
             'Gems',
             RbConfig::CONFIG['ruby_version']
           ]
         elsif RbConfig::CONFIG['rubylibprefix'] then
           [
            RbConfig::CONFIG['rubylibprefix'],
            'gems',
            RbConfig::CONFIG['ruby_version']
           ]
         else
           [
             RbConfig::CONFIG['libdir'],
             ruby_engine,
             'gems',
             RbConfig::CONFIG['ruby_version']
           ]
         end

  @default_dir ||= File.join(*path)
end

# File 'lib/rubygems/defaults.rb', line 103

def self.default_exec_format
  exec_format = RbConfig::CONFIG['ruby_install_name'].sub('ruby', '%s') rescue '%s'

  unless exec_format =~ /%s/ then
    raise Gem::Exception,
      "[BUG] invalid exec_format #{exec_format.inspect}, no %s"
  end

  exec_format
end

# File 'lib/rubygems/defaults.rb', line 62

def self.default_ext_dir_for base_dir
  nil
end

# File 'lib/rubygems/defaults.rb', line 139

def self.default_key_path
  File.join Gem.user_home, ".gem", "gem-private_key.pem"
end

# File 'lib/rubygems/defaults.rb', line 92

def self.default_path
  path = []
  path << user_dir if user_home && File.exist?(user_home)
  path << default_dir
  path << vendor_dir if vendor_dir and File.directory? vendor_dir
  path
end

# File 'lib/rubygems/defaults.rb', line 69

def self.default_rubygems_dirs
  nil # default to standard layout
end

# File 'lib/rubygems/defaults.rb', line 14

def self.default_sources
  %w[https://rubygems.org/]
end

# File 'lib/rubygems/defaults.rb', line 22

def self.default_spec_cache_dir
  File.join Gem.user_home, '.gem', 'specs'
end

# File 'lib/rubygems.rb', line 368

def self.deflate(data)
  require 'zlib'
  Zlib::Deflate.deflate data
end

# File 'lib/rubygems.rb', line 418

def self.dir
  paths.home
end

# File 'lib/rubygems.rb', line 777

def self.done_installing(&hook)
  @done_installing_hooks << hook
end

# File 'lib/rubygems.rb', line 452

def self.ensure_default_gem_subdirectories dir = Gem.dir, mode = nil
  ensure_subdirectories(dir, mode, REPOSITORY_DEFAULT_GEM_SUBDIRECTORIES)
end

# File 'lib/rubygems.rb', line 439

def self.ensure_gem_subdirectories dir = Gem.dir, mode = nil
  ensure_subdirectories(dir, mode, REPOSITORY_SUBDIRECTORIES)
end

# File 'lib/rubygems.rb', line 909

def self.env_requirement(gem_name)
  @env_requirements_by_name ||= {}
  @env_requirements_by_name[gem_name] ||= begin
    req = ENV["GEM_REQUIREMENT_#{gem_name.upcase}"] || '>= 0'.freeze
    Gem::Requirement.create(req)
  end
end

# File 'lib/rubygems.rb', line 499

def self.find_files(glob, check_load_path=true)
  files = []

  files = find_files_from_load_path glob if check_load_path

  gem_specifications = @gemdeps ? Gem.loaded_specs.values : Gem::Specification.stubs

  files.concat gem_specifications.map { |spec|
    spec.matches_for_glob("#{glob}#{Gem.suffix_pattern}")
  }.flatten

  # $LOAD_PATH might contain duplicate entries or reference
  # the spec dirs directly, so we prune.
  files.uniq! if check_load_path

  return files
end

# File 'lib/rubygems.rb', line 568

def self.find_home
  windows = File::ALT_SEPARATOR
  if not windows or RUBY_VERSION >= '1.9' then
    File.expand_path "~"
  else
    ['HOME', 'USERPROFILE'].each do |key|
      return File.expand_path ENV[key] if ENV[key]
    end

    if ENV['HOMEDRIVE'] && ENV['HOMEPATH'] then
      File.expand_path "#{ENV['HOMEDRIVE']}#{ENV['HOMEPATH']}"
    end
  end
rescue
  if windows then
    File.expand_path File.join(ENV['HOMEDRIVE'] || ENV['SystemDrive'], '/')
  else
    File.expand_path "/"
  end
end

# File 'lib/rubygems.rb', line 535

def self.find_latest_files(glob, check_load_path=true)
  files = []

  files = find_files_from_load_path glob if check_load_path

  files.concat Gem::Specification.latest_specs(true).map { |spec|
    spec.matches_for_glob("#{glob}#{Gem.suffix_pattern}")
  }.flatten

  # $LOAD_PATH might contain duplicate entries or reference
  # the spec dirs directly, so we prune.
  files.uniq! if check_load_path

  return files
end

# File 'lib/rubygems.rb', line 262

def self.find_spec_for_exe name, exec_name, requirements
  dep = Gem::Dependency.new name, requirements

  loaded = Gem.loaded_specs[name]

  return loaded if loaded && dep.matches_spec?(loaded)

  specs = dep.matching_specs(true)

  raise Gem::GemNotFoundException,
        "can't find gem #{dep}" if specs.empty?

  specs = specs.find_all { |spec|
    spec.executables.include? exec_name
  } if exec_name

  unless spec = specs.first
    msg = "can't find gem #{name} (#{requirements}) with executable #{exec_name}"
    raise Gem::GemNotFoundException, msg
  end

  spec
end

# File 'lib/rubygems.rb', line 1242

def find_unresolved_default_spec(path)
  Gem.suffixes.each do |suffix|
    spec = @path_to_default_spec_map["#{path}#{suffix}"]
    return spec if spec
  end
  nil
end

# File 'lib/rubygems.rb', line 235

def self.finish_resolve(request_set=Gem::RequestSet.new)
  request_set.import Gem::Specification.unresolved_deps.values
  request_set.import Gem.loaded_specs.values.map {|s| Gem::Dependency.new(s.name, s.version) }

  request_set.resolve_current.each do |s|
    s.full_spec.activate
  end
end

# File 'lib/rubygems.rb', line 596

def self.gunzip(data)
  require 'rubygems/util'
  Gem::Util.gunzip data
end

# File 'lib/rubygems.rb', line 604

def self.gzip(data)
  require 'rubygems/util'
  Gem::Util.gzip data
end

# File 'lib/rubygems.rb', line 612

def self.inflate(data)
  require 'rubygems/util'
  Gem::Util.inflate data
end

# File 'lib/rubygems.rb', line 625

def self.install name, version = Gem::Requirement.default, *options
  require "rubygems/dependency_installer"
  inst = Gem::DependencyInstaller.new(*options)
  inst.install name, version
  inst.installed_gems
end

# File 'lib/rubygems.rb', line 934

def self.latest_rubygems_version
  latest_version_for('rubygems-update') or
    raise "Can't find 'rubygems-update' in any repo. Check `gem source list`."
end

# File 'lib/rubygems.rb', line 921

def self.latest_spec_for name
  dependency   = Gem::Dependency.new name
  fetcher      = Gem::SpecFetcher.fetcher
  spec_tuples, = fetcher.spec_for_dependency dependency

  spec, = spec_tuples.first

  spec
end

# File 'lib/rubygems.rb', line 942

def self.latest_version_for name
  spec = latest_spec_for name
  spec and spec.version
end

# File 'lib/rubygems.rb', line 1108

def self.load_env_plugins
  path = "rubygems_plugin"

  files = []
  $LOAD_PATH.each do |load_path|
    globbed = Dir["#{File.expand_path path, load_path}#{Gem.suffix_pattern}"]

    globbed.each do |load_path_file|
      files << load_path_file if File.file?(load_path_file.untaint)
    end
  end

  load_plugin_files files
end

# File 'lib/rubygems.rb', line 652

def self.load_path_insert_index
  $LOAD_PATH.each_with_index do |path, i|
    return i if path.instance_variable_defined?(:@gem_prelude_index)
  end

  index = $LOAD_PATH.index RbConfig::CONFIG['sitelibdir']

  index
end

# File 'lib/rubygems.rb', line 1096

def self.load_plugins
  # Remove this env var by at least 3.0
  if ENV['RUBYGEMS_LOAD_ALL_PLUGINS']
    load_plugin_files find_files('rubygems_plugin', false)
  else
    load_plugin_files find_latest_files('rubygems_plugin', false)
  end
end

# File 'lib/rubygems.rb', line 667

def self.load_yaml
  return if @yaml_loaded
  return unless defined?(gem)

  test_syck = ENV['TEST_SYCK']

  # Only Ruby 1.8 and 1.9 have syck
  test_syck = false unless /^1\./ =~ RUBY_VERSION

  unless test_syck
    begin
      gem 'psych', '>= 2.0.0'
    rescue Gem::LoadError
      # It's OK if the user does not have the psych gem installed.  We will
      # attempt to require the stdlib version
    end

    begin
      # Try requiring the gem version *or* stdlib version of psych.
      require 'psych'
    rescue ::LoadError
      # If we can't load psych, thats fine, go on.
    else
      # If 'yaml' has already been required, then we have to
      # be sure to switch it over to the newly loaded psych.
      if defined?(YAML::ENGINE) && YAML::ENGINE.yamler != "psych"
        YAML::ENGINE.yamler = "psych"
      end

      require 'rubygems/psych_additions'
      require 'rubygems/psych_tree'
    end
  end

  require 'yaml'
  require 'rubygems/safe_yaml'

  # If we're supposed to be using syck, then we may have to force
  # activate it via the YAML::ENGINE API.
  if test_syck and defined?(YAML::ENGINE)
    YAML::ENGINE.yamler = "syck" unless YAML::ENGINE.syck?
  end

  # Now that we're sure some kind of yaml library is loaded, pull
  # in our hack to deal with Syck's DefaultKey ugliness.
  require 'rubygems/syck_hack'

  @yaml_loaded = true
end

# File 'lib/rubygems.rb', line 720

def self.location_of_caller
  caller[1] =~ /(.*?):(\d+).*?$/i
  file = $1
  lineno = $2.to_i

  [file, lineno]
end

# File 'lib/rubygems.rb', line 731

def self.marshal_version
  "#{Marshal::MAJOR_VERSION}.#{Marshal::MINOR_VERSION}"
end

# File 'lib/rubygems.rb', line 227

def self.needs
  rs = Gem::RequestSet.new

  yield rs

  finish_resolve rs
end

# File 'lib/rubygems.rb', line 422

def self.path
  paths.path
end

# File 'lib/rubygems/defaults.rb', line 85

def self.path_separator
  File::PATH_SEPARATOR
end

# File 'lib/rubygems/defaults.rb', line 193

def self.platform_defaults
  {}
end

# File 'lib/rubygems.rb', line 760

def self.post_build(&hook)
  @post_build_hooks << hook
end

# File 'lib/rubygems.rb', line 768

def self.post_install(&hook)
  @post_install_hooks << hook
end

# File 'lib/rubygems.rb', line 785

def self.post_reset(&hook)
  @post_reset_hooks << hook
end

# File 'lib/rubygems.rb', line 794

def self.post_uninstall(&hook)
  @post_uninstall_hooks << hook
end

# File 'lib/rubygems.rb', line 803

def self.pre_install(&hook)
  @pre_install_hooks << hook
end

# File 'lib/rubygems.rb', line 811

def self.pre_reset(&hook)
  @pre_reset_hooks << hook
end

# File 'lib/rubygems.rb', line 820

def self.pre_uninstall(&hook)
  @pre_uninstall_hooks << hook
end

# File 'lib/rubygems.rb', line 829

def self.prefix
  prefix = File.dirname RUBYGEMS_DIR

  if prefix != File.expand_path(RbConfig::CONFIG['sitelibdir']) and
     prefix != File.expand_path(RbConfig::CONFIG['libdir']) and
     'lib' == File.basename(RUBYGEMS_DIR) then
    prefix
  end
end

# File 'lib/rubygems.rb', line 849

def self.read_binary(path)
  open path, 'rb+' do |f|
    f.flock(File::LOCK_EX)
    f.read
  end
rescue *READ_BINARY_ERRORS
  open path, 'rb' do |f|
    f.read
  end
rescue Errno::ENOLCK # NFS
  if Thread.main != Thread.current
    raise
  else
    open path, 'rb' do |f|
      f.read
    end
  end
end

# File 'lib/rubygems.rb', line 842

def self.refresh
  Gem::Specification.reset
end

# File 'lib/rubygems.rb', line 1221

def register_default_spec(spec)
  new_format = Gem.default_gems_use_full_paths? || spec.require_paths.any? {|path| spec.files.any? {|f| f.start_with? path } }

  if new_format
    prefix_group = spec.require_paths.map {|f| f + "/"}.join("|")
    prefix_pattern = /^(#{prefix_group})/
  end

  spec.files.each do |file|
    if new_format
      file = file.sub(prefix_pattern, "")
      next unless $~
    end

    @path_to_default_spec_map[file] = spec
  end
end

# File 'lib/rubygems.rb', line 1254

def remove_unresolved_default_spec(spec)
  spec.files.each do |file|
    @path_to_default_spec_map.delete(file)
  end
end

# File 'lib/rubygems.rb', line 905

def self.ruby_api_version
  @ruby_api_version ||= RbConfig::CONFIG['ruby_version'].dup
end

# File 'lib/rubygems/defaults.rb', line 128

def self.ruby_engine
  if defined? RUBY_ENGINE then
    RUBY_ENGINE
  else
    'ruby'
  end
end

# File 'lib/rubygems.rb', line 950

def self.ruby_version
  return @ruby_version if defined? @ruby_version
  version = RUBY_VERSION.dup

  if defined?(RUBY_PATCHLEVEL) && RUBY_PATCHLEVEL != -1 then
    version << ".#{RUBY_PATCHLEVEL}"
  elsif defined?(RUBY_REVISION) then
    version << ".dev.#{RUBY_REVISION}"
  end

  @ruby_version = Gem::Version.new version
end

# File 'lib/rubygems.rb', line 966

def self.rubygems_version
  return @rubygems_version if defined? @rubygems_version
  @rubygems_version = Gem::Version.new Gem::VERSION
end

# File 'lib/rubygems.rb', line 426

def self.spec_cache_dir
  paths.spec_cache_dir
end

# File 'lib/rubygems.rb', line 998

def self.suffix_pattern
  @suffix_pattern ||= "{#{suffixes.join(',')}}"
end

# File 'lib/rubygems.rb', line 1005

def self.suffixes
  @suffixes ||= ['',
                 '.rb',
                 *%w(DLEXT DLEXT2).map { |key|
                   val = RbConfig::CONFIG[key]
                   next unless val and not val.empty?
                   ".#{val}"
                 }
                ].compact.uniq
end

# File 'lib/rubygems.rb', line 1020

def self.time(msg, width = 0, display = Gem.configuration.verbose)
  now = Time.now

  value = yield

  elapsed = Time.now - now

  ui.say "%2$*1$s: %3$3.3fs" % [-width, msg, elapsed] if display

  value
end

# File 'lib/rubygems.rb', line 202

def self.try_activate path
  # finds the _latest_ version... regardless of loaded specs and their deps
  # if another gem had a requirement that would mean we shouldn't
  # activate the latest version, then either it would already be activated
  # or if it was ambiguous (and thus unresolved) the code in our custom
  # require will try to activate the more specific version.

  spec = Gem::Specification.find_by_path path
  return false unless spec
  return true if spec.activated?

  begin
    spec.activate
  rescue Gem::LoadError => e # this could fail due to gem dep collisions, go lax
    spec_by_name = Gem::Specification.find_by_name(spec.name)
    if spec_by_name.nil?
      raise e
    else
      spec_by_name.activate
    end
  end

  return true
end

# File 'lib/rubygems.rb', line 1035

def self.ui
  require 'rubygems/user_interaction'

  Gem::DefaultUserInteraction.ui
end

# File 'lib/rubygems.rb', line 1143

def self.use_gemdeps path = nil
  raise_exception = path

  path ||= ENV['RUBYGEMS_GEMDEPS']
  return unless path

  path = path.dup

  if path == "-" then
    require 'rubygems/util'

    Gem::Util.traverse_parents Dir.pwd do |directory|
      dep_file = GEM_DEP_FILES.find { |f| File.file?(f) }

      next unless dep_file

      path = File.join directory, dep_file
      break
    end
  end

  path.untaint

  unless File.file? path then
    return unless raise_exception

    raise ArgumentError, "Unable to find gem dependencies file at #{path}"
  end

  rs = Gem::RequestSet.new
  @gemdeps = rs.load_gemdeps path

  rs.resolve_current.map do |s|
    sp = s.full_spec
    sp.activate
    sp
  end
rescue Gem::LoadError, Gem::UnsatisfiableDependencyError => e
  warn e.message
  warn "You may need to `gem install -g` to install missing gems"
  warn ""
end

# File 'lib/rubygems.rb', line 1045

def self.use_paths(home, *paths)
  paths.flatten!
  paths.compact!
  hash = { "GEM_HOME" => home, "GEM_PATH" => paths.empty? ? home : paths.join(File::PATH_SEPARATOR) }
  hash.delete_if { |_, v| v.nil? }
  self.paths = hash
end

# File 'lib/rubygems/defaults.rb', line 76

def self.user_dir
  parts = [Gem.user_home, '.gem', ruby_engine]
  parts << RbConfig::CONFIG['ruby_version'] unless RbConfig::CONFIG['ruby_version'].empty?
  File.join parts
end

# File 'lib/rubygems.rb', line 1056

def self.user_home
  @user_home ||= find_home.untaint
end

# File 'lib/rubygems.rb', line 870

def self.write_binary(path, data)
  open(path, 'wb') do |io|
    begin
      io.flock(File::LOCK_EX)
    rescue *WRITE_BINARY_ERRORS
    end
    io.write data
  end
rescue Errno::ENOLCK # NFS
  if Thread.main != Thread.current
    raise
  else
    open(path, 'wb') do |io|
      io.write data
    end
  end
end