модуль Bundler
Bundler обеспечивает согласованную среду для проектов Ruby, отслеживая и устанавливая точные драгоценные камни и версии, которые необходимы.
Начиная с Ruby 2.6, Bundler является частью стандартной библиотеки Ruby.
Bundler используется путем создания gemfiles, перечисляющих все зависимости проекта и (необязательно) их версии, а затем используя
require 'bundler/setup'
или Bundler.setup для настройки среды, в которой могут использоваться только указанные драгоценные камни и их указанные версии.
См. сайт Bundler для подробной документации по созданию gemfiles и Bundler использовании.
Как стандартная библиотека внутри проекта, Bundler может использоваться для интроспекции загруженных и необходимых модулей.
Константы
- ORIGINAL_ENV
- SUDO_MUTEX
Методы публичного класса
# File lib/bundler.rb, line 309 def app_cache(custom_path = nil) path = custom_path || root Pathname.new(path).join(settings.app_cache_path) end
# File lib/bundler.rb, line 295
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 105
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 96 def bundle_path @bundle_path ||= Pathname.new(configured_bundle_path.path).expand_path(root) end
Возвращает абсолютный путь установки gem на файловой системе.
# File lib/bundler.rb, line 343
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 430
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 408
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 595
def clear_gemspec_cache
@gemspec_cache = {}
end # File lib/bundler.rb, line 82 def configure @configured ||= configure_gem_home_and_path end
# File lib/bundler.rb, line 641 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 100 def configured_bundle_path @configured_bundle_path ||= settings.path.tap(&:validate!) end
# File lib/bundler.rb, line 459 def default_bundle_dir SharedHelpers.default_bundle_dir end
# File lib/bundler.rb, line 451 def default_gemfile SharedHelpers.default_gemfile end
# File lib/bundler.rb, line 455 def default_lockfile SharedHelpers.default_lockfile end
# File lib/bundler.rb, line 193
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] Запрошенные gem
to be updated or true if all gems should be updated
@return [Bundler::Definition]
# File lib/bundler.rb, line 183 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 604 def feature_flag @feature_flag ||= FeatureFlag.new(VERSION) end
# File lib/bundler.rb, line 201 def frozen_bundle? frozen = settings[:deployment] frozen ||= settings[:frozen] frozen end
# File lib/bundler.rb, line 599
def git_present?
return @git_present if defined?(@git_present)
@git_present = Bundler.which("git") || Bundler.which("git.exe")
end # File lib/bundler.rb, line 273
def home
bundle_path.join("bundler")
end # File lib/bundler.rb, line 277
def install_path
home.join("gems")
end # File lib/bundler.rb, line 179 def load @load ||= Runtime.new(root, definition) end
# File lib/bundler.rb, line 568
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 577
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 562
def load_marshal(data)
Marshal.load(data)
rescue StandardError => e
raise MarshalError, "#{e.class}: #{e.message}"
end # File lib/bundler.rb, line 446 def local_platform return Gem::Platform::RUBY if settings[:force_ruby_platform] || Gem.platforms == [Gem::Platform::RUBY] Gem::Platform.local end
# File lib/bundler.rb, line 207
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 508
def mkdir_p(path, options = {})
if requires_sudo? && !options[:no_sudo]
sudo "mkdir -p '#{path}'" unless File.exist?(path)
else
SharedHelpers.filesystem_access(path, :write) do |p|
FileUtils.mkdir_p(p)
end
end
end # File lib/bundler.rb, line 217 def most_specific_locked_platform?(platform) return false unless defined?(@definition) && @definition definition.most_specific_locked_platform == platform end
# File lib/bundler.rb, line 338 def original_env ORIGINAL_ENV.clone end
@return [Hash] Окружение, существовавшее до активации Bundler
# File lib/bundler.rb, line 425
def original_exec(*args)
with_original_env { Kernel.exec(*args) }
end Запуск ‘Kernel.exec` для подкоманды с окружением, присутствующим до активации Bundler
# File lib/bundler.rb, line 403
def original_system(*args)
with_original_env { Kernel.system(*args) }
end Запуск подкоманды с окружением, присутствующим до активации Bundler
# File lib/bundler.rb, line 472 def preferred_gemfile_name Bundler.settings[:init_gems_rb] ? "gems.rb" : "Gemfile" end
# File lib/bundler.rb, line 556
def read_file(file)
SharedHelpers.filesystem_access(file, :read) do
File.open(file, "r:UTF-8", &:read)
end
end # File lib/bundler.rb, line 175 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 480
def requires_sudo?
return @requires_sudo if defined?(@requires_sudo_ran)
sudo_present = which "sudo" if settings.allow_sudo?
if sudo_present
# the bundle path and subdirectories need to be writable for RubyGems
# to be able to unpack and install gems without exploding
path = bundle_path
path = path.parent until path.exist?
# bins are written to a different location on OS X
bin_dir = Pathname.new(Bundler.system_bindir)
bin_dir = bin_dir.parent until bin_dir.exist?
# if any directory is not writable, we need sudo
files = [path, bin_dir] | Dir[bundle_path.join("build_info/*").to_s] | Dir[bundle_path.join("*").to_s]
unwritable_files = files.reject {|f| File.writable?(f) }
sudo_needed = !unwritable_files.empty?
if sudo_needed
Bundler.ui.warn "Following files may not be writable, so sudo is needed:\n #{unwritable_files.map(&:to_s).sort.join("\n ")}"
end
end
@requires_sudo_ran = true
@requires_sudo = settings.allow_sudo? && sudo_present && sudo_needed
end # File lib/bundler.rb, line 608 def reset! reset_paths! Plugin.reset! reset_rubygems! end
# File lib/bundler.rb, line 619 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 634 def reset_rubygems! return unless defined?(@rubygems) && @rubygems rubygems.undo_replacements rubygems.reset @rubygems = nil end
# File lib/bundler.rb, line 614 def reset_settings_and_root! @settings = nil @root = nil end
# File lib/bundler.rb, line 319
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 can not continue.
You should probably consider fixing this issue by running `chmod o-w ~` on *nix.
Please refer to https://ruby-doc.org/stdlib-2.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 285
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 223
def ruby_scope
"#{Bundler.rubygems.ruby_engine}/#{RbConfig::CONFIG["ruby_version"]}"
end # File lib/bundler.rb, line 647
def self_manager
@self_manager ||= begin
require_relative "bundler/self_manager"
Bundler::SelfManager.new
end
end # File lib/bundler.rb, line 331
def settings
@settings ||= Settings.new(app_config_path)
rescue GemfileNotFound
@settings = Settings.new(Pathname.new(".bundle").expand_path)
end # File lib/bundler.rb, line 141
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 281
def specs_path
bundle_path.join("specifications")
end # File lib/bundler.rb, line 531
def sudo(str)
SUDO_MUTEX.synchronize do
prompt = "\n\n" + <<-PROMPT.gsub(/^ {6}/, "").strip + " "
Your user account isn't allowed to install to the system RubyGems.
You can cancel this installation and run:
bundle config set --local path 'vendor/bundle'
bundle install
to install the gems into ./vendor/bundle/, or you can enter your password
and install the bundled gems to RubyGems using sudo.
Password:
PROMPT
unless @prompted_for_sudo ||= system(%(sudo -k -p "#{prompt}" true))
raise SudoNotPermittedError,
"Bundler requires sudo access to install at the moment. " \
"Try installing again, granting Bundler sudo access when prompted, or installing into a different path."
end
`sudo -p "#{prompt}" #{str}`
end
end # File lib/bundler.rb, line 463 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 314 def tmp(name = Process.pid.to_s) Kernel.send(:require, "tmpdir") Pathname.new(Dir.mktmpdir(["bundler", name])) end
# File lib/bundler.rb, line 86 def ui (defined?(@ui) && @ui) || (self.ui = UI::Shell.new) end
# File lib/bundler.rb, line 90 def ui=(ui) Bundler.rubygems.ui = UI::RGProxy.new(ui) @ui = ui end
# File lib/bundler.rb, line 355
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(File.expand_path("..", __FILE__))
env["RUBYLIB"] = rubylib.join(File::PATH_SEPARATOR)
end
env
end @return [Hash] Окружение со всеми удаленными переменными, связанными с bundler
# File lib/bundler.rb, line 442
def unbundled_exec(*args)
with_env(unbundled_env) { Kernel.exec(*args) }
end Запуск ‘Kernel.exec` для подкоманды в окружении со всеми удаленными переменными, связанными с bundler
# File lib/bundler.rb, line 420
def unbundled_system(*args)
with_unbundled_env { Kernel.system(*args) }
end Запуск подкоманды в окружении со всеми удаленными переменными, связанными с bundler
# File lib/bundler.rb, line 476 def use_system_gems? configured_bundle_path.use_system_gems? end
# File lib/bundler.rb, line 251
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 269
def user_cache
user_bundle_path("cache")
end # File lib/bundler.rb, line 227
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 518
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 386
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 381
def with_original_env
with_env(original_env) { yield }
end Выполнить блок с окружением, присутствовавшим до активации Bundler
# File lib/bundler.rb, line 398
def with_unbundled_env
with_env(unbundled_env) { yield }
end Выполнить блок со всеми переменными, относящимися к Bundler, удалёнными
Методы частного класса
# File lib/bundler.rb, line 681 def configure_gem_home(path) Bundler::SharedHelpers.set_env "GEM_HOME", path.to_s end
# File lib/bundler.rb, line 672
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 664
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 656 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 685
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 695 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.