Class: Gem::Installer

Relationships & Source Files
Namespace Children
Classes: FakePackage
Super Chains via Extension / Inclusion / Inheritance
Instance Chain: self, UserInteraction, DefaultUserInteraction, Text
Inherits:	Object
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.

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 pre_install and post_install for details.

Constant Summary

ENV_PATHS =

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

# File 'lib/rubygems/installer.rb', line 34
```
%w[/usr/bin/env /bin/env]
```
ExtensionBuildError = Internal use only

Deprecated in favor of Ext::BuildError

# File 'lib/rubygems/installer.rb', line 39
```
Gem::Ext::BuildError
```

Class Attribute Summary

.exec_format rw

Defaults to use Ruby's program prefix and suffix.
.exec_format=(value) rw

Overrides the executable format.
.install_lock readonly

Certain aspects of the install process are not thread-safe.
.path_warning rw

True if we've warned about PATH not including bindir

Class Method Summary

.at(path, options = {})

Construct an installer object for the gem file located at path
.for_spec(spec, options = {})

Construct an installer object for an ephemeral gem (one where we don't actually have a #gem file, just a spec).
.new(package, options = {}) ⇒ Installer constructor

Constructs an Installer instance that will install the gem at package which can either be a path or an instance of Package.

Instance Attribute Summary

#bin_dir rw

The directory a gem's executables will be installed into.
#bin_dir=(value) rw

Available through requiring rubygems/installer_test_case.
#build_args=(value) writeonly

Available through requiring rubygems/installer_test_case.
#env_shebang=(value) writeonly

Available through requiring rubygems/installer_test_case.
#force=(value) writeonly

Available through requiring rubygems/installer_test_case.
#format=(value) writeonly

Available through requiring rubygems/installer_test_case.
#format_executable=(value) writeonly

Available through requiring rubygems/installer_test_case.
#gem readonly

Filename of the gem being installed.
#gem_dir rw

Lazy accessor for the spec's gem directory.
#gem_dir=(value) rw

Available through requiring rubygems/installer_test_case.
#gem_home rw

The gem repository the gem will be installed into.
#gem_home=(value) rw

Available through requiring rubygems/installer_test_case.
#ignore_dependencies=(value) writeonly

Available through requiring rubygems/installer_test_case.
#options readonly

The options passed when the Installer was instantiated.
#security_policy=(value) writeonly

Available through requiring rubygems/installer_test_case.
#wrappers=(value) writeonly

Available through requiring rubygems/installer_test_case.
#build_root readonly Internal use only

DefaultUserInteraction - Included

#ui	See DefaultUserInteraction.ui
#ui=	See DefaultUserInteraction.ui=

Instance Method Summary

#app_script_text(bin_file_name)

Return the text for an application file.
#build_extensions

Builds extensions.
#default_spec_file

The location of the default spec file for default gems.
#dir

Return the target directory where the gem is to be installed.
#ensure_dependency(spec, dependency)

Ensure that the dependency is satisfied by the current installation of gem.
#ensure_loadable_spec

Ensures the Specification written out for this gem is loadable upon installation.
#extract_bin

Extracts only the bin/ files from the gem into the gem directory.
#extract_files

Reads the file index and extracts each file into the gem directory.
#formatted_program_filename(filename)

Prefix and suffix the program filename the same as ruby.
#generate_bin_script(filename, bindir)

Creates the scripts to run the applications in the gem.
#generate_bin_symlink(filename, bindir)

Creates the symlinks to run the applications in the gem.
#generate_windows_script(filename, bindir)

Creates windows .bat files for easy running of commands.
#install

Installs the gem and returns a loaded Specification for the installed gem.
#installation_satisfies_dependency?(dependency) ⇒ Boolean

True if the gems in the system satisfy dependency.
#installed_specs

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

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.
#shebang(bin_file_name)

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

Lazy accessor for the installer's spec.
#spec_file

The location of the spec file that is installed.
#unpack(directory)

Unpacks the gem into the given directory.
#verify_spec
#windows_stub_script(bindir, bin_file_name)

return the stub script text used to launch the true Ruby script.
#write_build_info_file

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

Writes the #gem file to the cache directory.
#write_default_spec

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

Writes the .gemspec specification (in Ruby) to the gem home's specifications directory.
#check_executable_overwrite(filename) Internal use only

Checks if filename exists in @bin_dir.
#check_that_user_bin_dir_is_in_path Internal use only
#ensure_dependencies_met Internal use only
#ensure_required_ruby_version_met Internal use only
#ensure_required_rubygems_version_met Internal use only
#extension_build_error(build_dir, output, backtrace = nil) Internal use only

Logs the build output in build_dir, then raises Ext::BuildError.
#generate_bin Internal use only
#process_options Internal use only
#run_post_build_hooks Internal use only
#run_post_install_hooks Internal use only
#run_pre_install_hooks Internal use only
#verify_gem_home(unpack = false) Internal use only

UserInteraction - Included

#alert	Displays an alert `statement`.
#alert_error	Displays an error `statement` to the error output location.
#alert_warning	Displays a warning `statement` to the warning output location.
#ask	Asks a `question` and returns the answer.
#ask_for_password	Asks for a password with a `prompt`
#ask_yes_no	Asks a yes or no `question`.
#choose_from_list	Asks the user to answer `question` with an answer from the given `list`.
#say	Displays the given `statement` on the standard output (or equivalent).
#terminate_interaction	Terminates the RubyGems process with the given `exit_code`
#verbose	Calls `say` with `msg` or the results of the block if really_verbose is true.

DefaultUserInteraction - Included

#use_ui

See DefaultUserInteraction.use_ui

Text - Included

#clean_text	Remove any non-printable characters and make the text suitable for printing.
#format_text	Wraps `text` to `wrap` characters and optionally indents by `indent` characters.
#levenshtein_distance	This code is based directly on the Text gem implementation Returns a value representing the “cost” of transforming str1 into str2.
#truncate_text, #min3

Constructor Details

.new(package, options = {}) ⇒ `Installer`

Constructs an Installer instance that will install the gem at package which can either be a path or an instance of 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 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

[ GitHub ]

# File 'lib/rubygems/installer.rb', line 163


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 (rw)

Defaults to use Ruby's program prefix and suffix.

[ GitHub ]

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


def exec_format
  @exec_format ||= Gem.default_exec_format
end

.exec_format=(value) (rw)

Overrides the executable format.

This is a sprintf format with a “%s” which will be replaced with the executable name. It is based off the ruby executable name's difference from “ruby”.

[ GitHub ]

# File 'lib/rubygems/installer.rb', line 89


attr_writer :exec_format

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

[ GitHub ]

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


attr_reader :install_lock

.path_warning (rw)

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

[ GitHub ]

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


attr_accessor :path_warning

Class Method Details

.at(path, options = {})

Construct an installer object for the gem file located at Gem.path

[ GitHub ]

# 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 = {})

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

[ GitHub ]

# 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 Attribute Details

#bin_dir (rw)

The directory a gem's executables will be installed into

[ GitHub ]

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


attr_reader :bin_dir

#bin_dir=(value) (rw)

Available through requiring rubygems/installer_test_case

[ GitHub ]

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


attr_writer :bin_dir

#build_args=(value) (writeonly)

Available through requiring rubygems/installer_test_case

[ GitHub ]

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


attr_writer :build_args

#build_root (readonly)

This method is for internal use only.

[ GitHub ]

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


attr_reader :build_root # :nodoc:

#env_shebang=(value) (writeonly)

Available through requiring rubygems/installer_test_case

[ GitHub ]

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


attr_writer :env_shebang

#force=(value) (writeonly)

Available through requiring rubygems/installer_test_case

[ GitHub ]

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


attr_writer :force

#format=(value) (writeonly)

Available through requiring rubygems/installer_test_case

[ GitHub ]

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


attr_writer :format

#format_executable=(value) (writeonly)

Available through requiring rubygems/installer_test_case

[ GitHub ]

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


attr_writer :format_executable

#gem (readonly)

Filename of the gem being installed.

[ GitHub ]

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


attr_reader :gem

#gem_dir (rw)

Lazy accessor for the spec's gem directory.

[ GitHub ]

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


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

#gem_dir=(value) (rw)

Available through requiring rubygems/installer_test_case

[ GitHub ]

# File 'lib/rubygems/installer_test_case.rb', line 21


attr_writer :gem_dir

#gem_home (rw)

The gem repository the gem will be installed into

[ GitHub ]

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


attr_reader :gem_home

#gem_home=(value) (rw)

Available through requiring rubygems/installer_test_case

[ GitHub ]

# File 'lib/rubygems/installer_test_case.rb', line 36


attr_writer :gem_home

#ignore_dependencies=(value) (writeonly)

Available through requiring rubygems/installer_test_case

[ GitHub ]

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


attr_writer :ignore_dependencies

#options (readonly)

The options passed when the Installer was instantiated.

[ GitHub ]

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


attr_reader :options

#security_policy=(value) (writeonly)

Available through requiring rubygems/installer_test_case

[ GitHub ]

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


attr_writer :security_policy

#wrappers=(value) (writeonly)

Available through requiring rubygems/installer_test_case

[ GitHub ]

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


attr_writer :wrappers

Instance Method Details

#app_script_text(bin_file_name)

Return the text for an application file.

[ GitHub ]

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


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

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

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

[ GitHub ]

# File 'lib/rubygems/installer.rb', line 788


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

  builder.build_extensions
end

#check_executable_overwrite(filename)

This method is for internal use only.

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:

(Gem::InstallError)

[ GitHub ]

# 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|
    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 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

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/installer.rb', line 681


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

The location of the default spec file for default gems.

[ GitHub ]

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


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

#dir

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

[ GitHub ]

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


def dir
  gem_dir.to_s
end

#ensure_dependencies_met

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/installer.rb', line 636


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)

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

