class Bundler::Settings

Constants

BOOL_KEYS
CONFIG_REGEX
DEFAULT_CONFIG
NUMBER_KEYS

Attributes

cli_flags_given[RW]

Public Class Methods

new(root = nil) click to toggle source
# File lib/bundler/settings.rb, line 46
def initialize(root = nil)
  @root            = root
  @local_config    = load_config(local_config_file)
  @global_config   = load_config(global_config_file)
  @cli_flags_given = false
  @temporary       = {}
end

Private Class Methods

normalize_uri(uri) click to toggle source

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

# File lib/bundler/settings.rb, line 329
def self.normalize_uri(uri)
  uri = uri.to_s
  uri = "#{uri}/" unless uri =~ %r{/\Z}
  uri = URI(uri)
  unless uri.absolute?
    raise ArgumentError, format("Gem sources must be absolute. You provided '%s'.", uri)
  end
  uri
end

Public Instance Methods

[](name) click to toggle source
# File lib/bundler/settings.rb, line 54
def [](name)
  key = key_for(name)
  value = @temporary.fetch(name) 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
[]=(key, value) click to toggle source
# File lib/bundler/settings.rb, line 67
def []=(key, value)
  if cli_flags_given
    command = if value.nil?
      "bundle config --delete #{key}"
    else
      "bundle config #{key} #{Array(value).join(":")}"
    end

    Bundler::SharedHelpers.major_deprecation            "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}`"
  end
  local_config_file || raise(GemfileNotFound, "Could not locate Gemfile")
  set_key(key, value, @local_config, local_config_file)
end
Also aliased as: set_local
all() click to toggle source
# File lib/bundler/settings.rb, line 105
def all
  env_keys = ENV.keys.select {|k| k =~ /BUNDLE_.*/ }

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

  keys.map do |key|
    key.sub(/^BUNDLE_/, "").gsub(/__/, ".").downcase
  end
end
allow_sudo?() click to toggle source
# File lib/bundler/settings.rb, line 198
def allow_sudo?
  !@local_config.key?(key_for(:path))
end
app_cache_path() click to toggle source
# File lib/bundler/settings.rb, line 206
def app_cache_path
  @app_cache_path ||= begin
    path = self[:cache_path] || "vendor/cache"
    raise InvalidOption, "Cache path must be relative to the bundle path" if path.start_with?("/")
    path
  end
end
credentials_for(uri) click to toggle source
# File lib/bundler/settings.rb, line 128
def credentials_for(uri)
  self[uri.to_s] || self[uri.host]
end
delete(key) click to toggle source
# File lib/bundler/settings.rb, line 97
def delete(key)
  @local_config.delete(key_for(key))
end
gem_mirrors() click to toggle source
# File lib/bundler/settings.rb, line 132
def gem_mirrors
  all.inject(Mirrors.new) do |mirrors, k|
    mirrors.parse(k, self[k]) if k =~ /^mirror\./
    mirrors
  end
end
ignore_config?() click to toggle source
# File lib/bundler/settings.rb, line 202
def ignore_config?
  ENV["BUNDLE_IGNORE_CONFIG"]
end
local_overrides() click to toggle source
# File lib/bundler/settings.rb, line 115
def local_overrides
  repos = {}
  all.each do |k|
    repos[$'] = self[k] if k =~ /^local\./
  end
  repos
end
locations(key) click to toggle source
# File lib/bundler/settings.rb, line 139
def locations(key)
  key = key_for(key)
  locations = {}
  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) click to toggle source
# File lib/bundler/settings.rb, line 123
def mirror_for(uri)
  uri = URI(uri.to_s) unless uri.is_a?(URI)
  gem_mirrors.for(uri.to_s).uri
end
path() click to toggle source

@local_config should be prioritized over ENV

# File lib/bundler/settings.rb, line 186
def path
  key  = key_for(:path)
  path = ENV[key] || @global_config[key]
  return path if path && !@local_config.key?(key)

  if path = self[:path]
    "#{path}/#{Bundler.ruby_scope}"
  else
    Bundler.rubygems.gem_dir
  end
end
pretty_values_for(exposed_key) click to toggle source
# File lib/bundler/settings.rb, line 149
def pretty_values_for(exposed_key)
  key = key_for(exposed_key)

  locations = []
  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_global(key, value) click to toggle source
