module Bundler

Bundler provides a consistent environment for Ruby projects by tracking and installing the exact gems and versions that are needed.

Bundler is a part of Ruby’s standard library.

Bundler is used by creating gemfiles listing all the project dependencies and (optionally) their versions and then using

require 'bundler/setup'

or Bundler.setup to setup environment where only specified gems and their specified versions could be used.

See Bundler website for extensive documentation on gemfiles creation and Bundler usage.

As a standard library inside project, Bundler could be used for introspection of loaded and required modules.

Constants

ORIGINAL_ENV
SUDO_MUTEX

Public Class Methods

# File lib/bundler.rb, line 344
def app_cache(custom_path = nil)
  path = custom_path || root
  Pathname.new(path).join(settings.app_cache_path)
end
# File lib/bundler.rb, line 330
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

Automatically install dependencies if Bundler.settings[:auto_install] exists. This is set through config cmd ‘bundle config set –global auto_install 1`.

Note that this method ‘nil`s out the global Definition object, so it should be called first, before you instantiate anything like an `Installer` that’ll keep a reference to the old one instead.

# File lib/bundler.rb, line 183
def auto_install
  return unless settings[:auto_install]

  begin
    definition.specs
  rescue GemNotFound, GitError
    ui.info "Automatically installing missing gems."
    reset!
    CLI::Install.new({}).run
    reset!
  end
end
# File lib/bundler.rb, line 173
def auto_switch
  self_manager.restart_with_locked_bundler_if_needed
end

Returns absolute location of where binstubs are installed to.

# File lib/bundler.rb, line 121
def bin_path
  @bin_path ||= begin
    path = settings[:bin] || "bin"
    path = Pathname.new(path).expand_path(root).expand_path
    mkdir_p(path)
    path
  end
end

Returns absolute path of where gems are installed on the filesystem.

# File lib/bundler.rb, line 103
def bundle_path
  @bundle_path ||= Pathname.new(configured_bundle_path.path).expand_path(root)
end

@deprecated Use ‘unbundled_env` instead

# File lib/bundler.rb, line 370
def clean_env
  message =
    "`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`"
  removed_message =
    "`Bundler.clean_env` has been removed in favor of `Bundler.unbundled_env`. " \
    "If you instead want the environment before bundler was originally loaded, use `Bundler.original_env`"
  Bundler::SharedHelpers.major_deprecation(2, message, removed_message: removed_message, print_caller_location: true)
  unbundled_env
end

@deprecated Use ‘unbundled_exec` instead

# File lib/bundler.rb, line 441
def clean_exec(*args)
  message =
    "`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`"
  removed_message =
    "`Bundler.clean_exec` has been removed 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`"
  Bundler::SharedHelpers.major_deprecation(2, message, removed_message: removed_message, print_caller_location: true)
  with_env(unbundled_env) { Kernel.exec(*args) }
end

@deprecated Use ‘unbundled_system` instead

# File lib/bundler.rb, line 419
def clean_system(*args)
  message =
    "`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`"
  removed_message =
    "`Bundler.clean_system` has been removed 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`"
  Bundler::SharedHelpers.major_deprecation(2, message, removed_message: removed_message, print_caller_location: true)
  with_env(unbundled_env) { Kernel.system(*args) }
end
# File lib/bundler.rb, line 557
def clear_gemspec_cache
  @gemspec_cache = {}
end
# File lib/bundler.rb, line 89
def configure
  @configure ||= configure_gem_home_and_path
end
# File lib/bundler.rb, line 603
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 116
def configured_bundle_path
  @configured_bundle_path ||= settings.path.tap(&:validate!)
end
# File lib/bundler.rb, line 107
def create_bundle_path
  mkdir_p(bundle_path) 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 470
def default_bundle_dir
  SharedHelpers.default_bundle_dir
end
# File lib/bundler.rb, line 462
def default_gemfile
  SharedHelpers.default_gemfile
end
# File lib/bundler.rb, line 466
def default_lockfile
  SharedHelpers.default_lockfile
end

Returns an instance of Bundler::Definition for given Gemfile and lockfile

@param unlock [Hash, Boolean, nil] Gems that have been requested

to be updated or true if all gems should be updated

@param lockfile [Pathname] Path to Gemfile.lock @return [Bundler::Definition]