spec: Specification
dependency: Dependency

[ GitHub ]

# File 'lib/rubygems/installer.rb', line 384


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

#ensure_loadable_spec

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

[ GitHub ]

# File 'lib/rubygems/installer.rb', line 603


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

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/installer.rb', line 615


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

#ensure_required_rubygems_version_met

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/installer.rb', line 625


def ensure_required_rubygems_version_met # :nodoc:
  if rrgv = spec.required_rubygems_version then
    unless rrgv.satisfied_by? Gem.rubygems_version then
      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

#extension_build_error(build_dir, output, backtrace = nil)

This method is for internal use only.

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

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

[ GitHub ]

# File 'lib/rubygems/installer.rb', line 799


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

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.

[ GitHub ]

# File 'lib/rubygems/installer.rb', line 819


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

#extract_files

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

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

[ GitHub ]

# File 'lib/rubygems/installer.rb', line 810


def extract_files
  @package.extract_files gem_dir
end

#formatted_program_filename(filename)

Prefix and suffix the program filename the same as ruby.

[ GitHub ]

# File 'lib/rubygems/installer.rb', line 826


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

#generate_bin

This method is for internal use only.

Raises:

(Gem::FilePermissionError)

[ GitHub ]

# File 'lib/rubygems/installer.rb', line 464


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

  begin
    Dir.mkdir @bin_dir
  rescue SystemCallError
    raise unless File.directory? @bin_dir
  end

  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}` does not exist, 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)

Creates the scripts to run the applications in the gem.

[ GitHub ]

# File 'lib/rubygems/installer.rb', line 506


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)

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

[ GitHub ]

# File 'lib/rubygems/installer.rb', line 524


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)

Creates windows .bat files for easy running of commands

[ GitHub ]

# File 'lib/rubygems/installer.rb', line 452


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

Installs the gem and returns a loaded 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

[ GitHub ]

# File 'lib/rubygems/installer.rb', line 280


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.

[ GitHub ]

# File 'lib/rubygems/installer.rb', line 394


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

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

[ GitHub ]

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


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

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.

[ GitHub ]

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


def pre_install_checks
  verify_gem_home options[:unpack]

  # 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_options

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/installer.rb', line 645


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

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/installer.rb', line 340


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

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/installer.rb', line 353


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

#run_pre_install_hooks

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/installer.rb', line 329


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)

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

[ GitHub ]

# File 'lib/rubygems/installer.rb', line 558


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

Lazy accessor for the installer's spec.

[ GitHub ]

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


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

#spec_file

The location of the spec file that is installed.

[ GitHub ]

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


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

#unpack(directory)

Unpacks the gem into the given directory.

[ GitHub ]

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


def unpack(directory)
  @gem_dir = directory
  extract_files
end

#verify_gem_home(unpack = false)

This method is for internal use only.

Raises:

(Gem::FilePermissionError)

[ GitHub ]

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


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

#verify_spec

[ GitHub ]

# File 'lib/rubygems/installer.rb', line 710


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\n|\r|\n/ }
    raise Gem::InstallError, "#{spec} has an invalid require_paths"
  end

  if spec.extensions.any?{|ext| ext =~ /\r\n|\r|\n/ }
    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 =~ /\r\n|\r|\n/ || dep.name =~ /\r\n|\r|\n/ }
    raise Gem::InstallError, "#{spec} has an invalid dependencies"
  end
end

#windows_stub_script(bindir, bin_file_name)

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

[ GitHub ]

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


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

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

[ GitHub ]

# File 'lib/rubygems/installer.rb', line 881


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"

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

#write_cache_file

Writes the #gem file to the cache directory

[ GitHub ]

# File 'lib/rubygems/installer.rb', line 900


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

#write_default_spec

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

[ GitHub ]

# File 'lib/rubygems/installer.rb', line 443


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

#write_spec

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

[ GitHub ]

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


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

Class: Gem::Installer

Overview

Constant Summary

Class Attribute Summary

Class Method Summary

Instance Attribute Summary

DefaultUserInteraction - Included

Instance Method Summary

UserInteraction - Included

DefaultUserInteraction - Included

Text - Included

Constructor Details

.new(package, options = {}) ⇒ Installer

Class Attribute Details

.exec_format (rw)

.exec_format=(value) (rw)

.install_lock (readonly)

.path_warning (rw)

Class Method Details

.at(path, options = {})

.for_spec(spec, options = {})

Instance Attribute Details

#bin_dir (rw)

#bin_dir=(value) (rw)

#build_args=(value) (writeonly)

#build_root (readonly)

#env_shebang=(value) (writeonly)

#force=(value) (writeonly)

#format=(value) (writeonly)

#format_executable=(value) (writeonly)

#gem (readonly)

#gem_dir (rw)

#gem_dir=(value) (rw)

#gem_home (rw)

#gem_home=(value) (rw)

#ignore_dependencies=(value) (writeonly)

#options (readonly)

#security_policy=(value) (writeonly)

#wrappers=(value) (writeonly)

Instance Method Details

#app_script_text(bin_file_name)

#build_extensions

#check_executable_overwrite(filename)

#check_that_user_bin_dir_is_in_path

#default_spec_file

#dir

#ensure_dependencies_met

#ensure_dependency(spec, dependency)

#ensure_loadable_spec

#ensure_required_ruby_version_met

#ensure_required_rubygems_version_met

#extension_build_error(build_dir, output, backtrace = nil)

#extract_bin

#extract_files

#formatted_program_filename(filename)

#generate_bin

#generate_bin_script(filename, bindir)

#generate_bin_symlink(filename, bindir)

#generate_windows_script(filename, bindir)

#install

#installation_satisfies_dependency?(dependency) ⇒ Boolean

#installed_specs

#pre_install_checks

#process_options

#run_post_build_hooks

#run_post_install_hooks

#run_pre_install_hooks

#shebang(bin_file_name)

#spec

#spec_file

#unpack(directory)

#verify_gem_home(unpack = false)

#verify_spec

#windows_stub_script(bindir, bin_file_name)

#write_build_info_file

#write_cache_file

#write_default_spec

#write_spec

.new(package, options = {}) ⇒ `Installer`

#installation_satisfies_dependency?(dependency) ⇒ `Boolean`