1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599
|
# frozen_string_literal: true
module Bundler
class Settings
autoload :Mirror, File.expand_path("mirror", __dir__)
autoload :Mirrors, File.expand_path("mirror", __dir__)
autoload :Validator, File.expand_path("settings/validator", __dir__)
BOOL_KEYS = %w[
allow_offline_install
auto_clean_without_path
auto_install
cache_all
cache_all_platforms
clean
default_install_uses_path
deployment
disable_checksum_validation
disable_exec_load
disable_local_branch_check
disable_local_revision_check
disable_shared_gems
disable_version_check
force_ruby_platform
forget_cli_options
frozen
gem.changelog
gem.coc
gem.mit
git.allow_insecure
global_gem_cache
ignore_messages
init_gems_rb
inline
lockfile_checksums
no_install
no_prune
path_relative_to_cwd
path.system
plugins
prefer_patch
print_only_version_number
setup_makes_kernel_gem_public
silence_deprecations
silence_root_warning
update_requires_all_flag
].freeze
REMEMBERED_KEYS = %w[
bin
cache_all
clean
deployment
frozen
no_prune
path
shebang
path.system
without
with
].freeze
NUMBER_KEYS = %w[
jobs
redirect
retry
ssl_verify_mode
timeout
].freeze
ARRAY_KEYS = %w[
only
with
without
].freeze
STRING_KEYS = %w[
bin
cache_path
console
gem.ci
gem.github_username
gem.linter
gem.rubocop
gem.test
gemfile
path
shebang
system_bindir
trust-policy
version
].freeze
DEFAULT_CONFIG = {
"BUNDLE_SILENCE_DEPRECATIONS" => false,
"BUNDLE_DISABLE_VERSION_CHECK" => true,
"BUNDLE_PREFER_PATCH" => false,
"BUNDLE_REDIRECT" => 5,
"BUNDLE_RETRY" => 3,
"BUNDLE_TIMEOUT" => 10,
"BUNDLE_VERSION" => "lockfile",
}.freeze
def initialize(root = nil)
@root = root
@local_config = load_config(local_config_file)
@local_root = root || Pathname.new(".bundle").expand_path
@env_config = ENV.to_h
@env_config.select! {|key, _value| key.start_with?("BUNDLE_") }
@env_config.delete("BUNDLE_")
@global_config = load_config(global_config_file)
@temporary = {}
@key_cache = {}
end
def [](name)
key = key_for(name)
value = nil
configs.each do |_, config|
value = config[key]
next if value.nil?
break
end
converted_value(value, name)
end
def set_command_option(key, value)
if !is_remembered(key) || Bundler.feature_flag.forget_cli_options?
temporary(key => value)
value
else
set_local(key, value)
end
end
def set_command_option_if_given(key, value)
return if value.nil?
set_command_option(key, value)
end
def set_local(key, value)
local_config_file = @local_root.join("config")
set_key(key, value, @local_config, local_config_file)
end
def temporary(update)
existing = Hash[update.map {|k, _| [k, @temporary[key_for(k)]] }]
update.each do |k, v|
set_key(k, v, @temporary, nil)
end
return unless block_given?
begin
yield
ensure
existing.each {|k, v| set_key(k, v, @temporary, nil) }
end
end
def set_global(key, value)
set_key(key, value, @global_config, global_config_file)
end
def all
keys = @temporary.keys.union(@global_config.keys, @local_config.keys, @env_config.keys)
keys.map! do |key|
key = key.delete_prefix("BUNDLE_")
key.gsub!("___", "-")
key.gsub!("__", ".")
key.downcase!
key
end.sort!
keys
end
def local_overrides
repos = {}
all.each do |k|
repos[k.delete_prefix("local.")] = self[k] if k.start_with?("local.")
end
repos
end
def mirror_for(uri)
if uri.is_a?(String)
require_relative "vendored_uri"
uri = Gem::URI(uri)
end
gem_mirrors.for(uri.to_s).uri
end
def credentials_for(uri)
self[uri.to_s] || self[uri.host]
end
def gem_mirrors
all.inject(Mirrors.new) do |mirrors, k|
mirrors.parse(k, self[k]) if k.start_with?("mirror.")
mirrors
end
end
def locations(key)
key = key_for(key)
configs.keys.inject({}) do |partial_locations, level|
value_on_level = configs[level][key]
partial_locations[level] = value_on_level unless value_on_level.nil?
partial_locations
end
end
def pretty_values_for(exposed_key)
key = key_for(exposed_key)
locations = []
if value = @temporary[key]
locations << "Set for the current command: #{printable_value(value, exposed_key).inspect}"
end
if value = @local_config[key]
locations << "Set for your local app (#{local_config_file}): #{printable_value(value, exposed_key).inspect}"
end
if value = @env_config[key]
locations << "Set via #{key}: #{printable_value(value, exposed_key).inspect}"
end
if value = @global_config[key]
locations << "Set for the current user (#{global_config_file}): #{printable_value(value, exposed_key).inspect}"
end
return ["You have not configured a value for `#{exposed_key}`"] if locations.empty?
locations
end
def processor_count
require "etc"
Etc.nprocessors
rescue StandardError
1
end
# for legacy reasons, in Bundler 2, we do not respect :disable_shared_gems
def path
configs.each do |_level, settings|
path = value_for("path", settings)
path_system = value_for("path.system", settings)
disabled_shared_gems = value_for("disable_shared_gems", settings)
next if path.nil? && path_system.nil? && disabled_shared_gems.nil?
system_path = path_system || (disabled_shared_gems == false)
return Path.new(path, system_path)
end
path = "vendor/bundle" if self[:deployment]
Path.new(path, false)
end
Path = Struct.new(:explicit_path, :system_path) do
def path
path = base_path
path = File.join(path, Bundler.ruby_scope) unless use_system_gems?
path
end
def use_system_gems?
return true if system_path
return false if explicit_path
!Bundler.feature_flag.default_install_uses_path?
end
def base_path
path = explicit_path
path ||= ".bundle" unless use_system_gems?
path ||= Bundler.rubygems.gem_dir
path
end
def base_path_relative_to_pwd
base_path = Pathname.new(self.base_path)
expanded_base_path = base_path.expand_path(Bundler.root)
relative_path = expanded_base_path.relative_path_from(Pathname.pwd)
if relative_path.to_s.start_with?("..")
relative_path = base_path if base_path.absolute?
else
relative_path = Pathname.new(File.join(".", relative_path))
end
relative_path
rescue ArgumentError
expanded_base_path
end
def validate!
return unless explicit_path && system_path
path = Bundler.settings.pretty_values_for(:path)
path.unshift(nil, "path:") unless path.empty?
system_path = Bundler.settings.pretty_values_for("path.system")
system_path.unshift(nil, "path.system:") unless system_path.empty?
disable_shared_gems = Bundler.settings.pretty_values_for(:disable_shared_gems)
disable_shared_gems.unshift(nil, "disable_shared_gems:") unless disable_shared_gems.empty?
raise InvalidOption,
"Using a custom path while using system gems is unsupported.\n#{path.join("\n")}\n#{system_path.join("\n")}\n#{disable_shared_gems.join("\n")}"
end
end
def ignore_config?
ENV["BUNDLE_IGNORE_CONFIG"]
end
def app_cache_path
@app_cache_path ||= self[:cache_path] || "vendor/cache"
end
def validate!
all.each do |raw_key|
[@local_config, @env_config, @global_config].each do |settings|
value = value_for(raw_key, settings)
Validator.validate!(raw_key, value, settings.dup)
end
end
end
def key_for(key)
@key_cache[key] ||= self.class.key_for(key)
end
private
def configs
@configs ||= {
temporary: @temporary,
local: @local_config,
env: @env_config,
global: @global_config,
default: DEFAULT_CONFIG,
}
end
def value_for(name, config)
converted_value(config[key_for(name)], name)
end
def parent_setting_for(name)
split_specific_setting_for(name)[0]
end
def specific_gem_for(name)
split_specific_setting_for(name)[1]
end
def split_specific_setting_for(name)
name.split(".")
end
def is_bool(name)
name = self.class.key_to_s(name)
BOOL_KEYS.include?(name) || BOOL_KEYS.include?(parent_setting_for(name))
end
def is_string(name)
name = self.class.key_to_s(name)
STRING_KEYS.include?(name) || name.start_with?("local.") || name.start_with?("mirror.") || name.start_with?("build.")
end
def to_bool(value)
case value
when String
value.match?(/\A(false|f|no|n|0|)\z/i) ? false : true
when nil, false
false
else
true
end
end
def is_num(key)
NUMBER_KEYS.include?(self.class.key_to_s(key))
end
def is_array(key)
ARRAY_KEYS.include?(self.class.key_to_s(key))
end
def is_remembered(key)
REMEMBERED_KEYS.include?(self.class.key_to_s(key))
end
def is_credential(key)
key == "gem.push_key"
end
def is_userinfo(value)
value.include?(":")
end
def to_array(value)
return [] unless value
value.tr(" ", ":").split(":").map(&:to_sym)
end
def array_to_s(array)
array = Array(array)
return nil if array.empty?
array.join(":").tr(" ", ":")
end
def set_key(raw_key, value, hash, file)
raw_key = self.class.key_to_s(raw_key)
value = array_to_s(value) if is_array(raw_key)
key = key_for(raw_key)
return if hash[key] == value
hash[key] = value
hash.delete(key) if value.nil?
Validator.validate!(raw_key, converted_value(value, raw_key), hash)
return unless file
SharedHelpers.filesystem_access(file.dirname, :create) do |p|
FileUtils.mkdir_p(p)
end
SharedHelpers.filesystem_access(file) do |p|
p.open("w") {|f| f.write(serializer_class.dump(hash)) }
end
end
def converted_value(value, key)
key = self.class.key_to_s(key)
if is_array(key)
to_array(value)
elsif value.nil?
nil
elsif is_bool(key) || value == "false"
to_bool(value)
elsif is_num(key)
value.to_i
else
value.to_s
end
end
def printable_value(value, key)
converted = converted_value(value, key)
return converted unless converted.is_a?(String)
if is_string(key)
converted
elsif is_credential(key)
"[REDACTED]"
elsif is_userinfo(converted)
username, pass = converted.split(":", 2)
if pass == "x-oauth-basic"
username = "[REDACTED]"
else
pass = "[REDACTED]"
end
[username, pass].join(":")
else
converted
end
end
def global_config_file
if ENV["BUNDLE_CONFIG"] && !ENV["BUNDLE_CONFIG"].empty?
Pathname.new(ENV["BUNDLE_CONFIG"])
elsif ENV["BUNDLE_USER_CONFIG"] && !ENV["BUNDLE_USER_CONFIG"].empty?
Pathname.new(ENV["BUNDLE_USER_CONFIG"])
elsif ENV["BUNDLE_USER_HOME"] && !ENV["BUNDLE_USER_HOME"].empty?
Pathname.new(ENV["BUNDLE_USER_HOME"]).join("config")
elsif Bundler.rubygems.user_home && !Bundler.rubygems.user_home.empty?
Pathname.new(Bundler.rubygems.user_home).join(".bundle/config")
end
end
def local_config_file
Pathname.new(@root).join("config") if @root
end
def load_config(config_file)
return {} if !config_file || ignore_config?
SharedHelpers.filesystem_access(config_file, :read) do |file|
valid_file = file.exist? && !file.size.zero?
return {} unless valid_file
serializer_class.load(file.read).inject({}) do |config, (k, v)|
k = k.dup
k << "/" if /https?:/i.match?(k) && !k.end_with?("/", "__#{FALLBACK_TIMEOUT_URI_OPTION.upcase}")
k.gsub!(".", "__")
unless k.start_with?("#")
if k.include?("-")
Bundler.ui.warn "Your #{file} config includes `#{k}`, which contains the dash character (`-`).\n" \
"This is deprecated, because configuration through `ENV` should be possible, but `ENV` keys cannot include dashes.\n" \
"Please edit #{file} and replace any dashes in configuration keys with a triple underscore (`___`)."
# string hash keys are frozen
k = k.gsub("-", "___")
end
config[k] = v
end
config
end
end
end
def serializer_class
require "rubygems/yaml_serializer"
Gem::YAMLSerializer
rescue LoadError
# TODO: Remove this when RubyGems 3.4 is EOL
require_relative "yaml_serializer"
YAMLSerializer
end
FALLBACK_TIMEOUT_URI_OPTION = "fallback_timeout"
NORMALIZE_URI_OPTIONS_PATTERN =
/
\A
(\w+\.)? # optional prefix key
(https?.*?) # URI
(\.#{FALLBACK_TIMEOUT_URI_OPTION})? # optional suffix key
\z
/ix
def self.key_for(key)
key = key_to_s(key)
key = normalize_uri(key) if key.start_with?("http", "mirror.http")
key = key.gsub(".", "__")
key.gsub!("-", "___")
key.upcase!
key.gsub(/\A([ #]*)/, '\1BUNDLE_')
end
# TODO: duplicates Rubygems#normalize_uri
# TODO: is this the correct place to validate mirror URIs?
def self.normalize_uri(uri)
uri = uri.to_s
if uri =~ NORMALIZE_URI_OPTIONS_PATTERN
prefix = $1
uri = $2
suffix = $3
end
uri = URINormalizer.normalize_suffix(uri)
require_relative "vendored_uri"
uri = Gem::URI(uri)
unless uri.absolute?
raise ArgumentError, format("Gem sources must be absolute. You provided '%s'.", uri)
end
"#{prefix}#{uri}#{suffix}"
end
# This is a hot method, so avoid respond_to? checks on every invocation
if :read.respond_to?(:name)
def self.key_to_s(key)
case key
when String
key
when Symbol
key.name
when Gem::URI::HTTP
key.to_s
else
raise ArgumentError, "Invalid key: #{key.inspect}"
end
end
else
def self.key_to_s(key)
case key
when String
key
when Symbol
key.to_s
when Gem::URI::HTTP
key.to_s
else
raise ArgumentError, "Invalid key: #{key.inspect}"
end
end
end
end
end
|