123456789_123456789_123456789_123456789_123456789_

Module: Bundler

Relationships & Source Files
Namespace Children
Modules:
Classes:
Exceptions:
Defined in: lib/bundler.rb,
lib/bundler/build_metadata.rb,
lib/bundler/cli.rb,
lib/bundler/compact_index_client.rb,
lib/bundler/constants.rb,
lib/bundler/current_ruby.rb,
lib/bundler/definition.rb,
lib/bundler/dep_proxy.rb,
lib/bundler/dependency.rb,
lib/bundler/deployment.rb,
lib/bundler/deprecate.rb,
lib/bundler/digest.rb,
lib/bundler/dsl.rb,
lib/bundler/endpoint_specification.rb,
lib/bundler/env.rb,
lib/bundler/environment_preserver.rb,
lib/bundler/errors.rb,
lib/bundler/feature_flag.rb,
lib/bundler/fetcher.rb,
lib/bundler/friendly_errors.rb,
lib/bundler/gem_helper.rb,
lib/bundler/gem_helpers.rb,
lib/bundler/gem_version_promoter.rb,
lib/bundler/gemdeps.rb,
lib/bundler/graph.rb,
lib/bundler/index.rb,
lib/bundler/injector.rb,
lib/bundler/installer.rb,
lib/bundler/lazy_specification.rb,
lib/bundler/lockfile_generator.rb,
lib/bundler/lockfile_parser.rb,
lib/bundler/match_platform.rb,
lib/bundler/mirror.rb,
lib/bundler/plugin.rb,
lib/bundler/process_lock.rb,
lib/bundler/psyched_yaml.rb,
lib/bundler/remote_specification.rb,
lib/bundler/resolver.rb,
lib/bundler/retry.rb,
lib/bundler/ruby_dsl.rb,
lib/bundler/ruby_version.rb,
lib/bundler/rubygems_gem_installer.rb,
lib/bundler/rubygems_integration.rb,
lib/bundler/runtime.rb,
lib/bundler/settings.rb,
lib/bundler/shared_helpers.rb,
lib/bundler/similarity_detector.rb,
lib/bundler/source.rb,
lib/bundler/source_list.rb,
lib/bundler/source_map.rb,
lib/bundler/spec_set.rb,
lib/bundler/stub_specification.rb,
lib/bundler/ui.rb,
lib/bundler/uri_credentials_filter.rb,
lib/bundler/vendored_fileutils.rb,
lib/bundler/vendored_molinillo.rb,
lib/bundler/vendored_persistent.rb,
lib/bundler/vendored_persistent.rb,
lib/bundler/vendored_thor.rb,
lib/bundler/vendored_tmpdir.rb,
lib/bundler/vendored_tsort.rb,
lib/bundler/vendored_uri.rb,
lib/bundler/version.rb,
lib/bundler/version_ranges.rb,
lib/bundler/worker.rb,
lib/bundler/yaml_serializer.rb,
lib/bundler/cli/add.rb,
lib/bundler/cli/binstubs.rb,
lib/bundler/cli/cache.rb,
lib/bundler/cli/check.rb,
lib/bundler/cli/clean.rb,
lib/bundler/cli/common.rb,
lib/bundler/cli/config.rb,
lib/bundler/cli/console.rb,
lib/bundler/cli/doctor.rb,
lib/bundler/cli/exec.rb,
lib/bundler/cli/fund.rb,
lib/bundler/cli/gem.rb,
lib/bundler/cli/info.rb,
lib/bundler/cli/init.rb,
lib/bundler/cli/inject.rb,
lib/bundler/cli/install.rb,
lib/bundler/cli/issue.rb,
lib/bundler/cli/list.rb,
lib/bundler/cli/lock.rb,
lib/bundler/cli/open.rb,
lib/bundler/cli/outdated.rb,
lib/bundler/cli/platform.rb,
lib/bundler/cli/plugin.rb,
lib/bundler/cli/pristine.rb,
lib/bundler/cli/remove.rb,
lib/bundler/cli/show.rb,
lib/bundler/cli/update.rb,
lib/bundler/cli/viz.rb,
lib/bundler/compact_index_client/cache.rb,
lib/bundler/compact_index_client/gem_parser.rb,
lib/bundler/compact_index_client/updater.rb,
lib/bundler/fetcher/base.rb,
lib/bundler/fetcher/compact_index.rb,
lib/bundler/fetcher/dependency.rb,
lib/bundler/fetcher/downloader.rb,
lib/bundler/fetcher/index.rb,
lib/bundler/installer/gem_installer.rb,
lib/bundler/installer/parallel_installer.rb,
lib/bundler/installer/standalone.rb,
lib/bundler/plugin/api.rb,
lib/bundler/plugin/dsl.rb,
lib/bundler/plugin/events.rb,
lib/bundler/plugin/index.rb,
lib/bundler/plugin/installer.rb,
lib/bundler/plugin/source_list.rb,
lib/bundler/plugin/api/source.rb,
lib/bundler/plugin/installer/git.rb,
lib/bundler/plugin/installer/rubygems.rb,
lib/bundler/resolver/spec_group.rb,
lib/bundler/settings/validator.rb,
lib/bundler/source/gemspec.rb,
lib/bundler/source/git.rb,
lib/bundler/source/metadata.rb,
lib/bundler/source/path.rb,
lib/bundler/source/rubygems.rb,
lib/bundler/source/rubygems_aggregate.rb,
lib/bundler/source/git/git_proxy.rb,
lib/bundler/source/path/installer.rb,
lib/bundler/source/rubygems/remote.rb,
lib/bundler/ui/rg_proxy.rb,
lib/bundler/ui/shell.rb,
lib/bundler/ui/silent.rb,
lib/bundler/vendor/tsort/lib/tsort.rb,
lib/bundler/vendor/uri/lib/uri/common.rb

