module Bundler::SharedHelpers

Public Instance Methods

chdir(dir, &blk) click to toggle source
# File lib/bundler/shared_helpers.rb, line 53
def chdir(dir, &blk)
  Bundler.rubygems.ext_lock.synchronize do
    Dir.chdir dir, &blk
  end
end
const_get_safely(constant_name, namespace) click to toggle source
# File lib/bundler/shared_helpers.rb, line 125
def const_get_safely(constant_name, namespace)
  const_in_namespace = namespace.constants.include?(constant_name.to_s) ||
    namespace.constants.include?(constant_name.to_sym)
  return nil unless const_in_namespace
  namespace.const_get(constant_name)
end
default_bundle_dir() click to toggle source
# File lib/bundler/shared_helpers.rb, line 37
def default_bundle_dir
  bundle_dir = find_directory(".bundle")
  return nil unless bundle_dir

  bundle_dir = Pathname.new(bundle_dir)

  global_bundle_dir = Bundler.user_home.join(".bundle")
  return nil if bundle_dir == global_bundle_dir

  bundle_dir
end
default_gemfile() click to toggle source
# File lib/bundler/shared_helpers.rb, line 22
def default_gemfile
  gemfile = find_gemfile(:order_matters)
  raise GemfileNotFound, "Could not locate Gemfile" unless gemfile
  Pathname.new(gemfile).untaint.expand_path
end
default_lockfile() click to toggle source
# File lib/bundler/shared_helpers.rb, line 28
def default_lockfile
  gemfile = default_gemfile

  case gemfile.basename.to_s
  when "gems.rb" then Pathname.new(gemfile.sub(/.rb$/, ".locked"))
  else Pathname.new("#{gemfile}.lock")
  end.untaint
end
digest(name) click to toggle source
# File lib/bundler/shared_helpers.rb, line 208
def digest(name)
  require "digest"
  Digest(name)
end
ensure_same_dependencies(spec, old_deps, new_deps) click to toggle source
# File lib/bundler/shared_helpers.rb, line 164
def ensure_same_dependencies(spec, old_deps, new_deps)
  new_deps = new_deps.reject {|d| d.type == :development }
  old_deps = old_deps.reject {|d| d.type == :development }

  without_type = proc {|d| Gem::Dependency.new(d.name, d.requirements_list.sort) }
  new_deps.map!(&without_type)
  old_deps.map!(&without_type)

  extra_deps = new_deps - old_deps
  return if extra_deps.empty?

  Bundler.ui.debug "#{spec.full_name} from #{spec.remote} has either corrupted API or lockfile dependencies" \
    " (was expecting #{old_deps.map(&:to_s)}, but the real spec has #{new_deps.map(&:to_s)})"
  raise APIResponseMismatchError,
    "Downloading #{spec.full_name} revealed dependencies not in the API or the lockfile (#{extra_deps.join(", ")})." \
    "\nEither installing with `--full-index` or running `bundle update #{spec.name}` should fix the problem."
end
filesystem_access(path, action = :write, &block) click to toggle source

Rescues permissions errors raised by file system operations (ie. Errno:EACCESS, Errno::EAGAIN) and raises more friendly errors instead.

@param path [String] the path that the action will be attempted to @param action [Symbol, to_s] the type of operation that will be

performed. For example: :write, :read, :exec

@yield path

@raise [Bundler::PermissionError] if Errno:EACCES is raised in the

given block

@raise [Bundler::TemporaryResourceError] if Errno:EAGAIN is raised in the

given block

@example

filesystem_access("vendor/cache", :write) do
  FileUtils.mkdir_p("vendor/cache")
end

@see {Bundler::PermissionError}

# File lib/bundler/shared_helpers.rb, line 105
def filesystem_access(path, action = :write, &block)
  # Use block.call instead of yield because of a bug in Ruby 2.2.2
  # See https://github.com/bundler/bundler/issues/5341 for details
  block.call(path.dup.untaint)
rescue Errno::EACCES
  raise PermissionError.new(path, action)
rescue Errno::EAGAIN
  raise TemporaryResourceError.new(path, action)
rescue Errno::EPROTO
  raise VirtualProtocolError.new
rescue Errno::ENOSPC
  raise NoSpaceOnDeviceError.new(path, action)
rescue *[const_get_safely(:ENOTSUP, Errno)].compact
  raise OperationNotSupportedError.new(path, action)
rescue Errno::EEXIST, Errno::ENOENT
  raise
rescue SystemCallError => e
  raise GenericSystemCallError.new(e, "There was an error accessing `#{path}`.")
end
in_bundle?() click to toggle source
# File lib/bundler/shared_helpers.rb, line 49
def in_bundle?
  find_gemfile
