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: ExtensionBuildError

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]

Class Attribute Summary collapse

Instance Attribute 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

Methods included from DefaultUserInteraction

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

Constructor Details

#initialize(gem, 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



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/rubygems/installer.rb', line 101

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

  @gem = gem
  @options = options
  @package = Gem::Package.new @gem

  process_options

  @package.security_policy = @security_policy

  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.



72
73
74
 
# File 'lib/rubygems/installer.rb', line 72

def exec_format
  @exec_format ||= Gem.default_exec_format
end

.path_warning ⇒ Object

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



66
67
68
 
# File 'lib/rubygems/installer.rb', line 66

def path_warning
  @path_warning
end

Instance Attribute Details

#bin_dir ⇒ Object

The directory a gem’s executables will be installed into



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

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

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

DOC: Missing docs or :nodoc:.



42
43
44
 
# File 'lib/rubygems/installer.rb', line 42

def gem
  @gem
end

#gem_dir ⇒ Object

Lazy accessor for the spec’s gem directory.



182
183
184
 
# File 'lib/rubygems/installer.rb', line 182

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



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

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

#options ⇒ Object (readonly)

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



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

def options
  @options
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

#spec ⇒ Object

Lazy accessor for the installer’s spec.



189
190
191
192
193
 
# File 'lib/rubygems/installer.rb', line 189

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

#wrappers=(value) ⇒ Object (writeonly)

Available through requiring rubygems/installer_test_case



64
65
66
 
# File 'lib/rubygems/installer_test_case.rb', line 64

def wrappers=(value)
  @wrappers = value
end

Instance Method Details

#app_script_text(bin_file_name) ⇒ Object

Return the text for an application file.



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
 
# File 'lib/rubygems/installer.rb', line 592

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}"

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

gem '#{spec.name}', version
load Gem.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.



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
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
 
# File 'lib/rubygems/installer.rb', line 639

def build_extensions
  return if spec.extensions.empty?

  if @build_args.empty?
    say "Building native extensions.  This could take a while..."
  else
    say "Building native extensions with: '#{@build_args.join(' ')}'"
    say "This could take a while..."
  end

  dest_path = File.join gem_dir, spec.require_paths.first
  ran_rake = false # only run rake once

  spec.extensions.each do |extension|
    break if ran_rake
    results = []

    extension ||= ""
    extension_dir = File.join gem_dir, File.dirname(extension)

    builder = case extension
              when /extconf/ then
                Gem::Ext::ExtConfBuilder
              when /configure/ then
                Gem::Ext::ConfigureBuilder
              when /rakefile/i, /mkrf_conf/i then
                ran_rake = true
                Gem::Ext::RakeBuilder
              when /CMakeLists.txt/ then
                Gem::Ext::CmakeBuilder
              else
                message = "No builder for extension '#{extension}'"
                extension_build_error extension_dir, message
              end

    begin
      FileUtils.mkdir_p dest_path

      Dir.chdir extension_dir do
        results = builder.build(extension, gem_dir, dest_path,
                                results, @build_args)

        say results.join("\n") if Gem.configuration.really_verbose
      end
    rescue
      extension_build_error(extension_dir, results.join("\n"))
    end
  end
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:



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/rubygems/installer.rb', line 132

