Class: Gem::ConfigFile

Inherits:
Object
  • Object
show all
Defined in:
lib/rubygems/config_file.rb

Overview

Gem::ConfigFile RubyGems options and gem command options from ~/.gemrc.

~/.gemrc is a YAML file that uses strings to match gem command arguments and symbols to match RubyGems options.

Gem command arguments use a String key that matches the command name and allow you to specify default arguments:

install: --no-rdoc --no-ri
update: --no-rdoc --no-ri

You can use gem: to set default arguments for all commands.

RubyGems options use symbol keys. Valid options are:

:backtrace

See #backtrace

:benchmark

See #benchmark

:sources

Sets Gem::sources

:verbose

See #verbose

Constant Summary collapse

DEFAULT_BACKTRACE = 
false
DEFAULT_BENCHMARK = 
false
DEFAULT_BULK_THRESHOLD = 
1000
DEFAULT_VERBOSITY = 
true
DEFAULT_UPDATE_SOURCES = 
true
OPERATING_SYSTEM_DEFAULTS =

For Ruby packagers to set configuration defaults. Set in rubygems/defaults/operating_system.rb

{}
PLATFORM_DEFAULTS =

For Ruby implementers to set configuration defaults. Set in rubygems/defaults/#RUBY_ENGINE.rb

{}
SYSTEM_WIDE_CONFIG_FILE = 
File.join system_config_path, 'gemrc'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(arg_list) ⇒ ConfigFile

Create the config file object. args is the list of arguments from the command line.

The following command line options are handled early here rather than later at the time most command options are processed.

--config-file, --config-file==NAME

Obviously these need to be handled by the ConfigFile object to ensure we get the right config file.

--backtrace

Backtrace needs to be turned on early so that errors before normal option parsing can be properly handled.

--debug

Enable Ruby level debug messages. Handled early for the same reason as –backtrace.



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/rubygems/config_file.rb', line 150

def initialize(arg_list)
  @config_file_name = nil
  need_config_file_name = false

  arg_list = arg_list.map do |arg|
    if need_config_file_name then
      @config_file_name = arg
      need_config_file_name = false
      nil
    elsif arg =~ /^--config-file=(.*)/ then
      @config_file_name = $1
      nil
    elsif arg =~ /^--config-file$/ then
      need_config_file_name = true
      nil
    else
      arg
    end
  end.compact

  @backtrace = DEFAULT_BACKTRACE
  @benchmark = DEFAULT_BENCHMARK
  @bulk_threshold = DEFAULT_BULK_THRESHOLD
  @verbose = DEFAULT_VERBOSITY
  @update_sources = DEFAULT_UPDATE_SOURCES

  operating_system_config = Marshal.load Marshal.dump(OPERATING_SYSTEM_DEFAULTS)
  platform_config = Marshal.load Marshal.dump(PLATFORM_DEFAULTS)
  system_config = load_file SYSTEM_WIDE_CONFIG_FILE
  user_config = load_file config_file_name.dup.untaint

  @hash = operating_system_config.merge platform_config
  @hash = @hash.merge system_config
  @hash = @hash.merge user_config

  # HACK these override command-line args, which is bad
  @backtrace        = @hash[:backtrace]        if @hash.key? :backtrace
  @benchmark        = @hash[:benchmark]        if @hash.key? :benchmark
  @bulk_threshold   = @hash[:bulk_threshold]   if @hash.key? :bulk_threshold
  @home             = @hash[:gemhome]          if @hash.key? :gemhome
  @path             = @hash[:gempath]          if @hash.key? :gempath
  @update_sources   = @hash[:update_sources]   if @hash.key? :update_sources
  @verbose          = @hash[:verbose]          if @hash.key? :verbose

  load_api_keys

  Gem.sources = @hash[:sources] if @hash.key? :sources
  handle_arguments arg_list
end

Instance Attribute Details

#api_keys ⇒ Object (readonly)

Hash of RubyGems.org and alternate API keys



129
130
131
 
# File 'lib/rubygems/config_file.rb', line 129

def api_keys
  @api_keys
end

#args ⇒ Object (readonly)

List of arguments supplied to the config file object.



80
81
82
 
# File 'lib/rubygems/config_file.rb', line 80

def args
  @args
end

#backtrace ⇒ Object

True if the backtrace option has been specified, or debug is on.



248
249
250
 
# File 'lib/rubygems/config_file.rb', line 248

def backtrace
  @backtrace or $DEBUG
end

#benchmark ⇒ Object

True if we are benchmarking this run.



100
101
102
 
# File 'lib/rubygems/config_file.rb', line 100

def benchmark
  @benchmark
end

#bulk_threshold ⇒ Object

Bulk threshold value. If the number of missing gems are above this threshold value, then a bulk download technique is used. (deprecated)



106
107
108
 
# File 'lib/rubygems/config_file.rb', line 106

def bulk_threshold
  @bulk_threshold
end

#home ⇒ Object

Where to install gems (deprecated)



90
91
92
 
# File 'lib/rubygems/config_file.rb', line 90

def home
  @home
end

#path ⇒ Object

Where to look for gems (deprecated)



85
86
87
 
# File 'lib/rubygems/config_file.rb', line 85

def path
  @path
end

#rubygems_api_key ⇒ Object

API key for RubyGems.org



124
125
126
 
# File 'lib/rubygems/config_file.rb', line 124

def rubygems_api_key
  @rubygems_api_key
end

#update_sources ⇒ Object