Overview

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

Since Ruby 2.6, Bundler is a part of Ruby’s standard library.

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

require 'bundler/setup'

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

See 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.

Constant Summary

Class Attribute Summary

Class Method Summary

Class Attribute Details

.frozen_bundle?Boolean (readonly)

[ GitHub ]

  
# File 'lib/bundler.rb', line 200

def frozen_bundle?
  frozen = settings[:deployment]
  frozen ||= settings[:frozen]
  frozen
end

.git_present?Boolean (readonly)

[ GitHub ]

  
# File 'lib/bundler.rb', line 598

def git_present?
  return @git_present if defined?(@git_present)
  @git_present = Bundler.which("git") || Bundler.which("git.exe")
end

.requires_sudo?Boolean (readonly)

[ GitHub ]

  
# File 'lib/bundler.rb', line 479

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 ]

  
# File 'lib/bundler.rb', line 85

def ui
  (defined?(@ui) && @ui) || (self.ui = UI::Shell.new)
end

.ui=(ui) (rw)

[ GitHub ]

  
# File 'lib/bundler.rb', line 89

def ui=(ui)
  Bundler.rubygems.ui = UI::RGProxy.new(ui)
  @ui = ui
end

.use_system_gems?Boolean (readonly)

[ GitHub ]

  
# File 'lib/bundler.rb', line 475

def use_system_gems?
  configured_bundle_path.use_system_gems?
end

Class Method Details

.app_cache(custom_path = nil)

[ GitHub ]

  
# File 'lib/bundler.rb', line 308

def app_cache(custom_path = nil)
  path = custom_path || root
  Pathname.new(path).join(settings.app_cache_path)
end

.app_config_path

[ GitHub ]

  
# File 'lib/bundler.rb', line 294

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

.bin_path

Returns absolute location of where binstubs are installed to.

[ GitHub ]

  
# File 'lib/bundler.rb', line 104

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

.bundle_path

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

[ GitHub ]

  
# File 'lib/bundler.rb', line 95

def bundle_path
  @bundle_path ||= Pathname.new(configured_bundle_path.path).expand_path(root)
end

.bundler_major_version

[ GitHub ]

  
# File 'lib/bundler/version.rb', line 6

def self.bundler_major_version
  @bundler_major_version ||= VERSION.split(".").first.to_i
end

.clean_env

Deprecated.

Use .unbundled_env instead

[ GitHub ]

  
# File 'lib/bundler.rb', line 342

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

.clean_exec(*args)

Deprecated.

Use .unbundled_exec instead

[ GitHub ]

  
# File 'lib/bundler.rb', line 429

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

.clean_system(*args)

Deprecated.

Use .unbundled_system instead

[ GitHub ]

  
# File 'lib/bundler.rb', line 407

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

.clear_gemspec_cache

[ GitHub ]

  
# File 'lib/bundler.rb', line 594

def clear_gemspec_cache
  @gemspec_cache = {}
end

.configure

[ GitHub ]

  
# File 'lib/bundler.rb', line 81

def configure
  @configured ||= configure_gem_home_and_path
end

.configure_gem_home(path) (private)

[ GitHub ]

  
# File 'lib/bundler.rb', line 675

def configure_gem_home(path)
  Bundler::SharedHelpers.set_env "GEM_HOME", path.to_s
end

.configure_gem_home_and_path(path = bundle_path)

[ GitHub ]

  
# File 'lib/bundler.rb', line 640

def configure_gem_home_and_path(path = bundle_path)
  configure_gem_path
  configure_gem_home(path)
  Bundler.rubygems.clear_paths
