Class: Gem::Installer
- Inherits:
-
Object
- Object
- Gem::Installer
- 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
-
.exec_format ⇒ Object
Defaults to use Ruby’s program prefix and suffix.
-
.path_warning ⇒ Object
True if we’ve warned about PATH not including Gem.bindir.
Instance Attribute Summary collapse
-
#bin_dir ⇒ Object
readonly
The directory a gem’s executables will be installed into.
-
#build_root ⇒ Object
readonly
:nodoc:.
-
#gem_home ⇒ Object
readonly
The gem repository the gem will be installed into.
-
#options ⇒ Object
readonly
The options passed when the Gem::Installer was instantiated.
-
#package ⇒ Object
readonly
The gem package instance.
Class Method Summary collapse
-
.at(path, options = {}) ⇒ Object
Construct an installer object for the gem file located at
path
. -
.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).
-
.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).
Instance Method Summary collapse
-
#app_script_text(bin_file_name) ⇒ Object
Return the text for an application file.
-
#build_extensions ⇒ Object
Builds extensions.
-
#check_executable_overwrite(filename) ⇒ Object
Checks if
filename
exists in @bin_dir. -
#check_that_user_bin_dir_is_in_path ⇒ Object
:nodoc:.
-
#default_spec_file ⇒ Object
The location of the default spec file for default gems.
-
#dir ⇒ Object
Return the target directory where the gem is to be installed.
-
#ensure_dependencies_met ⇒ Object
:nodoc:.
-
#ensure_dependency(spec, dependency) ⇒ Object
Ensure that the dependency is satisfied by the current installation of gem.
-
#ensure_loadable_spec ⇒ Object
Ensures the Gem::Specification written out for this gem is loadable upon installation.
-
#ensure_writable_dir(dir) ⇒ Object
:nodoc:.
- #explicit_version_requirement(name) ⇒ Object
-
#extract_bin ⇒ Object
Extracts only the bin/ files from the gem into the gem directory.
-
#extract_files ⇒ Object
Reads the file index and extracts each file into the gem directory.
-
#formatted_program_filename(filename) ⇒ Object
Prefix and suffix the program filename the same as ruby.
-
#gem ⇒ Object
Filename of the gem being installed.
-
#gem_dir ⇒ Object
Lazy accessor for the spec’s gem directory.
- #gemdeps_load(name) ⇒ Object
-
#generate_bin ⇒ Object
:nodoc:.
-
#generate_bin_script(filename, bindir) ⇒ Object
Creates the scripts to run the applications in the gem.
-
#generate_bin_symlink(filename, bindir) ⇒ Object
Creates the symlinks to run the applications in the gem.
-
#generate_plugins ⇒ Object
:nodoc:.
-
#generate_windows_script(filename, bindir) ⇒ Object
Creates windows .bat files for easy running of commands.
-
#initialize(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 Gem::Package. -
#install ⇒ Object
Installs the gem and returns a loaded Gem::Specification for the installed gem.
-
#installation_satisfies_dependency?(dependency) ⇒ Boolean
True if the gems in the system satisfy
dependency
. -
#installed_specs ⇒ Object
Return an Array of Specifications contained within the gem_home we’ll be installing into.
-
#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.
-
#process_options ⇒ Object
:nodoc:.
-
#run_post_build_hooks ⇒ Object
:nodoc:.
-
#run_post_install_hooks ⇒ Object
:nodoc:.
-
#run_pre_install_hooks ⇒ Object
:nodoc:.
-
#shebang(bin_file_name) ⇒ Object
Generates a #! line for
bin_file_name
‘s wrapper copying arguments if necessary. -
#spec ⇒ Object
Lazy accessor for the installer’s spec.
-
#spec_file ⇒ Object
The location of the spec file that is installed.
-
#unpack(directory) ⇒ Object
Unpacks the gem into the given directory.
-
#verify_gem_home ⇒ Object
:nodoc:.
- #verify_spec ⇒ Object
-
#windows_stub_script(bindir, bin_file_name) ⇒ Object
return the stub script text used to launch the true Ruby script.
-
#write_build_info_file ⇒ Object
Writes the file containing the arguments for building this gem’s extensions.
-
#write_cache_file ⇒ Object
Writes the .gem file to the cache directory.
-
#write_default_spec ⇒ Object
Writes the full .gemspec specification (in Ruby) to the gem home’s specifications/default directory.
-
#write_spec ⇒ Object
Writes the .gemspec specification (in Ruby) to the gem home’s specifications directory.
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
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 |
# File 'lib/rubygems/installer.rb', line 180 def initialize(package, ={}) require "fileutils" @options = @package = package @package.dir_mode = [:dir_mode] @package.prog_mode = [:prog_mode] @package.data_mode = [:data_mode] if [:user_install] @gem_home = Gem.user_dir @bin_dir = Gem.bindir gem_home unless [:bin_dir] @plugins_dir = Gem.plugindir(gem_home) end 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 end end |
Class Attribute Details
.exec_format ⇒ Object
Defaults to use Ruby’s program prefix and suffix.
104 105 106 |
# File 'lib/rubygems/installer.rb', line 104 def exec_format @exec_format ||= Gem.default_exec_format end |
.path_warning ⇒ Object
True if we’ve warned about PATH not including Gem.bindir
92 93 94 |
# File 'lib/rubygems/installer.rb', line 92 def path_warning @path_warning 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 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
112 113 114 115 116 |
# File 'lib/rubygems/installer.rb', line 112 def self.at(path, = {}) security_policy = [:security_policy] package = Gem::Package.new path, security_policy new package, 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)
150 151 152 153 |
# File 'lib/rubygems/installer.rb', line 150 def self.for_spec(spec, = {}) # FIXME: we should have a real Package class for this new FakePackage.new(spec), 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.
81 82 83 84 85 86 87 |
# File 'lib/rubygems/installer.rb', line 81 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.
762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 |
# File 'lib/rubygems/installer.rb', line 762 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.
854 855 856 857 858 |
# File 'lib/rubygems/installer.rb', line 854 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.
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 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 |
# File 'lib/rubygems/installer.rb', line 221 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/ if load_relative_enabled? until line.nil? || line =~ shebang 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.to_s.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 ⇒ Object
:nodoc:
700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 |
# File 'lib/rubygems/installer.rb', line 700 def check_that_user_bin_dir_is_in_path # :nodoc: return if self.class.path_warning 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 will not run." self.class.path_warning = true end end end |
#default_spec_file ⇒ Object
The location of the default spec file for default gems.
457 458 459 |
# File 'lib/rubygems/installer.rb', line 457 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.
895 896 897 |
# File 'lib/rubygems/installer.rb', line 895 def dir gem_dir.to_s end |
#ensure_dependencies_met ⇒ Object
:nodoc:
655 656 657 658 659 660 661 662 |
# File 'lib/rubygems/installer.rb', line 655 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
419 420 421 422 423 424 |
# File 'lib/rubygems/installer.rb', line 419 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.
643 644 645 646 647 648 649 650 651 652 653 |
# File 'lib/rubygems/installer.rb', line 643 def ensure_loadable_spec ruby = spec.to_ruby_for_cache ruby.tap(&Gem::UNTAINT) 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:
968 969 970 971 972 973 974 975 976 |
# File 'lib/rubygems/installer.rb', line 968 def ensure_writable_dir(dir) # :nodoc: begin Dir.mkdir dir, *[[: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
805 806 807 808 809 810 811 812 813 |
# File 'lib/rubygems/installer.rb', line 805 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.
874 875 876 |
# File 'lib/rubygems/installer.rb', line 874 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.
865 866 867 |
# File 'lib/rubygems/installer.rb', line 865 def extract_files @package.extract_files gem_dir end |
#formatted_program_filename(filename) ⇒ Object
Prefix and suffix the program filename the same as ruby.
881 882 883 884 885 886 887 |
# File 'lib/rubygems/installer.rb', line 881 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.
902 903 904 |
# File 'lib/rubygems/installer.rb', line 902 def gem @package.gem.path end |
#gem_dir ⇒ Object
Lazy accessor for the spec’s gem directory.
288 289 290 |
# File 'lib/rubygems/installer.rb', line 288 def gem_dir @gem_dir ||= File.join(gem_home, "gems", spec.full_name) end |
#gemdeps_load(name) ⇒ Object
796 797 798 799 800 801 802 803 |
# File 'lib/rubygems/installer.rb', line 796 def gemdeps_load(name) return "" if name == "bundler" <<-TEXT Gem.use_gemdeps TEXT end |
#generate_bin ⇒ Object
:nodoc:
497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 |
# File 'lib/rubygems/installer.rb', line 497 def generate_bin # :nodoc: return if spec.executables.nil? || spec.executables.empty? ensure_writable_dir @bin_dir spec.executables.each do |filename| filename.tap(&Gem::UNTAINT) bin_path = File.join gem_dir, spec.bindir, filename next unless File.exist? bin_path mode = File.stat(bin_path).mode dir_mode = [:prog_mode] || (mode | 0o111) unless dir_mode == mode require "fileutils" FileUtils.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
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 |
# File 'lib/rubygems/installer.rb', line 547 def generate_bin_script(filename, bindir) bin_script_path = File.join bindir, formatted_program_filename(filename) 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.print app_script_text(filename) file.chmod([:prog_mode] || 0o755) 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.
567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 |
# File 'lib/rubygems/installer.rb', line 567 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:
525 526 527 528 529 530 531 532 533 534 535 536 537 538 |
# File 'lib/rubygems/installer.rb', line 525 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.}" end |
#generate_windows_script(filename, bindir) ⇒ Object
Creates windows .bat files for easy running of commands
485 486 487 488 489 490 491 492 493 494 495 |
# File 'lib/rubygems/installer.rb', line 485 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
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 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 |
# File 'lib/rubygems/installer.rb', line 310 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 = [: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. if [:post_install_message] && !spec..nil? Gem::Specification.add_spec(spec) load_plugin 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
.
429 430 431 432 433 434 |
# File 'lib/rubygems/installer.rb', line 429 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.
399 400 401 402 403 404 405 406 407 408 409 410 |
# File 'lib/rubygems/installer.rb', line 399 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.tap(&Gem::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 if the install is ignoring dependencies.
915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 |
# File 'lib/rubygems/installer.rb', line 915 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 [: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:
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 690 691 692 693 694 695 696 697 698 |
# File 'lib/rubygems/installer.rb', line 664 def # :nodoc: @options = { :bin_dir => nil, :env_shebang => false, :force => false, :only_install_dir => false, :post_install_message => true, }.merge @env_shebang = [:env_shebang] @force = [:force] @install_dir = [:install_dir] @gem_home = [:install_dir] || Gem.dir @plugins_dir = Gem.plugindir(@gem_home) @ignore_dependencies = [:ignore_dependencies] @format_executable = [:format_executable] @wrappers = [:wrappers] @only_install_dir = [: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 = [:bin_dir] || Gem.bindir(gem_home) @development = [:development] @build_root = [:build_root] @build_args = [:build_args] 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:
376 377 378 379 380 381 382 383 384 385 386 |
# File 'lib/rubygems/installer.rb', line 376 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+)/ = "post-build hook#{location} failed for #{spec.full_name}" raise Gem::InstallError, end end |
#run_post_install_hooks ⇒ Object
:nodoc:
388 389 390 391 392 |
# File 'lib/rubygems/installer.rb', line 388 def run_post_install_hooks # :nodoc: Gem.post_install_hooks.each do |hook| hook.call self end end |
#run_pre_install_hooks ⇒ Object
:nodoc:
366 367 368 369 370 371 372 373 374 |
# File 'lib/rubygems/installer.rb', line 366 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+)/ = "pre-install hook#{location} failed for #{spec.full_name}" raise Gem::InstallError, 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
601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 |
# File 'lib/rubygems/installer.rb', line 601 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.
295 296 297 |
# File 'lib/rubygems/installer.rb', line 295 def spec @package.spec end |
#spec_file ⇒ Object
The location of the spec file that is installed.
449 450 451 |
# File 'lib/rubygems/installer.rb', line 449 def spec_file File.join gem_home, "specifications", "#{spec.full_name}.gemspec" end |
#unpack(directory) ⇒ Object
Unpacks the gem into the given directory.
439 440 441 442 |
# File 'lib/rubygems/installer.rb', line 439 def unpack(directory) @gem_dir = directory extract_files end |
#verify_gem_home ⇒ Object
:nodoc:
724 725 726 727 |
# File 'lib/rubygems/installer.rb', line 724 def verify_gem_home # :nodoc: FileUtils.mkdir_p gem_home, :mode => [:dir_mode] && 0o755 raise Gem::FilePermissionError, gem_home unless File.writable?(gem_home) end |
#verify_spec ⇒ Object
729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 |
# File 'lib/rubygems/installer.rb', line 729 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
818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 |
# File 'lib/rubygems/installer.rb', line 818 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.
941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 |
# File 'lib/rubygems/installer.rb', line 941 def write_build_info_file return if build_args.empty? build_info_dir = File.join gem_home, "build_info" dir_mode = [: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
963 964 965 966 |
# File 'lib/rubygems/installer.rb', line 963 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.
478 479 480 |
# File 'lib/rubygems/installer.rb', line 478 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.
465 466 467 468 469 |
# File 'lib/rubygems/installer.rb', line 465 def write_spec spec.installed_by_version = Gem.rubygems_version Gem.write_binary(spec_file, spec.to_ruby_for_cache) end |