class Gem::Installer
Der Installer installiert die Dateien aus der .gem in das Gem.home.
Gem::Installer erledigt die Arbeit, Dateien an den richtigen Stellen im Dateisystem abzulegen, einschließlich des Entpackens des Gems in sein Gem-Verzeichnis, der Installation des Gemspec im Spezifikationsverzeichnis, der Speicherung des gecachten Gems im Cache-Verzeichnis und der Installation von Wrappern oder Symlinks für ausführbare Dateien.
Der Installer ruft vor- und nachgelagerte Hooks auf. Hooks können entweder über eine rubygems_plugin.rb-Datei in einem installierten Gem oder über eine rubygems/defaults/#{RUBY_ENGINE}.rb- oder rubygems/defaults/operating_system.rb-Datei hinzugefügt werden. Siehe Gem.pre_install und Gem.post_install für Details.
Constants
- ENV_PATHS
-
Pfade, unter denen env(1) leben könnte. Einige Systeme sind fehlerhaft und haben es unter /bin
Attribute
Überschreibt das Ausführungsformat.
Dies ist ein sprintf-Format mit einem „%s“, das durch den Namen der ausführbaren Datei ersetzt wird. Es basiert auf der Differenz des Ruby-Executable-Namens zu „ruby“.
Das Verzeichnis, in das ausführbare Dateien eines Gems installiert werden
Das Gem-Repository, in das das Gem installiert wird
Die Optionen, die beim Instanziieren von Gem::Installer übergeben wurden.
Die Gem-Paketinstanz.
Öffentliche Klassenmethoden
Source
# 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
Erstellt ein Installer-Objekt für die Gem-Datei unter path
Source
# File lib/rubygems/installer.rb, line 77 def exec_format @exec_format ||= Gem.default_exec_format end
Standardmäßig wird das Programmpräfix und -suffix von Ruby verwendet.
Source
# 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
Erstellt ein Installer-Objekt für ein temporäres Gem (eines, bei dem wir keine .gem-Datei haben, sondern nur ein Spec)
Source
# 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
Erstellt eine Installer-Instanz, die das Gem unter package installiert, wobei package entweder ein Pfad oder eine Instanz von Gem::Package sein kann. options ist ein Hash mit den folgenden Schlüsseln
- :bin_dir
-
Wo ein Binär-Wrapper platziert werden soll, falls erforderlich.
- :development
-
Ob Entwicklungsabhängigkeiten installiert werden sollen oder nicht.
- :env_shebang
-
Verwendet /usr/bin/env in Binär-Wrappern.
- :force
-
Überschreibt alle Versionsprüfungen und Sicherheitspolitikprüfungen, außer einer Signiert-Gems-nur-Politik.
- :format_executable
-
Formatiert die ausführbare Datei genauso wie die Ruby-ausführbare Datei. Wenn Ihr Ruby ruby18 ist, wird foo_exec als foo_exec18 installiert.
- :ignore_dependencies
-
Keine Ausnahme auslösen, wenn eine Abhängigkeit fehlt.
- :install_dir
-
Das Verzeichnis, in das das Gem installiert werden soll.
- :security_policy
-
Verwendet die angegebene Sicherheitspolitik. Siehe
Gem::Security - :user_install
-
Zeigt an, dass das Gem in das persönliche Gem-Verzeichnis des Benutzers entpackt werden soll.
- :only_install_dir
-
Nur Abhängigkeiten gegen das prüfen, was im install_dir vorhanden ist
- :wrappers
-
Installiert Wrapper, wenn true, Symlinks, wenn false.
- :build_args
-
Ein
Arrayvon Argumenten, die an den Erweiterungs-Builder-Prozess übergeben werden. Wenn nicht gesetzt, wirdGem::Command.build_argsverwendet - :post_install_message
-
Gibt die Nachinstallationsnachricht des Gems aus, wenn true
Öffentliche Instanzmethoden
Source
# 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 <<~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_and_load_bin_path) Gem.activate_and_load_bin_path('#{spec.name}', '#{bin_file_name}', version) else load Gem.activate_bin_path('#{spec.name}', '#{bin_file_name}', version) end TEXT end
Gibt den Text für eine Anwendungsdatei zurück.
Source
# 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
Baut Erweiterungen. Gültige Erweiterungstypen sind extconf.rb-Dateien, Configure-Skripte und Rakefiles oder mkrf_conf-Dateien.
Source
# File lib/rubygems/installer.rb, line 389 def default_spec_dir dir = File.join(gem_home, "specifications", "default") FileUtils.mkdir_p dir dir end
Source
# File lib/rubygems/installer.rb, line 399 def default_spec_file File.join default_spec_dir, "#{spec.full_name}.gemspec" end
Der Speicherort der Standard-Spec-Datei für Standard-Gems.
Source
# File lib/rubygems/installer.rb, line 847 def dir gem_dir.to_s end
Gibt das Zielverzeichnis zurück, in das das Gem installiert werden soll. Dieses Verzeichnis wird nicht garantiert gefüllt.
Source
# 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
Stellt sicher, dass die Abhängigkeit durch die aktuelle Installation des Gems erfüllt wird. Wenn nicht, wird eine Ausnahme ausgelöst.
- spec
- dependency
Source
# 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
Stellt sicher, dass die für dieses Gem geschriebene Gem::Specification nach der Installation geladen werden kann.
Source
# File lib/rubygems/installer.rb, line 757 def explicit_version_requirement(name) code = "version = str" return code unless name == "bundler" code += <<~TEXT ENV['BUNDLER_VERSION'] = str TEXT end
Source
# File lib/rubygems/installer.rb, line 826 def extract_bin @package.extract_files gem_dir, "#{spec.bindir}/*" end
Extrahiert nur die bin/-Dateien aus dem Gem in das Gem-Verzeichnis. Dies wird von Standard-Gems verwendet, um einem Gem-bewussten Stub zu ermöglichen, ohne das vollständige Gem zu funktionieren.
Source
# File lib/rubygems/installer.rb, line 817 def extract_files @package.extract_files gem_dir end
Liest den Dateiindex und extrahiert jede Datei in das Gem-Verzeichnis.
Stellt sicher, dass Dateien nicht außerhalb des Gem-Verzeichnisses installiert werden können.
Source
# 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
Präfix und Suffix des Programmnamens wie bei Ruby.
Source
# File lib/rubygems/installer.rb, line 854 def gem @package.gem.path end
Dateiname des zu installierenden Gems.
Source
# File lib/rubygems/installer.rb, line 246 def gem_dir @gem_dir ||= File.join(gem_home, "gems", spec.full_name) end
Lazy-Accessor für das Gem-Verzeichnis des Specs.
Source
# File lib/rubygems/installer.rb, line 748 def gemdeps_load(name) return "" if name == "bundler" <<~TEXT Gem.use_gemdeps TEXT end
Source
# 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
Erstellt die Skripte zum Ausführen der Anwendungen im Gem.
Source
# 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
Erstellt die Symlinks zum Ausführen der Anwendungen im Gem. Verschiebt den Symlink, wenn das zu installierende Gem eine neuere Version hat.
Source
# 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
Erstellt Windows-.bat-Dateien zum einfachen Ausführen von Befehlen
Source
# 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
Installiert das Gem und gibt eine geladene Gem::Specification für das installierte Gem zurück.
Das Gem wird mit folgender Struktur installiert
@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
Source
# 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
True, wenn die Gems im System die dependency erfüllen.
Source
# 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
Source
# 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
Führt verschiedene Prüfungen vor der Installation des Gems durch, z. B. ob das Installationsverzeichnis beschreibbar ist und seine Verzeichnisse existieren, ob die erforderlichen Ruby- und Rubygems-Versionen erfüllt sind und ob Abhängigkeiten installiert sind.
Versions- und Abhängigkeitsprüfungen werden übersprungen, wenn diese Installation erzwungen wird.
Die Abhängigkeitsprüfung wird übersprungen, wenn die Installation Abhängigkeiten ignoriert.
Source
# 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
Generiert eine !-Zeile für den Wrapper von bin_file_name, wobei Argumente bei Bedarf kopiert werden.
Wenn die Konfiguration :custom_shebang gesetzt ist, wird diese als Vorlage für die Erstellung des Shebangs verwendet, mit dem ausführbare Dateien eines Gems ausgeführt werden.
Die Vorlage unterstützt 4 Erweiterungen
$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
Source
# File lib/rubygems/installer.rb, line 253 def spec @package.spec end
Lazy-Accessor für das Spec des Installers.
Source
# File lib/rubygems/installer.rb, line 385 def spec_file File.join gem_home, "specifications", "#{spec.full_name}.gemspec" end
Der Speicherort der installierten Spec-Datei.
Source
# 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
Source
# 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 <<~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
Gibt den Stub-Skripttext zurück, der zum Starten des eigentlichen Ruby-Skripts verwendet wird
Source
# 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
Schreibt die Datei, die die Argumente für den Build der Erweiterungen dieses Gems enthält.
Source
# 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
Schreibt die .gem-Datei in das Cache-Verzeichnis
Source
# File lib/rubygems/installer.rb, line 420 def write_default_spec Gem.write_binary(default_spec_file, spec.to_ruby) end
Schreibt die vollständige .gemspec-Spezifikation (in Ruby) in das Verzeichnis specifications/default des Gem-Homes.
Im Gegensatz zu write_spec behält dies Dateilisten bei, sodass der Befehl ‚gem contents‘ funktioniert.
Source
# 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
Schreibt die .gemspec-Spezifikation (in Ruby) in das Verzeichnis specifications des Gem-Homes.
Private Instanzmethoden
Source
# File lib/rubygems/installer.rb, line 961 def bash_prolog_script if load_relative_enabled? <<~EOS #!/bin/sh # -*- ruby -*- _=_\\ =begin bindir="${0%/*}" ruby="$bindir/#{ruby_install_name}" if [ ! -f "$ruby" ]; then ruby="#{ruby_install_name}" fi exec "$ruby" "-x" "$0" "$@" =end EOS else "" end end
Source
# File lib/rubygems/installer.rb, line 938 def build_args @build_args ||= begin require_relative "command" Gem::Command.build_args end end
Source
# File lib/rubygems/installer.rb, line 945 def build_jobs @build_jobs ||= Etc.nprocessors + 1 end
Source
# File lib/rubygems/installer.rb, line 981 def load_plugin specs = Gem::Specification.find_all_by_name(spec.name) # If old version already exists, this plugin isn't loaded # immediately. It's for avoiding a case that multiple versions # are loaded at the same time. return unless specs.size == 1 plugin_files = spec.plugins.map do |plugin| File.join(@plugins_dir, "#{spec.name}_plugin#{File.extname(plugin)}") end Gem.load_plugin_files(plugin_files) end
Source
# File lib/rubygems/installer.rb, line 957 def load_relative_enabled? rb_config["LIBRUBY_RELATIVE"] == "yes" end
Source
# File lib/rubygems/installer.rb, line 949 def rb_config Gem.target_rbconfig end
Source
# File lib/rubygems/installer.rb, line 953 def ruby_install_name rb_config["ruby_install_name"] end
Source
# File lib/rubygems/installer.rb, line 925 def user_install_dir # never install to user home in --build-root mode return unless @build_root.nil? # Please note that @user_install might have three states: # * `true`: `--user-install` # * `false`: `--no-user-install` and # * `nil`: option was not specified if @user_install || (@user_install.nil? && Gem.default_user_install) Gem.user_dir end end