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[
  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
  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

Instance Method Summary collapse

Constructor Details

#initialize(root = nil) ⇒ Settings

Returns a new instance of Settings.



103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/bundler/settings.rb', line 103

def initialize(root = nil)
  @root            = root
  @local_config    = load_config(local_config_file)

  @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

Instance Method Details

#[](name) ⇒ Object 



117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/bundler/settings.rb', line 117

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 



167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/bundler/settings.rb', line 167

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 



316
317
318
 
# File 'lib/bundler/settings.rb', line 316

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

#credentials_for(uri) ⇒ Object 



197
198
199
 
# File 'lib/bundler/settings.rb', line 197

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

#gem_mirrors ⇒ Object 



201
202
203
204
205
206
 
# File 'lib/bundler/settings.rb', line 201

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) 


312
313
314
 
# File 'lib/bundler/settings.rb', line 312

def ignore_config?
  ENV["BUNDLE_IGNORE_CONFIG"]
end

#key_for(key) ⇒ Object 



329
330
331
 
# File 'lib/bundler/settings.rb', line 329

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

#local_overrides ⇒ Object 



180
181
182
183
184
185
186
 
# File 'lib/bundler/settings.rb', line 180

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 



208
209
210
211
212
213
214
215
 
# File 'lib/bundler/settings.rb', line 208

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 



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

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



250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/bundler/settings.rb', line 250

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 



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/bundler/settings.rb', line 217

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 



242
243
244
245
246
247
 
# File 'lib/bundler/settings.rb', line 242

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

#set_command_option(key, value) ⇒ Object 



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

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

#set_command_option_if_given(key, value) ⇒ Object 



139
140
141
142
 
# File 'lib/bundler/settings.rb', line 139

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

#set_global(key, value) ⇒ Object 



163
164
165
 
# File 'lib/bundler/settings.rb', line 163

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

#set_local(key, value) ⇒ Object 



144
145
146
147
148
 
# File 'lib/bundler/settings.rb', line 144

def set_local(key, value)
  local_config_file || raise(GemfileNotFound, "Could not locate Gemfile")

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

#temporary(update) ⇒ Object 



150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/bundler/settings.rb', line 150

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 



320
321
322
323
324
325
326
327
 
# File 'lib/bundler/settings.rb', line 320

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