end
major_deprecation(major_version, message) click to toggle source
# File lib/bundler/shared_helpers.rb, line 132
def major_deprecation(major_version, message)
  bundler_major_version = Bundler.bundler_major_version
  if bundler_major_version > major_version
    require "bundler/errors"
    raise DeprecatedError, "[REMOVED] #{message}"
  end

  return unless bundler_major_version >= major_version && prints_major_deprecations?
  @major_deprecation_ui ||= Bundler::UI::Shell.new("no-color" => true)
  ui = Bundler.ui.is_a?(@major_deprecation_ui.class) ? Bundler.ui : @major_deprecation_ui
  ui.warn("[DEPRECATED] #{message}")
end
md5_available?() click to toggle source
# File lib/bundler/shared_helpers.rb, line 195
def md5_available?
  return @md5_available if defined?(@md5_available)
  @md5_available = begin
    require "openssl"
    OpenSSL::Digest::MD5.digest("")
    true
  rescue LoadError
    true
  rescue OpenSSL::Digest::DigestError
    false
  end
end
pretty_dependency(dep, print_source = false) click to toggle source
# File lib/bundler/shared_helpers.rb, line 182
def pretty_dependency(dep, print_source = false)
  msg = String.new(dep.name)
  msg << " (#{dep.requirement})" unless dep.requirement == Gem::Requirement.default

  if dep.is_a?(Bundler::Dependency)
    platform_string = dep.platforms.join(", ")
    msg << " " << platform_string if !platform_string.empty? && platform_string != Gem::Platform::RUBY
  end

  msg << " from the `#{dep.source}` source" if print_source && dep.source
  msg
end
print_major_deprecations!() click to toggle source
pwd() click to toggle source
# File lib/bundler/shared_helpers.rb, line 59
def pwd
  Bundler.rubygems.ext_lock.synchronize do
    Pathname.pwd
  end
end
root() click to toggle source
# File lib/bundler/shared_helpers.rb, line 16
def root
  gemfile = find_gemfile
  raise GemfileNotFound, "Could not locate Gemfile" unless gemfile
  Pathname.new(gemfile).untaint.expand_path.parent
end
set_bundle_environment() click to toggle source
# File lib/bundler/shared_helpers.rb, line 78
def set_bundle_environment
  set_bundle_variables
  set_path
  set_rubyopt
  set_rubylib
end
set_env(key, value) click to toggle source
# File lib/bundler/shared_helpers.rb, line 280
def set_env(key, value)
  raise ArgumentError, "new key #{key}" unless EnvironmentPreserver::BUNDLER_KEYS.include?(key)
  orig_key = "#{EnvironmentPreserver::BUNDLER_PREFIX}#{key}"
  orig = ENV[key]
  orig ||= EnvironmentPreserver::INTENTIONALLY_NIL
  ENV[orig_key] ||= orig

  ENV[key] = value
end
trap(signal, override = false, &block) click to toggle source
# File lib/bundler/shared_helpers.rb, line 157
def trap(signal, override = false, &block)
  prior = Signal.trap(signal) do
    block.call
    prior.call unless override
  end
end
with_clean_git_env(&block) click to toggle source
# File lib/bundler/shared_helpers.rb, line 65
def with_clean_git_env(&block)
  keys    = %w[GIT_DIR GIT_WORK_TREE]
  old_env = keys.inject({}) do |h, k|
    h.update(k => ENV[k])
  end

  keys.each {|key| ENV.delete(key) }

  block.call
ensure
  keys.each {|key| ENV[key] = old_env[key] }
end
write_to_gemfile(gemfile_path, contents) click to toggle source
# File lib/bundler/shared_helpers.rb, line 213
def write_to_gemfile(gemfile_path, contents)
  filesystem_access(gemfile_path) {|g| File.open(g, "w") {|file| file.puts contents } }
end

Private Instance Methods

bundler_ruby_lib() click to toggle source
# File lib/bundler/shared_helpers.rb, line 330
def bundler_ruby_lib
  resolve_path File.expand_path("../..", __FILE__)
end
clean_load_path() click to toggle source
# File lib/bundler/shared_helpers.rb, line 334
def clean_load_path
  bundler_lib = bundler_ruby_lib

  loaded_gem_paths = Bundler.rubygems.loaded_gem_paths

  $LOAD_PATH.reject! do |p|
    next if resolve_path(p).start_with?(bundler_lib)
    loaded_gem_paths.delete(p)
  end
  $LOAD_PATH.uniq!
end
find_directory(*names) click to toggle source
# File lib/bundler/shared_helpers.rb, line 247
def find_directory(*names)
  search_up(*names) do |dirname|
    return dirname if File.directory?(dirname)
  end
end
find_file(*names) click to toggle source
# File lib/bundler/shared_helpers.rb, line 241
def find_file(*names)
  search_up(*names) do |filename|
    return filename if File.file?(filename)
  end
