Class: Gem::Installer

Inherits:
Object
  • Object
show all
Extended by:
Deprecate
Includes:
InstallerUninstallerUtils, UserInteraction
Defined in:
lib/rubygems/installer.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



173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/rubygems/installer.rb', line 173

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

Class Attribute Details

.exec_format ⇒ Object

Defaults to use Ruby’s program prefix and suffix.



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

def exec_format
  @exec_format ||= Gem.default_exec_format
end

Instance Attribute Details

#bin_dir ⇒ Object (readonly)

The directory a gem’s executables will be installed into



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

def bin_dir
  @bin_dir
end

#build_root ⇒ Object (readonly)

:nodoc:



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

def build_root
  @build_root
end

#gem_home ⇒ Object (readonly)

The gem repository the gem will be installed into



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

def gem_home
  @gem_home
end

#options ⇒ Object (readonly)

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



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

def options
  @options
end

#package ⇒ Object (readonly)

The gem package instance.



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

def package
  @package
end

Class Method Details

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

Construct an installer object for the gem file located at path



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

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)



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

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

.inherited(klass) ⇒ Object

Changes in rubygems to lazily loading ‘rubygems/command` (in order to lazily load `optparse` as a side effect) affect bundler’s custom installer which uses ‘Gem::Command` without requiring it (up until bundler 2.2.29). This hook is to compensate for that missing require.

TODO: Remove when rubygems no longer supports running on bundler older than 2.2.29.



79
80
81
82
83
84
85
 
# File 'lib/rubygems/installer.rb', line 79

def inherited(klass)
  if klass.name == "Bundler::RubyGemsGemInstaller"
    require "rubygems/command"
  end

  super(klass)
end

Instance Method Details

#app_script_text(bin_file_name) ⇒ Object

Return the text for an application file.



749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
 
# File 'lib/rubygems/installer.rb', line 749

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
  <<-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'
#{gemdeps_load(spec.name)}
version = "#{Gem::Requirement.default_prerelease}"

str = ARGV.first
if str
str = str.b[/\\A_(.*)_\\z/, 1]
if str and Gem::Version.correct?(str)
  #{explicit_version_requirement(spec.name)}
  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_extensions ⇒ Object

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



841
842
843
844
845
 