end

.configure_gem_path (private)

[ GitHub ]

  
# File 'lib/bundler.rb', line 666

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

.configured_bundle_path

[ GitHub ]

  
# File 'lib/bundler.rb', line 99

def configured_bundle_path
  @configured_bundle_path ||= settings.path.tap(&:validate!)
end

.current_rubyCurrentRuby

Returns current version of Ruby

Returns:

[ GitHub ]

  
# 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 458

def default_bundle_dir
  SharedHelpers.default_bundle_dir
end

.default_gemfile

[ GitHub ]

  
# File 'lib/bundler.rb', line 450

def default_gemfile
  SharedHelpers.default_gemfile
end

.default_lockfile

[ GitHub ]

  
# File 'lib/bundler.rb', line 454

def default_lockfile
  SharedHelpers.default_lockfile
end

.definition(unlock = nil) ⇒ Bundler::Definition

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

Parameters:

  • unlock (Hash, Boolean, nil) (defaults to: nil)

    Gems that have been requested to be updated or true if all gems should be updated

[ GitHub ]

  
# File 'lib/bundler.rb', line 192

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 182

def environment
  SharedHelpers.major_deprecation 2, "Bundler.environment has been removed in favor of Bundler.load", :print_caller_location => true
  load
end

.eval_gemspec(path, contents) (private)

[ GitHub ]

  
# File 'lib/bundler.rb', line 658

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

.eval_yaml_gemspec(path, contents) (private)

[ GitHub ]

  
# File 'lib/bundler.rb', line 648

def eval_yaml_gemspec(path, contents)
  require_relative "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 603

def feature_flag
  @feature_flag ||= FeatureFlag.new(VERSION)
end

.home

[ GitHub ]

  
# File 'lib/bundler.rb', line 272

def home
  bundle_path.join("bundler")
end

.install_path

[ GitHub ]

  
# File 'lib/bundler.rb', line 276

def install_path
  home.join("gems")
end

.load

[ GitHub ]

  
# File 'lib/bundler.rb', line 178

def load
  @load ||= Runtime.new(root, definition)
end

.load_gemspec(file, validate = false)

[ GitHub ]

  
# File 'lib/bundler.rb', line 567

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

.load_gemspec_uncached(file, validate = false)

[ GitHub ]

  
# File 'lib/bundler.rb', line 576

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

.load_marshal(data)

[ GitHub ]

  
# File 'lib/bundler.rb', line 561

def load_marshal(data)
  Marshal.load(data)
rescue StandardError => e
  raise MarshalError, "#{e.class}: #{e.message}"
end

.local_platform

[ GitHub ]

  
# File 'lib/bundler.rb', line 445

def local_platform
  return Gem::Platform::RUBY if settings[:force_ruby_platform] || Gem.platforms == [Gem::Platform::RUBY]
  Gem::Platform.local
end

.locked_gems

[ GitHub ]

  
# File 'lib/bundler.rb', line 206

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 507

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

.most_specific_locked_platform?(platform) ⇒ Boolean

[ GitHub ]

  
# File 'lib/bundler.rb', line 216

def most_specific_locked_platform?(platform)
  return false unless defined?(@definition) && @definition

  definition.most_specific_locked_platform == platform
end

.original_envHash

Returns:

  • (Hash)

    Environment present before Bundler was activated

[ GitHub ]

  
# File 'lib/bundler.rb', line 337

def original_env
  ORIGINAL_ENV.clone
end

.original_exec(*args)

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

[ GitHub ]

  
# File 'lib/bundler.rb', line 424

def original_exec(*args)
  with_original_env { Kernel.exec(*args) }
end

.original_system(*args)

Run subcommand with the environment present before Bundler was activated

[ GitHub ]

  
# File 'lib/bundler.rb', line 402

def original_system(*args)
  with_original_env { Kernel.system(*args) }
end

.preferred_gemfile_name

[ GitHub ]

  
# File 'lib/bundler.rb', line 471

def preferred_gemfile_name
  Bundler.settings[:init_gems_rb] ? "gems.rb" : "Gemfile"
end

.read_file(file)

[ GitHub ]

  
# File 'lib/bundler.rb', line 555

def read_file(file)
  SharedHelpers.filesystem_access(file, :read) do
    File.open(file, "r:UTF-8", &:read)
  end
end

.require(*groups)

Setups Bundler environment (see .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
[ GitHub ]

  
# File 'lib/bundler.rb', line 174

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
  require_relative "vendor/thor/lib/thor/actions"
end

.reset!

[ GitHub ]

  
# File 'lib/bundler.rb', line 607

def reset!
  reset_paths!
  Plugin.reset!
  reset_rubygems!
end

.reset_paths!

[ GitHub ]

  
# File 'lib/bundler.rb', line 618

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 ]

  
# File 'lib/bundler.rb', line 633

