Class: Gem::Installer
Relationships & Source Files | |
Super Chains via Extension / Inclusion / Inheritance | |
Instance Chain:
|
|
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
%w[/usr/bin/env /bin/env]
Class Attribute Summary
-
.exec_format
rw
Defaults to use Ruby's program prefix and suffix.
-
.exec_format=(value)
rw
Overrides the executable format.
-
.path_warning
rw
True if we've warned about PATH not including bindir
-
.install_lock
readonly
Certain aspects of the install process are not thread-safe.
Class Method Summary
-
.new(gem, options = {}) ⇒ Installer
constructor
Constructs an
Installer
instance that will install the gem located at #gem.
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.
-
#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.
-
#spec
rw
Lazy accessor for the installer's spec.
-
#spec=(value)
rw
Sets the specification for .gem-less installs.
-
#gem
readonly
Filename of the gem being installed.
-
#options
readonly
The options passed when the
Installer
was instantiated. -
#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.
-
#ignore_dependencies=(value)
writeonly
Available through requiring rubygems/installer_test_case.
-
#security_policy=(value)
writeonly
Available through requiring rubygems/installer_test_case.
-
#wrappers=(value)
writeonly
Available through requiring rubygems/installer_test_case.
DefaultUserInteraction - Included
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 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 forbin_file_name
's wrapper copying arguments if necessary. -
#spec_file
The location of of the spec file that is installed.
-
#unpack(directory)
Unpacks the gem into the given directory.
- #verify_spec_name
-
#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.
UserInteraction - Included
#alert | Displays an alert |
#alert_error | Displays an error |
#alert_warning | Displays a warning |
#ask | Asks a |
#ask_for_password | Asks for a password with a |
#ask_yes_no | Asks a yes or no |
#choose_from_list | Asks the user to answer |
#say | Displays the given |
#terminate_interaction | Terminates the RubyGems process with the given |
#verbose | Calls |
DefaultUserInteraction - Included
Constructor Details
.new(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 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
# File 'lib/rubygems/installer.rb', line 125
def initialize(gem, ={}) require 'fileutils' @gem = gem @options = @package = Gem::Package.new @gem @package.security_policy = @security_policy if [:user_install] and not [:unpack] then @gem_home = Gem.user_dir @bin_dir = Gem.bindir gem_home unless [: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.
# File 'lib/rubygems/installer.rb', line 96
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”.
# File 'lib/rubygems/installer.rb', line 93
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.
# File 'lib/rubygems/installer.rb', line 84
attr_reader :install_lock
.path_warning (rw)
True if we've warned about PATH not including Gem.bindir
# File 'lib/rubygems/installer.rb', line 78
attr_accessor :path_warning
Instance Attribute Details
#bin_dir (rw)
The directory a gem's executables will be installed into
# File 'lib/rubygems/installer.rb', line 50
attr_reader :bin_dir
#bin_dir=(value) (rw)
Available through requiring rubygems/installer_test_case
# File 'lib/rubygems/installer_test_case.rb', line 9
attr_writer :bin_dir
#build_args=(value) (writeonly)
Available through requiring rubygems/installer_test_case
# File 'lib/rubygems/installer_test_case.rb', line 14
attr_writer :build_args
#env_shebang=(value) (writeonly)
Available through requiring rubygems/installer_test_case
# File 'lib/rubygems/installer_test_case.rb', line 39
attr_writer :env_shebang
#force=(value) (writeonly)
Available through requiring rubygems/installer_test_case
# File 'lib/rubygems/installer_test_case.rb', line 24
attr_writer :force
#format=(value) (writeonly)
Available through requiring rubygems/installer_test_case
# File 'lib/rubygems/installer_test_case.rb', line 29
attr_writer :format
#format_executable=(value) (writeonly)
Available through requiring rubygems/installer_test_case
# File 'lib/rubygems/installer_test_case.rb', line 49
attr_writer :format_executable
#gem (readonly)
Filename of the gem being installed.
# File 'lib/rubygems/installer.rb', line 45
attr_reader :gem
#gem_dir (rw)
Lazy accessor for the spec's gem directory.
#gem_dir=(value) (rw)
Available through requiring rubygems/installer_test_case
# File 'lib/rubygems/installer_test_case.rb', line 19
attr_writer :gem_dir
#gem_home (rw)
The gem repository the gem will be installed into
# File 'lib/rubygems/installer.rb', line 57
attr_reader :gem_home
#gem_home=(value) (rw)
Available through requiring rubygems/installer_test_case
# File 'lib/rubygems/installer_test_case.rb', line 34
attr_writer :gem_home
#ignore_dependencies=(value) (writeonly)
Available through requiring rubygems/installer_test_case
# File 'lib/rubygems/installer_test_case.rb', line 44
attr_writer :ignore_dependencies
#options (readonly)
The options passed when the Installer
was instantiated.
# File 'lib/rubygems/installer.rb', line 62
attr_reader :
#security_policy=(value) (writeonly)
Available through requiring rubygems/installer_test_case
# File 'lib/rubygems/installer_test_case.rb', line 54
attr_writer :security_policy
#spec (rw)
Lazy accessor for the installer's spec.
# File 'lib/rubygems/installer.rb', line 213
def spec @spec ||= @package.spec rescue Gem::Package::Error => e raise Gem::InstallError, "invalid gem: #{e.}" end
#spec=(value) (rw)
Sets the specification for .gem-less installs.
# File 'lib/rubygems/installer.rb', line 67
attr_writer :spec
#wrappers=(value) (writeonly)
Available through requiring rubygems/installer_test_case
# File 'lib/rubygems/installer_test_case.rb', line 59
attr_writer :wrappers
Instance Method Details
#app_script_text(bin_file_name)
Return the text for an application file.
# File 'lib/rubygems/installer.rb', line 657
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/ and Gem::Version.correct?($1) then version = $1 ARGV.shift end end gem '#{spec.name}', version load Gem.bin_path('#{spec.name}', '#{bin_file_name}', version) TEXT end
#build_extensions
Builds extensions. Valid types of extensions are extconf.rb files, configure scripts and rakefiles or mkrf_conf files.
#default_spec_file
The location of of the default spec file for default gems.
#dir
Return the target directory where the gem is to be installed. This directory is not guaranteed to be populated.
# File 'lib/rubygems/installer.rb', line 756
def dir gem_dir.to_s 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
- dependency
# File 'lib/rubygems/installer.rb', line 328
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.
#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.
# File 'lib/rubygems/installer.rb', line 735
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.
# File 'lib/rubygems/installer.rb', line 726
def extract_files @package.extract_files gem_dir end
#formatted_program_filename(filename)
Prefix and suffix the program filename the same as ruby.
# File 'lib/rubygems/installer.rb', line 742
def formatted_program_filename(filename) if @format_executable then self.class.exec_format % File.basename(filename) else filename end end
#generate_bin_script(filename, bindir)
Creates the scripts to run the applications in the gem.
# File 'lib/rubygems/installer.rb', line 445
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.
# File 'lib/rubygems/installer.rb', line 463
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)
Creates windows .bat
files for easy running of commands
# File 'lib/rubygems/installer.rb', line 396
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
# File 'lib/rubygems/installer.rb', line 230
def install pre_install_checks FileUtils.rm_f File.join gem_home, 'specifications', @spec.spec_name run_pre_install_hooks # Completely remove any previous gem files FileUtils.rm_rf gem_dir FileUtils.mkdir_p gem_dir spec.loaded_from = spec_file if @options[:install_as_default] 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. unless spec. .nil? Gem::Installer.install_lock.synchronize { Gem::Specification.add_spec 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
.
# File 'lib/rubygems/installer.rb', line 338
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.
#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 this install is ignoring dependencies.
# File 'lib/rubygems/installer.rb', line 769
def pre_install_checks verify_gem_home [: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 verify_spec_name if [: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
#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
# File 'lib/rubygems/installer.rb', line 500
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_file
The location of of the spec file that is installed.
#unpack(directory)
Unpacks the gem into the given directory.
# File 'lib/rubygems/installer.rb', line 348
def unpack(directory) @gem_dir = directory extract_files end
#verify_spec_name
# File 'lib/rubygems/installer.rb', line 649
def verify_spec_name return if spec.name =~ Gem::Specification::VALID_NAME_PATTERN raise Gem::InstallError, "#{spec} has an invalid name" end
#windows_stub_script(bindir, bin_file_name)
return the stub script text used to launch the true Ruby script
# File 'lib/rubygems/installer.rb', line 688
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.
# File 'lib/rubygems/installer.rb', line 800
def write_build_info_file return if @build_args.empty? build_info_dir = File.join gem_home, 'build_info' FileUtils.mkdir_p build_info_dir build_info_file = File.join build_info_dir, "#{spec.full_name}.info" open build_info_file, 'w' do |io| @build_args.each do |arg| io.puts arg end end end
#write_cache_file
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.
# File 'lib/rubygems/installer.rb', line 387
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.
# File 'lib/rubygems/installer.rb', line 373
def write_spec open spec_file, 'w' do |file| spec.installed_by_version = Gem.rubygems_version file.puts spec.to_ruby_for_cache file.fsync rescue nil # for filesystems without fsync(2) end end