Class: Gem::Installer

Inherits:
Object
  • Object
show all
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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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



153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/rubygems/installer.rb', line 153

def initialize(package, options = {})
  require "fileutils"

  @options = options
  @package = package

  process_options

  @package.dir_mode = options[:dir_mode]
  @package.prog_mode = options[:prog_mode]
  @package.data_mode = options[:data_mode]
end

Class Attribute Details

.exec_format ⇒ Object

Defaults to use Ruby’s program prefix and suffix.



77
78
79
 
# File 'lib/rubygems/installer.rb', line 77

def exec_format
  @exec_format ||= Gem.default_exec_format
end

Instance Attribute Details

#bin_dir ⇒ Object (readonly)

The directory a gem’s executables will be installed into



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

def bin_dir
  @bin_dir
end

#build_root ⇒ Object (readonly)

:nodoc:



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

def build_root
  @build_root
end

#gem_home ⇒ Object (readonly)

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

#options ⇒ Object (readonly)

The options passed when the Gem::Installer was instantiated.



59
60
61
 
# File 'lib/rubygems/installer.rb', line 59

def options
  @options
end

#package ⇒ Object (readonly)

The gem package instance.



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

def package
  @package
end

Class Method Details

.at(path, options = {}) ⇒ Object

Construct an installer object for the gem file located at path



85
86
87
88
89
 
# File 'lib/rubygems/installer.rb', line 85

def self.at(path, options = {})
  security_policy = options[:security_policy]
  package = Gem::Package.new path, security_policy
  new package, options
end

.for_spec(spec, options = {}) ⇒ Object

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



123
124
125
126
 
# File 'lib/rubygems/installer.rb', line 123

def self.for_spec(spec, options = {})
  # FIXME: we should have a real Package class for this
  new FakePackage.new(spec), options
end

Instance Method Details

#app_script_text(bin_file_name) ⇒ Object

Return the text for an application file.



715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
 
# File 'lib/rubygems/installer.rb', line 715

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
  "    \#{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\n    require 'rubygems'\n    \#{gemdeps_load(spec.name)}\n    version = \"\#{Gem::Requirement.default_prerelease}\"\n\n    str = ARGV.first\n    if str\n      str = str.b[/\\\\A_(.*)_\\\\z/, 1]\n      if str and Gem::Version.correct?(str)\n        \#{explicit_version_requirement(spec.name)}\n        ARGV.shift\n      end\n    end\n\n    if Gem.respond_to?(:activate_and_load_bin_path)\n      Gem.activate_and_load_bin_path('\#{spec.name}', '\#{bin_file_name}', version)\n    else\n      load Gem.activate_bin_path('\#{spec.name}', '\#{bin_file_name}', version)\n    end\n  TEXT\nend\n"

#build_extensions ⇒ Object

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



806
807
808
809
810
 
# File 'lib/rubygems/installer.rb', line 806

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

  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.

