2018-11-02 19:07:56 -04:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
|
|
|
require "pathname"
|
2019-04-14 02:01:35 -04:00
|
|
|
require "rbconfig"
|
2018-11-02 19:07:56 -04:00
|
|
|
|
2019-06-01 05:49:40 -04:00
|
|
|
require_relative "version"
|
|
|
|
require_relative "constants"
|
|
|
|
require_relative "rubygems_integration"
|
|
|
|
require_relative "current_ruby"
|
2018-11-02 19:07:56 -04:00
|
|
|
|
|
|
|
module Bundler
|
|
|
|
module SharedHelpers
|
|
|
|
def root
|
|
|
|
gemfile = find_gemfile
|
|
|
|
raise GemfileNotFound, "Could not locate Gemfile" unless gemfile
|
2019-11-11 03:57:45 -05:00
|
|
|
Pathname.new(gemfile).tap{|x| x.untaint if RUBY_VERSION < "2.7" }.expand_path.parent
|
2018-11-02 19:07:56 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
def default_gemfile
|
2018-11-21 05:18:10 -05:00
|
|
|
gemfile = find_gemfile
|
2018-11-02 19:07:56 -04:00
|
|
|
raise GemfileNotFound, "Could not locate Gemfile" unless gemfile
|
2019-11-11 03:57:45 -05:00
|
|
|
Pathname.new(gemfile).tap{|x| x.untaint if RUBY_VERSION < "2.7" }.expand_path
|
2018-11-02 19:07:56 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
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")
|
2019-11-11 03:57:45 -05:00
|
|
|
end.tap{|x| x.untaint if RUBY_VERSION < "2.7" }
|
2018-11-02 19:07:56 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
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
|
|
|
|
|
|
|
|
def in_bundle?
|
|
|
|
find_gemfile
|
|
|
|
end
|
|
|
|
|
|
|
|
def chdir(dir, &blk)
|
|
|
|
Bundler.rubygems.ext_lock.synchronize do
|
|
|
|
Dir.chdir dir, &blk
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
def pwd
|
|
|
|
Bundler.rubygems.ext_lock.synchronize do
|
|
|
|
Pathname.pwd
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
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
|
|
|
|
|
|
|
|
def set_bundle_environment
|
|
|
|
set_bundle_variables
|
|
|
|
set_path
|
|
|
|
set_rubyopt
|
|
|
|
set_rubylib
|
|
|
|
end
|
|
|
|
|
|
|
|
# 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}
|
|
|
|
def filesystem_access(path, action = :write, &block)
|
2019-11-11 03:57:45 -05:00
|
|
|
yield(path.dup.tap{|x| x.untaint if RUBY_VERSION < "2.7" })
|
2018-11-02 19:07:56 -04:00
|
|
|
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
|
|
|
|
|
|
|
|
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
|
|
|
|
|
2019-11-11 03:57:45 -05:00
|
|
|
def major_deprecation(major_version, message, print_caller_location: false)
|
|
|
|
if print_caller_location
|
|
|
|
caller_location = caller_locations(2, 2).first
|
|
|
|
message = "#{message} (called at #{caller_location.path}:#{caller_location.lineno})"
|
|
|
|
end
|
|
|
|
|
2019-04-14 02:01:35 -04:00
|
|
|
bundler_major_version = Bundler.bundler_major_version
|
|
|
|
if bundler_major_version > major_version
|
2019-06-01 05:49:40 -04:00
|
|
|
require_relative "errors"
|
2019-04-14 02:01:35 -04:00
|
|
|
raise DeprecatedError, "[REMOVED] #{message}"
|
2018-11-02 19:07:56 -04:00
|
|
|
end
|
|
|
|
|
2019-04-14 02:01:35 -04:00
|
|
|
return unless bundler_major_version >= major_version && prints_major_deprecations?
|
2019-11-11 03:57:45 -05:00
|
|
|
Bundler.ui.warn("[DEPRECATED] #{message}")
|
2018-11-02 19:07:56 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
def print_major_deprecations!
|
|
|
|
multiple_gemfiles = search_up(".") do |dir|
|
|
|
|
gemfiles = gemfile_names.select {|gf| File.file? File.expand_path(gf, dir) }
|
|
|
|
next if gemfiles.empty?
|
2019-04-14 02:01:35 -04:00
|
|
|
break gemfiles.size != 1
|
2018-11-02 19:07:56 -04:00
|
|
|
end
|
2019-04-14 02:01:35 -04:00
|
|
|
return unless multiple_gemfiles
|
|
|
|
message = "Multiple gemfiles (gems.rb and Gemfile) detected. " \
|
|
|
|
"Make sure you remove Gemfile and Gemfile.lock since bundler is ignoring them in favor of gems.rb and gems.rb.locked."
|
|
|
|
Bundler.ui.warn message
|
2018-11-02 19:07:56 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
def trap(signal, override = false, &block)
|
|
|
|
prior = Signal.trap(signal) do
|
|
|
|
block.call
|
|
|
|
prior.call unless override
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
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
|
|
|
|
|
|
|
|
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
|
|
|
|
|
|
|
|
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
|
|
|
|
|
|
|
|
def digest(name)
|
|
|
|
require "digest"
|
|
|
|
Digest(name)
|
|
|
|
end
|
|
|
|
|
|
|
|
def write_to_gemfile(gemfile_path, contents)
|
|
|
|
filesystem_access(gemfile_path) {|g| File.open(g, "w") {|file| file.puts contents } }
|
|
|
|
end
|
|
|
|
|
|
|
|
private
|
|
|
|
|
|
|
|
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
|
|
|
|
|
2018-11-21 05:18:10 -05:00
|
|
|
def find_gemfile
|
2018-11-02 19:07:56 -04:00
|
|
|
given = ENV["BUNDLE_GEMFILE"]
|
|
|
|
return given if given && !given.empty?
|
2019-04-14 02:01:35 -04:00
|
|
|
find_file(*gemfile_names)
|
2018-11-02 19:07:56 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
def gemfile_names
|
2019-04-14 02:01:35 -04:00
|
|
|
["gems.rb", "Gemfile"]
|
2018-11-02 19:07:56 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
def find_file(*names)
|
|
|
|
search_up(*names) do |filename|
|
|
|
|
return filename if File.file?(filename)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
def find_directory(*names)
|
|
|
|
search_up(*names) do |dirname|
|
|
|
|
return dirname if File.directory?(dirname)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
def search_up(*names)
|
|
|
|
previous = nil
|
2019-11-11 03:57:45 -05:00
|
|
|
current = File.expand_path(SharedHelpers.pwd).tap{|x| x.untaint if RUBY_VERSION < "2.7" }
|
2018-11-02 19:07:56 -04:00
|
|
|
|
|
|
|
until !File.directory?(current) || current == previous
|
|
|
|
if ENV["BUNDLE_SPEC_RUN"]
|
|
|
|
# avoid stepping above the tmp directory when testing
|
Fix some bundler specs (#2380)
* These seem to consistenly pass already
* Show actual command when running `make test-bundler`
Current the setup command that installs the necessary gems for testing
bundler was printed, but not the actual command that runs the tests.
That was a bit confusing.
* Borrow trick from setproctitle specs
* A title that long doesn't get set sometimes
No idea why, but the test doesn't need that the title is that long.
* Fix most gem helper spec ruby-core failures
* Fix the rest of the gem helper failures
* Fix version spec by improving the assertion
* Remove unnecessary `BUNDLE_RUBY` environment var
We can use `RUBY` when necessary, and `BUNDLE_RUBY` is not a good name
because bundler considers `BUNDLE_*` variables as settings.
* Rename `BUNDLE_GEM` to `GEM_COMMAND`
This is more descriptive I think, and also friendlier for bundler
because `BUNDLE_` env variables are interpreted by bundler as settings,
and this is not a bundler setting.
This fixes one bundler spec failure in config specs against ruby-core.
* Fix quality spec when run in core
Use the proper path helper.
* Fix dummy lib builder to never load default gems
If a dummy library is named as a default gem, when requiring the library
from its executable, the default gem would be loaded when running from
core, because in core all default gems share path with bundler, and thus
they are always in the $LOAD_PATH. We fix the issue by loading lib
relatively inside dummy lib executables.
* More exact assertions
Sometimes I have the problem that I do some "print debugging" inside
specs, and suddently the spec passes. This happens when the assertion is
too relaxed, and the things I print make it match, specially when they
are simple strings like "1.0" than can be easily be part of gem paths
that I print for debugging.
I fix this by making a more exact assertion.
* Detect the correct shebang when ENV["RUBY"] is set
* Relax assertion
So that the spec passes even if another paths containing "ext" are in
the load path. This works to fix a ruby-core issue, but it's a better
assertion in general. We just want to know that the extension path was
added.
* Use folder structure independent path helper
It should fix this spec for ruby-core.
* Fix the last failing spec on ruby-core
* Skip `bundle open <default_gem>` spec when no default gems
2019-08-19 20:46:31 -04:00
|
|
|
gemspec = if ENV["GEM_COMMAND"]
|
2018-11-02 19:07:56 -04:00
|
|
|
# for Ruby Core
|
2019-02-18 04:53:13 -05:00
|
|
|
"lib/bundler/bundler.gemspec"
|
2018-11-02 19:07:56 -04:00
|
|
|
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
|
|
|
|
|
|
|
|
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
|
|
|
|
public :set_env
|
|
|
|
|
|
|
|
def set_bundle_variables
|
2019-07-13 09:20:12 -04:00
|
|
|
# bundler exe & lib folders have same root folder, typical gem installation
|
2019-06-01 05:49:40 -04:00
|
|
|
exe_file = File.expand_path("../../../exe/bundle", __FILE__)
|
2019-07-13 09:20:12 -04:00
|
|
|
|
|
|
|
# for Ruby core repository testing
|
2019-08-15 10:40:33 -04:00
|
|
|
exe_file = File.expand_path("../../../libexec/bundle", __FILE__) unless File.exist?(exe_file)
|
2019-07-13 09:20:12 -04:00
|
|
|
|
|
|
|
# bundler is a default gem, exe path is separate
|
|
|
|
exe_file = Bundler.rubygems.bin_path("bundler", "bundle", VERSION) unless File.exist?(exe_file)
|
|
|
|
|
2019-06-01 05:49:40 -04:00
|
|
|
Bundler::SharedHelpers.set_env "BUNDLE_BIN_PATH", exe_file
|
2018-11-21 05:18:10 -05:00
|
|
|
Bundler::SharedHelpers.set_env "BUNDLE_GEMFILE", find_gemfile.to_s
|
2018-11-02 19:07:56 -04:00
|
|
|
Bundler::SharedHelpers.set_env "BUNDLER_VERSION", Bundler::VERSION
|
|
|
|
end
|
|
|
|
|
|
|
|
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
|
|
|
|
|
|
|
|
def set_rubyopt
|
|
|
|
rubyopt = [ENV["RUBYOPT"]].compact
|
2019-06-01 05:49:40 -04:00
|
|
|
setup_require = "-r#{File.expand_path("setup", __dir__)}"
|
|
|
|
return if !rubyopt.empty? && rubyopt.first =~ /#{setup_require}/
|
2019-07-23 13:19:31 -04:00
|
|
|
rubyopt.unshift setup_require
|
2018-11-02 19:07:56 -04:00
|
|
|
Bundler::SharedHelpers.set_env "RUBYOPT", rubyopt.join(" ")
|
|
|
|
end
|
|
|
|
|
|
|
|
def set_rubylib
|
|
|
|
rubylib = (ENV["RUBYLIB"] || "").split(File::PATH_SEPARATOR)
|
2019-02-04 23:58:46 -05:00
|
|
|
rubylib.unshift bundler_ruby_lib unless RbConfig::CONFIG["rubylibdir"] == bundler_ruby_lib
|
2018-11-02 19:07:56 -04:00
|
|
|
Bundler::SharedHelpers.set_env "RUBYLIB", rubylib.uniq.join(File::PATH_SEPARATOR)
|
|
|
|
end
|
|
|
|
|
|
|
|
def bundler_ruby_lib
|
|
|
|
resolve_path File.expand_path("../..", __FILE__)
|
|
|
|
end
|
|
|
|
|
|
|
|
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
|
|
|
|
|
|
|
|
def resolve_path(path)
|
|
|
|
expanded = File.expand_path(path)
|
|
|
|
return expanded unless File.respond_to?(:realpath) && File.exist?(expanded)
|
|
|
|
|
|
|
|
File.realpath(expanded)
|
|
|
|
end
|
|
|
|
|
|
|
|
def prints_major_deprecations?
|
2019-06-01 05:49:40 -04:00
|
|
|
require_relative "../bundler"
|
2019-04-14 02:01:35 -04:00
|
|
|
return false if Bundler.settings[:silence_deprecations]
|
2019-06-01 05:49:40 -04:00
|
|
|
require_relative "deprecate"
|
2018-11-02 19:07:56 -04:00
|
|
|
return false if Bundler::Deprecate.skip
|
|
|
|
true
|
|
|
|
end
|
|
|
|
|
|
|
|
extend self
|
|
|
|
end
|
|
|
|
end
|