# File lib/bundler.rb, line 233
def definition(unlock = nil, lockfile = default_lockfile)
  @definition = nil if unlock
  @definition ||= begin
    configure
    Definition.build(default_gemfile, lockfile, unlock)
  end
end
# File lib/bundler.rb, line 222
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 566
def feature_flag
  @feature_flag ||= FeatureFlag.new(VERSION)
end
# File lib/bundler.rb, line 511
def find_executable(path)
  extensions = RbConfig::CONFIG["EXECUTABLE_EXTS"]&.split
  extensions = [RbConfig::CONFIG["EXEEXT"]] unless extensions&.any?
  candidates = extensions.map {|ext| "#{path}#{ext}" }

  candidates.find {|candidate| File.file?(candidate) && File.executable?(candidate) }
end
# File lib/bundler.rb, line 241
def frozen_bundle?
  frozen = settings[:frozen]
  return frozen unless frozen.nil?

  settings[:deployment]
end
# File lib/bundler.rb, line 561
def git_present?
  return @git_present if defined?(@git_present)
  @git_present = Bundler.which("git")
end
# File lib/bundler.rb, line 308
def home
  bundle_path.join("bundler")
end
# File lib/bundler.rb, line 312
def install_path
  home.join("gems")
end
# File lib/bundler.rb, line 218
def load
  @load ||= Runtime.new(root, definition)
end
# File lib/bundler.rb, line 538
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
end
# File lib/bundler.rb, line 547
def load_gemspec_uncached(file, validate = false)
  path = Pathname.new(file)
  contents = read_file(file)
  spec = eval_gemspec(path, contents)
  return unless spec
  spec.loaded_from = path.expand_path.to_s
  Bundler.rubygems.validate(spec) if validate
  spec
end
# File lib/bundler.rb, line 457
def local_platform
  return Gem::Platform::RUBY if settings[:force_ruby_platform]
  Gem::Platform.local
end
# File lib/bundler.rb, line 248
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 491
def mkdir_p(path)
  SharedHelpers.filesystem_access(path, :create) do |p|
    FileUtils.mkdir_p(p)
  end
end

@return [Hash] Environment present before Bundler was activated

# File lib/bundler.rb, line 365
def original_env
  ORIGINAL_ENV.clone
end

