Class: Gem::Installer

Inherits:
Object
  • Object
show all
Includes:
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]
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 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

Constructor Details

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

Constructs an Installer instance that will install the gem located at gem. 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



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/rubygems/installer.rb', line 161

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

  @options = options
  if package.is_a? String
    security_policy = options[:security_policy]
    @package = Gem::Package.new package, security_policy
    if $VERBOSE
      warn "constructing an Installer object with a string is deprecated. Please use Gem::Installer.at (called from: #{caller.first})"
    end
  else
    @package = package
  end

  process_options

  if options[:user_install] and not options[:unpack] then
    @gem_home = Gem.user_dir
    @bin_dir = Gem.bindir gem_home unless options[:bin_dir]
    check_that_user_bin_dir_is_in_path
  end
end

Class Attribute Details

.exec_format ⇒ Object

Defaults to use Ruby’s program prefix and suffix.



92
93
94
 
# File 'lib/rubygems/installer.rb', line 92

def exec_format
  @exec_format ||= Gem.default_exec_format
end

.install_lock ⇒ Object (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.



80
81
82
 
# File 'lib/rubygems/installer.rb', line 80

def install_lock
  @install_lock
end

.path_warning ⇒ Object

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



74
75
76
 
# File 'lib/rubygems/installer.rb', line 74

def path_warning
  @path_warning
end

Instance Attribute Details

#bin_dir ⇒ Object

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



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

def build_args=(value)
  @build_args = value
end

#build_root ⇒ Object (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



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

def env_shebang=(value)
  @env_shebang = value
end

#force=(value) ⇒ Object (writeonly)

Available through requiring rubygems/installer_test_case



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

def force=(value)
  @force = value
end

#format=(value) ⇒ Object (writeonly)

Available through requiring rubygems/installer_test_case



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

def format=(value)
  @format = value
end

#format_executable=(value) ⇒ Object (writeonly)

Available through requiring rubygems/installer_test_case



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

def format_executable=(value)
  @format_executable = value
end

#gem ⇒ Object (readonly)

Filename of the gem being installed.



46
47
48
 
# File 'lib/rubygems/installer.rb', line 46

def gem
  @gem
end

#gem_dir ⇒ Object

Lazy accessor for the spec’s gem directory.



254
255
256
 
# File 'lib/rubygems/installer.rb', line 254

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

#gem_home ⇒ Object

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



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

def ignore_dependencies=(value)
  @ignore_dependencies = value
end

#options ⇒ Object (readonly)

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



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

def options
  @options
end

#security_policy=(value) ⇒ Object (writeonly)

Available through requiring rubygems/installer_test_case



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

def security_policy=(value)
  @security_policy = value
end

#wrappers=(value) ⇒ Object (writeonly)

Available through requiring rubygems/installer_test_case



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

def wrappers=(value)
  @wrappers = value
end

Class Method Details

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

Construct an installer object for the gem file located at path



101
102
103
104
105
 
# File 'lib/rubygems/installer.rb', line 101

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)



133
134
135
136
 
# File 'lib/rubygems/installer.rb', line 133

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.



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

def app_script_text(bin_file_name)
  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}.a"

if ARGV.first
str = ARGV.first
str = str.dup.force_encoding("BINARY") if str.respond_to? :force_encoding
if str =~ /\\A_(.*)_\\z/ and Gem::Version.correct?($1) then
  version = $1
  ARGV.shift
end
end

load Gem.activate_bin_path('#{spec.name}', '#{bin_file_name}', version)
TEXT
end

#build_extensions ⇒ Object

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



749
750
751
752
753
 
# File 'lib/rubygems/installer.rb', line 749

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:



197
198
199
200
201
202
203
204
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
 
