Class: Gem::ConfigFile

Inherits:
Object
  • Object
show all
Includes:
UserInteraction
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

:sources

Sets Gem::sources

:verbose

See #verbose

gemrc files may exist in various locations and are read and merged in the following order:

  • system wide (/etc/gemrc)

  • per user (~/.gemrc)

  • per environment (gemrc files listed in the GEMRC environment variable)

Constant Summary collapse

DEFAULT_BACKTRACE = 
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 =

:startdoc:

File.join system_config_path, 'gemrc'

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from UserInteraction

#alert, #alert_error, #alert_warning, #ask, #ask_for_password, #ask_yes_no, #choose_from_list, #say, #terminate_interaction

Methods included from DefaultUserInteraction

ui, #ui, ui=, #ui=, use_ui, #use_ui

Constructor Details

#initialize(args) ⇒ 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.

– TODO: parse options upstream, pass in options directly



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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/rubygems/config_file.rb', line 165

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

  arg_list = []

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

  @backtrace = DEFAULT_BACKTRACE
  @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
  environment_config = (ENV['GEMRC'] || '').split(/[:;]/).inject({}) do |result, file|
    result.merge load_file file
  end


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

  # HACK these override command-line args, which is bad
  @backtrace                  = @hash[:backtrace]                  if @hash.key? :backtrace
  @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
  @disable_default_gem_server = @hash[:disable_default_gem_server] if @hash.key? :disable_default_gem_server

  @ssl_verify_mode  = @hash[:ssl_verify_mode]  if @hash.key? :ssl_verify_mode
  @ssl_ca_cert      = @hash[:ssl_ca_cert]      if @hash.key? :ssl_ca_cert

  @api_keys         = nil
  @rubygems_api_key = nil

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

Instance Attribute Details

#args ⇒ Object (readonly)

List of arguments supplied to the config file object.



94
95
96
 
# File 'lib/rubygems/config_file.rb', line 94

def args
  @args
end

#backtrace ⇒ Object

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



335
336
337
 
# File 'lib/rubygems/config_file.rb', line 335

def backtrace
  @backtrace or $DEBUG
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)



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

def bulk_threshold
  @bulk_threshold
end

#disable_default_gem_server ⇒ Object

True if we want to force specification of gem server when pushing a gem



133
134
135
 
# File 'lib/rubygems/config_file.rb', line 133

def disable_default_gem_server
  @disable_default_gem_server
end

#home ⇒ Object

Where to install gems (deprecated)



104
105
106
 
# File 'lib/rubygems/config_file.rb', line 104

def home
  @home
end

#path ⇒ Object

Where to look for gems (deprecated)



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

def path
  @path
end

#ssl_ca_cert ⇒ Object (readonly)

Path name of directory or file of openssl CA certificate, used for remote https connection



142
143
144
 
# File 'lib/rubygems/config_file.rb', line 142

def ssl_ca_cert
  @ssl_ca_cert
end

#ssl_verify_mode ⇒ Object (readonly)

openssl verify mode value, used for remote https connection



137
138
139
 
# File 'lib/rubygems/config_file.rb', line 137

def ssl_verify_mode
  @ssl_verify_mode
end

#update_sources ⇒ Object

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



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

def update_sources
  @update_sources
end

#verbose ⇒ Object

Verbose level of output:

  • false – No output

  • true – Normal output

  • :loud – Extra output



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

def verbose
  @verbose
end

Instance Method Details

#==(other) ⇒ Object

:nodoc:



447
448
449
450
451
452
453
454
 
# File 'lib/rubygems/config_file.rb', line 447

def ==(other) # :nodoc:
  self.class === other and
    @backtrace == other.backtrace 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.



438
439
440
 
# File 'lib/rubygems/config_file.rb', line 438

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

#[]=(key, value) ⇒ Object

Set configuration option key to value.



443
444
445
 
# File 'lib/rubygems/config_file.rb', line 443

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

#api_keys ⇒ Object

Hash of RubyGems.org and alternate API keys



225
226
227
228
229
 
# File 'lib/rubygems/config_file.rb', line 225

def api_keys
  load_api_keys unless @api_keys

  @api_keys
