Class: Gem::Installer

Inherits:
Object show all
Includes:
RequirePathsBuilder, UserInteraction
Defined in:
lib/rubygems/installer.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 fires 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

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)

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Methods included from RequirePathsBuilder

#write_require_paths_file_if_needed

Methods included from UserInteraction

#methname

Methods included from DefaultUserInteraction

ui, #ui, #ui=, ui=, use_ui, #use_ui

Constructor Details

- (Installer) initialize(gem, options = {})

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.

Raises:



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/rubygems/installer.rb', line 91

def initialize(gem, options={})
  require 'fileutils'

  @gem = gem

  options = {
    :bin_dir      => nil,
    :env_shebang  => false,
    :exec_format  => false,
    :force        => false,
    :install_dir  => Gem.dir,
    :source_index => Gem.source_index,
  }.merge options

  @env_shebang         = options[:env_shebang]
  @force               = options[:force]
  gem_home             = options[:install_dir]
  @gem_home            = File.expand_path(gem_home)
  @ignore_dependencies = options[:ignore_dependencies]
  @format_executable   = options[:format_executable]
  @security_policy     = options[:security_policy]
  @wrappers            = options[:wrappers]
  @bin_dir             = options[:bin_dir]
  @development         = options[:development]
  @source_index        = options[:source_index]

  begin
    @format = Gem::Format.from_file_by_path @gem, @security_policy
  rescue Gem::Package::FormatError
    raise Gem::InstallError, "invalid gem format for #{@gem}"
  end

  if options[:user_install] and not options[:unpack] then
    @gem_home = Gem.user_dir

    user_bin_dir = File.join(@gem_home, 'bin')
    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

  FileUtils.mkdir_p @gem_home
  raise Gem::FilePermissionError, @gem_home unless
    options[:unpack] or File.writable? @gem_home

  @spec = @format.spec

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

Class Attribute Details

+ (Object) exec_format

Defaults to use Ruby's program prefix and suffix.



70
71
72
 
# File 'lib/rubygems/installer.rb', line 70

def exec_format
  @exec_format ||= Gem.default_exec_format
end

+ (Object) path_warning

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



65
66
67
 
# File 'lib/rubygems/installer.rb', line 65

def path_warning
  @path_warning
end

Instance Attribute Details

- (Object) bin_dir (readonly)

The directory a gem's executables will be installed into



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

def bin_dir
  @bin_dir
end

- (Object) gem_home (readonly)

The gem repository the gem will be installed into



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

def gem_home
  @gem_home
end

- (Object) spec (readonly)

The Gem::Specification for the gem being installed



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

def spec
  @spec
end

Instance Method Details

- (Object) app_script_text(bin_file_name)

Return the text for an application file.



429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/rubygems/installer.rb', line 429

def app_script_text(bin_file_name)
  <<-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 =~ /^_(.*)_$/ and Gem::Version.correct? $1 then
version = $1
ARGV.shift
end

gem '#{@spec.name}', version
load Gem.bin_path('#{@spec.name}', '#{bin_file_name}', version)
TEXT
end

- (Object) build_extensions

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



471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/rubygems/installer.rb', line 471

def build_extensions
  return if @spec.extensions.empty?
  say "Building native extensions.  This could take a while..."
  start_dir = Dir.pwd
  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

    begin
      Dir.chdir File.join(@gem_dir, File.dirname(extension))
      results = builder.build(extension, @gem_dir, dest_path, results)

      say results.join("\n") if Gem.configuration.really_verbose

    rescue
      results = results.join "\n"

      File.open('gem_make.out', 'wb') { |f| f.puts results }

      message = <<-EOF
ERROR: Failed to build gem native extension.

#{results}

Gem files will remain installed in #{@gem_dir} for inspection.
Results logged to #{File.join(Dir.pwd, 'gem_make.out')}
      EOF

      raise ExtensionBuildError, message
    ensure
      Dir.chdir start_dir
    end
  end
end

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

Gem::Specification

dependency

Gem::Dependency



231
232
233
234
235
236
237
 
# File 'lib/rubygems/installer.rb', line 231

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

  true
end

- (Object) 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.

Raises:

  • (ArgumentError) 


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
556
557
558
559
560
561
562
563
564
565
566
 
# File 'lib/rubygems/installer.rb', line 527

def extract_files
  @gem_dir = File.expand_path @gem_dir

  raise ArgumentError, "format required to extract from" if @format.nil?

  dirs = []

  @format.file_entries.each do |entry, file_data|
    path = entry['path'].untaint

    if path =~ /\A\// then # for extra sanity
      raise Gem::InstallError,
            "attempt to install file into #{entry['path'].inspect}"
    end

    path = File.expand_path File.join(@gem_dir, path)

    if path !~ /\A#{Regexp.escape @gem_dir}/ then
      msg = "attempt to install file into %p under %p" %
              [entry['path'], @gem_dir]
      raise Gem::InstallError, msg
    end

    FileUtils.rm_rf(path) if File.exists?(path)

    dir = File.dirname(path)
    if !dirs.include?(dir)
      dirs << dir
      FileUtils.mkdir_p dir
    end

    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

- (Object) formatted_program_filename(filename)

Prefix and suffix the program filename the same as ruby.



571
572
573
574
575
576
577
 
# File 'lib/rubygems/installer.rb', line 571

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

- (Object) generate_bin