end
find_gemfile(order_matters = false) click to toggle source
# File lib/bundler/shared_helpers.rb, line 231
def find_gemfile(order_matters = false)
  given = ENV["BUNDLE_GEMFILE"]
  return given if given && !given.empty?
  find_file(*gemfile_names)
end
gemfile_names() click to toggle source
# File lib/bundler/shared_helpers.rb, line 237
def gemfile_names
  ["gems.rb", "Gemfile"]
end
prints_major_deprecations?() click to toggle source
# File lib/bundler/shared_helpers.rb, line 353
def prints_major_deprecations?
  require "bundler"
  return false if Bundler.settings[:silence_deprecations]
  require "bundler/deprecate"
  return false if Bundler::Deprecate.skip
  true
end
resolve_path(path) click to toggle source
# File lib/bundler/shared_helpers.rb, line 346
def resolve_path(path)
  expanded = File.expand_path(path)
  return expanded unless File.respond_to?(:realpath) && File.exist?(expanded)

  File.realpath(expanded)
end
search_up(*names) { |filename| ... } click to toggle source
# File lib/bundler/shared_helpers.rb, line 253
def search_up(*names)
  previous = nil
  current  = File.expand_path(SharedHelpers.pwd).untaint

  until !File.directory?(current) || current == previous
    if ENV["BUNDLE_SPEC_RUN"]
      # avoid stepping above the tmp directory when testing
      gemspec = if ENV["BUNDLE_RUBY"] && ENV["BUNDLE_GEM"]
        # for Ruby Core
        "lib/bundler/bundler.gemspec"
      else
        "bundler.gemspec"
      end

      # avoid stepping above the tmp directory when testing
      return nil if File.file?(File.join(current, gemspec))
    end

    names.each do |name|
      filename = File.join(current, name)
      yield filename
    end
    previous = current
    current = File.expand_path("..", current)
  end
end
set_bundle_variables() click to toggle source
# File lib/bundler/shared_helpers.rb, line 291
def set_bundle_variables
  begin
    exe_file = Bundler.rubygems.bin_path("bundler", "bundle", VERSION)
    unless File.exist?(exe_file)
      exe_file = File.expand_path("../../../exe/bundle", __FILE__)
    end
    Bundler::SharedHelpers.set_env "BUNDLE_BIN_PATH", exe_file
  rescue Gem::GemNotFoundException
    exe_file = File.expand_path("../../../exe/bundle", __FILE__)
    # for Ruby core repository
    exe_file = File.expand_path("../../../../bin/bundle", __FILE__) unless File.exist?(exe_file)
    Bundler::SharedHelpers.set_env "BUNDLE_BIN_PATH", exe_file
  end

  # Set BUNDLE_GEMFILE
  Bundler::SharedHelpers.set_env "BUNDLE_GEMFILE", find_gemfile(:order_matters).to_s
  Bundler::SharedHelpers.set_env "BUNDLER_VERSION", Bundler::VERSION
end
set_path() click to toggle source
# File lib/bundler/shared_helpers.rb, line 310
def set_path
  validate_bundle_path
  paths = (ENV["PATH"] || "").split(File::PATH_SEPARATOR)
  paths.unshift "#{Bundler.bundle_path}/bin"
  Bundler::SharedHelpers.set_env "PATH", paths.uniq.join(File::PATH_SEPARATOR)
end
set_rubylib() click to toggle source
# File lib/bundler/shared_helpers.rb, line 324
def set_rubylib
  rubylib = (ENV["RUBYLIB"] || "").split(File::PATH_SEPARATOR)
  rubylib.unshift bundler_ruby_lib unless RbConfig::CONFIG["rubylibdir"] == bundler_ruby_lib
  Bundler::SharedHelpers.set_env "RUBYLIB", rubylib.uniq.join(File::PATH_SEPARATOR)
end
set_rubyopt() click to toggle source
# File lib/bundler/shared_helpers.rb, line 317
def set_rubyopt
  rubyopt = [ENV["RUBYOPT"]].compact
  return if !rubyopt.empty? && rubyopt.first =~ %r{-rbundler/setup}
  rubyopt.unshift %(-rbundler/setup)
  Bundler::SharedHelpers.set_env "RUBYOPT", rubyopt.join(" ")
end
validate_bundle_path() click to toggle source
# File lib/bundler/shared_helpers.rb, line 219
def validate_bundle_path
  path_separator = Bundler.rubygems.path_separator
  return unless Bundler.bundle_path.to_s.split(path_separator).size > 1
  message = "Your bundle path contains text matching #{path_separator.inspect}, " \
            "which is the path separator for your system. Bundler cannot " \
            "function correctly when the Bundle path contains the " \
            "system's PATH separator. Please change your " \
            "bundle path to not match #{path_separator.inspect}." \
            "\nYour current bundle path is '#{Bundler.bundle_path}'."
  raise Bundler::PathError, message
end