module Bundler

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

This code was extracted from github.com/Solistra/ruby-digest which is under public domain

TSort implements topological sorting using Tarjan’s algorithm for strongly connected components.

TSort is designed to be able to be used with any object which can be interpreted as a directed graph.

TSort requires two methods to interpret an object as a graph, tsort_each_node and tsort_each_child.

  • tsort_each_node is used to iterate for all nodes over a graph.

  • tsort_each_child is used to iterate for child nodes of a given node.

The equality of nodes are defined by eql? and hash since TSort uses Hash internally.

A Simple Example

The following example demonstrates how to mix the TSort module into an existing class (in this case, Hash). Here, we’re treating each key in the hash as a node in the graph, and so we simply alias the required tsort_each_node method to Hash’s each_key method. For each key in the hash, the associated value is an array of the node’s child nodes. This choice in turn leads to our implementation of the required tsort_each_child method, which fetches the array of child nodes and then iterates over that array using the user-supplied block.

require 'tsort'

class Hash
  include TSort
  alias tsort_each_node each_key
  def tsort_each_child(node, &block)
    fetch(node).each(&block)
  end
end

{1=>[2, 3], 2=>[3], 3=>[], 4=>[]}.tsort
#=> [3, 2, 1, 4]

{1=>[2], 2=>[3, 4], 3=>[2], 4=>[]}.strongly_connected_components
#=> [[4], [2, 3], [1]]

A More Realistic Example

A very simple ‘make’ like tool can be implemented as follows:

require 'tsort'

class Make
  def initialize
    @dep = {}
    @dep.default = []
  end

  def rule(outputs, inputs=[], &block)
    triple = [outputs, inputs, block]
    outputs.each {|f| @dep[f] = [triple]}
    @dep[triple] = inputs
  end

  def build(target)
    each_strongly_connected_component_from(target) {|ns|
      if ns.length != 1
        fs = ns.delete_if {|n| Array === n}
        raise TSort::Cyclic.new("cyclic dependencies: #{fs.join ', '}")
      end
      n = ns.first
      if Array === n
        outputs, inputs, block = n
        inputs_time = inputs.map {|f| File.mtime f}.max
        begin
          outputs_time = outputs.map {|f| File.mtime f}.min
        rescue Errno::ENOENT
          outputs_time = nil
        end
        if outputs_time == nil ||
           inputs_time != nil && outputs_time <= inputs_time
          sleep 1 if inputs_time != nil && inputs_time.to_i == Time.now.to_i
          block.call
        end
      end
    }
  end

  def tsort_each_child(node, &block)
    @dep[node].each(&block)
  end
  include TSort
end

def command(arg)
  print arg, "\n"
  system arg
end

m = Make.new
m.rule(%w[t1]) { command 'date > t1' }
m.rule(%w[t2]) { command 'date > t2' }
m.rule(%w[t3]) { command 'date > t3' }
m.rule(%w[t4], %w[t1 t3]) { command 'cat t1 t3 > t4' }
m.rule(%w[t5], %w[t4 t2]) { command 'cat t4 t2 > t5' }
m.build('t5')

Bugs

  • ‘tsort.rb’ is wrong name because this library uses Tarjan’s algorithm for strongly connected components. Although ‘strongly_connected_components.rb’ is correct but too long.

References

    1. Tarjan, “Depth First Search and Linear Graph Algorithms”,

SIAM Journal on Computing, Vol. 1, No. 2, pp. 146-160, June 1972.

Constants

Deprecate
FREEBSD
NULL
ORIGINAL_ENV
SUDO_MUTEX
VERSION
WINDOWS

Public Class Methods

URI(uri) click to toggle source

Returns uri converted to an Bundler::URI object.

# File bundler/vendor/uri/lib/uri/common.rb, line 670
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
app_cache(custom_path = nil) click to toggle source
# File bundler.rb, line 309
def app_cache(custom_path = nil)
  path = custom_path || root
  Pathname.new(path).join(settings.app_cache_path)
end
app_config_path() click to toggle source
# File 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
bin_path() click to toggle source

Returns absolute location of where binstubs are installed to.

# File 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
bundle_path() click to toggle source

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

# File bundler.rb, line 96
def bundle_path
  @bundle_path ||= Pathname.new(configured_bundle_path.path).expand_path(root)
end
bundler_major_version() click to toggle source
# File bundler/version.rb, line 6
def self.bundler_major_version
  @bundler_major_version ||= VERSION.split(".").first.to_i
end
clean_env() click to toggle source