Raises:



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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/rubygems/installer.rb', line 179

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/o

    # TruffleRuby uses a bash prelude in default launchers
    if load_relative_enabled? || RUBY_ENGINE == "truffleruby"
      until line.nil? || shebang.match?(line) 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&.include?("This file was generated by RubyGems")

    ruby_executable = true
    existing = io.read.slice(/
        ^\s*(
          Gem\.activate_and_load_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(executables) ⇒ Object

:nodoc:



657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'lib/rubygems/installer.rb', line 657

def check_that_user_bin_dir_is_in_path(executables) # :nodoc:
  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 (#{executables.join(", ")}) will not run."
    end
  end
end

#default_spec_dir ⇒ Object 



389
390
391
392
393
 
# File 'lib/rubygems/installer.rb', line 389

def default_spec_dir
  dir = File.join(gem_home, "specifications", "default")
  FileUtils.mkdir_p dir
  dir
end

#default_spec_file ⇒ Object

The location of the default spec file for default gems.



399
400
401
 
# File 'lib/rubygems/installer.rb', line 399

def default_spec_file
  File.join default_spec_dir, "#{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.



847
848
849
 
# File 'lib/rubygems/installer.rb', line 847

def dir
  gem_dir.to_s
end

#ensure_dependencies_met ⇒ Object

:nodoc:



606
607
608
609
610
611
612
613
 
# File 'lib/rubygems/installer.rb', line 606

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



364
365
366
367
368
369
 
# File 'lib/rubygems/installer.rb', line 364

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.



595
596
597
598
599
600
601
602
603
604
 
# File 'lib/rubygems/installer.rb', line 595

def ensure_loadable_spec
  ruby = spec.to_ruby_for_cache

  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:

Raises:



916
917
918
919
920
921
 
# File 'lib/rubygems/installer.rb', line 916

def ensure_writable_dir(dir) # :nodoc:
  require "fileutils"
  FileUtils.mkdir_p dir, mode: options[:dir_mode] && 0o755

  raise Gem::FilePermissionError.new(dir) unless File.writable? dir
end

#explicit_version_requirement(name) ⇒ Object 



757
758
759
760
761
762
763
764
765
 
# File 'lib/rubygems/installer.rb', line 757

def explicit_version_requirement(name)
  code = "version = str"
  return code unless name == "bundler"

  code += "\n    ENV['BUNDLER_VERSION'] = str\n  TEXT\nend\n"

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



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

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.



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

def extract_files
  @package.extract_files gem_dir
end

#formatted_program_filename(filename) ⇒ Object

Prefix and suffix the program filename the same as ruby.



833
834
835
836
837
838
839
 
# File 'lib/rubygems/installer.rb', line 833

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.



854
855
856
 
# File 'lib/rubygems/installer.rb', line 854

def gem
  @package.gem.path
end

#gem_dir ⇒ Object

Lazy accessor for the spec’s gem directory.



246
247
248
 
# File 'lib/rubygems/installer.rb', line 246

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

#gemdeps_load(name) ⇒ Object 



748
749
750
751
752
753
754
755
 
# File 'lib/rubygems/installer.rb', line 748

def gemdeps_load(name)
  return "" if name == "bundler"

  "\n    Gem.use_gemdeps\n  TEXT\nend\n"

#generate_bin ⇒ Object

:nodoc:



439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
 
# File 'lib/rubygems/installer.rb', line 439

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

  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(executables)
  end

  ensure_writable_dir @bin_dir

  executables.each do |filename|
    bin_path = File.join gem_dir, spec.bindir, filename
    next unless File.exist? bin_path

    mode = File.stat(bin_path).mode
    dir_mode = options[:prog_mode] || (mode | 0o111)

    unless dir_mode == mode
      File.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



497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
 
# File 'lib/rubygems/installer.rb', line 497

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

  Gem.open_file_with_lock(bin_script_path) do
    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.write app_script_text(filename)
      file.chmod(options[:prog_mode] || 0o755)
    end
  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.



519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/rubygems/installer.rb', line 519

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:



475
476
477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/rubygems/installer.rb', line 475

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.message}"
end

#generate_windows_script(filename, bindir) ⇒ Object

Creates windows .bat files for easy running of commands



427
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/rubygems/installer.rb', line 427

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



268
269
270
271
272
273
274
275
276
277
278
279
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 268

def install
  pre_install_checks

  run_pre_install_hooks

  # Set loaded_from to ensure extension_dir is correct
  spec.loaded_from = spec_file

  # Completely remove any previous gem files
  FileUtils.rm_rf gem_dir
  FileUtils.rm_rf spec.extension_dir

  dir_mode = options[:dir_mode]
  FileUtils.mkdir_p gem_dir, mode: dir_mode && 0o755

  extract_files

  build_extensions
  write_build_info_file
  run_post_build_hooks

  generate_bin
  generate_plugins

  write_spec
  write_cache_file

  File.chmod(dir_mode, gem_dir) if dir_mode

  say spec.post_install_message if options[:post_install_message] && !spec.post_install_message.nil?

  Gem::Specification.add_spec(spec) unless @install_dir

  load_plugin

  run_post_install_hooks

  spec
rescue Errno::EACCES => e
  # Permission denied - /path/to/foo
  raise Gem::FilePermissionError, e.message.split(" - ").last
end

#installation_satisfies_dependency?(dependency) ⇒ Boolean

True if the gems in the system satisfy dependency.

Returns:

  • (Boolean) 


374
375
376
377
378
379
 
# File 'lib/rubygems/installer.rb', line 374

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.



344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/rubygems/installer.rb', line 344

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



867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
 
# File 'lib/rubygems/installer.rb', line 867

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

  Gem.ensure_gem_subdirectories gem_home

  return true if @force

  ensure_dependencies_met unless @ignore_dependencies

  true
end

#process_options ⇒ Object

:nodoc:



615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
 
# File 'lib/rubygems/installer.rb', line 615

def process_options # :nodoc:
  @options = {
    bin_dir: nil,
    env_shebang: false,
    force: false,
    only_install_dir: false,
    post_install_message: true,
  }.merge options

  @env_shebang         = options[:env_shebang]
  @force               = options[:force]
  @install_dir         = options[:install_dir]
  @user_install        = options[:user_install]
  @ignore_dependencies = options[:ignore_dependencies]
  @format_executable   = options[:format_executable]
  @wrappers            = options[:wrappers]
  @only_install_dir    = options[:only_install_dir]

  @bin_dir             = options[:bin_dir]
  @development         = options[:development]
  @build_root          = options[:build_root]

  @build_args = options[:build_args]
  @build_jobs = options[:build_jobs]

  @gem_home = @install_dir || user_install_dir || Gem.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 ||= Gem.bindir(@gem_home)

  @plugins_dir = Gem.plugindir(@gem_home)

  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:



321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/rubygems/installer.rb', line 321

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+)/

    message = "post-build hook#{location} failed for #{spec.full_name}"
    raise Gem::InstallError, message
  end
end

#run_post_install_hooks ⇒ Object

:nodoc:



333
334
335
336
337
 
# File 'lib/rubygems/installer.rb', line 333

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

#run_pre_install_hooks ⇒ Object

:nodoc:



311
312
313
314
315
316
317
318
319
 
# File 'lib/rubygems/installer.rb', line 311

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+)/

    message = "pre-install hook#{location} failed for #{spec.full_name}"
    raise Gem::InstallError, message
  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