# File 'lib/rubygems/installer.rb', line 841

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 it is a RubyGems wrapper for a different gem, then 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:



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
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/rubygems/installer.rb', line 199

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|
    line = io.gets
    shebang = /^#!.*ruby/o

    # TruffleRuby uses a bash prelude in default launchers
    if load_relative_enabled? || RUBY_ENGINE == "truffleruby"
      until line.nil? || shebang.match?(line) do
        line = io.gets
      end
    end

    next unless line&.match?(shebang)

    io.gets # blankline

    # TODO: detect a specially formatted comment instead of trying
    # to find a string inside Ruby code.
    next unless io.gets&.include?("This file was generated by RubyGems")

    ruby_executable = true
    existing = io.read.slice(/
        ^\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 && !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_path(executables) ⇒ Object

:nodoc:



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

def check_that_user_bin_dir_is_in_path(executables) # :nodoc:
  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 (#{executables.join(", ")}) will not run."
    end
  end
end

#default_spec_file ⇒ Object

The location of the default spec file for default gems.



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

def default_spec_file
  File.join gem_home, "specifications", "default", "#{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.



882
883
884
 
# File 'lib/rubygems/installer.rb', line 882

def dir
  gem_dir.to_s
end

#ensure_dependencies_met ⇒ Object

:nodoc:



641
642
643
644
645
646
647
648
 
# File 'lib/rubygems/installer.rb', line 641

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



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

def ensure_dependency(spec, dependency)
  unless installation_satisfies_dependency? dependency
    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.



630
631
632
633
634
635
636
637
638
639
 
# File 'lib/rubygems/installer.rb', line 630

def ensure_loadable_spec
  ruby = spec.to_ruby_for_cache

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

#ensure_writable_dir(dir) ⇒ Object

:nodoc:

Raises:



955
956
957
958
959
960
961
962
963
 
# File 'lib/rubygems/installer.rb', line 955

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

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

#explicit_version_requirement(name) ⇒ Object 



792
793
794
795
796
797
798
799
800
 
# File 'lib/rubygems/installer.rb', line 792

def explicit_version_requirement(name)
  code = "version = str"
  return code unless name == "bundler"

  code += <<-TEXT

  ENV['BUNDLER_VERSION'] = str
TEXT
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.



861
862
863
 
# File 'lib/rubygems/installer.rb', line 861

def extract_bin
  @package.extract_files gem_dir, "#{spec.bindir}/*"
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.



852
853
854
 
# File 'lib/rubygems/installer.rb', line 852

def extract_files
  @package.extract_files gem_dir
end

#formatted_program_filename(filename) ⇒ Object

Prefix and suffix the program filename the same as ruby.



868
869
870
871
872
873
874
 
# File 'lib/rubygems/installer.rb', line 868

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

#gem ⇒ Object

Filename of the gem being installed.



889
890
891
 
# File 'lib/rubygems/installer.rb', line 889

def gem
  @package.gem.path
end

#gem_dir ⇒ Object

Lazy accessor for the spec’s gem directory.



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

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

#gemdeps_load(name) ⇒ Object 



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

def gemdeps_load(name)
  return "" if name == "bundler"

  <<-TEXT

Gem.use_gemdeps
TEXT
end

#generate_bin ⇒ Object

:nodoc:



474
475
476
477
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
506
507
508
 
# File 'lib/rubygems/installer.rb', line 474

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

  if @gem_home == Gem.user_dir
    # If we get here, then one of the following likely happened:
    # - `--user-install` was specified
    # - `Gem::PathSupport#home` fell back to `Gem.user_dir`
    # - GEM_HOME was manually set to `Gem.user_dir`

    check_that_user_bin_dir_is_in_path(executables)
  end

  ensure_writable_dir @bin_dir

  executables.each do |filename|
    bin_path = File.join gem_dir, spec.bindir, filename
    next unless File.exist? bin_path

    mode = File.stat(bin_path).mode
    dir_mode = options[:prog_mode] || (mode | 0o111)

    unless dir_mode == mode
      File.chmod dir_mode, bin_path
    end

    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.ruby-lang.org/ruby-talk/193379



532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
 
# File 'lib/rubygems/installer.rb', line 532

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

  Gem.open_file_with_lock(bin_script_path) do
    require "fileutils"
    FileUtils.rm_f bin_script_path # prior install may have been --no-wrappers

    File.open(bin_script_path, "wb", 0o755) do |file|
      file.write app_script_text(filename)
      file.chmod(options[:prog_mode] || 0o755)
    end
  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.



554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
 
# File 'lib/rubygems/installer.rb', line 554

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

:nodoc:



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

def generate_plugins # :nodoc:
  latest = 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
rescue ArgumentError => e
  raise e, "#{latest.name} #{latest.version} #{spec.name} #{spec.version}: #{e.message}"
end

#generate_windows_script(filename, bindir) ⇒ Object

Creates windows .bat files for easy running of commands



462
463
464
465
466
467
468
469
470
471
472
 
# File 'lib/rubygems/installer.rb', line 462

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

#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



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

def install
  pre_install_checks

  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 && 0o755

  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::Specification.add_spec(spec) unless @install_dir

  load_plugin

  run_post_install_hooks

  spec
rescue Errno::EACCES => e
  # Permission denied - /path/to/foo
  raise Gem::FilePermissionError, e.message.split(" - ").last
end

#installation_satisfies_dependency?(dependency) ⇒ Boolean

True if the gems in the system satisfy dependency.

Returns:

  • (Boolean) 


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

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

#installed_specs ⇒ Object

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



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

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

    Gem::Util.glob_files_in_dir("*.gemspec", File.join(gem_home, "specifications")).each do |path|
      spec = Gem::Specification.load path
      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 if the install is ignoring dependencies.



902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
 
# File 'lib/rubygems/installer.rb', line 902

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_dependencies_met unless @ignore_dependencies

  true
end

#process_options ⇒ Object

:nodoc:



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

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]
  @user_install        = options[:user_install]
  @ignore_dependencies = options[:ignore_dependencies]
  @format_executable   = options[:format_executable]
  @wrappers            = options[:wrappers]
  @only_install_dir    = options[:only_install_dir]

  @bin_dir             = options[:bin_dir]
  @development         = options[:development]
  @build_root          = options[:build_root]

  @build_args = options[:build_args]

  @gem_home = @install_dir || user_install_dir || Gem.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 ||= Gem.bindir(@gem_home)

  @plugins_dir = Gem.plugindir(@gem_home)

  unless @build_root.nil?
    @bin_dir = File.join(@build_root, @bin_dir.gsub(/^[a-zA-Z]:/, ""))
    @gem_home = File.join(@build_root, @gem_home.gsub(/^[a-zA-Z]:/, ""))
    @plugins_dir = File.join(@build_root, @plugins_dir.gsub(/^[a-zA-Z]:/, ""))
    alert_warning "You build with buildroot.\n  Build root: #{@build_root}\n  Bin dir: #{@bin_dir}\n  Gem home: #{@gem_home}\n  Plugins dir: #{@plugins_dir}"
  end
end

#run_post_build_hooks ⇒ Object

:nodoc:



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

def run_post_build_hooks # :nodoc:
  Gem.post_build_hooks.each do |hook|
    next unless 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

#run_post_install_hooks ⇒ Object

:nodoc:



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

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

#run_pre_install_hooks ⇒ Object

:nodoc:



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

def run_pre_install_hooks # :nodoc:
  Gem.pre_install_hooks.each do |hook|
    next unless 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

#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



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
620
621
622
623
624
 
# File 'lib/rubygems/installer.rb', line 588

def shebang(bin_file_name)
  path = File.join gem_dir, spec.bindir, bin_file_name
  first_line = File.open(path, "rb", &: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}$/," #{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 @env_shebang
    # Create a plain shebang line.
    @env_path ||= ENV_PATHS.find {|env_path| File.executable? env_path }
    "#!#{@env_path} #{ruby_install_name}"
  else
    "#{bash_prolog_script}#!#{Gem.ruby}#{opts}"
  end
end

#spec ⇒ Object

Lazy accessor for the installer’s spec.



274
275
276
 
# File 'lib/rubygems/installer.rb', line 274

def spec
  @package.spec
end

#spec_file ⇒ Object

The location of the spec file that is installed.



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

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

#unpack(directory) ⇒ Object

Unpacks the gem into the given directory.



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

def unpack(directory)
  @gem_dir = directory
  extract_files
end

#verify_gem_home ⇒ Object

:nodoc:



712
713
714
 
# File 'lib/rubygems/installer.rb', line 712

def verify_gem_home # :nodoc:
  FileUtils.mkdir_p gem_home, mode: options[:dir_mode] && 0o755
end

#verify_spec ⇒ Object 



716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
 
# File 'lib/rubygems/installer.rb', line 716

def verify_spec
  unless Gem::Specification::VALID_NAME_PATTERN.match?(spec.name)
    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

  if /\R/.match?(spec.platform.to_s)
    raise Gem::InstallError, "#{spec.platform} is an invalid platform"
  end

  unless /\A\d+\z/.match?(spec.specification_version.to_s)
    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



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
832
833
834
835
836
 
# File 'lib/rubygems/installer.rb', line 805

def windows_stub_script(bindir, bin_file_name)
  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_file ⇒ Object

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



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

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 && 0o755

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

Writes the .gem file to the cache directory



950
951
952
953
 
# File 'lib/rubygems/installer.rb', line 950

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.

In contrast to #write_spec, this keeps file lists, so the ‘gem contents` command works.



455
456
457
 
# File 'lib/rubygems/installer.rb', line 455

def write_default_spec
  Gem.write_binary(default_spec_file, spec.to_ruby)
end

#write_spec ⇒ Object

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



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

def write_spec
  spec.installed_by_version = Gem.rubygems_version

  Gem.write_binary(spec_file, spec.to_ruby_for_cache)
end