module Bundler
def self.bundler_major_version
def self.bundler_major_version @bundler_major_version ||= VERSION.split(".").first.to_i end
def self.current_ruby
-
(CurrentRuby)- Current version of Ruby
def self.current_ruby @current_ruby ||= CurrentRuby.new end
def self.require_thor_actions
def self.require_thor_actions require_relative "vendor/thor/lib/thor/actions" end
def self.rubygems
def self.rubygems @rubygems ||= RubygemsIntegration.new end
def self.with_friendly_errors
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
def URI(uri)
Returns +uri+ converted to an Bundler::URI object.
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
def app_cache(custom_path = nil)
def app_cache(custom_path = nil) path = custom_path || root Pathname.new(path).join(settings.app_cache_path) end
def app_config_path
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
def bin_path
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
def bundle_path @bundle_path ||= Pathname.new(configured_bundle_path.path).expand_path(root) end
def clean_env
- Use `unbundled_env` instead
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
def clean_exec(*args)
- Use `unbundled_exec` instead
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
def clean_system(*args)
- Use `unbundled_system` instead
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
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(path)
def configure_gem_home(path) Bundler::SharedHelpers.set_env "GEM_HOME", path.to_s end
def configure_gem_home_and_path(path = bundle_path)
def configure_gem_home_and_path(path = bundle_path) configure_gem_path configure_gem_home(path) Bundler.rubygems.clear_paths end
def configure_gem_path
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
def configured_bundle_path
def configured_bundle_path @configured_bundle_path ||= settings.path.tap(&:validate!) 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)
-
(Bundler::Definition)-
Parameters:
-
unlock(Hash, Boolean, nil) -- Gems that have been requested
def definition(unlock = nil) @definition = nil if unlock @definition ||= begin configure Definition.build(default_gemfile, default_lockfile, unlock) end end
def environment
def environment SharedHelpers.major_deprecation 2, "Bundler.environment has been removed in favor of Bundler.load", :print_caller_location => true load end
def eval_gemspec(path, contents)
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
def eval_yaml_gemspec(path, contents)
def eval_yaml_gemspec(path, contents) require_relative "bundler/psyched_yaml" # 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 YamlLibrarySyntaxError, ArgumentError, Gem::EndOfYAMLException, Gem::Exception eval_gemspec(path, contents) end
def feature_flag
def feature_flag @feature_flag ||= FeatureFlag.new(VERSION) end
def frozen_bundle?
def frozen_bundle? frozen = settings[:deployment] frozen ||= settings[:frozen] frozen 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) 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
def load_marshal(data)
def load_marshal(data) Marshal.load(data) rescue StandardError => e raise MarshalError, "#{e.class}: #{e.message}" end
def local_platform
def local_platform return Gem::Platform::RUBY if settings[:force_ruby_platform] || Gem.platforms == [Gem::Platform::RUBY] Gem::Platform.local end
def locked_gems
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
def mkdir_p(path, options = {})
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
def most_specific_locked_platform?(platform)
def most_specific_locked_platform?(platform) return false unless defined?(@definition) && @definition definition.most_specific_locked_platform == platform end
def original_env
-
(Hash)- Environment present before Bundler was activated
def original_env ORIGINAL_ENV.clone end
def original_exec(*args)
def original_exec(*args) with_original_env { Kernel.exec(*args) } end
def original_system(*args)
def original_system(*args) with_original_env { Kernel.system(*args) } end
def preferred_gemfile_name
def preferred_gemfile_name Bundler.settings[:init_gems_rb] ? "gems.rb" : "Gemfile" end
def read_file(file)
def read_file(file) SharedHelpers.filesystem_access(file, :read) do File.open(file, "r:UTF-8", &:read) end end
def require(*groups)
Bundler.require(:test) # requires second_gem
# ...later
Bundler.require(:default) # requires only first_gem
Bundler.setup # allow all groups
The code will work as follows:
end
gem 'second_gem', '= 1.0'
group :test do
gem 'first_gem', '= 1.0'
Assuming Gemfile
multiple times with different groups (if they were allowed by setup).
and loads all gems from groups specified. Unlike ::setup, can be called
Setups Bundler environment (see Bundler.setup) if it is not already set,
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[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
def reset!
def reset! reset_paths! Plugin.reset! reset_rubygems! end
def reset_paths!
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
def reset_rubygems!
def reset_rubygems! return unless defined?(@rubygems) && @rubygems rubygems.undo_replacements rubygems.reset @rubygems = nil end
def reset_settings_and_root!
def reset_settings_and_root! @settings = nil @root = nil end
def rm_rf(path)
def rm_rf(path) FileUtils.remove_entry_secure(path) if path && File.exist?(path) rescue ArgumentError message = <<EOF s a security vulnerability to allow your home directory to be world-writable, and bundler can not continue. should probably consider fixing this issue by running `chmod o-w ~` on *nix. se refer to https://ruby-doc.org/stdlib-2.1.2/libdoc/fileutils/rdoc/FileUtils.html#method-c-remove_entry_secure for details. File.world_writable?(path) ? Bundler.ui.warn(message) : raise raise PathError, "Please fix the world-writable issue with your #{path} directory" end
def root
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
def ruby_scope
def ruby_scope "#{Bundler.rubygems.ruby_engine}/#{RbConfig::CONFIG["ruby_version"]}" end
def settings
def settings @settings ||= Settings.new(app_config_path) rescue GemfileNotFound @settings = Settings.new(Pathname.new(".bundle").expand_path) end
def setup(*groups)
To require all gems from Gemfile (or only some groups), see Bundler.require.
be allowed (gems specified outside groups belong to special +:default+ group).
If _groups_ list is provided, only gems from specified groups would
+Bundler.setup+ can be called only once, all subsequent calls are no-op.
require 'second_gem' # loads exactly version 1.0
require 'fourth_gem' # fails with LoadError
Bundler.setup
require 'first_gem' # allowed, loads the last installed version
require 'third_gem' # allowed, required from global gems
The code using Bundler.setup works as follows:
end
gem 'second_gem', '= 1.0'
group :test do
gem 'first_gem', '= 1.0'
Assuming Gemfile
in Gemfile, only those versions would be loaded.
the Gemfile or Ruby's standard library. If the versions specified
+require+ of the gems would be allowed only if they are part of
Turns on the Bundler runtime. After +Bundler.setup+ call, all +load+ or
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
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 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
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 set --local 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) Kernel.send(:require, "tmpdir") Pathname.new(Dir.mktmpdir(["bundler", name])) end
def tmp_home_path
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
def ui
def ui (defined?(@ui) && @ui) || (self.ui = UI::Shell.new) end
def ui=(ui)
def ui=(ui) Bundler.rubygems.ui = UI::RGProxy.new(ui) @ui = ui end
def unbundled_env
-
(Hash)- Environment with all bundler-related variables removed
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
def unbundled_exec(*args)
def unbundled_exec(*args) with_env(unbundled_env) { Kernel.exec(*args) } end
def unbundled_system(*args)
def unbundled_system(*args) with_unbundled_env { Kernel.system(*args) } end
def use_system_gems?
def use_system_gems? configured_bundle_path.use_system_gems? end
def user_bundle_path(dir = "home")
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
def user_cache
def user_cache user_bundle_path("cache") end
def user_home
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
def which(executable)
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
def with_clean_env
- Use `with_unbundled_env` instead
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
def with_env(env)
-
env(Hash) --
def with_env(env) backup = ENV.to_hash ENV.replace(env) yield ensure ENV.replace(backup) end
def with_original_env
def with_original_env with_env(original_env) { yield } end
def with_unbundled_env
def with_unbundled_env with_env(unbundled_env) { yield } end