True if we want to update the SourceInfoCache every time, false otherwise



119
120
121
 
# File 'lib/rubygems/config_file.rb', line 119

def update_sources
  @update_sources
end

#verbose ⇒ Object

Verbose level of output:

  • false – No output

  • true – Normal output

  • :loud – Extra output



114
115
116
 
# File 'lib/rubygems/config_file.rb', line 114

def verbose
  @verbose
end

Instance Method Details

#==(other) ⇒ Object

:nodoc:



348
349
350
351
352
353
354
355
356
 
# File 'lib/rubygems/config_file.rb', line 348

def ==(other) # :nodoc:
  self.class === other and
  @backtrace == other.backtrace and
  @benchmark == other.benchmark and
  @bulk_threshold == other.bulk_threshold and
  @verbose == other.verbose and
  @update_sources == other.update_sources and
  @hash == other.hash
end

#[](key) ⇒ Object

Return the configuration information for key.



339
340
341
 
# File 'lib/rubygems/config_file.rb', line 339

def [](key)
  @hash[key.to_s]
end

#[]=(key, value) ⇒ Object

Set configuration option key to value.



344
345
346
 
# File 'lib/rubygems/config_file.rb', line 344

def []=(key, value)
  @hash[key.to_s] = value
end

#config_file_name ⇒ Object

The name of the configuration file.



253
254
255
 
# File 'lib/rubygems/config_file.rb', line 253

def config_file_name
  @config_file_name || Gem.config_file
end

#credentials_path ⇒ Object

Location of RubyGems.org credentials



203
204
205
 
# File 'lib/rubygems/config_file.rb', line 203

def credentials_path
  File.join Gem.user_home, '.gem', 'credentials'
end

#each {|:update_sources, @update_sources| ... } ⇒ Object

Delegates to @hash

Yields:



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/rubygems/config_file.rb', line 258

def each(&block)
  hash = @hash.dup
  hash.delete :update_sources
  hash.delete :verbose
  hash.delete :benchmark
  hash.delete :backtrace
  hash.delete :bulk_threshold

  yield :update_sources, @update_sources
  yield :verbose, @verbose
  yield :benchmark, @benchmark
  yield :backtrace, @backtrace
  yield :bulk_threshold, @bulk_threshold

  yield 'config_file_name', @config_file_name if @config_file_name

  hash.each(&block)
end

#handle_arguments(arg_list) ⇒ Object

Handle the command arguments.



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/rubygems/config_file.rb', line 278

def handle_arguments(arg_list)
  @args = []

  arg_list.each do |arg|
    case arg
    when /^--(backtrace|traceback)$/ then
      @backtrace = true
    when /^--bench(mark)?$/ then
      @benchmark = true
    when /^--debug$/ then
      $DEBUG = true
    else
      @args << arg
    end
  end
end

#load_api_keys ⇒ Object 



207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/rubygems/config_file.rb', line 207

def load_api_keys
  @api_keys = if File.exist? credentials_path then
                load_file(credentials_path)
              else
                @hash
              end
  if @api_keys.key? :rubygems_api_key then
    @rubygems_api_key = @api_keys[:rubygems_api_key]
    @api_keys[:rubygems] = @api_keys.delete :rubygems_api_key unless @api_keys.key? :rubygems
  end
end

#load_file(filename) ⇒ Object 



234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/rubygems/config_file.rb', line 234

def load_file(filename)
  Gem.load_yaml

  return {} unless filename and File.exist? filename
  begin
    YAML.load(File.read(filename))
  rescue ArgumentError
    warn "Failed to load #{config_file_name}"
  rescue Errno::EACCES
    warn "Failed to load #{config_file_name} due to permissions problem."
  end or {}
end

#really_verbose ⇒ Object

Really verbose mode gives you extra output.



296
297
298
299
300
301
 
# File 'lib/rubygems/config_file.rb', line 296

def really_verbose
  case verbose
  when true, false, nil then false
  else true
  end
end

#to_yaml ⇒ Object

to_yaml only overwrites things you can’t override on the command line.



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/rubygems/config_file.rb', line 304

def to_yaml # :nodoc:
  yaml_hash = {}
  yaml_hash[:backtrace] = @hash.key?(:backtrace) ? @hash[:backtrace] :
    DEFAULT_BACKTRACE
  yaml_hash[:benchmark] = @hash.key?(:benchmark) ? @hash[:benchmark] :
    DEFAULT_BENCHMARK
  yaml_hash[:bulk_threshold] = @hash.key?(:bulk_threshold) ?
    @hash[:bulk_threshold] : DEFAULT_BULK_THRESHOLD
  yaml_hash[:sources] = Gem.sources
  yaml_hash[:update_sources] = @hash.key?(:update_sources) ?
    @hash[:update_sources] : DEFAULT_UPDATE_SOURCES
  yaml_hash[:verbose] = @hash.key?(:verbose) ? @hash[:verbose] :
    DEFAULT_VERBOSITY

  keys = yaml_hash.keys.map { |key| key.to_s }
  keys << 'debug'
  re = Regexp.union(*keys)

  @hash.each do |key, value|
    key = key.to_s
    next if key =~ re
    yaml_hash[key.to_s] = value
  end

  yaml_hash.to_yaml
end

#write ⇒ Object

Writes out this config file, replacing its source.



332
333
334
335
336
 
# File 'lib/rubygems/config_file.rb', line 332

def write
  open config_file_name, 'w' do |io|
    io.write to_yaml
  end
end