# File lib/bundler/settings.rb, line 101
def set_global(key, value)
  set_key(key, value, @global_config, global_config_file)
end
set_local(key, value)
Alias for: []=
temporary(update) { || ... } click to toggle source
# File lib/bundler/settings.rb, line 86
def temporary(update)
  existing = Hash[update.map {|k, _| [k, @temporary[k]] }]
  @temporary.update(update)
  return unless block_given?
  begin
    yield
  ensure
    existing.each {|k, v| v.nil? ? @temporary.delete(k) : @temporary[k] = v }
  end
end
with() click to toggle source
# File lib/bundler/settings.rb, line 181
def with
  get_array(:with)
end
with=(array) click to toggle source
# File lib/bundler/settings.rb, line 173
def with=(array)
  set_array(:with, array)
end
without() click to toggle source
# File lib/bundler/settings.rb, line 177
def without
  get_array(:without)
end
without=(array) click to toggle source
# File lib/bundler/settings.rb, line 169
def without=(array)
  set_array(:without, array)
end

Private Instance Methods

converted_value(value, key) click to toggle source
# File lib/bundler/settings.rb, line 275
def converted_value(value, key)
  if value.nil?
    nil
  elsif is_bool(key) || value == "false"
    to_bool(value)
  elsif is_num(key)
    value.to_i
  else
    value
  end
end
get_array(key) click to toggle source
# File lib/bundler/settings.rb, line 251
def get_array(key)
  self[key] ? self[key].split(":").map(&:to_sym) : []
end
global_config_file() click to toggle source
# File lib/bundler/settings.rb, line 287
def global_config_file
  if ENV["BUNDLE_CONFIG"] && !ENV["BUNDLE_CONFIG"].empty?
    Pathname.new(ENV["BUNDLE_CONFIG"])
  else
    begin
      Bundler.user_bundle_path.join("config")
    rescue PermissionError, GenericSystemCallError
      nil
    end
  end
end
is_bool(name) click to toggle source
# File lib/bundler/settings.rb, line 234
def is_bool(name)
  BOOL_KEYS.include?(name.to_s) || BOOL_KEYS.include?(parent_setting_for(name.to_s))
end
is_num(value) click to toggle source
# File lib/bundler/settings.rb, line 247
def is_num(value)
  NUMBER_KEYS.include?(value.to_s)
end
key_for(key) click to toggle source
# File lib/bundler/settings.rb, line 216
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
load_config(config_file) click to toggle source
# File lib/bundler/settings.rb, line 317
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
    require "bundler/yaml_serializer"
    YAMLSerializer.load file.read
  end
end
local_config_file() click to toggle source
# File lib/bundler/settings.rb, line 299
def local_config_file
  Pathname.new(@root).join("config") if @root
end
parent_setting_for(name) click to toggle source
# File lib/bundler/settings.rb, line 222
def parent_setting_for(name)
  split_specfic_setting_for(name)[0]
end
set_array(key, array) click to toggle source
# File lib/bundler/settings.rb, line 255
def set_array(key, array)
  self[key] = (array.empty? ? nil : array.join(":")) if array
end
set_key(key, value, hash, file) click to toggle source
# File lib/bundler/settings.rb, line 259
def set_key(key, value, hash, file)
  key = key_for(key)

  unless hash[key] == value
    hash[key] = value
    hash.delete(key) if value.nil?
    SharedHelpers.filesystem_access(file) do |p|
      FileUtils.mkdir_p(p.dirname)
      require "bundler/yaml_serializer"
      p.open("w") {|f| f.write(YAMLSerializer.dump(hash)) }
    end
  end

  value
end
specfic_gem_for(name) click to toggle source
# File lib/bundler/settings.rb, line 226
def specfic_gem_for(name)
  split_specfic_setting_for(name)[1]
end
split_specfic_setting_for(name) click to toggle source
# File lib/bundler/settings.rb, line 230
def split_specfic_setting_for(name)
  name.split(".")
end
to_bool(value) click to toggle source
# File lib/bundler/settings.rb, line 238
def to_bool(value)
  case value
  when nil, /\A(false|f|no|n|0|)\z/i, false
    false
  else
    true
  end
end