модуль Bundler
Bundler обеспечивает согласованную среду для проектов Ruby, отслеживая и устанавливая точные зависимости и версии драгоценных камней.
Начиная с Ruby 2.6, Bundler является частью стандартной библиотеки Ruby.
Bundler используется путём создания файлов gemspec, перечисляющих все зависимости проекта и (необязательно) их версии, а затем с помощью
require 'bundler/setup'
или Bundler.setup для настройки среды, где будут использоваться только указанные драгоценные камни и их определённые версии.
См. веб-сайт Bundler для подробной документации по созданию файлов gemspec и Bundler использования.
В качестве стандартной библиотеки внутри проекта, Bundler может использоваться для интроспекции загруженных и требуемых модулей.
Константы
- ORIGINAL_ENV
- SAFE_MARSHAL_CLASSES
- SAFE_MARSHAL_ERROR
- SAFE_MARSHAL_PROC
- SUDO_MUTEX
Публичные методы класса
# File lib/bundler.rb, line 328 def app_cache(custom_path = nil) path = custom_path || root Pathname.new(path).join(settings.app_cache_path) end
# File lib/bundler.rb, line 314
def app_config_path
if app_config = ENV["BUNDLE_APP_CONFIG"]
app_config_pathname = Pathname.new(app_config)
if app_config_pathname.absolute?
app_config_pathname
else
app_config_pathname.expand_path(root)
end
else
root.join(".bundle")
end
end # File lib/bundler.rb, line 124
def bin_path
@bin_path ||= begin
path = settings[:bin] || "bin"
path = Pathname.new(path).expand_path(root).expand_path
SharedHelpers.filesystem_access(path) {|p| FileUtils.mkdir_p(p) }
path
end
end Возвращает абсолютное расположение, куда установлены binstubs.
# File lib/bundler.rb, line 104 def bundle_path @bundle_path ||= Pathname.new(configured_bundle_path.path).expand_path(root) end
Возвращает абсолютный путь, куда гемы установлены в файловой системе.
# File lib/bundler.rb, line 362
def clean_env
Bundler::SharedHelpers.major_deprecation(
2,
"`Bundler.clean_env` has been deprecated in favor of `Bundler.unbundled_env`. " \
"If you instead want the environment before bundler was originally loaded, use `Bundler.original_env`",
:print_caller_location => true
)
unbundled_env
end @deprecated Используйте ‘unbundled_env` вместо этого
# File lib/bundler.rb, line 449
def clean_exec(*args)
Bundler::SharedHelpers.major_deprecation(
2,
"`Bundler.clean_exec` has been deprecated in favor of `Bundler.unbundled_exec`. " \
"If you instead want to exec to a command in the environment before bundler was originally loaded, use `Bundler.original_exec`",
:print_caller_location => true
)
with_env(unbundled_env) { Kernel.exec(*args) }
end @deprecated Используйте ‘unbundled_exec` вместо этого
# File lib/bundler.rb, line 427
def clean_system(*args)
Bundler::SharedHelpers.major_deprecation(
2,
"`Bundler.clean_system` has been deprecated in favor of `Bundler.unbundled_system`. " \
"If you instead want to run the command in the environment before bundler was originally loaded, use `Bundler.original_system`",
:print_caller_location => true
)
with_env(unbundled_env) { Kernel.system(*args) }
end @deprecated Используйте ‘unbundled_system` вместо этого
# File lib/bundler.rb, line 561
def clear_gemspec_cache
@gemspec_cache = {}
end # File lib/bundler.rb, line 90 def configure @configured ||= configure_gem_home_and_path end
# File lib/bundler.rb, line 607 def configure_gem_home_and_path(path = bundle_path) configure_gem_path configure_gem_home(path) Bundler.rubygems.clear_paths end
# File lib/bundler.rb, line 119 def configured_bundle_path @configured_bundle_path ||= settings.path.tap(&:validate!) end
# File lib/bundler.rb, line 108
def create_bundle_path
SharedHelpers.filesystem_access(bundle_path.to_s) do |p|
mkdir_p(p)
end unless bundle_path.exist?
@bundle_path = bundle_path.realpath
rescue Errno::EEXIST
raise PathError, "Could not install to path `#{bundle_path}` " \
"because a file already exists at that path. Either remove or rename the file so the directory can be created."
end # File lib/bundler.rb, line 478 def default_bundle_dir SharedHelpers.default_bundle_dir end
# File lib/bundler.rb, line 470 def default_gemfile SharedHelpers.default_gemfile end
# File lib/bundler.rb, line 474 def default_lockfile SharedHelpers.default_lockfile end
# File lib/bundler.rb, line 212
def definition(unlock = nil)
@definition = nil if unlock
@definition ||= begin
configure
Definition.build(default_gemfile, default_lockfile, unlock)
end
end Возвращает экземпляр Bundler::Definition для заданного Gemfile и lockfile
@param unlock [Hash, Boolean, nil] Гемы, которые были запрошены
to be updated or true if all gems should be updated
@return [Bundler::Definition]
# File lib/bundler.rb, line 202 def environment SharedHelpers.major_deprecation 2, "Bundler.environment has been removed in favor of Bundler.load", :print_caller_location => true load end
# File lib/bundler.rb, line 570 def feature_flag @feature_flag ||= FeatureFlag.new(VERSION) end
# File lib/bundler.rb, line 220 def frozen_bundle? frozen = settings[:deployment] frozen ||= settings[:frozen] frozen end
# File lib/bundler.rb, line 565
def git_present?
return @git_present if defined?(@git_present)
@git_present = Bundler.which("git#{RbConfig::CONFIG["EXEEXT"]}")
end # File lib/bundler.rb, line 292
def home
bundle_path.join("bundler")
end # File lib/bundler.rb, line 296
def install_path
home.join("gems")
end # File lib/bundler.rb, line 198 def load @load ||= Runtime.new(root, definition) end
# File lib/bundler.rb, line 534
def load_gemspec(file, validate = false)
@gemspec_cache ||= {}
key = File.expand_path(file)
@gemspec_cache[key] ||= load_gemspec_uncached(file, validate)
# Protect against caching side-effected gemspecs by returning a
# new instance each time.
@gemspec_cache[key].dup if @gemspec_cache[key]
end # File lib/bundler.rb, line 543
def load_gemspec_uncached(file, validate = false)
path = Pathname.new(file)
contents = read_file(file)
spec = if contents.start_with?("---") # YAML header
eval_yaml_gemspec(path, contents)
else
# Eval the gemspec from its parent directory, because some gemspecs
# depend on "./" relative paths.
SharedHelpers.chdir(path.dirname.to_s) do
eval_gemspec(path, contents)
end
end
return unless spec
spec.loaded_from = path.expand_path.to_s
Bundler.rubygems.validate(spec) if validate
spec
end # File lib/bundler.rb, line 528
def load_marshal(data, marshal_proc: nil)
Marshal.load(data, marshal_proc)
rescue TypeError => e
raise MarshalError, "#{e.class}: #{e.message}"
end # File lib/bundler.rb, line 465 def local_platform return Gem::Platform::RUBY if settings[:force_ruby_platform] Gem::Platform.local end
# File lib/bundler.rb, line 226
def locked_gems
@locked_gems ||=
if defined?(@definition) && @definition
definition.locked_gems
elsif Bundler.default_lockfile.file?
lock = Bundler.read_file(Bundler.default_lockfile)
LockfileParser.new(lock)
end
end # File lib/bundler.rb, line 499
def mkdir_p(path, options = {})
SharedHelpers.filesystem_access(path, :write) do |p|
FileUtils.mkdir_p(p)
end
end # File lib/bundler.rb, line 236 def most_specific_locked_platform?(platform) return false unless defined?(@definition) && @definition definition.most_specific_locked_platform == platform end
# File lib/bundler.rb, line 357 def original_env ORIGINAL_ENV.clone end
@return [Hash] Окружение, существовавшее до активации Bundler
# File lib/bundler.rb, line 444
def original_exec(*args)
with_original_env { Kernel.exec(*args) }
end Выполняет «Kernel.exec» для подкоманды с окружением, существовавшим до активации Bundler
# File lib/bundler.rb, line 422
def original_system(*args)
with_original_env { Kernel.system(*args) }
end Выполняет подкоманду с окружением, существовавшим до активации Bundler
# File lib/bundler.rb, line 491 def preferred_gemfile_name Bundler.settings[:init_gems_rb] ? "gems.rb" : "Gemfile" end
# File lib/bundler.rb, line 518
def read_file(file)
SharedHelpers.filesystem_access(file, :read) do
File.open(file, "r:UTF-8", &:read)
end
end # File lib/bundler.rb, line 194 def require(*groups) setup(*groups).require(*groups) end
Настраивает окружение Bundler (см. Bundler.setup), если оно ещё не настроено, и загружает все зависимости из указанных групп. В отличие от ::setup, может вызываться несколько раз с разными группами (если это разрешено настройкой).
Предполагая Gemfile
gem 'first_gem', '= 1.0' group :test do gem 'second_gem', '= 1.0' end
Код будет работать следующим образом:
Bundler.setup # allow all groups Bundler.require(:default) # requires only first_gem # ...later Bundler.require(:test) # requires second_gem
# File lib/bundler.rb, line 574 def reset! reset_paths! Plugin.reset! reset_rubygems! end
# File lib/bundler.rb, line 585 def reset_paths! @bin_path = nil @bundler_major_version = nil @bundle_path = nil @configured = nil @configured_bundle_path = nil @definition = nil @load = nil @locked_gems = nil @root = nil @settings = nil @setup = nil @user_home = nil end
# File lib/bundler.rb, line 600 def reset_rubygems! return unless defined?(@rubygems) && @rubygems rubygems.undo_replacements rubygems.reset @rubygems = nil end
# File lib/bundler.rb, line 580 def reset_settings_and_root! @settings = nil @root = nil end
# File lib/bundler.rb, line 338
def rm_rf(path)
FileUtils.remove_entry_secure(path) if path && File.exist?(path)
rescue ArgumentError
message = <<EOF
It is a security vulnerability to allow your home directory to be world-writable, and bundler cannot continue.
You should probably consider fixing this issue by running `chmod o-w ~` on *nix.
Please refer to https://ruby-doc.org/stdlib-3.1.2/libdoc/fileutils/rdoc/FileUtils.html#method-c-remove_entry_secure for details.
EOF
File.world_writable?(path) ? Bundler.ui.warn(message) : raise
raise PathError, "Please fix the world-writable issue with your #{path} directory"
end # File lib/bundler.rb, line 304
def root
@root ||= begin
SharedHelpers.root
rescue GemfileNotFound
bundle_dir = default_bundle_dir
raise GemfileNotFound, "Could not locate Gemfile or .bundle/ directory" unless bundle_dir
Pathname.new(File.expand_path("..", bundle_dir))
end
end # File lib/bundler.rb, line 242
def ruby_scope
"#{Bundler.rubygems.ruby_engine}/#{RbConfig::CONFIG["ruby_version"]}"
end # File lib/bundler.rb, line 524 def safe_load_marshal(data) load_marshal(data, :marshal_proc => SAFE_MARSHAL_PROC) end
# File lib/bundler.rb, line 613
def self_manager
@self_manager ||= begin
require_relative "bundler/self_manager"
Bundler::SelfManager.new
end
end # File lib/bundler.rb, line 350
def settings
@settings ||= Settings.new(app_config_path)
rescue GemfileNotFound
@settings = Settings.new(Pathname.new(".bundle").expand_path)
end # File lib/bundler.rb, line 160
def setup(*groups)
# Return if all groups are already loaded
return @setup if defined?(@setup) && @setup
definition.validate_runtime!
SharedHelpers.print_major_deprecations!
if groups.empty?
# Load all groups, but only once
@setup = load.setup
else
load.setup(*groups)
end
end Включает работу с Bundler. После вызова Bundler.setup, все load или require зависимостей будут разрешены только если они указаны в Gemfile или являются частью стандартной библиотеки Ruby. Если в Gemfile указаны версии, будут загружены только эти версии.
Предполагая Gemfile
gem 'first_gem', '= 1.0' group :test do gem 'second_gem', '= 1.0' end
Код, использующий Bundler.setup, работает следующим образом:
require 'third_gem' # allowed, required from global gems require 'first_gem' # allowed, loads the last installed version Bundler.setup require 'fourth_gem' # fails with LoadError require 'second_gem' # loads exactly version 1.0
Bundler.setup может быть вызван только один раз, все последующие вызовы игнорируются.
Если список groups предоставлен, будут разрешены только зависимости из указанных групп (зависимости, не указанные в группах, относятся к специальной группе :default).
Чтобы загрузить все зависимости из Gemfile (или только из некоторых групп), см. Bundler.require.
# File lib/bundler.rb, line 300
def specs_path
bundle_path.join("specifications")
end # File lib/bundler.rb, line 482 def system_bindir # Gem.bindir doesn't always return the location that RubyGems will install # system binaries. If you put '-n foo' in your .gemrc, RubyGems will # install binstubs there instead. Unfortunately, RubyGems doesn't expose # that directory at all, so rather than parse .gemrc ourselves, we allow # the directory to be set as well, via `bundle config set --local bindir foo`. Bundler.settings[:system_bindir] || Bundler.rubygems.gem_bindir end
# File lib/bundler.rb, line 333 def tmp(name = Process.pid.to_s) Kernel.send(:require, "tmpdir") Pathname.new(Dir.mktmpdir(["bundler", name])) end
# File lib/bundler.rb, line 94 def ui (defined?(@ui) && @ui) || (self.ui = UI::Shell.new) end
# File lib/bundler.rb, line 98 def ui=(ui) Bundler.rubygems.ui = UI::RGProxy.new(ui) @ui = ui end
# File lib/bundler.rb, line 374
def unbundled_env
env = original_env
if env.key?("BUNDLER_ORIG_MANPATH")
env["MANPATH"] = env["BUNDLER_ORIG_MANPATH"]
end
env.delete_if {|k, _| k[0, 7] == "BUNDLE_" }
if env.key?("RUBYOPT")
rubyopt = env["RUBYOPT"].split(" ")
rubyopt.delete("-r#{File.expand_path("bundler/setup", __dir__)}")
rubyopt.delete("-rbundler/setup")
env["RUBYOPT"] = rubyopt.join(" ")
end
if env.key?("RUBYLIB")
rubylib = env["RUBYLIB"].split(File::PATH_SEPARATOR)
rubylib.delete(__dir__)
env["RUBYLIB"] = rubylib.join(File::PATH_SEPARATOR)
end
env
end @return [Hash] Окружение со всеми переменными, связанными с bundler, удалёнными
# File lib/bundler.rb, line 461
def unbundled_exec(*args)
with_env(unbundled_env) { Kernel.exec(*args) }
end Выполнить «Kernel.exec` подкоманду в среде со всеми переменными, связанными с bundler, удалёнными
# File lib/bundler.rb, line 439
def unbundled_system(*args)
with_unbundled_env { Kernel.system(*args) }
end Выполнить подкоманду в среде со всеми переменными, связанными с bundler, удалёнными
# File lib/bundler.rb, line 495 def use_system_gems? configured_bundle_path.use_system_gems? end
# File lib/bundler.rb, line 270
def user_bundle_path(dir = "home")
env_var, fallback = case dir
when "home"
["BUNDLE_USER_HOME", proc { Pathname.new(user_home).join(".bundle") }]
when "cache"
["BUNDLE_USER_CACHE", proc { user_bundle_path.join("cache") }]
when "config"
["BUNDLE_USER_CONFIG", proc { user_bundle_path.join("config") }]
when "plugin"
["BUNDLE_USER_PLUGIN", proc { user_bundle_path.join("plugin") }]
else
raise BundlerError, "Unknown user path requested: #{dir}"
end
# `fallback` will already be a Pathname, but Pathname.new() is
# idempotent so it's OK
Pathname.new(ENV.fetch(env_var, &fallback))
end # File lib/bundler.rb, line 288
def user_cache
user_bundle_path("cache")
end # File lib/bundler.rb, line 246
def user_home
@user_home ||= begin
home = Bundler.rubygems.user_home
bundle_home = home ? File.join(home, ".bundle") : nil
warning = if home.nil?
"Your home directory is not set."
elsif !File.directory?(home)
"`#{home}` is not a directory."
elsif !File.writable?(home) && (!File.directory?(bundle_home) || !File.writable?(bundle_home))
"`#{home}` is not writable."
end
if warning
Bundler.ui.warn "#{warning}\n"
user_home = tmp_home_path
Bundler.ui.warn "Bundler will use `#{user_home}' as your home directory temporarily.\n"
user_home
else
Pathname.new(home)
end
end
end # File lib/bundler.rb, line 505
def which(executable)
if File.file?(executable) && File.executable?(executable)
executable
elsif paths = ENV["PATH"]
quote = '"'.freeze
paths.split(File::PATH_SEPARATOR).find do |path|
path = path[1..-2] if path.start_with?(quote) && path.end_with?(quote)
executable_path = File.expand_path(executable, path)
return executable_path if File.file?(executable_path) && File.executable?(executable_path)
end
end
end # File lib/bundler.rb, line 405
def with_clean_env
Bundler::SharedHelpers.major_deprecation(
2,
"`Bundler.with_clean_env` has been deprecated in favor of `Bundler.with_unbundled_env`. " \
"If you instead want the environment before bundler was originally loaded, use `Bundler.with_original_env`",
:print_caller_location => true
)
with_env(unbundled_env) { yield }
end @deprecated Используйте ‘with_unbundled_env` вместо этого
# File lib/bundler.rb, line 400
def with_original_env
with_env(original_env) { yield }
end Выполнить блок со средой, присутствующей до активации Bundler
# File lib/bundler.rb, line 417
def with_unbundled_env
with_env(unbundled_env) { yield }
end Выполнить блок со всеми переменными, связанными с bundler, удалёнными
Методы приватного класса
# File lib/bundler.rb, line 647 def configure_gem_home(path) Bundler::SharedHelpers.set_env "GEM_HOME", path.to_s end
# File lib/bundler.rb, line 638
def configure_gem_path
unless use_system_gems?
# this needs to be empty string to cause
# PathSupport.split_gem_path to only load up the
# Bundler --path setting as the GEM_PATH.
Bundler::SharedHelpers.set_env "GEM_PATH", ""
end
end # File lib/bundler.rb, line 630
def eval_gemspec(path, contents)
eval(contents, TOPLEVEL_BINDING.dup, path.expand_path.to_s)
rescue ScriptError, StandardError => e
msg = "There was an error while loading `#{path.basename}`: #{e.message}"
raise GemspecError, Dsl::DSLError.new(msg, path, e.backtrace, contents)
end # File lib/bundler.rb, line 622 def eval_yaml_gemspec(path, contents) Kernel.require "psych" Gem::Specification.from_yaml(contents) rescue ::Psych::SyntaxError, ArgumentError, Gem::EndOfYAMLException, Gem::Exception eval_gemspec(path, contents) end
# File lib/bundler.rb, line 651
def tmp_home_path
Kernel.send(:require, "tmpdir")
SharedHelpers.filesystem_access(Dir.tmpdir) do
path = Bundler.tmp
at_exit { Bundler.rm_rf(path) }
path
end
end # File lib/bundler.rb, line 661 def with_env(env) backup = ENV.to_hash ENV.replace(env) yield ensure ENV.replace(backup) end
@param env [Hash]
Ruby Core © 1993–2022 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.