# File 'lib/rubygems/installer.rb', line 197

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

  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{
        ^(
          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 then
    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_path ⇒ Object

:nodoc:



671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
 
# File 'lib/rubygems/installer.rb', line 671

def check_that_user_bin_dir_is_in_path # :nodoc:
  user_bin_dir = @bin_dir || Gem.bindir(gem_home)
  user_bin_dir = user_bin_dir.gsub(File::SEPARATOR, File::ALT_SEPARATOR) if
    File::ALT_SEPARATOR

  path = ENV['PATH']
  if Gem.win_platform? then
    path = path.downcase
    user_bin_dir = user_bin_dir.downcase
  end

  path = path.split(File::PATH_SEPARATOR)

  unless path.include? user_bin_dir then
    unless !Gem.win_platform? && (path.include? user_bin_dir.sub(ENV['HOME'], '~'))
      unless self.class.path_warning then
        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
end

#default_spec_file ⇒ Object

The location of the default spec file for default gems.



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

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

#dir ⇒ Object

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



801
802
803
 
# File 'lib/rubygems/installer.rb', line 801

def dir
  gem_dir.to_s
end

#ensure_dependencies_met ⇒ Object

:nodoc:



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

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



382
383
384
385
386
387
 
# File 'lib/rubygems/installer.rb', line 382

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

#ensure_loadable_spec ⇒ Object

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



596
597
598
599
600
601
602
603
604
605
606
 
# File 'lib/rubygems/installer.rb', line 596

def ensure_loadable_spec
  ruby = spec.to_ruby_for_cache
  ruby.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_met ⇒ Object

:nodoc:



608
609
610
611
612
613
614
 
# File 'lib/rubygems/installer.rb', line 608

def ensure_required_ruby_version_met # :nodoc:
  if rrv = spec.required_ruby_version then
    unless rrv.satisfied_by? Gem.ruby_version then
      raise Gem::InstallError, "#{spec.name} requires Ruby version #{rrv}."
    end
  end
end

#ensure_required_rubygems_version_met ⇒ Object

:nodoc:



616
617
618
619
620
621
622
623
624
 
# File 'lib/rubygems/installer.rb', line 616

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

#extension_build_error(build_dir, output, backtrace = nil) ⇒ Object

Logs the build output in build_dir, then raises Gem::Ext::BuildError.

TODO: Delete this for RubyGems 3. It remains for API compatibility



760
761
762
763
764
 
# File 'lib/rubygems/installer.rb', line 760

def extension_build_error(build_dir, output, backtrace = nil) # :nodoc:
  builder = Gem::Ext::Builder.new spec, @build_args

  builder.build_error build_dir, output, backtrace
end

#extract_bin ⇒ Object

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.



780
781
782
 
# File 'lib/rubygems/installer.rb', line 780

def extract_bin
  @package.extract_files gem_dir, "bin/*"
end

#extract_files ⇒ Object

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

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



771
772
773
 
# File 'lib/rubygems/installer.rb', line 771

def extract_files
  @package.extract_files gem_dir
end

#formatted_program_filename(filename) ⇒ Object

Prefix and suffix the program filename the same as ruby.



787
788
789
790
791
792
793
 
# File 'lib/rubygems/installer.rb', line 787

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

#generate_bin ⇒ Object

:nodoc:

Raises:



462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/rubygems/installer.rb', line 462

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

  Dir.mkdir @bin_dir unless File.exist? @bin_dir
  raise Gem::FilePermissionError.new(@bin_dir) unless File.writable? @bin_dir

  spec.executables.each do |filename|
    filename.untaint
    bin_path = File.join gem_dir, spec.bindir, filename

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

    mode = File.stat(bin_path).mode
    FileUtils.chmod mode | 0111, bin_path unless (mode | 0111) == mode

    check_executable_overwrite filename

    if @wrappers then
      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



499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'lib/rubygems/installer.rb', line 499

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)
  end

  verbose bin_script_path

  generate_windows_script filename, bindir
end

#generate_bin_symlink(filename, bindir) ⇒ Object

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



517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
 
# File 'lib/rubygems/installer.rb', line 517

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 then
    if File.symlink? dst then
      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_windows_script(filename, bindir) ⇒ Object

Creates windows .bat files for easy running of commands



450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/rubygems/installer.rb', line 450

def generate_windows_script(filename, bindir)
  if Gem.win_platform? then
    script_name = 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

#install ⇒ Object

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



278
279
280
281
282
283
284
285
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
 
# File 'lib/rubygems/installer.rb', line 278

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] then
    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

  FileUtils.mkdir_p gem_dir

  if @options[:install_as_default] then
    extract_bin
    write_default_spec
  else
    extract_files

    build_extensions
    write_build_info_file
    run_post_build_hooks

    generate_bin
    write_spec
    write_cache_file
  end

  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) 


