module Bundler

def self.current_ruby

Returns:
  • (CurrentRuby) - Current version of Ruby
def self.current_ruby
  @current_ruby ||= CurrentRuby.new
end

def self.issues_url(exception)

def self.issues_url(exception)
  "https://github.com/bundler/bundler/search?q=" \
  "#{CGI.escape(exception.message.lines.first.chomp)}&type=Issues"
end

def self.preserve_gem_path

def self.preserve_gem_path
  original_gem_path = ENV["_ORIGINAL_GEM_PATH"]
  gem_path          = ENV["GEM_PATH"]
  ENV["_ORIGINAL_GEM_PATH"] = gem_path          if original_gem_path.nil? || original_gem_path == ""
  ENV["GEM_PATH"]           = original_gem_path if gem_path.nil? || gem_path == ""
end

def self.request_issue_report_for(e)

def self.request_issue_report_for(e)
  Bundler.ui.info <<-EOS.gsub(/^ {6}/, "")
    --- ERROR REPORT TEMPLATE -------------------------------------------------------
    - What did you do?
      I ran the command `#{$PROGRAM_NAME} #{ARGV.join(" ")}`
    - What did you expect to happen?
      I expected Bundler to...
    - What happened instead?
      Instead, what actually happened was...
    Error details
        #{e.class}: #{e.message}
          #{e.backtrace.join("\n            ")}
    #{Bundler::Env.new.report(:print_gemfile => false, :print_gemspecs => false).gsub(/\n/, "\n      ").strip}
    --- TEMPLATE END ----------------------------------------------------------------
  EOS
  Bundler.ui.error "Unfortunately, an unexpected error occurred, and Bundler cannot continue."
  Bundler.ui.warn <<-EOS.gsub(/^ {6}/, "")
    First, try this link to see if there are any existing issue reports for this error:
    #{issues_url(e)}
    If there aren't any reports for this error yet, please create copy and paste the report template above into a new issue. Don't forget to anonymize any private data! The new issue form is located at:
    https://github.com/bundler/bundler/issues/new
  EOS
end

def self.with_friendly_errors

def self.with_friendly_errors
  yield
rescue YAMLSyntaxError => e
  Bundler.ui.error e.message
  Bundler.ui.trace e.orig_exception
  exit e.status_code
rescue Bundler::Dsl::DSLError => e
  Bundler.ui.error e.message
  exit e.status_code
rescue Bundler::GemRequireError => e
  Bundler.ui.error e.message
  Bundler.ui.trace e.orig_exception, nil, true
  exit e.status_code
rescue Bundler::BundlerError => e
  Bundler.ui.error e.message, :wrap => true
  Bundler.ui.trace e
  exit e.status_code
rescue Thor::AmbiguousTaskError => e
  Bundler.ui.error e.message
  exit 15
rescue Thor::UndefinedTaskError => e
  Bundler.ui.error e.message
  exit 15
rescue Thor::Error => e
  Bundler.ui.error e.message
  exit 1
rescue LoadError => e
  raise e unless e.message =~ /cannot load such file -- openssl|openssl.so|libcrypto.so/
  Bundler.ui.error "\nCould not load OpenSSL."
  Bundler.ui.warn <<-WARN, :wrap => true
    You must recompile Ruby with OpenSSL support or change the sources in your \
    Gemfile from 'https' to 'http'. Instructions for compiling with OpenSSL \
    using RVM are available at http://rvm.io/packages/openssl.
  WARN
  Bundler.ui.trace e
  exit 1
rescue Interrupt => e
  Bundler.ui.error "\nQuitting..."
  Bundler.ui.trace e
  exit 1
rescue SystemExit => e
  exit e.status
rescue Exception => e
  request_issue_report_for(e)
  exit 1
end

def app_cache(custom_path = nil)

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

def app_config_path

def app_config_path
  if ENV["BUNDLE_APP_CONFIG"]
    Pathname.new(ENV["BUNDLE_APP_CONFIG"]).expand_path(root)
  else
    root.join(".bundle")
  end
end

def bin_path

Returns absolute location of where binstubs are installed to.
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

def bundle_path

Returns absolute path of where gems are installed on the filesystem.
def bundle_path
  @bundle_path ||= Pathname.new(settings.path).expand_path(root)
end

def cache

def cache
  bundle_path.join("cache/bundler")
end

def clean_exec(*args)

def clean_exec(*args)
  with_clean_env { Kernel.exec(*args) }
end

def clean_system(*args)

def clean_system(*args)
  with_clean_env { Kernel.system(*args) }
end

def clear_gemspec_cache

def clear_gemspec_cache
  @gemspec_cache = {}
end

def configure

def configure
  @configured ||= configure_gem_home_and_path
end

def configure_gem_home

def configure_gem_home
  # TODO: This mkdir_p is only needed for JRuby <= 1.5 and should go away (GH #602)
  begin
    FileUtils.mkdir_p bundle_path.to_s
  rescue
    nil
  end
  ENV["GEM_HOME"] = File.expand_path(bundle_path, root)
  Bundler.rubygems.clear_paths
end

def configure_gem_home_and_path

def configure_gem_home_and_path
  blank_home = ENV["GEM_HOME"].nil? || ENV["GEM_HOME"].empty?
  if settings[:disable_shared_gems]
    ENV["GEM_PATH"] = ""
  elsif blank_home || Bundler.rubygems.gem_dir != bundle_path.to_s
    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
  configure_gem_home
  bundle_path
end

def default_bundle_dir

def default_bundle_dir
  SharedHelpers.default_bundle_dir
end

def default_gemfile

def default_gemfile
  SharedHelpers.default_gemfile
end

def default_lockfile