553
554
555
556
557
558
559
560
561
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
 
# File 'lib/rubygems/installer.rb', line 553

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.



253
254
255
 
# File 'lib/rubygems/installer.rb', line 253

def spec
  @package.spec
end

#spec_file ⇒ Object

The location of the spec file that is installed.



385
386
387
 
# File 'lib/rubygems/installer.rb', line 385

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

#verify_gem_home ⇒ Object

:nodoc:



678
679
680
 
# File 'lib/rubygems/installer.rb', line 678

def verify_gem_home # :nodoc:
  FileUtils.mkdir_p gem_home, mode: options[:dir_mode] && 0o755
end

#verify_spec ⇒ Object 



682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
 
# File 'lib/rubygems/installer.rb', line 682

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



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
795
796
797
798
799
800
801
 
# File 'lib/rubygems/installer.rb', line 770

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
    "      @ECHO OFF\n      @\"%~dp0\#{ruby_exe}\" \"%~dpn0\" %*\n    TEXT\n  elsif bindir.downcase.start_with? rb_topdir.downcase\n    # stub within ruby folder, but not standard bin.  Portable\n    require \"pathname\"\n    from = Pathname.new bindir\n    to   = Pathname.new \"\#{rb_topdir}/bin\"\n    rel  = to.relative_path_from from\n    <<~TEXT\n      @ECHO OFF\n      @\"%~dp0\#{rel}/\#{ruby_exe}\" \"%~dpn0\" %*\n    TEXT\n  else\n    # outside ruby folder, maybe -user-install or bundler.  Portable, but ruby\n    # is dependent on PATH\n    <<~TEXT\n      @ECHO OFF\n      @\#{ruby_exe} \"%~dpn0\" %*\n    TEXT\n  end\nend\n"

#write_build_info_file ⇒ Object

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



889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
 
# File 'lib/rubygems/installer.rb', line 889

def write_build_info_file
  return if build_args.empty?

  build_info_dir = File.join gem_home, "build_info"

  dir_mode = options[: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



911
912
913
914
 
# File 'lib/rubygems/installer.rb', line 911

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.



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

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.



407
408
409
410
411
 
# File 'lib/rubygems/installer.rb', line 407

def write_spec
  spec.installed_by_version = Gem.rubygems_version

  Gem.write_binary(spec_file, spec.to_ruby_for_cache)
end