Class: Bundler::Settings

Inherits:
Object
  • Object
show all
Defined in:
lib/bundler/mirror.rb,
lib/bundler/settings.rb,
lib/bundler/settings/validator.rb

Defined Under Namespace

Classes: Mirror, MirrorConfig, Mirrors, Path, TCPSocketProbe, Validator

Constant Summary collapse

BOOL_KEYS = 
%w[
  auto_install
  cache_all
  cache_all_platforms
  clean
  deployment
  disable_checksum_validation
  disable_exec_load
  disable_local_branch_check
  disable_local_revision_check
  disable_shared_gems
  disable_version_check
  force_ruby_platform
  frozen
  gem.changelog
  gem.coc
  gem.mit
  gem.bundle
  git.allow_insecure
  global_gem_cache
  ignore_messages
  init_gems_rb
  inline
  lockfile_checksums
  no_install
  no_prune
  path.system
  plugins
  prefer_patch
  silence_deprecations
  silence_root_warning
  update_requires_all_flag
  verbose
].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
  default_cli_command
  gem.ci
  gem.github_username
  gem.linter
  gem.rubocop
  gem.test
  gemfile
  lockfile
  path
  shebang
  simulate_version
  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",
  "BUNDLE_LOCKFILE_CHECKSUMS" => true,
  "BUNDLE_CACHE_ALL" => true,
  "BUNDLE_PLUGINS" => true,
  "BUNDLE_GLOBAL_GEM_CACHE" => false,
  "BUNDLE_UPDATE_REQUIRES_ALL_FLAG" => false,
}.freeze

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(root = nil) ⇒ Settings

Returns a new instance of Settings.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/bundler/settings.rb', line 93

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

Class Method Details

.key_for(key) ⇒ Object 



527
528
529
530
531
532
533
534
535
 
# File 'lib/bundler/settings.rb', line 527

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

.key_to_s(key) ⇒ Object 



557
558
559
560
561
562
563
564
565
566
567
568
 
# File 'lib/bundler/settings.rb', line 557

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

.normalize_uri(uri) ⇒ Object

TODO: duplicates Rubygems#normalize_uri TODO: is this the correct place to validate mirror URIs?



539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
 
# File 'lib/bundler/settings.rb', line 539

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

Instance Method Details

#[](name) ⇒ Object 



108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/bundler/settings.rb', line 108

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

#all ⇒ Object 



154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/bundler/settings.rb', line 154

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

#app_cache_path ⇒ Object 



303
304
305
 
# File 'lib/bundler/settings.rb', line 303

def app_cache_path
  @app_cache_path ||= self[:cache_path] || "vendor/cache"
end

#credentials_for(uri) ⇒ Object 



184
185
186
 
# File 'lib/bundler/settings.rb', line 184

def credentials_for(uri)
  self[uri.to_s] || self[uri.host]
end

#gem_mirrors ⇒ Object 



188
189
190
191
192
193
 
# File 'lib/bundler/settings.rb', line 188

def gem_mirrors
  all.inject(Mirrors.new) do |mirrors, k|
    mirrors.parse(k, self[k]) if k.start_with?("mirror.")
    mirrors
  end
end

#ignore_config? ⇒ Boolean

Returns:

  • (Boolean) 


299
300
301
 
# File 'lib/bundler/settings.rb', line 299

def ignore_config?
  ENV["BUNDLE_IGNORE_CONFIG"]
end

#installation_parallelization ⇒ Object 



307
308
309
 
# File 'lib/bundler/settings.rb', line 307

def installation_parallelization
  self[:jobs] || processor_count
end

#key_for(key) ⇒ Object 



320
321
322
 
# File 'lib/bundler/settings.rb', line 320

def key_for(key)
  @key_cache[key] ||= self.class.key_for(key)
end

#local_overrides ⇒ Object 



167
168
169
170
171
172
173
 
# File 'lib/bundler/settings.rb', line 167

def local_overrides
  repos = {}
  all.each do |k|
    repos[k.delete_prefix("local.")] = self[k] if k.start_with?("local.")
  end
  repos
end

#locations(key) ⇒ Object 



195
196
197
198
199
200
201
202
 
# File 'lib/bundler/settings.rb', line 195

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

#mirror_for(uri) ⇒ Object 



175
176
177
178
179
180
181
182
 
# File 'lib/bundler/settings.rb', line 175

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

#path ⇒ Object

for legacy reasons, in Bundler 2, we do not respect :disable_shared_gems



237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/bundler/settings.rb', line 237

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

#pretty_values_for(exposed_key) ⇒ Object 



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/bundler/settings.rb', line 204

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

#processor_count ⇒ Object 



229
230
231
232
233
234
 
# File 'lib/bundler/settings.rb', line 229

def processor_count
  require "etc"
  Etc.nprocessors
rescue StandardError
  1
end

#set_command_option(key, value) ⇒ Object 



121
122
123
124
 
# File 'lib/bundler/settings.rb', line 121

def set_command_option(key, value)
  temporary(key => value)
  value
end

#set_command_option_if_given(key, value) ⇒ Object 



126
127
128
129
 
# File 'lib/bundler/settings.rb', line 126

def set_command_option_if_given(key, value)
  return if value.nil?
  set_command_option(key, value)
end

#set_global(key, value) ⇒ Object 



150
151
152
 
# File 'lib/bundler/settings.rb', line 150

def set_global(key, value)
  set_key(key, value, @global_config, global_config_file)
end

#set_local(key, value) ⇒ Object 



131
132
133
134
135
 
# File 'lib/bundler/settings.rb', line 131

def set_local(key, value)
  local_config_file = @local_root.join("config")

  set_key(key, value, @local_config, local_config_file)
end

#temporary(update) ⇒ Object 



137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/bundler/settings.rb', line 137

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

#validate! ⇒ Object 



311
312
313
314
315
316
317
318
 
# File 'lib/bundler/settings.rb', line 311

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