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

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
  cache_command_is_package
  console_command
  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
  error_on_stderr
  force_ruby_platform
  forget_cli_options
  frozen
  gem.coc
  gem.mit
  global_gem_cache
  ignore_messages
  init_gems_rb
  list_command
  lockfile_uses_separate_rubygems_sources
  major_deprecations
  no_install
  no_prune
  only_update_to_newer_versions
  path.system
  plugins
  prefer_gems_rb
  print_only_version_number
  setup_makes_kernel_gem_public
  silence_root_warning
  skip_default_git_sources
  specific_platform
  suppress_install_using_messages
  unlock_source_unlocks_spec
  update_requires_all_flag
].freeze
NUMBER_KEYS =
%w[
  redirect
  retry
  ssl_verify_mode
  timeout
].freeze
ARRAY_KEYS =
%w[
  with
  without
].freeze
DEFAULT_CONFIG =
{
  :disable_version_check => true,
  :redirect => 5,
  :retry => 3,
  :timeout => 10,
}.freeze

Instance Method Summary collapse

Constructor Details

#initialize(root = nil) ⇒ Settings

Returns a new instance of Settings



77
78
79
80
81
82
# File 'lib/bundler/settings.rb', line 77

def initialize(root = nil)
  @root            = root
  @local_config    = load_config(local_config_file)
  @global_config   = load_config(global_config_file)
  @temporary       = {}
end

Instance Method Details

#[](name) ⇒ Object



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

def [](name)
  key = key_for(name)
  value = @temporary.fetch(key) do
          @local_config.fetch(key) do
          ENV.fetch(key) do
          @global_config.fetch(key) do
          DEFAULT_CONFIG.fetch(name) do
            nil
          end end end end end

  converted_value(value, name)
end

#allObject



146
147
148
149
150
151
152
153
154
# File 'lib/bundler/settings.rb', line 146

def all
  env_keys = ENV.keys.grep(/\ABUNDLE_.+/)

  keys = @temporary.keys | @global_config.keys | @local_config.keys | env_keys

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

#allow_sudo?Boolean

Returns:

  • (Boolean)


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

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

#app_cache_pathObject



272
273
274
# File 'lib/bundler/settings.rb', line 272

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

#credentials_for(uri) ⇒ Object



169
170
171
# File 'lib/bundler/settings.rb', line 169

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

#gem_mirrorsObject



173
174
175
176
177
178
# File 'lib/bundler/settings.rb', line 173

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)


268
269
270
# File 'lib/bundler/settings.rb', line 268

def ignore_config?
  ENV["BUNDLE_IGNORE_CONFIG"]
end

#key_for(key) ⇒ Object



285
286
287
288
289
# File 'lib/bundler/settings.rb', line 285

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



156
157
158
159
160
161
162
# File 'lib/bundler/settings.rb', line 156

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

#locations(key) ⇒ Object



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

def locations(key)
  key = key_for(key)
  locations = {}
  locations[:temporary] = @temporary[key] if @temporary.key?(key)
  locations[:local]  = @local_config[key] if @local_config.key?(key)
  locations[:env]    = ENV[key] if ENV[key]
  locations[:global] = @global_config[key] if @global_config.key?(key)
  locations[:default] = DEFAULT_CONFIG[key] if DEFAULT_CONFIG.key?(key)
  locations
end

#mirror_for(uri) ⇒ Object



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

def mirror_for(uri)
  uri = URI(uri.to_s) unless uri.is_a?(URI)
  gem_mirrors.for(uri.to_s).uri
end

#pathObject

for legacy reasons, the ruby scope isnt appended when the setting comes from ENV or the global config, nor do we respect :disable_shared_gems



218
219
220
221
222
223
224
225
226
227
# File 'lib/bundler/settings.rb', line 218

def path
  key  = key_for(:path)
  path = ENV[key] || @global_config[key]
  if path && !@temporary.key?(key) && !@local_config.key?(key)
    return Path.new(path, false, false, false)
  end

  system_path = self["path.system"] || (self[:disable_shared_gems] == false)
  Path.new(self[:path], true, system_path, Bundler.feature_flag.default_install_uses_path?)
end

#pretty_values_for(exposed_key) ⇒ Object



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
# File 'lib/bundler/settings.rb', line 191

def pretty_values_for(exposed_key)
  key = key_for(exposed_key)

  locations = []

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

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

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

  if @global_config.key?(key)
    locations << "Set for the current user (#{global_config_file}): #{converted_value(@global_config[key], 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



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
# File 'lib/bundler/settings.rb', line 97

def set_command_option(key, value)
  if Bundler.feature_flag.forget_cli_options?
    temporary(key => value)
    value
  else
    command = if value.nil?
      "bundle config --delete #{key}"
    else
      "bundle config #{key} #{Array(value).join(":")}"
    end

    Bundler::SharedHelpers.major_deprecation 2,\
      "flags passed to commands " \
      "will no longer be automatically remembered. Instead please set flags " \
      "you want remembered between commands using `bundle config " \
      "<setting name> <setting value>`, i.e. `#{command}`"

    set_local(key, value)
  end
end

#set_command_option_if_given(key, value) ⇒ Object



118
119
120
121
# File 'lib/bundler/settings.rb', line 118

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

#set_global(key, value) ⇒ Object



142
143
144
# File 'lib/bundler/settings.rb', line 142

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

#set_local(key, value) ⇒ Object



123
124
125
126
127
# File 'lib/bundler/settings.rb', line 123

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



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

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



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

def validate!
  all.each do |raw_key|
    [@local_config, ENV, @global_config].each do |settings|
      value = converted_value(settings[key_for(raw_key)], raw_key)
      Validator.validate!(raw_key, value, settings.to_hash.dup)
    end
  end
end