class Bundler::Settings

Constants

BOOL_KEYS
DEFAULT_CONFIG
NUMBER_KEYS

Public Class Methods

new(root = nil) click to toggle source
# File lib/bundler/settings.rb, line 10
def initialize(root = nil)
  @root          = root
  @local_config  = load_config(local_config_file)
  @global_config = load_config(global_config_file)
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 245
def self.normalize_uri(uri)
  uri = uri.to_s
  uri = "#{uri}/" unless uri =~ %r{/\Z}
  uri = URI(uri)
  unless uri.absolute?
    raise ArgumentError, "Gem sources must be absolute. You provided '#{uri}'."
  end
  uri
end

Public Instance Methods

[](name) click to toggle source
# File lib/bundler/settings.rb, line 16
def [](name)
  key = key_for(name)
  value = (@local_config[key] || ENV[key] || @global_config[key] || DEFAULT_CONFIG[name])

  case
  when value.nil?
    nil
  when is_bool(name) || value == "false"
    to_bool(value)
  when is_num(name)
    value.to_i
  else
    value
  end
end
[]=(key, value) click to toggle source
# File lib/bundler/settings.rb, line 32
def []=(key, value)
  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 47
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 140
def allow_sudo?
  !@local_config.key?(key_for(:path))
end
app_cache_path() click to toggle source
# File lib/bundler/settings.rb, line 148
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 70
def credentials_for(uri)
  self[uri.to_s] || self[uri.host]
end
delete(key) click to toggle source
# File lib/bundler/settings.rb, line 39
def delete(key)
  @local_config.delete(key_for(key))
end
gem_mirrors() click to toggle source
# File lib/bundler/settings.rb, line 74
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 144
def ignore_config?
  ENV["BUNDLE_IGNORE_CONFIG"]
end
local_overrides() click to toggle source
# File lib/bundler/settings.rb, line 57
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 81
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 65
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 128
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 91
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}): #{@local_config[key].inspect}"
  end

  if value = ENV[key]
    locations << "Set via #{key}: #{value.inspect}"
  end

  if @global_config.key?(key)
    locations << "Set for the current user (#{global_config_file}): #{@global_config[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 43
def set_global(key, value)
  set_key(key, value, @global_config, global_config_file)
end
set_local(key, value)
Alias for: []=
with() click to toggle source
# File lib/bundler/settings.rb, line 123
def with
  get_array(:with)
end
with=(array) click to toggle source
# File lib/bundler/settings.rb, line 115
def with=(array)
  set_array(:with, array)
end
without() click to toggle source
# File lib/bundler/settings.rb, line 119
def without
  get_array(:without)
end
without=(array) click to toggle source
# File lib/bundler/settings.rb, line 111
def without=(array)
  set_array(:without, array)
end

Private Instance Methods

convert_to_backward_compatible_key(key) click to toggle source
# File lib/bundler/settings.rb, line 237
def convert_to_backward_compatible_key(key)
  key = "#{key}/" if key =~ /https?:/i && key !~ %r{/\Z}
  key = key.gsub(".", "__") if key.include?(".")
  key
end
get_array(key) click to toggle source
# File lib/bundler/settings.rb, line 188
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 212
def global_config_file
  if ENV["BUNDLE_CONFIG"] && !ENV["BUNDLE_CONFIG"].empty?
    Pathname.new(ENV["BUNDLE_CONFIG"])
  else
    Bundler.user_bundle_path.join("config")
  end
end
is_bool(name) click to toggle source
# File lib/bundler/settings.rb, line 176
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 184
def is_num(value)
  NUMBER_KEYS.include?(value.to_s)
end
key_for(key) click to toggle source
# File lib/bundler/settings.rb, line 158
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 224
def load_config(config_file)
  SharedHelpers.filesystem_access(config_file, :read) do
    valid_file = config_file && config_file.exist? && !config_file.size.zero?
    return {} if ignore_config? || !valid_file
    config_regex = /^(BUNDLE_.+): (['"]?)(.*(?:\n(?!BUNDLE).+)?)\2$/
    config_pairs = config_file.read.scan(config_regex).map do |m|
      key, _, value = m
      [convert_to_backward_compatible_key(key), value.gsub(/\s+/, " ").tr('"', "'")]
    end
    Hash[config_pairs]
  end
end
local_config_file() click to toggle source
# File lib/bundler/settings.rb, line 220
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 164
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 192
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 196
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/psyched_yaml"
      File.open(p, "w") {|f| f.puts YAML.dump(hash) }
    end
  end

  value
end
specfic_gem_for(name) click to toggle source
# File lib/bundler/settings.rb, line 168
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 172
def split_specfic_setting_for(name)
  name.split(".")
end
to_bool(value) click to toggle source
# File lib/bundler/settings.rb, line 180
def to_bool(value)
  !(value.nil? || value == "" || value =~ /^(false|f|no|n|0)$/i || value == false)
end