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_bundler_dependency_conflicts
  allow_deployment_source_credential_changes
  allow_offline_install
  auto_clean_without_path
  auto_install
  cache_all
  cache_all_platforms
  default_install_uses_path
  deployment
  deployment_means_frozen
  disable_checksum_validation
  disable_exec_load
  disable_local_branch_check
  disable_multisource
  disable_shared_gems
  disable_version_check
  force_ruby_platform
  forget_cli_options
  frozen
  gem.coc
  gem.mit
  global_gem_cache
  ignore_messages
  init_gems_rb
  no_install
  no_prune
  only_update_to_newer_versions
  path_relative_to_cwd
  path.system
  plugins
  prefer_patch
  print_only_version_number
  setup_makes_kernel_gem_public
  silence_deprecations
  silence_root_warning
  suppress_install_using_messages
  unlock_source_unlocks_spec
  update_requires_all_flag
  use_gem_version_promoter_for_major_updates
].freeze
NUMBER_KEYS =
%w[
  jobs
  redirect
  retry
  ssl_verify_mode
  timeout
].freeze
ARRAY_KEYS =
%w[
  with
  without
].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,
}.freeze

Instance Method Summary collapse

Constructor Details

#initialize(root = nil) ⇒ Settings

Returns a new instance of Settings.


73
74
75
76
77
78
79
# File 'lib/bundler/settings.rb', line 73

def initialize(root = nil)
  @root            = root
  @local_config    = load_config(local_config_file)
  @env_config      = ENV.to_h.select {|key, _value| key =~ /\ABUNDLE_.+/ }
  @global_config   = load_config(global_config_file)
  @temporary       = {}
end

Instance Method Details

#[](name) ⇒ Object


81
82
83
84
85
86
# File 'lib/bundler/settings.rb', line 81

def [](name)
  key = key_for(name)
  value = configs.values.map {|config| config[key] }.compact.first

  converted_value(value, name)
end

#allObject


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

def all
  keys = @temporary.keys | @global_config.keys | @local_config.keys | @env_config.keys

  keys.map do |key|
    key.sub(/^BUNDLE_/, "").gsub(/__/, ".").downcase
  end
end

#allow_sudo?Boolean

Returns:

  • (Boolean)

256
257
258
259
260
# File 'lib/bundler/settings.rb', line 256

def allow_sudo?
  key = key_for(:path)
  path_configured = @temporary.key?(key) || @local_config.key?(key)
  !path_configured
end

#app_cache_pathObject


266
267
268
# File 'lib/bundler/settings.rb', line 266

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

#credentials_for(uri) ⇒ Object


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

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

#gem_mirrorsObject


154
155
156
157
158
159
# File 'lib/bundler/settings.rb', line 154

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)

262
263
264
# File 'lib/bundler/settings.rb', line 262

def ignore_config?
  ENV["BUNDLE_IGNORE_CONFIG"]
end

#key_for(key) ⇒ Object


279
280
281
282
283
# File 'lib/bundler/settings.rb', line 279

def key_for(key)
  key = Settings.normalize_uri(key).to_s if key.is_a?(String) && /https?:/ =~ key
  key = key.to_s.gsub(".", "__").upcase
  "BUNDLE_#{key}"
end

#local_overridesObject


133
134
135
136
137
138
139
# File 'lib/bundler/settings.rb', line 133

def local_overrides
  repos = {}
  all.each do |k|
    repos[$'] = self[k] if k =~ /^local\./
  end
  repos
end

#locations(key) ⇒ Object


161
162
163
164
165
166
167
168
# File 'lib/bundler/settings.rb', line 161

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


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

def mirror_for(uri)
  if uri.is_a?(String)
    require_relative "vendored_uri"
    uri = Bundler::URI(uri)
  end

  gem_mirrors.for(uri.to_s).uri
end

#pathObject

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


196
197
198
199
200
201
202
203
204
205
206
207
# File 'lib/bundler/settings.rb', line 196

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.new(nil, false)
end

#pretty_values_for(exposed_key) ⇒ Object


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
# File 'lib/bundler/settings.rb', line 170

def pretty_values_for(exposed_key)
  key = key_for(exposed_key)

  locations = []

  if value = @temporary[key]
    locations << "Set for the current command: #{converted_value(value, exposed_key).inspect}"
  end

  if value = @local_config[key]
    locations << "Set for your local app (#{local_config_file}): #{converted_value(value, exposed_key).inspect}"
  end

  if value = @env_config[key]
    locations << "Set via #{key}: #{converted_value(value, exposed_key).inspect}"
  end

  if value = @global_config[key]
    locations << "Set for the current user (#{global_config_file}): #{converted_value(value, exposed_key).inspect}"
  end

  return ["You have not configured a value for `#{exposed_key}`"] if locations.empty?
  locations
end

#set_command_option(key, value) ⇒ Object


88
89
90
91
92
93
94
95
# File 'lib/bundler/settings.rb', line 88

def set_command_option(key, value)
  if 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


97
98
99
100
# File 'lib/bundler/settings.rb', line 97

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

#set_global(key, value) ⇒ Object


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

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

#set_local(key, value) ⇒ Object


102
103
104
105
106
# File 'lib/bundler/settings.rb', line 102

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


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

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


270
271
272
273
274
275
276
277
# File 'lib/bundler/settings.rb', line 270

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