end

#check_credentials_permissions ⇒ Object

Checks the permissions of the credentials file. If they are not 0600 an error message is displayed and RubyGems aborts.



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/rubygems/config_file.rb', line 235

def check_credentials_permissions
  return if Gem.win_platform? # windows doesn't write 0600 as 0600
  return unless File.exist? credentials_path

  existing_permissions = File.stat(credentials_path).mode & 0777

  return if existing_permissions == 0600

  alert_error <<-ERROR
Your gem push credentials file located at:

\t#{credentials_path}

has file permissions of 0#{existing_permissions.to_s 8} but 0600 is required.

You should reset your credentials at:

\thttps://rubygems.org/profile/edit

if you believe they were disclosed to a third party.
  ERROR

  terminate_interaction 1
end

#config_file_name ⇒ Object

The name of the configuration file.



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

def config_file_name
  @config_file_name || Gem.config_file
end

#credentials_path ⇒ Object

Location of RubyGems.org credentials



263
264
265
 
# File 'lib/rubygems/config_file.rb', line 263

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

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

Delegates to @hash

Yields:



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/rubygems/config_file.rb', line 345

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

  yield :update_sources, @update_sources
  yield :verbose, @verbose
  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.



363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/rubygems/config_file.rb', line 363

def handle_arguments(arg_list)
  @args = []

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

#load_api_keys ⇒ Object 



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/rubygems/config_file.rb', line 267

def load_api_keys
  check_credentials_permissions

  @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 



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/rubygems/config_file.rb', line 313

def load_file(filename)
  Gem.load_yaml

  return {} unless filename and File.exist? filename

  begin
    content = YAML.load(File.read(filename))
    unless content.kind_of? Hash
      warn "Failed to load #{filename} because it doesn't contain valid YAML hash"
      return {}
    end
    return content
  rescue ArgumentError
    warn "Failed to load #{filename}"
  rescue Errno::EACCES
    warn "Failed to load #{filename} due to permissions problem."
  end

  {}
end

#really_verbose ⇒ Object

Really verbose mode gives you extra output.



379
380
381
382
383
384
385
386
 
# File 'lib/rubygems/config_file.rb', line 379

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

#rubygems_api_key ⇒ Object

Returns the RubyGems.org API key



286
287
288
289
290
 
# File 'lib/rubygems/config_file.rb', line 286

def rubygems_api_key
  load_api_keys unless @rubygems_api_key

  @rubygems_api_key
end

#rubygems_api_key=(api_key) ⇒ Object

Sets the RubyGems.org API key to api_key



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/rubygems/config_file.rb', line 295

def rubygems_api_key= api_key
  check_credentials_permissions

  config = load_file(credentials_path).merge(:rubygems_api_key => api_key)

  dirname = File.dirname credentials_path
  Dir.mkdir(dirname) unless File.exist? dirname

  Gem.load_yaml

  permissions = 0600 & (~File.umask)
  File.open(credentials_path, 'w', permissions) do |f|
    f.write config.to_yaml
  end

  @rubygems_api_key = api_key
end

#to_yaml ⇒ Object

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



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/rubygems/config_file.rb', line 389

def to_yaml # :nodoc:
  yaml_hash = {}
  yaml_hash[:backtrace] = if @hash.key?(:backtrace)
                            @hash[:backtrace]
                          else
                            DEFAULT_BACKTRACE
                          end

  yaml_hash[:bulk_threshold] = if @hash.key?(:bulk_threshold)
                                 @hash[:bulk_threshold]
                               else
                                 DEFAULT_BULK_THRESHOLD
                               end

  yaml_hash[:sources] = Gem.sources.to_a

  yaml_hash[:update_sources] = if @hash.key?(:update_sources)
                                 @hash[:update_sources]
                               else
                                 DEFAULT_UPDATE_SOURCES
                               end

  yaml_hash[:verbose] = if @hash.key?(:verbose)
                          @hash[:verbose]
                        else
                          DEFAULT_VERBOSITY
                        end

  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.



431
432
433
434
435
 
# File 'lib/rubygems/config_file.rb', line 431

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