@deprecated Use ‘unbundled_env` instead

# File 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
clean_exec(*args) click to toggle source

@deprecated Use ‘unbundled_exec` instead

# File 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
clean_system(*args) click to toggle source

@deprecated Use ‘unbundled_system` instead

# File 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
clear_gemspec_cache() click to toggle source
# File bundler.rb, line 595
def clear_gemspec_cache
  @gemspec_cache = {}
end
configure() click to toggle source
# File bundler.rb, line 82
def configure
  @configured ||= configure_gem_home_and_path
end
configure_gem_home_and_path(path = bundle_path) click to toggle source
# File 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
configured_bundle_path() click to toggle source
# File bundler.rb, line 100
def configured_bundle_path
  @configured_bundle_path ||= settings.path.tap(&:validate!)
end
current_ruby() click to toggle source

Returns current version of Ruby

@return [CurrentRuby] Current version of Ruby

# File bundler/current_ruby.rb, line 7
def self.current_ruby
  @current_ruby ||= CurrentRuby.new
end
default_bundle_dir() click to toggle source
# File bundler.rb, line 459
def default_bundle_dir
  SharedHelpers.default_bundle_dir
end
default_gemfile() click to toggle source
# File bundler.rb, line 451
def default_gemfile
  SharedHelpers.default_gemfile
end
default_lockfile() click to toggle source
# File bundler.rb, line 455
def default_lockfile
  SharedHelpers.default_lockfile
end
definition(unlock = nil) click to toggle source

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

@return [Bundler::Definition]

# File bundler.rb, line 193
def definition(unlock = nil)
  @definition = nil if unlock
  @definition ||= begin
    configure
    Definition.build(default_gemfile, default_lockfile, unlock)
  end
end
environment() click to toggle source
# File 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
feature_flag() click to toggle source
# File bundler.rb, line 604
def feature_flag
  @feature_flag ||= FeatureFlag.new(VERSION)
end
frozen_bundle?() click to toggle source
# File bundler.rb, line 201
def frozen_bundle?
  frozen = settings[:deployment]
  frozen ||= settings[:frozen]
  frozen
end
git_present?() click to toggle source
# File bundler.rb, line 599
def git_present?
  return @git_present if defined?(@git_present)
  @git_present = Bundler.which("git") || Bundler.which("git.exe")
end
home() click to toggle source
# File bundler.rb, line 273
def home
  bundle_path.join("bundler")
end
install_path() click to toggle source
# File bundler.rb, line 277
def install_path
  home.join("gems")
end
load() click to toggle source
# File bundler.rb, line 179
def load
  @load ||= Runtime.new(root, definition)
end
load_gemspec(file, validate = false) click to toggle source
# File 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
load_gemspec_uncached(file, validate = false) click to toggle source
# File 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
load_marshal(data) click to toggle source
# File bundler.rb, line 562
def load_marshal(data)
  Marshal.load(data)
rescue StandardError => e
  raise MarshalError, "#{e.class}: #{e.message}"
end
local_platform() click to toggle source
# File 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
locked_gems() click to toggle source
# File 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
mkdir_p(path, options = {}) click to toggle source
# File 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
most_specific_locked_platform?(platform) click to toggle source
# File bundler.rb, line 217
def most_specific_locked_platform?(platform)
  return false unless defined?(@definition) && @definition

  definition.most_specific_locked_platform == platform
end
original_env() click to toggle source

@return [Hash] Environment present before Bundler was activated

# File bundler.rb, line 338
def original_env
  ORIGINAL_ENV.clone
end
original_exec(*args) click to toggle source

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

# File bundler.rb, line 425
def original_exec(*args)
  with_original_env { Kernel.exec(*args) }
end
original_system(*args) click to toggle source

Run subcommand with the environment present before Bundler was activated

# File bundler.rb, line 403
def original_system(*args)
  with_original_env { Kernel.system(*args) }
end
preferred_gemfile_name() click to toggle source
# File bundler.rb, line 472
def preferred_gemfile_name
  Bundler.settings[:init_gems_rb] ? "gems.rb" : "Gemfile"
end
read_file(file) click to toggle source
# File bundler.rb, line 556
def read_file(file)
  SharedHelpers.filesystem_access(file, :read) do
    File.open(file, "r:UTF-8", &:read)
  end
end
require(*groups) click to toggle source

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 bundler.rb, line 175
def require(*groups)
  setup(*groups).require(*groups)
end
require_thor_actions() click to toggle source
# File bundler/vendored_thor.rb, line 4
def self.require_thor_actions
  require_relative "vendor/thor/lib/thor/actions"
end
requires_sudo?() click to toggle source
# File 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
reset!() click to toggle source
# File bundler.rb, line 608
def reset!
  reset_paths!
  Plugin.reset!
  reset_rubygems!
end
reset_paths!() click to toggle source
# File 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
reset_rubygems!() click to toggle source
# File bundler.rb, line 634
def reset_rubygems!
  return unless defined?(@rubygems) && @rubygems
  rubygems.undo_replacements
  rubygems.reset
  @rubygems = nil
end
reset_settings_and_root!() click to toggle source
# File bundler.rb, line 614
def reset_settings_and_root!
  @settings = nil
  @root = nil
end
rm_rf(path) click to toggle source
# File 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
root() click to toggle source
# File 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
ruby_scope() click to toggle source
# File bundler.rb, line 223
def ruby_scope
  "#{Bundler.rubygems.ruby_engine}/#{RbConfig::CONFIG["ruby_version"]}"
end
rubygems() click to toggle source
# File bundler/rubygems_integration.rb, line 581
def self.rubygems
  @rubygems ||= RubygemsIntegration.new
end
self_manager() click to toggle source
# File bundler.rb, line 647
def self_manager
  @self_manager ||= begin
                      require_relative "bundler/self_manager"
                      Bundler::SelfManager.new
                    end
end
settings() click to toggle source
# File bundler.rb, line 331
def settings
  @settings ||= Settings.new(app_config_path)
rescue GemfileNotFound
  @settings = Settings.new(Pathname.new(".bundle").expand_path)
end
setup(*groups) click to toggle source

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 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
specs_path() click to toggle source
# File bundler.rb, line 281
def specs_path
  bundle_path.join("specifications")
end
sudo(str) click to toggle source
# File 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
system_bindir() click to toggle source
# File 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
tmp(name = Process.pid.to_s) click to toggle source
# File bundler.rb, line 314
def tmp(name = Process.pid.to_s)
  Kernel.send(:require, "tmpdir")
  Pathname.new(Dir.mktmpdir(["bundler", name]))
end
ui() click to toggle source
# File bundler.rb, line 86
def ui
  (defined?(@ui) && @ui) || (self.ui = UI::Shell.new)
end
ui=(ui) click to toggle source
# File bundler.rb, line 90
def ui=(ui)
  Bundler.rubygems.ui = UI::RGProxy.new(ui)
  @ui = ui
end
unbundled_env() click to toggle source

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

# File 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
unbundled_exec(*args) click to toggle source

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

# File bundler.rb, line 442
def unbundled_exec(*args)
  with_env(unbundled_env) { Kernel.exec(*args) }
end
unbundled_system(*args) click to toggle source

Run subcommand in an environment with all bundler related variables removed

# File bundler.rb, line 420
def unbundled_system(*args)
  with_unbundled_env { Kernel.system(*args) }
end
use_system_gems?() click to toggle source
# File bundler.rb, line 476
def use_system_gems?
  configured_bundle_path.use_system_gems?
end
user_bundle_path(dir = "home") click to toggle source
# File 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
user_cache() click to toggle source
# File bundler.rb, line 269
def user_cache
  user_bundle_path("cache")
end
user_home() click to toggle source
# File 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
which(executable) click to toggle source
# File 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
with_clean_env() { || ... } click to toggle source

@deprecated Use ‘with_unbundled_env` instead

# File 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
with_friendly_errors() { || ... } click to toggle source
# File 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() { || ... } click to toggle source

Run block with environment present before Bundler was activated

# File bundler.rb, line 381
def with_original_env
  with_env(original_env) { yield }
end
with_unbundled_env() { || ... } click to toggle source

Run block with all bundler-related variables removed

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

Private Class Methods

configure_gem_home(path) click to toggle source
# File bundler.rb, line 681
def configure_gem_home(path)
  Bundler::SharedHelpers.set_env "GEM_HOME", path.to_s
end
configure_gem_path() click to toggle source
# File 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
eval_gemspec(path, contents) click to toggle source
# File 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
eval_yaml_gemspec(path, contents) click to toggle source
# File 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
tmp_home_path() click to toggle source
# File 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
with_env(env) { || ... } click to toggle source

@param env [Hash]

# File bundler.rb, line 695
def with_env(env)
  backup = ENV.to_hash
  ENV.replace(env)
  yield
ensure
  ENV.replace(backup)
end

Private Instance Methods

URI(uri) click to toggle source

Returns uri converted to an Bundler::URI object.

# File bundler/vendor/uri/lib/uri/common.rb, line 670
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