Raises:



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 286

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 ? @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.expand_path "#{@spec.bindir}/#{filename}", @gem_dir
    mode = File.stat(bin_path).mode | 0111
    File.chmod mode, bin_path

    if @wrappers then
      generate_bin_script filename, bindir
    else
      generate_bin_symlink filename, bindir
    end
  end
end

- (Object) generate_bin_script(filename, bindir)

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
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
365
366
367
368
369
370
371
 
# File 'lib/rubygems/installer.rb', line 318

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

  File.join @gem_dir, @spec.bindir, filename

  # HACK some gems don't have #! in their executables, restore 2008/06
  #if File.read(exec_path, 2) == '#!' then
    # XXX MACRUBY do not allow executables to be overriden by a different
    # Ruby implementation
    #FileUtils.rm_f bin_script_path # prior install may have been --no-wrappers

    #File.open bin_script_path, 'w', 0755 do |file|
    bin_script_exists = File.exists?(bin_script_path)
    mode   = 'w' unless(bin_script_exists)
    mode ||= 'r+'
    new_shebang = shebang(filename)
    File.open bin_script_path, mode, 0755 do |file|
      if bin_script_exists
        # If the first line is different than the shebang we want to insert
        # we are probably overwriting a script installed by another ruby
        # implementation / version
        begin
          old_shebang = file.readline.chomp
        rescue
          old_shebang = ""
        end

        if old_shebang != new_shebang
          warn = <<-WARN_MESSAGE
You are installing a new version of #{bin_script_path}.
This file already exists with a different shebang, possibly from a different
ruby implementation or version. This operation may break the script.
WARN_MESSAGE
          alert_warning(warn)
          if !@force && !ask_yes_no("Do you still wish to continue?")
            raise Gem::InstallError, "Could not write #{bin_script_path}"
          end
          say "Overwrote #{bin_script_path}" if Gem.configuration.really_verbose
        end
        file.seek(0)
        file.truncate(0)
      end
      file.print app_script_text(filename)
    end

    say bin_script_path if Gem.configuration.really_verbose

    generate_windows_script filename, bindir
  #else
  #  FileUtils.rm_f bin_script_path
  #  FileUtils.cp exec_path, bin_script_path,
  #               :verbose => Gem.configuration.really_verbose
  #end
end

- (Object) 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.



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/rubygems/installer.rb', line 377

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, 'bin', 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

- (Object) generate_windows_script(filename, bindir)

Creates windows .bat files for easy running of commands



274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/rubygems/installer.rb', line 274

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

- (Object) install

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


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

def install
  # If we're forcing the install then disable security unless the security
  # policy says that we only install singed gems.
  @security_policy = nil if @force and @security_policy and
                            not @security_policy.only_signed

  unless @force then
    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

    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

    unless @ignore_dependencies then
      deps = @spec.runtime_dependencies
      deps |= @spec.development_dependencies if @development

      deps.each do |dep_gem|
        ensure_dependency @spec, dep_gem
      end
    end
  end

  Gem.pre_install_hooks.each do |hook|
    hook.call self
  end

  FileUtils.mkdir_p @gem_home unless File.directory? @gem_home

  Gem.ensure_gem_subdirectories @gem_home

  FileUtils.mkdir_p @gem_dir

  extract_files
  generate_bin
  build_extensions
  write_spec

  write_require_paths_file_if_needed

  # HACK remove?  Isn't this done in multiple places?
  cached_gem = File.join @gem_home, "cache", @gem.split(/\//).pop
  unless File.exist? cached_gem then
    FileUtils.cp @gem, File.join(@gem_home, "cache")
  end

  say @spec.post_install_message unless @spec.post_install_message.nil?

  @spec.loaded_from = File.join(@gem_home, 'specifications', @spec.spec_name)

  @source_index.add_spec @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}"
end

- (Boolean) installation_satisfies_dependency?(dependency)

True if the gems in the source_index satisfy dependency.

Returns:

  • (Boolean) 


242
243
244
 
# File 'lib/rubygems/installer.rb', line 242

def installation_satisfies_dependency?(dependency)
  @source_index.find_name(dependency.name, dependency.requirement).size > 0
end

- (Object) shebang(bin_file_name)

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



403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/rubygems/installer.rb', line 403

def shebang(bin_file_name)
  ruby_name = Gem::ConfigMap[: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 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

- (Object) unpack(directory)

Unpacks the gem into the given directory.



249
250
251
252
253
 
# File 'lib/rubygems/installer.rb', line 249

def unpack(directory)
  @gem_dir = directory
  @format = Gem::Format.from_file_by_path @gem, @security_policy
  extract_files
end

- (Object) windows_stub_script(bindir, bin_file_name)

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



456
457
458
459
460
461
462
463
464
465
 
# File 'lib/rubygems/installer.rb', line 456

def windows_stub_script(bindir, bin_file_name)
  <<-TEXT
@ECHO OFF
IF NOT "%~f0" == "~f0" GOTO :WinNT
@"#{File.basename(Gem.ruby).chomp('"')}" "#{File.join(bindir, bin_file_name)}" %1 %2 %3 %4 %5 %6 %7 %8 %9
GOTO :EOF
:WinNT
@"#{File.basename(Gem.ruby).chomp('"')}" "%~dpn0" %*
TEXT
end

- (Object) write_spec

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



259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/rubygems/installer.rb', line 259

def write_spec
  rubycode = @spec.to_ruby

  file_name = File.join @gem_home, 'specifications', @spec.spec_name

  file_name.untaint

  File.open(file_name, "w") do |file|
    file.puts rubycode
  end
end