Run a ‘Kernel.exec` to a subcommand with the environment present before Bundler was activated

# File lib/bundler.rb, line 436
def original_exec(*args)
  with_original_env { Kernel.exec(*args) }
end

Run subcommand with the environment present before Bundler was activated

# File lib/bundler.rb, line 414
def original_system(*args)
  with_original_env { Kernel.system(*args) }
end
# File lib/bundler.rb, line 483
def preferred_gemfile_name
  Bundler.settings[:init_gems_rb] ? "gems.rb" : "Gemfile"
end
# File lib/bundler.rb, line 519
def read_file(file)
  SharedHelpers.filesystem_access(file, :read) do
    File.open(file, "r:UTF-8", &:read)
  end
end

Setups Bundler environment (see Bundler.setup) if it is not already set, and loads all gems from groups specified. Unlike ::setup, can be called multiple times with different groups (if they were allowed by setup).

Assuming Gemfile

gem 'first_gem', '= 1.0'
group :test do
  gem 'second_gem', '= 1.0'
end

The code will work as follows:

Bundler.setup # allow all groups
Bundler.require(:default) # requires only first_gem
# ...later
Bundler.require(:test)   # requires second_gem
# File lib/bundler.rb, line 214
def require(*groups)
  setup(*groups).require(*groups)
end
# File lib/bundler.rb, line 570
def reset!
  reset_paths!
  Plugin.reset!
  reset_rubygems!
end
# File lib/bundler.rb, line 581
def reset_paths!
  @bin_path = nil
  @bundler_major_version = nil
  @bundle_path = nil
  @configure = 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 596
def reset_rubygems!
  return unless defined?(@rubygems) && @rubygems
  rubygems.undo_replacements
  rubygems.reset
  @rubygems = nil
end
# File lib/bundler.rb, line 576
def reset_settings_and_root!
  @settings = nil
  @root = nil
end
# File lib/bundler.rb, line 354
def rm_rf(path)
  FileUtils.remove_entry_secure(path) if path && File.exist?(path)
end
# File lib/bundler.rb, line 320
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 258
def ruby_scope
  "#{Bundler.rubygems.ruby_engine}/#{RbConfig::CONFIG["ruby_version"]}"
end
# File lib/bundler.rb, line 525
def safe_load_marshal(data)
  if Gem.respond_to?(:load_safe_marshal)
    Gem.load_safe_marshal
    begin
      Gem::SafeMarshal.safe_load(data)
    rescue Gem::SafeMarshal::Reader::Error, Gem::SafeMarshal::Visitors::ToRuby::Error => e
      raise MarshalError, "#{e.class}: #{e.message}"
    end
  else
    load_marshal(data, marshal_proc: SafeMarshal.proc)
  end
end
# File lib/bundler.rb, line 609
def self_manager
  @self_manager ||= begin
                      require_relative "bundler/self_manager"
                      Bundler::SelfManager.new
                    end
end
# File lib/bundler.rb, line 358
def settings
  @settings ||= Settings.new(app_config_path)
rescue GemfileNotFound
  @settings = Settings.new
end

Turns on the Bundler runtime. After Bundler.setup call, all load or require of the gems would be allowed only if they are part of the Gemfile or Ruby’s standard library. If the versions specified in Gemfile, only those versions would be loaded.

Assuming Gemfile

gem 'first_gem', '= 1.0'
group :test do
  gem 'second_gem', '= 1.0'
end

The code using Bundler.setup works as follows:

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 can be called only once, all subsequent calls are no-op.

If groups list is provided, only gems from specified groups would be allowed (gems specified outside groups belong to special :default group).

To require all gems from Gemfile (or only some groups), see Bundler.require.

# File lib/bundler.rb, line 157
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
# File lib/bundler.rb, line 316
def specs_path
  bundle_path.join("specifications")
end
# File lib/bundler.rb, line 474
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 349
def tmp(name = Process.pid.to_s)
  Kernel.send(:require, "tmpdir")
  Pathname.new(Dir.mktmpdir(["bundler", name]))
end
# File lib/bundler.rb, line 93
def ui
  (defined?(@ui) && @ui) || (self.ui = UI::Shell.new)
end
# File lib/bundler.rb, line 97
def ui=(ui)
  Bundler.rubygems.ui = UI::RGProxy.new(ui)
  @ui = ui
end

Remove all bundler-related variables from ENV

# File lib/bundler.rb, line 387
def unbundle_env!
  ENV.replace(unbundle_env(ENV))
end

@return [Hash] Environment with all bundler-related variables removed

# File lib/bundler.rb, line 382
def unbundled_env
  unbundle_env(original_env)
end

Run a ‘Kernel.exec` to a subcommand in an environment with all bundler related variables removed

# File lib/bundler.rb, line 453
def unbundled_exec(*args)
  with_env(unbundled_env) { Kernel.exec(*args) }
end

Run subcommand in an environment with all bundler related variables removed

# File lib/bundler.rb, line 431
def unbundled_system(*args)
  with_unbundled_env { Kernel.system(*args) }
end
# File lib/bundler.rb, line 487
def use_system_gems?
  configured_bundle_path.use_system_gems?
end
# File lib/bundler.rb, line 286
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 304
def user_cache
  user_bundle_path("cache")
end
# File lib/bundler.rb, line 262
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 497
def which(executable)
  executable_path = find_executable(executable)
  return executable_path if executable_path

  if (paths = ENV["PATH"])
    quote = '"'
    paths.split(File::PATH_SEPARATOR).find do |path|
      path = path[1..-2] if path.start_with?(quote) && path.end_with?(quote)
      executable_path = find_executable(File.expand_path(executable, path))
      return executable_path if executable_path
    end
  end
end

@deprecated Use ‘with_unbundled_env` instead

# File lib/bundler.rb, line 397
def with_clean_env
  message =
    "`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`"
  removed_message =
    "`Bundler.with_clean_env` has been removed in favor of `Bundler.with_unbundled_env`. " \
    "If you instead want the environment before bundler was originally loaded, use `Bundler.with_original_env`"
  Bundler::SharedHelpers.major_deprecation(2, message, removed_message: removed_message, print_caller_location: true)
  with_env(unbundled_env) { yield }
end

Run block with environment present before Bundler was activated

# File lib/bundler.rb, line 392
def with_original_env
  with_env(original_env) { yield }
end

Run block with all bundler-related variables removed

# File lib/bundler.rb, line 409
def with_unbundled_env
  with_env(unbundled_env) { yield }
end