Class: Gem::Installer

Inherits:
Object
  • Object
show all
Extended by:
Deprecate
Includes:
InstallerUninstallerUtils, UserInteraction
Defined in:
lib/rubygems/installer.rb,
lib/rubygems/installer_test_case.rb

Overview

The installer installs the files contained in the .gem into the Gem.home.

Gem::Installer does the work of putting files in all the right places on the filesystem including unpacking the gem into its gem dir, installing the gemspec in the specifications dir, storing the cached gem in the cache dir, and installing either wrappers or symlinks for executables.

The installer invokes pre and post install hooks. Hooks can be added either through a rubygems_plugin.rb file in an installed gem or via a rubygems/defaults/#RUBY_ENGINE.rb or rubygems/defaults/operating_system.rb file. See Gem.pre_install and Gem.post_install for details.

Defined Under Namespace

Classes: FakePackage

Constant Summary collapse

ENV_PATHS =

Paths where env(1) might live. Some systems are broken and have it in /bin

%w[/usr/bin/env /bin/env].freeze
ExtensionBuildError =

Deprecated in favor of Gem::Ext::BuildError

Gem::Ext::BuildError

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Deprecate

deprecate, next_rubygems_major_version, rubygems_deprecate, rubygems_deprecate_command, skip, skip=, skip_during

Methods included from InstallerUninstallerUtils

#regenerate_plugins_for, #remove_plugins_for

Methods included from UserInteraction

#alert, #alert_error, #alert_warning, #ask, #ask_for_password, #ask_yes_no, #choose_from_list, #say, #terminate_interaction, #verbose

Methods included from DefaultUserInteraction

ui, #ui, #ui=, ui=, use_ui, #use_ui

Methods included from Text

#clean_text, #format_text, #levenshtein_distance, #min3, #truncate_text

Constructor Details

#initialize(package, options = {}) ⇒ Installer

Constructs an Installer instance that will install the gem at package which can either be a path or an instance of Gem::Package. options is a Hash with the following keys:

:bin_dir

Where to put a bin wrapper if needed.

:development

Whether or not development dependencies should be installed.

:env_shebang

Use /usr/bin/env in bin wrappers.

:force

Overrides all version checks and security policy checks, except for a signed-gems-only policy.

:format_executable

Format the executable the same as the Ruby executable. If your Ruby is ruby18, foo_exec will be installed as foo_exec18.

:ignore_dependencies

Don't raise if a dependency is missing.

:install_dir

The directory to install the gem into.

:security_policy

Use the specified security policy. See Gem::Security

:user_install

Indicate that the gem should be unpacked into the users personal gem directory.

:only_install_dir

Only validate dependencies against what is in the install_dir

:wrappers

Install wrappers if true, symlinks if false.

:build_args

An Array of arguments to pass to the extension builder process. If not set, then Gem::Command.build_args is used

:post_install_message

Print gem post install message if true


172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
# File 'lib/rubygems/installer.rb', line 172

def initialize(package, options={})
  require 'fileutils'

  @options = options
  @package = package

  process_options

  @package.dir_mode = options[:dir_mode]
  @package.prog_mode = options[:prog_mode]
  @package.data_mode = options[:data_mode]

  if options[:user_install]
    @gem_home = Gem.user_dir
    @bin_dir = Gem.bindir gem_home unless options[:bin_dir]
    @plugins_dir = Gem.plugindir(gem_home)
    check_that_user_bin_dir_is_in_path
  end
end

Class Attribute Details

.exec_formatObject

Defaults to use Ruby's program prefix and suffix.


96
97
98
# File 'lib/rubygems/installer.rb', line 96

def exec_format
  @exec_format ||= Gem.default_exec_format
end

.install_lockObject (readonly)

Certain aspects of the install process are not thread-safe. This lock is used to allow multiple threads to install Gems at the same time.


84
85
86
# File 'lib/rubygems/installer.rb', line 84

def install_lock
  @install_lock
end

.path_warningObject

True if we've warned about PATH not including Gem.bindir


78
79
80
# File 'lib/rubygems/installer.rb', line 78

def path_warning
  @path_warning
end

Instance Attribute Details

#bin_dirObject

The directory a gem's executables will be installed into


51
52
53
# File 'lib/rubygems/installer.rb', line 51