def reset_rubygems!
  return unless defined?(@rubygems) && @rubygems
  rubygems.undo_replacements
  rubygems.reset
  @rubygems = nil
end

.reset_settings_and_root!

[ GitHub ]

  
# File 'lib/bundler.rb', line 613

def reset_settings_and_root!
  @settings = nil
  @root = nil
end

.rm_rf(path)

[ GitHub ]

  
# File 'lib/bundler.rb', line 318

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

.root

[ GitHub ]

  
# File 'lib/bundler.rb', line 284

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

.ruby_scope

[ GitHub ]

  
# File 'lib/bundler.rb', line 222

def ruby_scope
  "#{Bundler.rubygems.ruby_engine}/#{RbConfig::CONFIG["ruby_version"]}"
end

.rubygems

[ GitHub ]

  
# File 'lib/bundler/rubygems_integration.rb', line 630

def self.rubygems
  @rubygems ||= RubygemsIntegration.new
end

.settings

[ GitHub ]

  
# File 'lib/bundler.rb', line 330

def settings
  @settings ||= Settings.new(app_config_path)
rescue GemfileNotFound
  @settings = Settings.new(Pathname.new(".bundle").expand_path)
end

.setup(*groups)

Turns on the Bundler runtime. After 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 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

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 .require.

[ GitHub ]

  
# File 'lib/bundler.rb', line 140

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 280

def specs_path
  bundle_path.join("specifications")
end

.sudo(str)

[ GitHub ]

  
# File 'lib/bundler.rb', line 530

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

.system_bindir

[ GitHub ]

  
# File 'lib/bundler.rb', line 462

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

.tmp(name = Process.pid.to_s)

[ GitHub ]

  
# File 'lib/bundler.rb', line 313

def tmp(name = Process.pid.to_s)
  Kernel.send(:require, "tmpdir")
  Pathname.new(Dir.mktmpdir(["bundler", name]))
end

.tmp_home_path (private)

[ GitHub ]

  
# File 'lib/bundler.rb', line 679

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

.unbundled_envHash

Returns:

  • (Hash)

    Environment with all bundler-related variables removed

[ GitHub ]

  
# File 'lib/bundler.rb', line 354

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

.unbundled_exec(*args)

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

[ GitHub ]

  
# File 'lib/bundler.rb', line 441

def unbundled_exec(*args)
  with_env(unbundled_env) { Kernel.exec(*args) }
end

.unbundled_system(*args)

Run subcommand in an environment with all bundler related variables removed

[ GitHub ]

  
# File 'lib/bundler.rb', line 419

def unbundled_system(*args)
  with_unbundled_env { Kernel.system(*args) }
end

URI(uri) (mod_func)

Returns uri converted to an ::Bundler::URI object.

[ GitHub ]

  
# File 'lib/bundler/vendor/uri/lib/uri/common.rb', line 733

def URI(uri)
  if uri.is_a?(Bundler::URI::Generic)
    uri
  elsif uri = String.try_convert(uri)
    Bundler::URI.parse(uri)
  else
    raise ArgumentError,
      "bad argument (expected Bundler::URI object or Bundler::URI string)"
  end
end

.user_bundle_path(dir = "home")

[ GitHub ]

  
# File 'lib/bundler.rb', line 250

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

.user_cache

[ GitHub ]

  
# File 'lib/bundler.rb', line 268

def user_cache
  user_bundle_path("cache")
end

.user_home

[ GitHub ]

  
# File 'lib/bundler.rb', line 226

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

.which(executable)

[ GitHub ]

  
# File 'lib/bundler.rb', line 517

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

.with_clean_env

Deprecated.

Use .with_unbundled_env instead

[ GitHub ]

  
# File 'lib/bundler.rb', line 385

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

.with_env(env) (private)

Parameters:

  • env (Hash)
[ GitHub ]

  
# File 'lib/bundler.rb', line 689

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 101

def self.with_friendly_errors
  FriendlyErrors.enable!
  yield
rescue SignalException
  raise
rescue Exception => e # rubocop:disable Lint/RescueException
  raise if FriendlyErrors.disabled?

  FriendlyErrors.log_error(e)
  exit FriendlyErrors.exit_status(e)
end

.with_original_env

Run block with environment present before Bundler was activated

[ GitHub ]

  
# File 'lib/bundler.rb', line 380

def with_original_env
  with_env(original_env) { yield }
end

.with_unbundled_env

Run block with all bundler-related variables removed

[ GitHub ]

  
# File 'lib/bundler.rb', line 397

def with_unbundled_env
  with_env(unbundled_env) { yield }
end