Module: Bundler

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

def git_present?
  return @git_present if defined?(@git_present)
  @git_present = Bundler.which("git#{RbConfig::CONFIG["EXEEXT"]}")
end

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

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

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

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

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

def use_system_gems?
  configured_bundle_path.use_system_gems?
end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

def clear_gemspec_cache
  @gemspec_cache = {}
end

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

def configure
  @configure ||= configure_gem_home_and_path
end

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

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

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

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 631

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

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

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

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

def create_bundle_path
  SharedHelpers.filesystem_access(bundle_path.to_s) do |p|
    mkdir_p(p)
  end 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/current_ruby.rb', line 7

def self.current_ruby
  @current_ruby ||= CurrentRuby.new
end

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

def default_bundle_dir
  SharedHelpers.default_bundle_dir
end

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

def default_gemfile
  SharedHelpers.default_gemfile
end

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

def default_lockfile
  SharedHelpers.default_lockfile
end

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

def definition(unlock = nil)
  @definition = nil if unlock
  @definition ||= begin
    configure
    Definition.build(default_gemfile, default_lockfile, unlock)
  end
end

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

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 623

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

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

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

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

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

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

def self.gem_version
  @gem_version ||= Gem::Version.create(VERSION)
end

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

def home
  bundle_path.join("bundler")
end

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

def install_path
  home.join("gems")
end

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

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

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

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 530

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

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

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

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

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

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

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 492

def mkdir_p(path, options = {})
  SharedHelpers.filesystem_access(path, :write) do |p|
    FileUtils.mkdir_p(p)
  end
end

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

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

  definition.most_specific_locked_platform == platform
end

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

def original_env
  ORIGINAL_ENV.clone
end

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

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

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

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

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

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

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

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

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

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

# File 'lib/bundler/vendored_thor.rb', line 4

def self.require_thor_actions
  require_relative "vendor/thor/lib/thor/actions"
end

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

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

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

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 587

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

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

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

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

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 cannot continue.
You should probably consider fixing this issue by running `chmod o-w ~` on *nix.
Please refer to https://ruby-doc.org/stdlib-3.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

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

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 235

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

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

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

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

def safe_load_marshal(data)
  load_marshal(data, :marshal_proc => SafeMarshal.proc)
end

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

def self_manager
  @self_manager ||= begin
                      require_relative "bundler/self_manager"
                      Bundler::SelfManager.new
                    end
end

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

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

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

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 293

def specs_path
  bundle_path.join("specifications")
end

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

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 326

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

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

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

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

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(__dir__)
    env["RUBYLIB"] = rubylib.join(File::PATH_SEPARATOR)
  end

  env
end

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

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

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

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

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

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

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

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 281

def user_cache
  user_bundle_path("cache")
end

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

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 498

def which(executable)
  if File.file?(executable) && File.executable?(executable)
    executable
  elsif 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 = File.expand_path(executable, path)
      return executable_path if File.file?(executable_path) && File.executable?(executable_path)
    end
  end
end

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

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

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

def with_env(env)
  backup = ENV.to_hash
  ENV.replace(env)
  yield
ensure
  ENV.replace(backup)
end

# File 'lib/bundler/friendly_errors.rb', line 115

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

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

def with_original_env
  with_env(original_env) { yield }
end

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

def with_unbundled_env
  with_env(unbundled_env) { yield }
end