Class: Bundler::Settings

Inherits:
Object
  • Object
show all
Defined in:
lib/bundler/settings.rb

Constant Summary

BOOL_KEYS =
%w(frozen cache_all no_prune disable_local_branch_check ignore_messages gem.mit gem.coc).freeze
NUMBER_KEYS =
%w(retry timeout redirect).freeze
DEFAULT_CONFIG =
{:retry => 3, :timeout => 10, :redirect => 5}

Instance Method Summary collapse

Constructor Details

#initialize(root = nil) ⇒ Settings

Returns a new instance of Settings



9
10
11
12
13
# File 'lib/bundler/settings.rb', line 9

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

Instance Method Details

#[](name) ⇒ Object



15
16
17
18
19
20
21
22
23
24
25
26
27
# File 'lib/bundler/settings.rb', line 15

def [](name)
  key = key_for(name)
  value = (@local_config[key] || ENV[key] || @global_config[key] || DEFAULT_CONFIG[name])

  case
  when !value.nil? && is_bool(name)
    to_bool(value)
  when !value.nil? && is_num(name)
    value.to_i
  else
    value
  end
end

#[]=(key, value) ⇒ Object Also known as: set_local



29
30
31
32
# File 'lib/bundler/settings.rb', line 29

def []=(key, value)
  local_config_file or raise GemfileNotFound, "Could not locate Gemfile"
  set_key(key, value, @local_config, local_config_file)
end

#allObject



44
45
46
47
48
49
50
51
52
# File 'lib/bundler/settings.rb', line 44

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?Boolean

Returns:

  • (Boolean)


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

def allow_sudo?
  !@local_config.key?(key_for(:path))
end

#app_cache_pathObject



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

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) ⇒ Object



72
73
74
# File 'lib/bundler/settings.rb', line 72

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

#delete(key) ⇒ Object



36
37
38
# File 'lib/bundler/settings.rb', line 36

def delete(key)
  @local_config.delete(key_for(key))
end

#gem_mirrorsObject



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

def gem_mirrors
  all.inject({}) do |h, k|
    if k =~ /^mirror\./
      uri = normalize_uri($')
      h[uri] = normalize_uri(self[k])
    end
    h
  end
end

#ignore_config?Boolean

Returns:

  • (Boolean)


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

def ignore_config?
  ENV['BUNDLE_IGNORE_CONFIG']
end

#local_overridesObject



54
55
56
57
58
59
60
61
62
# File 'lib/bundler/settings.rb', line 54

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

#locations(key) ⇒ Object



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

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) ⇒ Object



64
65
66
67
68
69
70
# File 'lib/bundler/settings.rb', line 64

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

  # Settings keys are all downcased
  normalized_key = normalize_uri(uri.to_s.downcase)
  gem_mirrors[normalized_key] || uri
end

#pathObject

@local_config should be prioritized over ENV



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

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) ⇒ Object



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

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) ⇒ Object



40
41
42
# File 'lib/bundler/settings.rb', line 40

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

#withObject



128
129
130
# File 'lib/bundler/settings.rb', line 128

def with
  get_array(:with)
end

#with=(array) ⇒ Object



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

def with=(array)
  set_array(:with, array)
end

#withoutObject



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

def without
  get_array(:without)
end

#without=(array) ⇒ Object



116
117
118
# File 'lib/bundler/settings.rb', line 116

def without=(array)
  set_array(:without, array)
end