Module: Gem

286
287
288
289
290
291
292
293
294
295
296

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

def self.all_load_paths
  result = []

  Gem.path.each do |gemdir|
    each_load_path all_partials(gemdir) do |load_path|
      result << load_path
    end
  end

  result
end

301
302
303

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

def self.all_partials(gemdir)
  Dir[File.join(gemdir, 'gems/*')]
end

310
311
312
313
314
315
316
317
318
319

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

def self.available?(gem, *requirements)
  requirements = Gem::Requirement.default if requirements.empty?

  unless gem.respond_to?(:name) and
         gem.respond_to?(:requirement) then
    gem = Gem::Dependency.new gem, requirements
  end

  !Gem.source_index.search(gem).empty?
end

327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352

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

def self.bin_path(name, exec_name = nil, *requirements)
  requirements = Gem::Requirement.default if
    requirements.empty?
  specs = Gem.source_index.find_name(name, requirements)

  raise Gem::GemNotFoundException,
        "can't find gem #{name} (#{requirements})" if specs.empty?

  specs = specs.find_all do |spec|
    spec.executables.include?(exec_name)
  end if exec_name

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

  exec_name ||= spec.default_executable

  unless exec_name
    msg = "no default executable for #{spec.full_name} and none given"
    raise Gem::Exception, msg
  end

  File.join(spec.full_gem_path, spec.bindir, exec_name)
end

357
358
359

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

def self.binary_mode
  'rb'
end

364
365
366
367
368

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

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

375
376
377
378
379
380
381
382
383

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

def self.clear_paths
  @gem_home = nil
  @gem_path = nil
  @user_home = nil

  @@source_index = nil

  @searcher = nil
end

388
389
390

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

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

395
396
397

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

def self.configuration
  @configuration ||= Gem::ConfigFile.new []
end

403
404
405

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

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

411
412
413
414
415

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

def self.datadir(gem_name)
  spec = @loaded_specs[gem_name]
  return nil if spec.nil?
  File.join(spec.full_gem_path, 'data', gem_name)
end

67
68
69
70
71
72
73

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

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

19
20
21
22
23
24
25
26
27
28
29
30

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

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

53
54
55
56
57
58
59
60
61
62

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