392
393
394
395
396
397
 
# File 'lib/rubygems/installer.rb', line 392

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_specs ⇒ Object

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



362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/rubygems/installer.rb', line 362

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

    Dir[File.join(gem_home, "specifications", "*.gemspec")].each do |path|
      spec = Gem::Specification.load path.untaint
      specs << spec if spec
    end

    specs
  end
end

#pre_install_checks ⇒ Object

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 this install is ignoring dependencies.



814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
 
# File 'lib/rubygems/installer.rb', line 814

def pre_install_checks
  verify_gem_home options[:unpack]

  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_options ⇒ Object

:nodoc:



635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
 
# File 'lib/rubygems/installer.rb', line 635

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
  @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_hooks ⇒ Object

:nodoc:



338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/rubygems/installer.rb', line 338

def run_post_build_hooks # :nodoc:
  Gem.post_build_hooks.each do |hook|
    if hook.call(self) == false then
      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_hooks ⇒ Object

:nodoc:



351
352
353
354
355
 
# File 'lib/rubygems/installer.rb', line 351

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

#run_pre_install_hooks ⇒ Object

:nodoc:



327
328
329
330
331
332
333
334
335
336
 
# File 'lib/rubygems/installer.rb', line 327

def run_pre_install_hooks # :nodoc:
  Gem.pre_install_hooks.each do |hook|
    if hook.call(self) == false then
      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



551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
 
# File 'lib/rubygems/installer.rb', line 551

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 /\A#!/ =~ first_line then
    # 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 then
    "#!#{Gem.ruby}#{opts}"
  elsif opts then
    "#!/bin/sh\n'exec' #{ruby_name.dump} '-x' \"$0\" \"$@\"\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

#spec ⇒ Object

Lazy accessor for the installer’s spec.



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

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

#spec_file ⇒ Object

The location of the spec file that is installed.



411
412
413
 
# File 'lib/rubygems/installer.rb', line 411

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

#unpack(directory) ⇒ Object

Unpacks the gem into the given directory.



402
403
404
405
 
# File 'lib/rubygems/installer.rb', line 402

def unpack(directory)
  @gem_dir = directory
  extract_files
end

#verify_gem_home(unpack = false) ⇒ Object

:nodoc:

Raises:



694
695
696
697
698
 
# File 'lib/rubygems/installer.rb', line 694

def verify_gem_home(unpack = false) # :nodoc:
  FileUtils.mkdir_p gem_home
  raise Gem::FilePermissionError, gem_home unless
    unpack or File.writable?(gem_home)
end

#windows_stub_script(bindir, bin_file_name) ⇒ Object

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



733
734
735
736
737
738
739
740
741
742
743
 
# File 'lib/rubygems/installer.rb', line 733

def windows_stub_script(bindir, bin_file_name)
  ruby = Gem.ruby.gsub(/^\"|\"$/, "").tr(File::SEPARATOR, "\\")
  return <<-TEXT
@ECHO OFF
IF NOT "%~f0" == "~f0" GOTO :WinNT
@"#{ruby}" "#{File.join(bindir, bin_file_name)}" %1 %2 %3 %4 %5 %6 %7 %8 %9
GOTO :EOF
:WinNT
@"#{ruby}" "%~dpn0" %*
TEXT
end

#write_build_info_file ⇒ Object

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



838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
 
# File 'lib/rubygems/installer.rb', line 838

def write_build_info_file
  return if @build_args.empty?

  build_info_dir = File.join gem_home, 'build_info'

  FileUtils.mkdir_p build_info_dir

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

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

#write_cache_file ⇒ Object

Writes the .gem file to the cache directory



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

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

#write_default_spec ⇒ Object

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



441
442
443
444
445
 
# File 'lib/rubygems/installer.rb', line 441

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

#write_spec ⇒ Object

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



427
428
429
430
431
432
433
434
435
 
# File 'lib/rubygems/installer.rb', line 427

def write_spec
  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