def bin_dir
  @bin_dir
end

#build_args=(value) ⇒ Object (writeonly)

Available through requiring rubygems/installer_test_case


14
15
16
# File 'lib/rubygems/installer_test_case.rb', line 14

def build_args=(value)
  @build_args = value
end

#build_rootObject (readonly)

:nodoc:


53
54
55
# File 'lib/rubygems/installer.rb', line 53

def build_root
  @build_root
end

#env_shebang=(value) ⇒ Object (writeonly)

Available through requiring rubygems/installer_test_case


39
40
41
# File 'lib/rubygems/installer_test_case.rb', line 39

def env_shebang=(value)
  @env_shebang = value
end

#force=(value) ⇒ Object (writeonly)

Available through requiring rubygems/installer_test_case


24
25
26
# File 'lib/rubygems/installer_test_case.rb', line 24

def force=(value)
  @force = value
end

#format=(value) ⇒ Object (writeonly)

Available through requiring rubygems/installer_test_case


29
30
31
# File 'lib/rubygems/installer_test_case.rb', line 29

def format=(value)
  @format = value
end

#format_executable=(value) ⇒ Object (writeonly)

Available through requiring rubygems/installer_test_case


49
50
51
# File 'lib/rubygems/installer_test_case.rb', line 49

def format_executable=(value)
  @format_executable = value
end

#gem_dirObject

Lazy accessor for the spec's gem directory.


262
263
264
# File 'lib/rubygems/installer.rb', line 262

def gem_dir
  @gem_dir ||= File.join(gem_home, "gems", spec.full_name)
end

#gem_homeObject

The gem repository the gem will be installed into


58
59
60
# File 'lib/rubygems/installer.rb', line 58

def gem_home
  @gem_home
end

#ignore_dependencies=(value) ⇒ Object (writeonly)

Available through requiring rubygems/installer_test_case


44
45
46
# File 'lib/rubygems/installer_test_case.rb', line 44

def ignore_dependencies=(value)
  @ignore_dependencies = value
end

#optionsObject (readonly)

The options passed when the Gem::Installer was instantiated.


63
64
65
# File 'lib/rubygems/installer.rb', line 63

def options
  @options
end

#packageObject (readonly)

The gem package instance.


68
69
70
# File 'lib/rubygems/installer.rb', line 68

def package
  @package
end

#security_policy=(value) ⇒ Object (writeonly)

Available through requiring rubygems/installer_test_case


54
55
56
# File 'lib/rubygems/installer_test_case.rb', line 54

def security_policy=(value)
  @security_policy = value
end

#wrappers=(value) ⇒ Object (writeonly)

Available through requiring rubygems/installer_test_case


59
60
61
# File 'lib/rubygems/installer_test_case.rb', line 59

def wrappers=(value)
  @wrappers = value
end

Class Method Details

.at(path, options = {}) ⇒ Object

Construct an installer object for the gem file located at path


104
105
106
107
108
# File 'lib/rubygems/installer.rb', line 104

def self.at(path, options = {})
  security_policy = options[:security_policy]
  package = Gem::Package.new path, security_policy
  new package, options
end

.for_spec(spec, options = {}) ⇒ Object