def default_lockfile
  SharedHelpers.default_lockfile
end

def definition(unlock = nil)

Returns:
  • (Bundler::Definition) -

Parameters:
  • unlock (Hash, Boolean, nil) -- Gems that have been requested
def definition(unlock = nil)
  @definition = nil if unlock
  @definition ||= begin
    configure
    upgrade_lockfile
    Definition.build(default_gemfile, default_lockfile, unlock)
  end
end

def environment

def environment
  Bundler::Environment.new(root, definition)
end

def eval_gemspec(path, contents)

def eval_gemspec(path, contents)
  eval(contents, TOPLEVEL_BINDING, path.expand_path.to_s)
rescue ScriptError, StandardError => e
  original_line = e.backtrace.find {|line| line.include?(path.to_s) }
  msg = "There was a #{e.class} while loading #{path.basename}: \n#{e.message}"
  msg << " from\n  #{original_line}" if original_line
  msg << "\n"
  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, msg
end

def eval_yaml_gemspec(path, contents)

def eval_yaml_gemspec(path, contents)
  # 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 YamlSyntaxError, ArgumentError, Gem::EndOfYAMLException, Gem::Exception
  eval_gemspec(path, contents)
end

def git_present?

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

def home

def home
  bundle_path.join("bundler")
end

def install_path

def install_path
  home.join("gems")
end

def load

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

def load_gemspec(file, validate = false)

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

def load_gemspec_uncached(file, validate = false)

def load_gemspec_uncached(file, validate = false)
  path = Pathname.new(file)
  # Eval the gemspec from its parent directory, because some gemspecs
  # depend on "./" relative paths.
  SharedHelpers.chdir(path.dirname.to_s) do
    contents = path.read
    if contents[0..2] == "---" # YAML header
      spec = eval_yaml_gemspec(path, contents)
    else
      spec = eval_gemspec(path, contents)
    end
    Bundler.rubygems.validate(spec) if spec && validate
    spec
  end
rescue Gem::InvalidSpecificationException => e
  UI::Shell.new.warn "The gemspec at #{file} is not valid. " \
    "The validation error was '#{e.message}'"
  nil
end

def load_marshal(data)

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

def locked_gems

def locked_gems
  return @locked_gems if defined?(@locked_gems)
  if Bundler.default_lockfile.exist?
    lock = Bundler.read_file(Bundler.default_lockfile)
    @locked_gems = LockfileParser.new(lock)
  else
    @locked_gems = nil
  end
end

def mkdir_p(path)

def mkdir_p(path)
  if requires_sudo?
    sudo "mkdir -p '#{path}'" unless File.exist?(path)
  else
    SharedHelpers.filesystem_access(path, :write) do |p|
      FileUtils.mkdir_p(p)
    end
  end
end

def read_file(file)

def read_file(file)
  File.open(file, "rb", &:read)
end

def require(*groups)

def require(*groups)
  setup(*groups).require(*groups)
end

def requires_sudo?

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[path.join("build_info/*").to_s] | Dir[path.join("*").to_s]
    sudo_needed = files.any? {|f| !File.writable?(f) }
  end
  @requires_sudo_ran = true
  @requires_sudo = settings.allow_sudo? && sudo_present && sudo_needed
end

def reset!

def reset!
  @definition = nil
end

def rm_rf(path)

def rm_rf(path)
  FileUtils.remove_entry_secure(path) if path && File.exist?(path)
end

def root

def root
  @root ||= begin
              default_gemfile.dirname.expand_path
            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

def ruby_scope

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

def ruby_version

def ruby_version
  @ruby_version ||= SystemRubyVersion.new
end

def settings

def settings
  return @settings if defined?(@settings)
  @settings = Settings.new(app_config_path)
rescue GemfileNotFound
  @settings = Settings.new(Pathname.new(".bundle").expand_path)
end

def setup(*groups)

def setup(*groups)
  # Just return if all groups are already loaded
  return @setup if defined?(@setup)
  definition.validate_ruby!
  if groups.empty?
    # Load all groups, but only once
    @setup = load.setup
  else
    load.setup(*groups)
  end
end

def specs_path

def specs_path
  bundle_path.join("specifications")
end

def sudo(str)

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
    `sudo -p "#{prompt}" #{str}`
  end
end

def system_bindir

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

def tmp(name = Process.pid.to_s)

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

def ui

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

def ui=(ui)

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

def upgrade_lockfile

def upgrade_lockfile
  lockfile = default_lockfile
  if lockfile.exist? && lockfile.read(3) == "---"
    Bundler.ui.warn "Detected Gemfile.lock generated by 0.9, deleting..."
    lockfile.rmtree
  end
end

def user_bundle_path

def user_bundle_path
  Pathname.new(Bundler.rubygems.user_home).join(".bundler")
end

def which(executable)

def which(executable)
  if File.file?(executable) && File.executable?(executable)
    executable
  elsif ENV["PATH"]
    path = ENV["PATH"].split(File::PATH_SEPARATOR).find do |p|
      abs_path = File.join(p, executable)
      File.file?(abs_path) && File.executable?(abs_path)
    end
    path && File.expand_path(executable, path)
  end
end

def with_clean_env

def with_clean_env
  with_original_env do
    ENV["MANPATH"] = ENV["BUNDLE_ORIG_MANPATH"]
    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.expand_path("..", __FILE__))
      ENV["RUBYLIB"] = rubylib.join(File::PATH_SEPARATOR)
    end
    yield
  end
end

def with_original_env

def with_original_env
  bundled_env = ENV.to_hash
  ENV.replace(ORIGINAL_ENV)
  yield
ensure
  ENV.replace(bundled_env.to_hash)
end