Module: Bundler
Overview
Some versions of the Bundler
1.1 RC series introduced corrupted lockfiles. There were two major problems:
-
multiple copies of the same GIT section appeared in the lockfile
-
when this happened, those sections got multiple copies of gems in those sections.
As a result, Bundler
1.1 contains code that fixes the earlier corruption. We will remove this fix-up code in Bundler
1.2.
Constant Summary
-
FREEBSD =
# File 'lib/bundler/constants.rb', line 5RbConfig::CONFIG["host_os"] =~ /bsd/
-
NULL =
# File 'lib/bundler/constants.rb', line 6WINDOWS ? "NUL" : "/dev/null"
-
ORIGINAL_ENV =
# File 'lib/bundler.rb', line 22environment_preserver.restore
-
SUDO_MUTEX =
# File 'lib/bundler.rb', line 24Mutex.new
-
VERSION =
We’re doing this because we might write tests that deal with other versions of bundler and we are unsure how to handle this better.
"1.17.2"
-
WINDOWS =
# File 'lib/bundler/constants.rb', line 4RbConfig::CONFIG["host_os"] =~ /(msdos|mswin|djgpp|mingw)/
-
YamlLibrarySyntaxError =
Syck raises ArgumentError
::ArgumentError
Class Attribute Summary
- .frozen_bundle? ⇒ Boolean readonly
- .git_present? ⇒ Boolean readonly
- .requires_sudo? ⇒ Boolean readonly
- .ui rw
- .ui=(ui) rw
- .use_system_gems? ⇒ Boolean readonly
Class Method Summary
- .app_cache(custom_path = nil)
- .app_config_path
-
.bin_path
Returns absolute location of where binstubs are installed to.
-
.bundle_path
Returns absolute path of where gems are installed on the filesystem.
- .bundler_major_version
-
.clean_env ⇒ Hash
deprecated
Deprecated.
Use .original_env instead
- .clean_exec(*args)
- .clean_system(*args)
- .clear_gemspec_cache
- .configure
- .configured_bundle_path
-
.current_ruby ⇒ CurrentRuby
Returns current version of Ruby.
- .default_bundle_dir
- .default_gemfile
- .default_lockfile
-
.definition(unlock = nil) ⇒ Bundler::Definition
Returns an instance of
Definition
for given Gemfile and lockfile. - .environment
- .feature_flag
- .home
- .install_path
- .load
- .load_gemspec(file, validate = false)
- .load_gemspec_uncached(file, validate = false)
- .load_marshal(data)
- .local_platform
- .locked_gems
- .mkdir_p(path, options = {})
- .original_env ⇒ Hash
- .read_file(file)
- .require(*groups)
- .require_thor_actions
- .reset!
- .reset_paths!
- .reset_rubygems!
- .rm_rf(path)
- .root
- .ruby_scope
- .rubygems
- .settings
- .setup(*groups)
- .specs_path
- .sudo(str)
- .system_bindir
- .tmp(name = Process.pid.to_s)
- .tmp_home_path(login, warning)
- .user_bundle_path(dir = "home")
- .user_cache
- .user_home
- .which(executable)
- .with_clean_env
- .with_friendly_errors
- .with_original_env
- .configure_gem_home private
- .configure_gem_home_and_path private
- .configure_gem_path(env = ENV) private
- .eval_gemspec(path, contents) private
- .eval_yaml_gemspec(path, contents) private
- .overwrite_loaded_gem_version private
- .with_env(env) private
Class Attribute Details
.frozen_bundle? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'lib/bundler.rb', line 139
def frozen_bundle? frozen = settings[:deployment] frozen ||= settings[:frozen] unless feature_flag.deployment_means_frozen? frozen end
.git_present? ⇒ Boolean
(readonly)
[ GitHub ]
.requires_sudo? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'lib/bundler.rb', line 354
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
.ui (rw)
[ GitHub ].ui=(ui) (rw)
[ GitHub ]
.use_system_gems? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'lib/bundler.rb', line 350
def use_system_gems? configured_bundle_path.use_system_gems? end
Class Method Details
.app_cache(custom_path = nil)
[ GitHub ].app_config_path
[ GitHub ].bin_path
Returns absolute location of where binstubs are installed to.
# File 'lib/bundler.rb', line 88
def bin_path @bin_path ||= begin path = settings[:bin] || "bin" path = Pathname.new(path). (root). SharedHelpers.filesystem_access(path) {|p| FileUtils.mkdir_p(p) } path end end
.bundle_path
Returns absolute path of where gems are installed on the filesystem.
# File 'lib/bundler.rb', line 79
def bundle_path @bundle_path ||= Pathname.new(configured_bundle_path.path). (root) end
.bundler_major_version
[ GitHub ]# File 'lib/bundler/version.rb', line 25
def self.bundler_major_version @bundler_major_version ||= VERSION.split(".").first.to_i end
.clean_env ⇒ Hash
Use .original_env instead
# File 'lib/bundler.rb', line 285
def clean_env Bundler::SharedHelpers.major_deprecation(2, "`Bundler.clean_env` has weird edge cases, use `.original_env` instead") 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") env["RUBYOPT"] = env["RUBYOPT"].sub "-rbundler/setup", "" end if env.key?("RUBYLIB") rubylib = env["RUBYLIB"].split(File::PATH_SEPARATOR) rubylib.delete(File. ("..", __FILE__)) env["RUBYLIB"] = rubylib.join(File::PATH_SEPARATOR) end env end
.clean_exec(*args)
[ GitHub ]# File 'lib/bundler.rb', line 320
def clean_exec(*args) with_clean_env { Kernel.exec(*args) } end
.clean_system(*args)
[ GitHub ]# File 'lib/bundler.rb', line 316
def clean_system(*args) with_clean_env { Kernel.system(*args) } end
.clear_gemspec_cache
[ GitHub ]# File 'lib/bundler.rb', line 468
def clear_gemspec_cache @gemspec_cache = {} end
.configure
[ GitHub ]# File 'lib/bundler.rb', line 65
def configure @configured ||= configure_gem_home_and_path end
.configure_gem_home (private)
[ GitHub ]# File 'lib/bundler.rb', line 553
def configure_gem_home Bundler::SharedHelpers.set_env "GEM_HOME", File. (bundle_path, root) Bundler.rubygems.clear_paths end
.configure_gem_home_and_path (private)
[ GitHub ]# File 'lib/bundler.rb', line 533
def configure_gem_home_and_path configure_gem_path configure_gem_home bundle_path end
.configure_gem_path(env = ENV) (private)
[ GitHub ]# File 'lib/bundler.rb', line 539
def configure_gem_path(env = ENV) blank_home = env["GEM_HOME"].nil? || env["GEM_HOME"].empty? if !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. env["GEM_PATH"] = "" elsif blank_home possibles = [Bundler.rubygems.gem_dir, Bundler.rubygems.gem_path] paths = possibles.flatten.compact.uniq.reject(&:empty?) env["GEM_PATH"] = paths.join(File::PATH_SEPARATOR) end end
.configured_bundle_path
[ GitHub ]# File 'lib/bundler.rb', line 83
def configured_bundle_path @configured_bundle_path ||= settings.path.tap(&:validate!) end
.current_ruby ⇒ CurrentRuby
Returns current version of Ruby
# File 'lib/bundler/current_ruby.rb', line 7
def self.current_ruby @current_ruby ||= CurrentRuby.new end
.default_bundle_dir
[ GitHub ]# File 'lib/bundler.rb', line 337
def default_bundle_dir SharedHelpers.default_bundle_dir end
.default_gemfile
[ GitHub ]# File 'lib/bundler.rb', line 329
def default_gemfile SharedHelpers.default_gemfile end
.default_lockfile
[ GitHub ]# File 'lib/bundler.rb', line 333
def default_lockfile SharedHelpers.default_lockfile end
.definition(unlock = nil) ⇒ Bundler::Definition
Returns an instance of ::Bundler::Definition
for given Gemfile and lockfile
# File 'lib/bundler.rb', line 131
def definition(unlock = nil) @definition = nil if unlock @definition ||= begin configure Definition.build(default_gemfile, default_lockfile, unlock) end end
.environment
[ GitHub ]# File 'lib/bundler.rb', line 121
def environment SharedHelpers.major_deprecation 2, "Bundler.environment has been removed in favor of Bundler.load" load end
.eval_gemspec(path, contents) (private)
[ GitHub ]# File 'lib/bundler.rb', line 521
def eval_gemspec(path, contents) eval(contents, TOPLEVEL_BINDING.dup, path. .to_s) rescue ScriptError, StandardError => e msg = "There was an error while loading `#{path.basename}`: #{e.}" if e.is_a?(LoadError) && RUBY_VERSION >= "1.9" msg += "\nDoes it try to require a relative path? That's been removed in Ruby 1.9" end raise GemspecError, Dsl::DSLError.new(msg, path, e.backtrace, contents) end
.eval_yaml_gemspec(path, contents) (private)
[ GitHub ]# File 'lib/bundler.rb', line 511
def eval_yaml_gemspec(path, contents) Kernel.send(:require, "bundler/psyched_yaml") # If the YAML is invalid, Syck raises an ArgumentError, and Psych # raises a Psych::SyntaxError. See psyched_yaml.rb for more info. Gem::Specification.from_yaml(contents) rescue YamlLibrarySyntaxError, ArgumentError, Gem::EndOfYAMLException, Gem::Exception eval_gemspec(path, contents) end
.feature_flag
[ GitHub ]# File 'lib/bundler.rb', line 477
def feature_flag @feature_flag ||= FeatureFlag.new(VERSION) end
.home
[ GitHub ]# File 'lib/bundler.rb', line 220
def home bundle_path.join("bundler") end
.install_path
[ GitHub ]# File 'lib/bundler.rb', line 224
def install_path home.join("gems") end
.load
[ GitHub ]# File 'lib/bundler.rb', line 117
def load @load ||= Runtime.new(root, definition) end
.load_gemspec(file, validate = false)
[ GitHub ]# File 'lib/bundler.rb', line 441
def load_gemspec(file, validate = false) @gemspec_cache ||= {} key = File. (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
.load_gemspec_uncached(file, validate = false)
[ GitHub ]# File 'lib/bundler.rb', line 450
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. .to_s Bundler.rubygems.validate(spec) if validate spec end
.load_marshal(data)
[ GitHub ]# File 'lib/bundler.rb', line 435
def load_marshal(data) Marshal.load(data) rescue StandardError => e raise MarshalError, "#{e.class}: #{e.}" end
.local_platform
[ GitHub ].locked_gems
[ GitHub ]# File 'lib/bundler.rb', line 145
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
.mkdir_p(path, options = {})
[ GitHub ]# File 'lib/bundler.rb', line 382
def mkdir_p(path, = {}) if requires_sudo? && ! [: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
.original_env ⇒ Hash
# File 'lib/bundler.rb', line 279
def original_env ORIGINAL_ENV.clone end
.overwrite_loaded_gem_version (private)
[ GitHub ].read_file(file)
[ GitHub ]# File 'lib/bundler.rb', line 429
def read_file(file) SharedHelpers.filesystem_access(file, :read) do File.open(file, "r:UTF-8", &:read) end end
.require(*groups)
[ GitHub ]# File 'lib/bundler.rb', line 113
def require(*groups) setup(*groups).require(*groups) end
.require_thor_actions
[ GitHub ]# File 'lib/bundler/vendored_thor.rb', line 4
def self.require_thor_actions Kernel.send(:require, "bundler/vendor/thor/lib/thor/actions") end
.reset!
[ GitHub ]# File 'lib/bundler.rb', line 481
def reset! reset_paths! Plugin.reset! reset_rubygems! end
.reset_paths!
[ GitHub ]# File 'lib/bundler.rb', line 487
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
.reset_rubygems!
[ GitHub ].rm_rf(path)
[ GitHub ]# File 'lib/bundler.rb', line 260
def rm_rf(path) FileUtils.remove_entry_secure(path) if path && File.exist?(path) rescue ArgumentError = <<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 http://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( ) : raise raise PathError, "Please fix the world-writable issue with your #{path} directory" end
.root
[ GitHub ]# File 'lib/bundler.rb', line 232
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. ("..", bundle_dir)) end end
.ruby_scope
[ GitHub ].rubygems
[ GitHub ]# File 'lib/bundler/rubygems_integration.rb', line 879
def self.rubygems @rubygems ||= if RubygemsIntegration.provides?(">= 2.1.0") RubygemsIntegration::MoreFuture.new elsif RubygemsIntegration.provides?(">= 1.99.99") RubygemsIntegration::Future.new elsif RubygemsIntegration.provides?(">= 1.8.20") RubygemsIntegration::MoreModern.new elsif RubygemsIntegration.provides?(">= 1.8.5") RubygemsIntegration::Modern.new elsif RubygemsIntegration.provides?(">= 1.8.0") RubygemsIntegration::AlmostModern.new elsif RubygemsIntegration.provides?(">= 1.7.0") RubygemsIntegration::Transitional.new elsif RubygemsIntegration.provides?(">= 1.4.0") RubygemsIntegration::Legacy.new else # RubyGems 1.3.6 and 1.3.7 RubygemsIntegration::Ancient.new end end
.settings
[ GitHub ]# File 'lib/bundler.rb', line 272
def settings @settings ||= Settings.new(app_config_path) rescue GemfileNotFound @settings = Settings.new(Pathname.new(".bundle"). ) end
.setup(*groups)
[ GitHub ]# File 'lib/bundler.rb', line 97
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
.specs_path
[ GitHub ]# File 'lib/bundler.rb', line 228
def specs_path bundle_path.join("specifications") end
.sudo(str)
[ GitHub ]# File 'lib/bundler.rb', line 405
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 install --path vendor/bundle 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
.system_bindir
[ GitHub ]# File 'lib/bundler.rb', line 341
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 bindir foo`. Bundler.settings[:system_bindir] || Bundler.rubygems.gem_bindir end
.tmp(name = Process.pid.to_s)
[ GitHub ]# File 'lib/bundler.rb', line 255
def tmp(name = Process.pid.to_s) Kernel.send(:require, "tmpdir") Pathname.new(Dir.mktmpdir(["bundler", name])) end
.tmp_home_path(login, warning)
[ GitHub ]# File 'lib/bundler.rb', line 183
def tmp_home_path(login, warning) login ||= "unknown" Kernel.send(:require, "tmpdir") path = Pathname.new(Dir.tmpdir).join("bundler", "home") SharedHelpers.filesystem_access(path) do |tmp_home_path| unless tmp_home_path.exist? tmp_home_path.mkpath tmp_home_path.chmod(0o777) end tmp_home_path.join(login).tap(&:mkpath) end rescue RuntimeError => e raise e.exception("#{warning}\nBundler also failed to create a temporary home directory at `#{path}':\n#{e}") end
.user_bundle_path(dir = "home")
[ GitHub ]# File 'lib/bundler.rb', line 198
def user_bundle_path(dir = "home") env_var, fallback = case dir when "home" ["BUNDLE_USER_HOME", Pathname.new(user_home).join(".bundle")] when "cache" ["BUNDLE_USER_CACHE", user_bundle_path.join("cache")] when "config" ["BUNDLE_USER_CONFIG", user_bundle_path.join("config")] when "plugin" ["BUNDLE_USER_PLUGIN", 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
.user_cache
[ GitHub ]# File 'lib/bundler.rb', line 216
def user_cache user_bundle_path("cache") end
.user_home
[ GitHub ]# File 'lib/bundler.rb', line 159
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 Kernel.send(:require, "etc") user_home = tmp_home_path(Etc.getlogin, warning) Bundler.ui.warn "#{warning}\nBundler will use `#{user_home}' as your home directory temporarily.\n" user_home else Pathname.new(home) end end end
.which(executable)
[ GitHub ]# File 'lib/bundler.rb', line 392
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. (executable, path) return executable_path if File.file?(executable_path) && File.executable?(executable_path) end end end
.with_clean_env
[ GitHub ].with_env(env) (private)
# File 'lib/bundler.rb', line 559
def with_env(env) backup = ENV.to_hash ENV.replace(env) yield ensure ENV.replace(backup) end
.with_friendly_errors
[ GitHub ]# File 'lib/bundler/friendly_errors.rb', line 123
def self.with_friendly_errors yield rescue SignalException raise rescue Exception => e FriendlyErrors.log_error(e) exit FriendlyErrors.exit_status(e) end
.with_original_env
[ GitHub ]# File 'lib/bundler.rb', line 308
def with_original_env with_env(original_env) { yield } end