def check_executable_overwrite filename # :nodoc:
  return if @force

  generated_bin = File.join @bin_dir, 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(/^gem (['"])(.*?)(\1),/, 2)
  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 "

  if ruby_executable then
    question << existing

    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

DOC: Missing docs or :nodoc:.



563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
 
# File 'lib/rubygems/installer.rb', line 563

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

  unless path.split(File::PATH_SEPARATOR).include? user_bin_dir then
    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

#dir ⇒ Object

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



735
736
737
 
# File 'lib/rubygems/installer.rb', line 735

def dir
  gem_dir.to_s
end

#ensure_dependencies_met ⇒ Object

DOC: Missing docs or :nodoc:.



525
526
527
528
529
530
531
532
 
# File 'lib/rubygems/installer.rb', line 525

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



297
298
299
300
301
302
 
# File 'lib/rubygems/installer.rb', line 297

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.



492
493
494
495
496
497
498
499
500
501
502
 
# File 'lib/rubygems/installer.rb', line 492

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

DOC: Missing docs or :nodoc:.



505
506
507
508
509
510
511
 
# File 'lib/rubygems/installer.rb', line 505

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

DOC: Missing docs or :nodoc:.



514
515
516
517
518
519
520
521
522
 
# File 'lib/rubygems/installer.rb', line 514

def ensure_required_rubygems_version_met
  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) ⇒ Object

Logs the build output in build_dir, then raises ExtensionBuildError.

Raises:



692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
 
# File 'lib/rubygems/installer.rb', line 692

def extension_build_error(build_dir, output)
  gem_make_out = File.join build_dir, 'gem_make.out'

  open gem_make_out, 'wb' do |io| io.puts output end

  message = <<-EOF
ERROR: Failed to build gem native extension.

  #{output}

Gem files will remain installed in #{gem_dir} for inspection.
Results logged to #{gem_make_out}
EOF

  raise ExtensionBuildError, message
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.



714
715
716
 
# File 'lib/rubygems/installer.rb', line 714

def extract_files
  @package.extract_files gem_dir
end

#formatted_program_filename(filename) ⇒ Object

Prefix and suffix the program filename the same as ruby.



721
722
723
724
725
726
727
 
# File 'lib/rubygems/installer.rb', line 721

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

#generate_bin ⇒ Object

DOC: Missing docs or :nodoc:.

Raises:



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/rubygems/installer.rb', line 355

def generate_bin
  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 | 0111
    FileUtils.chmod mode, bin_path

    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



392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/rubygems/installer.rb', line 392

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

  say bin_script_path if Gem.configuration.really_verbose

  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.



410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/rubygems/installer.rb', line 410

def generate_bin_symlink(filename, bindir)
  if Gem.win_platform? then
    alert_warning "Unable to use symlinks on Windows, installing wrapper"
    generate_bin_script filename, bindir
    return
  end

  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
end

#generate_windows_script(filename, bindir) ⇒ Object

Creates windows .bat files for easy running of commands



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

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

    say script_path if Gem.configuration.really_verbose
  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



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
 
# File 'lib/rubygems/installer.rb', line 206

def install
  pre_install_checks

  run_pre_install_hooks

  # Completely remove any previous gem files
  FileUtils.rm_rf gem_dir

  FileUtils.mkdir_p gem_dir

  extract_files

  build_extensions
  write_build_info_file
  run_post_build_hooks

  generate_bin
  write_spec
  write_cache_file

  say spec.post_install_message unless spec.post_install_message.nil?

  spec.loaded_from = spec_file

  Gem::Specification.add_spec spec unless Gem::Specification.include? spec

  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) 


307
308
309
310
311
 
# File 'lib/rubygems/installer.rb', line 307

def installation_satisfies_dependency?(dependency)
  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.



277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/rubygems/installer.rb', line 277

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.



748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
 
# File 'lib/rubygems/installer.rb', line 748

def pre_install_checks
  verify_gem_home options[:unpack]

  # If we're forcing the install then disable security unless the security
  # policy says that we only install signed gems.
  @security_policy = nil if
    @force and @security_policy and not @security_policy.only_signed

  ensure_loadable_spec

  Gem.ensure_gem_subdirectories gem_home

  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

DOC: Missing docs or :nodoc:.



535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
 
# File 'lib/rubygems/installer.rb', line 535

def process_options
  @options = {
    :bin_dir      => nil,
    :env_shebang  => false,
    :force        => false,
    :install_dir  => Gem.dir,
    :only_install_dir => false
  }.merge options

  @env_shebang         = options[:env_shebang]
  @force               = options[:force]
  @gem_home            = options[:install_dir]
  @ignore_dependencies = options[:ignore_dependencies]
  @format_executable   = options[:format_executable]
  @security_policy     = options[:security_policy]
  @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_args          = options[:build_args] || Gem::Command.build_args
end

#run_post_build_hooks ⇒ Object

:nodoc:



253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/rubygems/installer.rb', line 253

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:



266
267
268
269
270
 
# File 'lib/rubygems/installer.rb', line 266

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

#run_pre_install_hooks ⇒ Object

:nodoc:



242
243
244
245
246
247
248
249
250
251
 
# File 'lib/rubygems/installer.rb', line 242

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



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
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
 
# File 'lib/rubygems/installer.rb', line 447

def shebang(bin_file_name)
  ruby_name = Gem::ConfigMap[: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}$/," #{Gem::ConfigMap[: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_file ⇒ Object

The location of of the spec file that is installed.



325
326
327
 
# File 'lib/rubygems/installer.rb', line 325

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

#unpack(directory) ⇒ Object

Unpacks the gem into the given directory.



316
317
318
319
 
# File 'lib/rubygems/installer.rb', line 316

def unpack(directory)
  @gem_dir = directory
  extract_files
end

#verify_gem_home(unpack = false) ⇒ Object

DOC: Missing docs or :nodoc:.

Raises:



583
584
585
586
587
 
# File 'lib/rubygems/installer.rb', line 583

def verify_gem_home(unpack = false)
  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



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

def windows_stub_script(bindir, bin_file_name)
  ruby = File.basename(Gem.ruby).chomp('"')
  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.



773
774
775
776
777
778
779
780
781
 
# File 'lib/rubygems/installer.rb', line 773

def write_build_info_file
  return if @build_args.empty?

  open spec.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



786
787
788
789
790
 
# File 'lib/rubygems/installer.rb', line 786

def write_cache_file
  cache_file = File.join gem_home, 'cache', spec.file_name

  FileUtils.cp @gem, cache_file unless File.exist? cache_file
end

#write_spec ⇒ Object

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



333
334
335
336
337
 
# File 'lib/rubygems/installer.rb', line 333

def write_spec
  File.open(spec_file, "w") do |file|
    file.puts spec.to_ruby_for_cache
  end
end