def self.default_exec_format
  exec_format = ConfigMap[: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

42
43
44
45
46
47
48

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

def self.default_path
  if File.exist? Gem.user_home then
    [user_dir, default_dir]
  else
    [default_dir]
  end
end

11
12
13

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

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

78
79
80

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

def self.default_system_source_cache_dir
  File.join Gem.dir, 'source_cache'
end

85
86
87

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

def self.default_user_source_cache_dir
  File.join Gem.user_home, '.gem', 'source_cache'
end

420
421
422
423

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

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

428
429
430
431
432

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

def self.dir
  @gem_home ||= nil
  set_home(ENV['GEM_HOME'] || Gem.configuration.home || default_dir) unless @gem_home
  @gem_home
end

438
439
440
441
442
443
444
445
446
447
448
449
450
451
452

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

def self.each_load_path(partials)
  partials.each do |gp|
    base = File.basename(gp)
    specfn = File.join(dir, "specifications", base + ".gemspec")
    if File.exist?(specfn)
      spec = eval(File.read(specfn))
      spec.require_paths.each do |rp|
        yield(File.join(gp, rp))
      end
    else
      filename = File.join(gp, 'lib')
      yield(filename) if File.exist?(filename)
    end
  end
end

461
462
463
464
465
466
467
468

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

def self.ensure_gem_subdirectories(gemdir)
  require 'fileutils'

  Gem::DIRECTORIES.each do |filename|
    fn = File.join gemdir, filename
    FileUtils.mkdir_p fn rescue nil unless File.exist? fn
  end
end

31
32
33
34
35

# File 'lib/rubygems/gem_openssl.rb', line 31

def ensure_ssl_available
  unless ssl_available?
    raise Gem::Exception, "SSL is not installed on this system"
  end
end

482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506

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

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

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

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

  specs = searcher.find_all glob

  specs.each do |spec|
    files.concat searcher.matching_files(spec, glob)
  end

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

  return files
end

519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538

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

def self.find_home
  unless RUBY_VERSION > '1.9' then
    ['HOME', 'USERPROFILE'].each do |homekey|
      return File.expand_path(ENV[homekey]) if ENV[homekey]
    end

    if ENV['HOMEDRIVE'] && ENV['HOMEPATH'] then
      return File.expand_path("#{ENV['HOMEDRIVE']}#{ENV['HOMEPATH']}")
    end
  end

  File.expand_path "~"
rescue
  if File::ALT_SEPARATOR then
    drive = ENV['HOMEDRIVE'] || ENV['SystemDrive']
    File.join(drive.to_s, '/')
  else
    "/"
  end
end

545
546
547
548
549
550
551

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

def self.gunzip(data)
  require 'stringio'
  require 'zlib'
  data = StringIO.new data

  Zlib::GzipReader.new(data).read
end

556
557
558
559
560
561
562
563
564

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

def self.gzip(data)
  require 'stringio'
  require 'zlib'
  zipped = StringIO.new

  Zlib::GzipWriter.wrap zipped do |io| io.write data end

  zipped.string
end

578
579
580

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

def self.host
  @host ||= "https://rubygems.org"
end

584
585
586

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

def self.host= host
  @host = host
end

569
570
571
572

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

def self.inflate(data)
  require 'zlib'
  Zlib::Inflate.inflate data
end

592
593
594
595
596
597
598
599
600
601
602

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

def self.latest_load_paths
  result = []

  Gem.path.each do |gemdir|
    each_load_path(latest_partials(gemdir)) do |load_path|
      result << load_path
    end
  end

  result
end

607
608
609
610
611
612
613
614
615
616
617
618
619
620

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

def self.latest_partials(gemdir)
  latest = {}
  all_partials(gemdir).each do |gp|
    base = File.basename(gp)
    if base =~ /(.*)-((\d+\.)*\d+)/ then
      name, version = $1, $2
      ver = Gem::Version.new(version)
      if latest[name].nil? || ver > latest[name][0]
        latest[name] = [ver, gp]
      end
    end
  end
  latest.collect { |k,v| v[1] }
end

1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053

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

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

631
632
633
634
635
636
637
638
639
640
641
642
643

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

def self.load_path_insert_index
  index = $LOAD_PATH.index ConfigMap[:sitelibdir]

  $LOAD_PATH.each_with_index do |path, i|
    if path.instance_variables.include?(:@gem_prelude_index) or
      path.instance_variables.include?('@gem_prelude_index') then
      index = i
      break
    end
  end

  index
end

1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028

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

def self.load_plugin_files(plugins)
  plugins.each do |plugin|

    # Skip older versions of the GemCutter plugin: Its commands are in
    # RubyGems proper now.

    next if plugin =~ /gemcutter-0\.[0-3]/

    begin
      load plugin
    rescue ::Exception => e
      details = "#{plugin.inspect}: #{e.message} (#{e.class})"
      warn "Error loading RubyGems plugin #{details}"
    end
  end
end

1033
1034
1035

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

def self.load_plugins
  load_plugin_files find_files('rubygems_plugin', false)
end

648
649
650
651
652
653
654

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

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

  [file, lineno]
end

659
660
661

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

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

666
667
668
669
670
671
672
673
674
675
676
677
678
679
680

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

def self.path
  @gem_path ||= nil

  unless @gem_path then
    paths = [ENV['GEM_PATH'] || Gem.configuration.path || default_path]

    if defined?(APPLE_GEM_HOME) and not ENV['GEM_PATH'] then
      paths << APPLE_GEM_HOME
    end

    set_paths paths.compact.join(File::PATH_SEPARATOR)
  end

  @gem_path
end

692
693
694
695
696
697
698

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

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

685
686
687

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

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

704
705
706

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

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

713
714
715

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

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

721
722
723

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

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

730
731
732

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

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

737
738
739
740
741
742
743
744
745
746
747
748

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

def self.prefix
  dir = File.dirname File.expand_path(__FILE__)
  prefix = File.dirname dir

  if prefix == File.expand_path(ConfigMap[:sitelibdir]) or
     prefix == File.expand_path(ConfigMap[:libdir]) or
     'lib' != File.basename(dir) then
    nil
  else
    prefix
  end
end

755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775

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

def self.promote_load_path(gem_name, over_name)
  gem = Gem.loaded_specs[gem_name]
  over = Gem.loaded_specs[over_name]

  raise ArgumentError, "gem #{gem_name} is not activated" if gem.nil?
  raise ArgumentError, "gem #{over_name} is not activated" if over.nil?

  last_gem_path = File.join gem.full_gem_path, gem.require_paths.last

  over_paths = over.require_paths.map do |path|
    File.join over.full_gem_path, path
  end

  over_paths.each do |path|
    $LOAD_PATH.delete path
  end

  gem = $LOAD_PATH.index(last_gem_path) + 1

  $LOAD_PATH.insert(gem, *over_paths)
end

789
790
791

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

def self.read_binary(path)
  File.open path, binary_mode do |f| f.read end
end

780
781
782
783
784

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

def self.refresh
  source_index.refresh!

  @searcher = nil
end

798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813

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

def self.report_activate_error(gem)
  matches = Gem.source_index.find_name(gem.name)

  if matches.empty? then
    error = Gem::LoadError.new(
        "Could not find RubyGem #{gem.name} (#{gem.requirement})\n")
  else
    error = Gem::LoadError.new(
        "RubyGem version error: " +
        "#{gem.name}(#{matches.first.version} not #{gem.requirement})\n")
  end

  error.name = gem.name
  error.requirement = gem.requirement
  raise error
end

821
822
823
824
825
826
827
828
829
830
831
832
833
834
835

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

def self.required_location(gemname, libfile, *requirements)
  requirements = Gem::Requirement.default if requirements.empty?

  matches = Gem.source_index.find_name gemname, requirements

  return nil if matches.empty?

  spec = matches.last
  spec.require_paths.each do |path|
    result = File.join spec.full_gem_path, path, libfile
    return result if File.exist? result
  end

  nil
end

840
841
842
843
844
845
846
847
848
849
850
851

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

def self.ruby
  if @ruby.nil? then
    @ruby = File.join(ConfigMap[:bindir],
                      ConfigMap[:ruby_install_name])
    @ruby << ConfigMap[:EXEEXT]

    # escape string in case path to ruby executable contain spaces.
    @ruby.sub!(/.*\s.*/m, '"\&"')
  end

  @ruby
end

92
93
94
95
96
97
98

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

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

856
857
858
859
860
861
862
863
864
865
866
867

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

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

872
873
874

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

def self.searcher
  @searcher ||= Gem::GemPathSearcher.new
end

879
880
881
882

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

def self.set_home(home)
  home = home.gsub File::ALT_SEPARATOR, File::SEPARATOR if File::ALT_SEPARATOR
  @gem_home = home
end

889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906

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

def self.set_paths(gpaths)
  if gpaths
    @gem_path = gpaths.split(File::PATH_SEPARATOR)

    if File::ALT_SEPARATOR then
      @gem_path.map! do |path|
        path.gsub File::ALT_SEPARATOR, File::SEPARATOR
      end
    end

    @gem_path << Gem.dir
  else
    # TODO: should this be Gem.default_path instead?
    @gem_path = [Gem.dir]
  end

  @gem_path.uniq!
end

913
914
915

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

def self.source_index
  @@source_index ||= SourceIndex.from_installed_gems
end

922
923
924
925
926
927
928
929
930
931
932
933

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

def self.sources
  if @sources.empty? then
    begin
      gem 'sources', '> 0.0.1'
      require 'sources'
    rescue LoadError
      @sources = default_sources
    end
  end

  @sources
end

939
940
941

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

def self.sources=(new_sources)
  @sources = new_sources
end

19
20
21

# File 'lib/rubygems/gem_openssl.rb', line 19

def ssl_available?
  @ssl_available
end

946
947
948

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

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

953
954
955

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

def self.suffixes
  ['', '.rb', '.rbw', '.so', '.bundle', '.dll', '.sl', '.jar']
end

961
962
963
964
965
966
967
968
969
970
971

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

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

976
977
978
979
980

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

def self.ui
  require 'rubygems/user_interaction'

  Gem::DefaultUserInteraction.ui
end

986
987
988
989
990

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

def self.use_paths(home, paths=[])
  clear_paths
  set_home(home) if home
  set_paths(paths.join(File::PATH_SEPARATOR)) if paths
end

35
36
37

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

def self.user_dir
  File.join Gem.user_home, '.gem', ruby_engine, ConfigMap[:ruby_version]
end

995
996
997

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

def self.user_home
  @user_home ||= find_home
end

1002
1003
1004
1005
1006
1007
1008

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

def self.win_platform?
  if @@win_platform.nil? then
    @@win_platform = !!WIN_PATTERNS.find { |r| RUBY_PLATFORM =~ r }
  end

  @@win_platform
end