Class: Gem::Installer
- Inherits:
-
Object
- Object
- Gem::Installer
- Includes:
- RequirePathsBuilder, UserInteraction
- Defined in:
- lib/rubygems/installer.rb,
lib/rubygems/installer_test_case.rb
Overview
The installer class processes RubyGem .gem files and installs the files contained in the .gem into the Gem.path.
Gem::Installer does the work of putting files in all the right places on the filesystem including unpacking the gem into its gem dir, installing the gemspec in the specifications dir, storing the cached gem in the cache dir, and installing either wrappers or symlinks for executables.
The installer invokes pre and post install hooks. Hooks can be added either through a rubygems_plugin.rb file in an installed gem or via a rubygems/defaults/#RUBY_ENGINE.rb or rubygems/defaults/operating_system.rb file. See Gem.pre_install and Gem.post_install for details.
Defined Under Namespace
Classes: ExtensionBuildError
Constant Summary collapse
- ENV_PATHS =
Paths where env(1) might live. Some systems are broken and have it in /bin
%w[/usr/bin/env /bin/env]
Class Attribute Summary collapse
-
.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.
-
#env_shebang ⇒ Object
writeonly
Available through requiring rubygems/installer_test_case.
-
#format ⇒ Object
Lazy accessor for the installer’s Gem::Format instance.
-
#format_executable ⇒ Object
writeonly
Available through requiring rubygems/installer_test_case.
-
#gem ⇒ Object
readonly
Returns the value of attribute gem.
-
#gem_dir ⇒ Object
Lazy accessor for the spec’s gem directory.
-
#gem_home ⇒ Object
The gem repository the gem will be installed into.
-
#ignore_dependencies ⇒ Object
writeonly
Available through requiring rubygems/installer_test_case.
-
#options ⇒ Object
readonly
The options passed when the Gem::Installer was instantiated.
-
#security_policy ⇒ Object
writeonly
Available through requiring rubygems/installer_test_case.
-
#spec ⇒ Object
Lazy accessor for the installer’s spec.
-
#wrappers ⇒ Object
writeonly
Available through requiring rubygems/installer_test_case.
Instance Method Summary collapse
-
#app_script_text(bin_file_name) ⇒ Object
Return the text for an application file.
-
#build_extensions ⇒ Object
Builds extensions.
- #check_that_user_bin_dir_is_in_path ⇒ Object
-
#dir ⇒ Object
Return the target directory where the gem is to be installed.
- #ensure_dependencies_met ⇒ Object
-
#ensure_dependency(spec, dependency) ⇒ Object
Ensure that the dependency is satisfied by the current installation of gem.
- #ensure_required_ruby_version_met ⇒ Object
- #ensure_required_rubygems_version_met ⇒ Object
-
#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.
- #generate_bin ⇒ Object
-
#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_windows_script(filename, bindir) ⇒ Object
Creates windows .bat files for easy running of commands.
-
#initialize(gem, options = {}) ⇒ Installer
constructor
Constructs an Installer instance that will install the gem located at
gem
. -
#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 source_index satisfy
dependency
. - #process_options ⇒ Object
-
#shebang(bin_file_name) ⇒ Object
Generates a #! line for
bin_file_name
‘s wrapper copying arguments if necessary. -
#unpack(directory) ⇒ Object
Unpacks the gem into the given directory.
- #verify_gem_home(unpack = false) ⇒ Object
-
#windows_stub_script(bindir, bin_file_name) ⇒ Object
return the stub script text used to launch the true ruby script.
-
#write_spec ⇒ Object
Writes the .gemspec specification (in Ruby) to the gem home’s specifications directory.
Methods included from RequirePathsBuilder
#write_require_paths_file_if_needed
Methods included from UserInteraction
#alert, #alert_error, #alert_warning, #ask, #ask_for_password, #ask_yes_no, #choose_from_list, #say, #terminate_interaction
Methods included from DefaultUserInteraction
ui, #ui, ui=, #ui=, use_ui, #use_ui
Constructor Details
#initialize(gem, options = {}) ⇒ Installer
Constructs an Installer instance that will install the gem located at gem
. options
is a Hash with the following keys:
- :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.
- :ignore_dependencies
-
Don’t raise if a dependency is missing.
- :install_dir
-
The directory to install the gem into.
- :format_executable
-
Format the executable the same as the ruby executable. If your ruby is ruby18, foo_exec will be installed as foo_exec18.
- :security_policy
-
Use the specified security policy. See Gem::Security
- :wrappers
-
Install wrappers if true, symlinks if false.
94 95 96 97 98 99 100 101 102 103 104 105 |
# File 'lib/rubygems/installer.rb', line 94 def initialize(gem, ={}) require 'fileutils' @gem = gem = if [:user_install] and not [:unpack] then @gem_home = 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.
73 74 75 |
# File 'lib/rubygems/installer.rb', line 73 def exec_format @exec_format ||= Gem.default_exec_format end |
.path_warning ⇒ Object
True if we’ve warned about PATH not including Gem.bindir
68 69 70 |
# File 'lib/rubygems/installer.rb', line 68 def path_warning @path_warning end |
Instance Attribute Details
#bin_dir ⇒ Object (readonly)
The directory a gem’s executables will be installed into
49 50 51 |
# File 'lib/rubygems/installer.rb', line 49 def bin_dir @bin_dir end |
#env_shebang=(value) ⇒ Object (writeonly)
Available through requiring rubygems/installer_test_case
24 25 26 |
# File 'lib/rubygems/installer_test_case.rb', line 24 def env_shebang=(value) @env_shebang = value end |
#format ⇒ Object
Lazy accessor for the installer’s Gem::Format instance.
117 118 119 120 121 122 123 |
# File 'lib/rubygems/installer.rb', line 117 def format begin @format ||= Gem::Format.from_file_by_path gem, @security_policy rescue Gem::Package::FormatError raise Gem::InstallError, "invalid gem format for #{gem}" end end |
#format_executable=(value) ⇒ Object (writeonly)
Available through requiring rubygems/installer_test_case
34 35 36 |
# File 'lib/rubygems/installer_test_case.rb', line 34 def format_executable=(value) @format_executable = value end |
#gem ⇒ Object (readonly)
Returns the value of attribute gem.
44 45 46 |
# File 'lib/rubygems/installer.rb', line 44 def gem @gem end |
#gem_dir ⇒ Object
Lazy accessor for the spec’s gem directory.
110 111 112 |
# File 'lib/rubygems/installer.rb', line 110 def gem_dir @gem_dir ||= spec.gem_dir.dup.untaint end |
#gem_home ⇒ Object
The gem repository the gem will be installed into
54 55 56 |
# File 'lib/rubygems/installer.rb', line 54 def gem_home @gem_home end |
#ignore_dependencies=(value) ⇒ Object (writeonly)
Available through requiring rubygems/installer_test_case
29 30 31 |
# File 'lib/rubygems/installer_test_case.rb', line 29 def ignore_dependencies=(value) @ignore_dependencies = value end |
#options ⇒ Object (readonly)
The options passed when the Gem::Installer was instantiated.
59 60 61 |
# File 'lib/rubygems/installer.rb', line 59 def end |
#security_policy=(value) ⇒ Object (writeonly)
Available through requiring rubygems/installer_test_case
39 40 41 |
# File 'lib/rubygems/installer_test_case.rb', line 39 def security_policy=(value) @security_policy = value end |
#spec ⇒ Object
Lazy accessor for the installer’s spec.
128 129 130 |
# File 'lib/rubygems/installer.rb', line 128 def spec @spec ||= format.spec end |
#wrappers=(value) ⇒ Object (writeonly)
Available through requiring rubygems/installer_test_case
49 50 51 |
# File 'lib/rubygems/installer_test_case.rb', line 49 def wrappers=(value) @wrappers = value end |
Instance Method Details
#app_script_text(bin_file_name) ⇒ Object
Return the text for an application file.
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 |
# File 'lib/rubygems/installer.rb', line 455 def app_script_text(bin_file_name) return "\#{shebang bin_file_name}\n#\n# This file was generated by RubyGems.\n#\n# The application '\#{spec.name}' is installed as part of a gem, and\n# this file is here to facilitate running it.\n#\n\nrequire 'rubygems'\n\nversion = \"\#{Gem::Requirement.default}\"\n\nif ARGV.first =~ /^_(.*)_$/ and Gem::Version.correct? $1 then\nversion = $1\nARGV.shift\nend\n\ngem '\#{spec.name}', version\nload Gem.bin_path('\#{spec.name}', '\#{bin_file_name}', version)\n" end |
#build_extensions ⇒ Object
Builds extensions. Valid types of extensions are extconf.rb files, configure scripts and rakefiles or mkrf_conf files.
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 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 |
# File 'lib/rubygems/installer.rb', line 499 def build_extensions return if spec.extensions.empty? say "Building native extensions. This could take a while..." dest_path = File.join gem_dir, spec.require_paths.first ran_rake = false # only run rake once spec.extensions.each do |extension| break if ran_rake results = [] builder = case extension when /extconf/ then Gem::Ext::ExtConfBuilder when /configure/ then Gem::Ext::ConfigureBuilder when /rakefile/i, /mkrf_conf/i then ran_rake = true Gem::Ext::RakeBuilder else results = ["No builder for extension '#{extension}'"] nil end extension_dir = begin File.join gem_dir, File.dirname(extension) rescue TypeError # extension == nil gem_dir end begin Dir.chdir extension_dir do results = builder.build(extension, gem_dir, dest_path, results) say results.join("\n") if Gem.configuration.really_verbose end rescue results = results.join "\n" gem_make_out = File.join extension_dir, 'gem_make.out' open gem_make_out, 'wb' do |io| io.puts results end = "ERROR: Failed to build gem native extension.\n\n \#{results}\n\nGem files will remain installed in \#{gem_dir} for inspection.\nResults logged to \#{gem_make_out}\n" raise ExtensionBuildError, end end end |
#check_that_user_bin_dir_is_in_path ⇒ Object
435 436 437 438 439 440 441 442 443 444 |
# File 'lib/rubygems/installer.rb', line 435 def check_that_user_bin_dir_is_in_path user_bin_dir = @bin_dir || Gem.bindir(gem_home) user_bin_dir.gsub!(File::SEPARATOR, File::ALT_SEPARATOR) if File::ALT_SEPARATOR unless ENV['PATH'].split(File::PATH_SEPARATOR).include? user_bin_dir then unless self.class.path_warning then alert_warning "You don't have #{user_bin_dir} in your PATH,\n\t gem executables will not run." self.class.path_warning = true end end end |
#dir ⇒ Object
Return the target directory where the gem is to be installed. This directory is not guaranteed to be populated.
612 613 614 |
# File 'lib/rubygems/installer.rb', line 612 def dir gem_dir.to_s end |
#ensure_dependencies_met ⇒ Object
403 404 405 406 407 408 409 410 |
# File 'lib/rubygems/installer.rb', line 403 def ensure_dependencies_met deps = spec.runtime_dependencies deps |= spec.development_dependencies if @development deps.each do |dep_gem| ensure_dependency spec, dep_gem end end |
#ensure_dependency(spec, dependency) ⇒ Object
Ensure that the dependency is satisfied by the current installation of gem. If it is not an exception is raised.
- spec
-
Gem::Specification
- dependency
-
Gem::Dependency
230 231 232 233 234 235 |
# File 'lib/rubygems/installer.rb', line 230 def ensure_dependency(spec, dependency) unless installation_satisfies_dependency? dependency then raise Gem::InstallError, "#{spec.name} requires #{dependency}" end true end |
#ensure_required_ruby_version_met ⇒ Object
385 386 387 388 389 390 391 |
# File 'lib/rubygems/installer.rb', line 385 def ensure_required_ruby_version_met if rrv = spec.required_ruby_version then unless rrv.satisfied_by? Gem.ruby_version then raise Gem::InstallError, "#{spec.name} requires Ruby version #{rrv}." end end end |
#ensure_required_rubygems_version_met ⇒ Object
393 394 395 396 397 398 399 400 401 |
# File 'lib/rubygems/installer.rb', line 393 def ensure_required_rubygems_version_met if rrgv = spec.required_rubygems_version then unless rrgv.satisfied_by? Gem::Version.new(Gem::VERSION) then raise Gem::InstallError, "#{spec.name} requires RubyGems version #{rrgv}. " + "Try 'gem update --system' to update RubyGems itself." end end 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.
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 |
# File 'lib/rubygems/installer.rb', line 562 def extract_files raise ArgumentError, "format required to extract from" if @format.nil? @format.file_entries.each do |entry, file_data| path = entry['path'].untaint if path.start_with? "/" then # for extra sanity raise Gem::InstallError, "attempt to install file into #{entry['path']}" end path = File. File.join(gem_dir, path) unless path.start_with? gem_dir then msg = "attempt to install file into %p under %s" % [entry['path'], gem_dir] raise Gem::InstallError, msg end FileUtils.rm_rf(path) if File.exist? path dir = File.dirname path FileUtils.mkdir_p dir unless File.exist? dir File.open(path, "wb") do |out| out.write file_data end FileUtils.chmod entry['mode'], path say path if Gem.configuration.really_verbose end end |
#formatted_program_filename(filename) ⇒ Object
Prefix and suffix the program filename the same as ruby.
598 599 600 601 602 603 604 |
# File 'lib/rubygems/installer.rb', line 598 def formatted_program_filename(filename) if @format_executable then self.class.exec_format % File.basename(filename) else filename end end |
#generate_bin ⇒ Object
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 |
# File 'lib/rubygems/installer.rb', line 280 def generate_bin return if spec.executables.nil? or spec.executables.empty? # 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. bindir = @bin_dir || Gem.bindir(gem_home) Dir.mkdir bindir unless File.exist? bindir raise Gem::FilePermissionError.new(bindir) unless File.writable? bindir spec.executables.each do |filename| filename.untaint bin_path = File. File.join(gem_dir, spec.bindir, filename) unless File.exist? bin_path warn "Hey?!?! Where did #{bin_path} go??" next end mode = File.stat(bin_path).mode | 0111 FileUtils.chmod mode, bin_path if @wrappers then generate_bin_script filename, bindir else generate_bin_symlink filename, bindir end end end |
#generate_bin_script(filename, bindir) ⇒ Object
Creates the scripts to run the applications in the gem. – The Windows script is generated in addition to the regular one due to a bug or misfeature in the Windows shell’s pipe. See blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/193379
318 319 320 321 322 323 324 325 326 327 328 329 330 |
# File 'lib/rubygems/installer.rb', line 318 def generate_bin_script(filename, bindir) bin_script_path = File.join bindir, formatted_program_filename(filename) FileUtils.rm_f bin_script_path # prior install may have been --no-wrappers File.open bin_script_path, 'wb', 0755 do |file| file.print app_script_text(filename) end say bin_script_path if Gem.configuration.really_verbose generate_windows_script filename, bindir end |
#generate_bin_symlink(filename, bindir) ⇒ Object
Creates the symlinks to run the applications in the gem. Moves the symlink if the gem being installed has a newer version.
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 |
# File 'lib/rubygems/installer.rb', line 336 def generate_bin_symlink(filename, bindir) if Gem.win_platform? then alert_warning "Unable to use symlinks on Windows, installing wrapper" generate_bin_script filename, bindir return end src = File.join gem_dir, spec.bindir, filename dst = File.join bindir, formatted_program_filename(filename) if File.exist? dst then if File.symlink? dst then link = File.readlink(dst).split File::SEPARATOR cur_version = Gem::Version.create(link[-3].sub(/^.*-/, '')) return if spec.version < cur_version end File.unlink dst end FileUtils.symlink src, dst, :verbose => Gem.configuration.really_verbose end |
#generate_windows_script(filename, bindir) ⇒ Object
Creates windows .bat files for easy running of commands
268 269 270 271 272 273 274 275 276 277 278 |
# File 'lib/rubygems/installer.rb', line 268 def generate_windows_script(filename, bindir) if Gem.win_platform? then script_name = filename + ".bat" script_path = File.join bindir, File.basename(script_name) File.open script_path, 'w' do |file| file.puts windows_stub_script(bindir, filename) end say script_path if Gem.configuration.really_verbose end end |
#install ⇒ Object
Installs the gem and returns a loaded Gem::Specification for the installed gem.
The gem will be installed with the following structure:
@gem_home/
cache/<gem-version>.gem #=> a cached copy of the installed gem
gems/<gem-version>/... #=> extracted files
specifications/<gem-version>.gemspec #=> the Gem::Specification
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 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 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 |
# File 'lib/rubygems/installer.rb', line 143 def install current_home = Gem.dir current_path = Gem.paths.path verify_gem_home([:unpack]) Gem.use_paths gem_home, current_path # HACK: shouldn't need Gem.paths.path # 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 unless @force ensure_required_ruby_version_met ensure_required_rubygems_version_met ensure_dependencies_met unless @ignore_dependencies end Gem.pre_install_hooks.each do |hook| result = hook.call self if result == false then location = " at #{$1}" if hook.inspect =~ /@(.*:\d+)/ = "pre-install hook#{location} failed for #{spec.full_name}" raise Gem::InstallError, end end Gem.ensure_gem_subdirectories gem_home # Completely remove any previous gem files FileUtils.rm_rf(gem_dir) if File.exist? gem_dir FileUtils.mkdir_p gem_dir extract_files build_extensions Gem.post_build_hooks.each do |hook| result = hook.call self if result == false then 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 generate_bin write_spec write_require_paths_file_if_needed if Gem::QUICKLOADER_SUCKAGE cache_file = spec.cache_file FileUtils.cp gem, cache_file unless File.exist? cache_file say spec. unless spec..nil? spec.loaded_from = spec.spec_file Gem::Specification.add_spec spec unless Gem::Specification.include? spec Gem.post_install_hooks.each do |hook| hook.call self end return spec rescue Zlib::GzipFile::Error raise Gem::InstallError, "gzip error installing #{gem}" ensure # conditional since we might be here because we're erroring out early. if current_path Gem.use_paths current_home, current_path end end |
#installation_satisfies_dependency?(dependency) ⇒ Boolean
True if the gems in the source_index satisfy dependency
.
240 241 242 |
# File 'lib/rubygems/installer.rb', line 240 def installation_satisfies_dependency?(dependency) not dependency.matching_specs.empty? end |
#process_options ⇒ Object
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 |
# File 'lib/rubygems/installer.rb', line 412 def = { :bin_dir => nil, :env_shebang => false, :exec_format => false, :force => false, :install_dir => Gem.dir, }.merge @env_shebang = [:env_shebang] @force = [:force] @gem_home = [:install_dir] @ignore_dependencies = [:ignore_dependencies] @format_executable = [:format_executable] @security_policy = [:security_policy] @wrappers = [:wrappers] @bin_dir = [:bin_dir] @development = [:development] raise "NOTE: Installer option :source_index is dead" if [:source_index] end |
#shebang(bin_file_name) ⇒ Object
Generates a #! line for bin_file_name
‘s wrapper copying arguments if necessary.
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 |
# File 'lib/rubygems/installer.rb', line 362 def shebang(bin_file_name) ruby_name = Gem::ConfigMap[:ruby_install_name] if @env_shebang path = spec.bin_file 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 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 |
#unpack(directory) ⇒ Object
Unpacks the gem into the given directory.
247 248 249 250 251 |
# File 'lib/rubygems/installer.rb', line 247 def unpack(directory) @gem_dir = directory @format = Gem::Format.from_file_by_path gem, @security_policy extract_files end |
#verify_gem_home(unpack = false) ⇒ Object
446 447 448 449 450 |
# File 'lib/rubygems/installer.rb', line 446 def verify_gem_home(unpack = false) FileUtils.mkdir_p gem_home raise Gem::FilePermissionError, gem_home unless unpack or File.writable?(gem_home) end |
#windows_stub_script(bindir, bin_file_name) ⇒ Object
return the stub script text used to launch the true ruby script
482 483 484 485 486 487 488 489 490 491 492 493 |
# File 'lib/rubygems/installer.rb', line 482 def windows_stub_script(bindir, bin_file_name) ruby = File.basename(Gem.ruby).chomp('"') return "@ECHO OFF\nIF NOT \"%~f0\" == \"~f0\" GOTO :WinNT\n@\"\#{ruby}\" \"\#{File.join(bindir, bin_file_name)}\" %1 %2 %3 %4 %5 %6 %7 %8 %9\nGOTO :EOF\n:WinNT\n@\"\#{ruby}\" \"%~dpn0\" %*\n" end |
#write_spec ⇒ Object
Writes the .gemspec specification (in Ruby) to the gem home’s specifications directory.
257 258 259 260 261 262 263 |
# File 'lib/rubygems/installer.rb', line 257 def write_spec file_name = spec.spec_file.untaint File.open(file_name, "w") do |file| file.puts spec.to_ruby_for_cache end end |