Construct an installer object for an ephemeral gem (one where we don't actually have a .gem file, just a spec)


142
143
144
145
# File 'lib/rubygems/installer.rb', line 142

def self.for_spec(spec, options = {})
  # FIXME: we should have a real Package class for this
  new FakePackage.new(spec), options
end

Instance Method Details

#app_script_text(bin_file_name) ⇒ Object

Return the text for an application file.


762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
# File 'lib/rubygems/installer.rb', line 762

def app_script_text(bin_file_name)
  # note that the `load` lines cannot be indented, as old RG versions match
  # against the beginning of the line
  return <<-TEXT
#{shebang bin_file_name}
#
# This file was generated by RubyGems.
#
# The application '#{spec.name}' is installed as part of a gem, and
# this file is here to facilitate running it.
#

require 'rubygems'

version = "#{Gem::Requirement.default_prerelease}"

str = ARGV.first
if str
str = str.b[/\\A_(.*)_\\z/, 1]
if str and Gem::Version.correct?(str)
  version = str
  ARGV.shift
end
end

if Gem.respond_to?(:activate_bin_path)
load Gem.activate_bin_path('#{spec.name}', '#{bin_file_name}', version)
else
gem #{spec.name.dump}, version
load Gem.bin_path(#{spec.name.dump}, #{bin_file_name.dump}, version)
end
TEXT
end

#build_extensionsObject

Builds extensions. Valid types of extensions are extconf.rb files, configure scripts and rakefiles or mkrf_conf files.


836
837
838
839
840
# File 'lib/rubygems/installer.rb', line 836

def build_extensions
  builder = Gem::Ext::Builder.new spec, @build_args

  builder.build_extensions
end

#check_executable_overwrite(filename) ⇒ Object

Checks if filename exists in @bin_dir.

If @force is set filename is overwritten.

If filename exists and is a RubyGems wrapper for different gem the user is consulted.

If filename exists and @bin_dir is Gem.default_bindir (/usr/local) the user is consulted.

Otherwise filename is overwritten.

Raises:


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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
# File 'lib/rubygems/installer.rb', line 205

def check_executable_overwrite(filename) # :nodoc:
  return if @force

  generated_bin = File.join @bin_dir, formatted_program_filename(filename)

  return unless File.exist? generated_bin

  ruby_executable = false
  existing = nil

  File.open generated_bin, 'rb' do |io|
    next unless io.gets =~ /^#!/ # shebang
    io.gets # blankline

    # TODO detect a specially formatted comment instead of trying
    # to run a regexp against Ruby code.
    next unless io.gets =~ /This file was generated by RubyGems/

    ruby_executable = true
    existing = io.read.slice(%r{
        ^\s*(
          gem \s |
          load \s Gem\.bin_path\( |
          load \s Gem\.activate_bin_path\(
        )
        (['"])(.*?)(\2),
      }x, 3)
  end

  return if spec.name == existing

  # somebody has written to RubyGems' directory, overwrite, too bad
  return if Gem.default_bindir != @bin_dir and not ruby_executable

  question = "#{spec.name}'s executable \"#{filename}\" conflicts with ".dup

  if ruby_executable
    question << (existing || 'an unknown executable')

    return if ask_yes_no "#{question}\nOverwrite the executable?", false

    conflict = "installed executable from #{existing}"
  else
    question << generated_bin

    return if ask_yes_no "#{question}\nOverwrite the executable?", false

    conflict = generated_bin
  end

  raise Gem::InstallError,
    "\"#{filename}\" from #{spec.name} conflicts with #{conflict}"
end

#check_that_user_bin_dir_is_in_pathObject

:nodoc:


704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
# File 'lib/rubygems/installer.rb', line 704

def check_that_user_bin_dir_is_in_path # :nodoc:
  return if self.class.path_warning

  user_bin_dir = @bin_dir || Gem.bindir(gem_home)
  user_bin_dir = user_bin_dir.tr(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR

  path = ENV['PATH']
  path = path.tr(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR

  if Gem.win_platform?
    path = path.downcase
    user_bin_dir = user_bin_dir.downcase
  end

  path = path.split(File::PATH_SEPARATOR)

  unless path.include? user_bin_dir
    unless !Gem.win_platform? && (path.include? user_bin_dir.sub(ENV['HOME'], '~'))
      alert_warning "You don't have #{user_bin_dir} in your PATH,\n\t  gem executables will not run."
      self.class.path_warning = true
    end
  end
end

#default_spec_fileObject

The location of the default spec file for default gems.


435
436
437
# File 'lib/rubygems/installer.rb', line 435

def default_spec_file
  File.join Gem.default_specifications_dir, "#{spec.full_name}.gemspec"
end

#dirObject

Return the target directory where the gem is to be installed. This directory is not guaranteed to be populated.


877
878
879
# File 'lib/rubygems/installer.rb', line 877

def dir
  gem_dir.to_s
end

#ensure_dependencies_metObject

:nodoc:


658
659
660
661
662
663
664
665
# File 'lib/rubygems/installer.rb', line 658

def ensure_dependencies_met # :nodoc:
  deps = spec.runtime_dependencies
  deps |= spec.development_dependencies if @development

  deps.each do |dep_gem|
    ensure_dependency spec, dep_gem
  end
end

#ensure_dependency(spec, dependency) ⇒ Object

Ensure that the dependency is satisfied by the current installation of gem. If it is not an exception is raised.

spec

Gem::Specification

dependency

Gem::Dependency


397
398
399
400
401
402
# File 'lib/rubygems/installer.rb', line 397

def ensure_dependency(spec, dependency)
  unless installation_satisfies_dependency? dependency
    raise Gem::InstallError, "#{spec.name} requires #{dependency}"
  end
  true
end

#ensure_loadable_specObject

Ensures the Gem::Specification written out for this gem is loadable upon installation.


625
626
627
628
629
630
631
632
633
634
635
# File 'lib/rubygems/installer.rb', line 625

def ensure_loadable_spec
  ruby = spec.to_ruby_for_cache
  ruby.tap(&Gem::UNTAINT)

  begin
    eval ruby
  rescue StandardError, SyntaxError => e
    raise Gem::InstallError,
          "The specification for #{spec.full_name} is corrupt (#{e.class})"
  end
end

#ensure_required_ruby_version_metObject

:nodoc:


637
638
639
640
641
642
643
644
645
# File 'lib/rubygems/installer.rb', line 637

def ensure_required_ruby_version_met # :nodoc:
  if rrv = spec.required_ruby_version
    ruby_version = Gem.ruby_version
    unless rrv.satisfied_by? ruby_version
      raise Gem::RuntimeRequirementNotMetError,
        "#{spec.name} requires Ruby version #{rrv}. The current ruby version is #{ruby_version}."
    end
  end
end

#ensure_required_rubygems_version_metObject

:nodoc:


647
648
649
650
651
652
653
654
655
656
# File 'lib/rubygems/installer.rb', line 647

def ensure_required_rubygems_version_met # :nodoc:
  if rrgv = spec.required_rubygems_version
    unless rrgv.satisfied_by? Gem.rubygems_version
      rg_version = Gem::VERSION
      raise Gem::RuntimeRequirementNotMetError,
        "#{spec.name} requires RubyGems version #{rrgv}. The current RubyGems version is #{rg_version}. " +
        "Try 'gem update --system' to update RubyGems itself."
    end
  end
end

#ensure_writable_dir(dir) ⇒ Object

:nodoc:


952
953
954
955
956
957
958
959
960
# File 'lib/rubygems/installer.rb', line 952

def ensure_writable_dir(dir) # :nodoc:
  begin
    Dir.mkdir dir, *[options[:dir_mode] && 0755].compact
  rescue SystemCallError
    raise unless File.directory? dir
  end

  raise Gem::FilePermissionError.new(dir) unless File.writable? dir
end

#extract_binObject

Extracts only the bin/ files from the gem into the gem directory. This is used by default gems to allow a gem-aware stub to function without the full gem installed.


856
857
858
# File 'lib/rubygems/installer.rb', line 856

def extract_bin
  @package.extract_files gem_dir, "#{spec.bindir}/*"
end

#extract_filesObject

Reads the file index and extracts each file into the gem directory.

Ensures that files can't be installed outside the gem directory.


847
848
849
# File 'lib/rubygems/installer.rb', line 847

def extract_files
  @package.extract_files gem_dir
end

#formatted_program_filename(filename) ⇒ Object

Prefix and suffix the program filename the same as ruby.


863
864
865
866
867
868
869
# File 'lib/rubygems/installer.rb', line 863

def formatted_program_filename(filename)
  if @format_executable
    self.class.exec_format % File.basename(filename)
  else
    filename
  end
end

#gemObject

Filename of the gem being installed.


884
885
886
# File 'lib/rubygems/installer.rb', line 884

def gem
  @package.gem.path
end

#generate_binObject

:nodoc:


478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
# File 'lib/rubygems/installer.rb', line 478

def generate_bin # :nodoc:
  return if spec.executables.nil? or spec.executables.empty?

  ensure_writable_dir @bin_dir

  spec.executables.each do |filename|
    filename.tap(&Gem::UNTAINT)
    bin_path = File.join gem_dir, spec.bindir, filename

    unless File.exist? bin_path
      # TODO change this to a more useful warning
      warn "`#{bin_path}` does not exist, maybe `gem pristine #{spec.name}` will fix it?"
      next
    end

    mode = File.stat(bin_path).mode
    dir_mode = options[:prog_mode] || (mode | 0111)
    FileUtils.chmod dir_mode, bin_path unless dir_mode == mode

    check_executable_overwrite filename

    if @wrappers
      generate_bin_script filename, @bin_dir
    else
      generate_bin_symlink filename, @bin_dir
    end
  end
end

#generate_bin_script(filename, bindir) ⇒ Object

Creates the scripts to run the applications in the gem. – The Windows script is generated in addition to the regular one due to a bug or misfeature in the Windows shell's pipe. See blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/193379


527
528
529
530
531
532
533
534
535
536
537
538
539
540
# File 'lib/rubygems/installer.rb', line 527

def generate_bin_script(filename, bindir)
  bin_script_path = File.join bindir, formatted_program_filename(filename)

  FileUtils.rm_f bin_script_path # prior install may have been --no-wrappers

  File.open bin_script_path, 'wb', 0755 do |file|
    file.print app_script_text(filename)
    file.chmod(options[:prog_mode] || 0755)
  end

  verbose bin_script_path

  generate_windows_script filename, bindir
end

Creates the symlinks to run the applications in the gem. Moves the symlink if the gem being installed has a newer version.


546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
# File 'lib/rubygems/installer.rb', line 546

def generate_bin_symlink(filename, bindir)
  src = File.join gem_dir, spec.bindir, filename
  dst = File.join bindir, formatted_program_filename(filename)

  if File.exist? dst
    if File.symlink? dst
      link = File.readlink(dst).split File::SEPARATOR
      cur_version = Gem::Version.create(link[-3].sub(/^.*-/, ''))
      return if spec.version < cur_version
    end
    File.unlink dst
  end

  FileUtils.symlink src, dst, :verbose => Gem.configuration.really_verbose
rescue NotImplementedError, SystemCallError
  alert_warning "Unable to use symlinks, installing wrapper"
  generate_bin_script filename, bindir
end

#generate_pluginsObject

:nodoc:


507
508
509
510
511
512
513
514
515
516
517
518
# File 'lib/rubygems/installer.rb', line 507

def generate_plugins # :nodoc:
  latest = Gem::Installer.install_lock.synchronize { Gem::Specification.latest_spec_for(spec.name) }
  return if latest && latest.version > spec.version

  ensure_writable_dir @plugins_dir

  if spec.plugins.empty?
    remove_plugins_for(spec, @plugins_dir)
  else
    regenerate_plugins_for(spec, @plugins_dir)
  end
end

#generate_windows_script(filename, bindir) ⇒ Object

Creates windows .bat files for easy running of commands


466
467
468
469
470
471
472
473
474
475
476
# File 'lib/rubygems/installer.rb', line 466

def generate_windows_script(filename, bindir)
  if Gem.win_platform?
    script_name = formatted_program_filename(filename) + ".bat"
    script_path = File.join bindir, File.basename(script_name)
    File.open script_path, 'w' do |file|
      file.puts windows_stub_script(bindir, filename)
    end

    verbose script_path
  end
end

#installObject

Installs the gem and returns a loaded Gem::Specification for the installed gem.

The gem will be installed with the following structure:

@gem_home/
  cache/<gem-version>.gem #=> a cached copy of the installed gem
  gems/<gem-version>/... #=> extracted files
  specifications/<gem-version>.gemspec #=> the Gem::Specification

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
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
# File 'lib/rubygems/installer.rb', line 286

def install
  pre_install_checks

  FileUtils.rm_f File.join gem_home, 'specifications', spec.spec_name

  run_pre_install_hooks

  # Set loaded_from to ensure extension_dir is correct
  if @options[:install_as_default]
    spec.loaded_from = default_spec_file
  else
    spec.loaded_from = spec_file
  end

  # Completely remove any previous gem files
  FileUtils.rm_rf gem_dir
  FileUtils.rm_rf spec.extension_dir

  dir_mode = options[:dir_mode]
  FileUtils.mkdir_p gem_dir, :mode => dir_mode && 0755

  if @options[:install_as_default]
    extract_bin
    write_default_spec
  else
    extract_files

    build_extensions
    write_build_info_file
    run_post_build_hooks
  end

  generate_bin
  generate_plugins

  unless @options[:install_as_default]
    write_spec
    write_cache_file
  end

  File.chmod(dir_mode, gem_dir) if dir_mode

  say spec.post_install_message if options[:post_install_message] && !spec.post_install_message.nil?

  Gem::Installer.install_lock.synchronize { Gem::Specification.reset }

  run_post_install_hooks

  spec

# TODO This rescue is in the wrong place. What is raising this exception?
# move this rescue to around the code that actually might raise it.
rescue Zlib::GzipFile::Error
  raise Gem::InstallError, "gzip error installing #{gem}"
end

#installation_satisfies_dependency?(dependency) ⇒ Boolean

True if the gems in the system satisfy dependency.

Returns:

  • (Boolean)

407
408
409
410
411
412
# File 'lib/rubygems/installer.rb', line 407

def installation_satisfies_dependency?(dependency)
  return true if @options[:development] and dependency.type == :development
  return true if installed_specs.detect {|s| dependency.matches_spec? s }
  return false if @only_install_dir
  not dependency.matching_specs.empty?
end

#installed_specsObject

Return an Array of Specifications contained within the gem_home we'll be installing into.


377
378
379
380
381
382
383
384
385
386
387
388
# File 'lib/rubygems/installer.rb', line 377

def installed_specs
  @specs ||= begin
    specs = []

    Gem::Util.glob_files_in_dir("*.gemspec", File.join(gem_home, "specifications")).each do |path|
      spec = Gem::Specification.load path.tap(&Gem::UNTAINT)
      specs << spec if spec
    end

    specs
  end
end

#pre_install_checksObject

Performs various checks before installing the gem such as the install repository is writable and its directories exist, required Ruby and rubygems versions are met and that dependencies are installed.

Version and dependency checks are skipped if this install is forced.

The dependent check will be skipped if the install is ignoring dependencies.


897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
# File 'lib/rubygems/installer.rb', line 897

def pre_install_checks
  verify_gem_home

  # The name and require_paths must be verified first, since it could contain
  # ruby code that would be eval'ed in #ensure_loadable_spec
  verify_spec

  ensure_loadable_spec

  if options[:install_as_default]
    Gem.ensure_default_gem_subdirectories gem_home
  else
    Gem.ensure_gem_subdirectories gem_home
  end

  return true if @force

  ensure_required_ruby_version_met
  ensure_required_rubygems_version_met
  ensure_dependencies_met unless @ignore_dependencies

  true
end

#process_optionsObject

:nodoc:


667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
# File 'lib/rubygems/installer.rb', line 667

def process_options # :nodoc:
  @options = {
    :bin_dir      => nil,
    :env_shebang  => false,
    :force        => false,
    :only_install_dir => false,
    :post_install_message => true,
  }.merge options

  @env_shebang         = options[:env_shebang]
  @force               = options[:force]
  @install_dir         = options[:install_dir]
  @gem_home            = options[:install_dir] || Gem.dir
  @plugins_dir         = Gem.plugindir(@gem_home)
  @ignore_dependencies = options[:ignore_dependencies]
  @format_executable   = options[:format_executable]
  @wrappers            = options[:wrappers]
  @only_install_dir    = options[:only_install_dir]

  # If the user has asked for the gem to be installed in a directory that is
  # the system gem directory, then use the system bin directory, else create
  # (or use) a new bin dir under the gem_home.
  @bin_dir             = options[:bin_dir] || Gem.bindir(gem_home)
  @development         = options[:development]
  @build_root          = options[:build_root]

  @build_args = options[:build_args] || Gem::Command.build_args

  unless @build_root.nil?
    require 'pathname'
    @build_root = Pathname.new(@build_root).expand_path
    @bin_dir = File.join(@build_root, options[:bin_dir] || Gem.bindir(@gem_home))
    @gem_home = File.join(@build_root, @gem_home)
    alert_warning "You build with buildroot.\n  Build root: #{@build_root}\n  Bin dir: #{@bin_dir}\n  Gem home: #{@gem_home}"
  end
end

#run_post_build_hooksObject

:nodoc:


353
354
355
356
357
358
359
360
361
362
363
364
# File 'lib/rubygems/installer.rb', line 353

def run_post_build_hooks # :nodoc:
  Gem.post_build_hooks.each do |hook|
    if hook.call(self) == false
      FileUtils.rm_rf gem_dir

      location = " at #{$1}" if hook.inspect =~ /[ @](.*:\d+)/

      message = "post-build hook#{location} failed for #{spec.full_name}"
      raise Gem::InstallError, message
    end
  end
end

#run_post_install_hooksObject

:nodoc:


366
367
368
369
370
# File 'lib/rubygems/installer.rb', line 366

def run_post_install_hooks # :nodoc:
  Gem.post_install_hooks.each do |hook|
    hook.call self
  end
end

#run_pre_install_hooksObject

:nodoc:


342
343
344
345
346
347
348
349
350
351
# File 'lib/rubygems/installer.rb', line 342

def run_pre_install_hooks # :nodoc:
  Gem.pre_install_hooks.each do |hook|
    if hook.call(self) == false
      location = " at #{$1}" if hook.inspect =~ /[ @](.*:\d+)/

      message = "pre-install hook#{location} failed for #{spec.full_name}"
      raise Gem::InstallError, message
    end
  end
end

#shebang(bin_file_name) ⇒ Object

Generates a #! line for bin_file_name's wrapper copying arguments if necessary.

If the :custom_shebang config is set, then it is used as a template for how to create the shebang used for to run a gem's executables.

The template supports 4 expansions:

$env    the path to the unix env utility
$ruby   the path to the currently running ruby interpreter
$exec   the path to the gem's executable
$name   the name of the gem the executable is for

580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
# File 'lib/rubygems/installer.rb', line 580

def shebang(bin_file_name)
  ruby_name = RbConfig::CONFIG['ruby_install_name'] if @env_shebang
  path = File.join gem_dir, spec.bindir, bin_file_name
  first_line = File.open(path, "rb") {|file| file.gets } || ""

  if first_line.start_with?("#!")
    # Preserve extra words on shebang line, like "-w".  Thanks RPA.
    shebang = first_line.sub(/\A\#!.*?ruby\S*((\s+\S+)+)/, "#!#{Gem.ruby}")
    opts = $1
    shebang.strip! # Avoid nasty ^M issues.
  end

  if which = Gem.configuration[:custom_shebang]
    # replace bin_file_name with "ruby" to avoid endless loops
    which = which.gsub(/ #{bin_file_name}$/," #{RbConfig::CONFIG['ruby_install_name']}")

    which = which.gsub(/\$(\w+)/) do
      case $1
      when "env"
        @env_path ||= ENV_PATHS.find {|env_path| File.executable? env_path }
      when "ruby"
        "#{Gem.ruby}#{opts}"
      when "exec"
        bin_file_name
      when "name"
        spec.name
      end
    end

    "#!#{which}"
  elsif not ruby_name
    "#!#{Gem.ruby}#{opts}"
  elsif opts
    "#!/bin/sh\n'exec' #{ruby_name.dump} '-x' \"$0\" \"[email protected]\"\n#{shebang}"
  else
    # Create a plain shebang line.
    @env_path ||= ENV_PATHS.find {|env_path| File.executable? env_path }
    "#!#{@env_path} #{ruby_name}"
  end
end

#specObject

Lazy accessor for the installer's spec.


269
270
271
272
273
# File 'lib/rubygems/installer.rb', line 269

def spec
  @package.spec
rescue Gem::Package::Error => e
  raise Gem::InstallError, "invalid gem: #{e.message}"
end

#spec_fileObject

The location of the spec file that is installed.


427
428
429
# File 'lib/rubygems/installer.rb', line 427

def spec_file
  File.join gem_home, "specifications", "#{spec.full_name}.gemspec"
end

#unpack(directory) ⇒ Object

Unpacks the gem into the given directory.


417
418
419
420
# File 'lib/rubygems/installer.rb', line 417

def unpack(directory)
  @gem_dir = directory
  extract_files
end

#verify_gem_homeObject

:nodoc:


728
729
730
731
# File 'lib/rubygems/installer.rb', line 728

def verify_gem_home # :nodoc:
  FileUtils.mkdir_p gem_home, :mode => options[:dir_mode] && 0755
  raise Gem::FilePermissionError, gem_home unless File.writable?(gem_home)
end

#verify_specObject


733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
# File 'lib/rubygems/installer.rb', line 733

def verify_spec
  unless spec.name =~ Gem::Specification::VALID_NAME_PATTERN
    raise Gem::InstallError, "#{spec} has an invalid name"
  end

  if spec.raw_require_paths.any?{|path| path =~ /\R/ }
    raise Gem::InstallError, "#{spec} has an invalid require_paths"
  end

  if spec.extensions.any?{|ext| ext =~ /\R/ }
    raise Gem::InstallError, "#{spec} has an invalid extensions"
  end

  unless spec.specification_version.to_s =~ /\A\d+\z/
    raise Gem::InstallError, "#{spec} has an invalid specification_version"
  end

  if spec.dependencies.any? {|dep| dep.type != :runtime && dep.type != :development }
    raise Gem::InstallError, "#{spec} has an invalid dependencies"
  end

  if spec.dependencies.any? {|dep| dep.name =~ /(?:\R|[<>])/ }
    raise Gem::InstallError, "#{spec} has an invalid dependencies"
  end
end

#windows_stub_script(bindir, bin_file_name) ⇒ Object

return the stub script text used to launch the true Ruby script


799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
# File 'lib/rubygems/installer.rb', line 799

def windows_stub_script(bindir, bin_file_name)
  rb_config = RbConfig::CONFIG
  rb_topdir = RbConfig::TOPDIR || File.dirname(rb_config["bindir"])

  # get ruby executable file name from RbConfig
  ruby_exe = "#{rb_config['RUBY_INSTALL_NAME']}#{rb_config['EXEEXT']}"
  ruby_exe = "ruby.exe" if ruby_exe.empty?

  if File.exist?(File.join bindir, ruby_exe)
    # stub & ruby.exe within same folder.  Portable
    <<-TEXT
@ECHO OFF
@"%~dp0#{ruby_exe}" "%~dpn0" %*
    TEXT
  elsif bindir.downcase.start_with? rb_topdir.downcase
    # stub within ruby folder, but not standard bin.  Portable
    require 'pathname'
    from = Pathname.new bindir
    to   = Pathname.new "#{rb_topdir}/bin"
    rel  = to.relative_path_from from
    <<-TEXT
@ECHO OFF
@"%~dp0#{rel}/#{ruby_exe}" "%~dpn0" %*
    TEXT
  else
    # outside ruby folder, maybe -user-install or bundler.  Portable, but ruby
    # is dependent on PATH
    <<-TEXT
@ECHO OFF
@#{ruby_exe} "%~dpn0" %*
    TEXT
  end
end

#write_build_info_fileObject

Writes the file containing the arguments for building this gem's extensions.


925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
# File 'lib/rubygems/installer.rb', line 925

def write_build_info_file
  return if @build_args.empty?

  build_info_dir = File.join gem_home, 'build_info'

  dir_mode = options[:dir_mode]
  FileUtils.mkdir_p build_info_dir, :mode => dir_mode && 0755

  build_info_file = File.join build_info_dir, "#{spec.full_name}.info"

  File.open build_info_file, 'w' do |io|
    @build_args.each do |arg|
      io.puts arg
    end
  end

  File.chmod(dir_mode, build_info_dir) if dir_mode
end

#write_cache_fileObject

Writes the .gem file to the cache directory


947
948
949
950
# File 'lib/rubygems/installer.rb', line 947

def write_cache_file
  cache_file = File.join gem_home, 'cache', spec.file_name
  @package.copy_to cache_file
end

#write_default_specObject

Writes the full .gemspec specification (in Ruby) to the gem home's specifications/default directory.


457
458
459
460
461
# File 'lib/rubygems/installer.rb', line 457

def write_default_spec
  File.open(default_spec_file, "w") do |file|
    file.puts spec.to_ruby
  end
end

#write_specObject

Writes the .gemspec specification (in Ruby) to the gem home's specifications directory.


443
444
445
446
447
448
449
450
451
# File 'lib/rubygems/installer.rb', line 443

def write_spec
  File.open spec_file, 'w' do |file|
    spec.installed_by_version = Gem.rubygems_version

    file.puts spec.to_ruby_for_cache

    file.fsync rescue nil # for filesystems without fsync(2)
  end
end