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

:concurrent_downloads

See #concurrent_downloads

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
DEFAULT_CONCURRENT_DOWNLOADS =
8
DEFAULT_CERT_EXPIRATION_LENGTH_DAYS =
365
OPERATING_SYSTEM_DEFAULTS =

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

Gem.operating_system_defaults
PLATFORM_DEFAULTS =

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

Gem.platform_defaults
SYSTEM_CONFIG_PATH =

:stopdoc:

begin
  require "etc"
  Etc.sysconfdir
rescue LoadError, NoMethodError
  RbConfig::CONFIG["sysconfdir"] || "/etc"
end
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

Methods included from Text

#clean_text, #format_text, #levenshtein_distance, #min3, #truncate_text

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


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
# File 'lib/rubygems/config_file.rb', line 169

def initialize(args)
  set_config_file_name(args)

  @backtrace = DEFAULT_BACKTRACE
  @bulk_threshold = DEFAULT_BULK_THRESHOLD
  @verbose = DEFAULT_VERBOSITY
  @update_sources = DEFAULT_UPDATE_SOURCES
  @concurrent_downloads = DEFAULT_CONCURRENT_DOWNLOADS
  @cert_expiration_length_days = DEFAULT_CERT_EXPIRATION_LENGTH_DAYS

  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.tap(&Gem::UNTAINT)

  environment_config = (ENV['GEMRC'] || '')
    .split(File::PATH_SEPARATOR).inject({}) do |result, file|
      result.merge load_file file
    end

  @hash = operating_system_config.merge platform_config
  unless args.index '--norc'
    @hash = @hash.merge system_config
    @hash = @hash.merge user_config
    @hash = @hash.merge environment_config
  end

  # 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
  @sources                     = @hash[:sources]                     if @hash.key? :sources
  @cert_expiration_length_days = @hash[:cert_expiration_length_days] if @hash.key? :cert_expiration_length_days

  @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
  @ssl_client_cert  = @hash[:ssl_client_cert]  if @hash.key? :ssl_client_cert

  @api_keys         = nil
  @rubygems_api_key = nil

  handle_arguments args
end

Instance Attribute Details

#argsObject (readonly)

List of arguments supplied to the config file object.


78
79
80
# File 'lib/rubygems/config_file.rb', line 78

def args
  @args
end

#backtraceObject

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


360
361
362
# File 'lib/rubygems/config_file.rb', line 360

def backtrace
  @backtrace or $DEBUG
end

#bulk_thresholdObject

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


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

def bulk_threshold
  @bulk_threshold
end

#cert_expiration_length_daysObject

Expiration length to sign a certificate


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

def cert_expiration_length_days
  @cert_expiration_length_days
end

#concurrent_downloadsObject

Number of gem downloads that should be performed concurrently.


112
113
114
# File 'lib/rubygems/config_file.rb', line 112

def concurrent_downloads
  @concurrent_downloads
end

#disable_default_gem_serverObject

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


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

def disable_default_gem_server
  @disable_default_gem_server
end

#homeObject

Where to install gems (deprecated)


88
89
90
# File 'lib/rubygems/config_file.rb', line 88

def home
  @home
end

#pathObject

Where to look for gems (deprecated)


83
84
85
# File 'lib/rubygems/config_file.rb', line 83

def path
  @path
end

#sourcesObject

sources to look for gems


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

def sources
  @sources
end

#ssl_ca_certObject

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


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

def ssl_ca_cert
  @ssl_ca_cert
end

#ssl_client_certObject (readonly)

Path name of directory or file of openssl client certificate, used for remote https connection with client authentication


146
147
148
# File 'lib/rubygems/config_file.rb', line 146

def ssl_client_cert
  @ssl_client_cert
end

#ssl_verify_modeObject (readonly)

openssl verify mode value, used for remote https connection


126
127
128
# File 'lib/rubygems/config_file.rb', line 126

def ssl_verify_mode
  @ssl_verify_mode
end

#update_sourcesObject

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


117
118
119
# File 'lib/rubygems/config_file.rb', line 117

def update_sources
  @update_sources
end

#verboseObject

Verbose level of output:

  • false – No output

  • true – Normal output

  • :loud – Extra output


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

def verbose
  @verbose
end

Instance Method Details

#==(other) ⇒ Object

:nodoc:


470
471
472
473
474
475
476
477
# File 'lib/rubygems/config_file.rb', line 470

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.


461
462
463
# File 'lib/rubygems/config_file.rb', line 461

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

#[]=(key, value) ⇒ Object

Set configuration option key to value.


466
467
468
# File 'lib/rubygems/config_file.rb', line 466

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

#api_keysObject

Hash of RubyGems.org and alternate API keys


220
221
222
223
224
# File 'lib/rubygems/config_file.rb', line 220

def api_keys
  load_api_keys unless @api_keys

  @api_keys
end

#check_credentials_permissionsObject

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


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

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.

To fix this error run:

\tchmod 0600 #{credentials_path}

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_nameObject

The name of the configuration file.


365
366
367
# File 'lib/rubygems/config_file.rb', line 365

def config_file_name
  @config_file_name || Gem.config_file
end

#credentials_pathObject

Location of RubyGems.org credentials


262
263
264
265
266
267
268
269
# File 'lib/rubygems/config_file.rb', line 262

def credentials_path
  credentials = File.join Gem.user_home, '.gem', 'credentials'
  if File.exist? credentials
    credentials
  else
    File.join Gem.data_home, "gem", "credentials"
  end
end

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

Delegates to @hash

Yields:


370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
# File 'lib/rubygems/config_file.rb', line 370

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.


388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
# File 'lib/rubygems/config_file.rb', line 388

def handle_arguments(arg_list)
  @args = []

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

      warn 'NOTE:  Debugging mode prints all exceptions even when rescued'
    else
      @args << arg
    end
  end
end

#load_api_keysObject


271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
# File 'lib/rubygems/config_file.rb', line 271

def load_api_keys
  check_credentials_permissions

  @api_keys = if File.exist? credentials_path
                load_file(credentials_path)
              else
                @hash
              end

  if @api_keys.key? :rubygems_api_key
    @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


335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'lib/rubygems/config_file.rb', line 335

def load_file(filename)
  Gem.load_yaml

  yaml_errors = [ArgumentError]
  yaml_errors << Psych::SyntaxError if defined?(Psych::SyntaxError)

  return {} unless filename && !filename.empty? && File.exist?(filename)

  begin
    content = Gem::SafeYAML.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 *yaml_errors => e
    warn "Failed to load #{filename}, #{e}"
  rescue Errno::EACCES
    warn "Failed to load #{filename} due to permissions problem."
  end

  {}
end

#really_verboseObject

Really verbose mode gives you extra output.


406
407
408
409
410
411
412
413
# File 'lib/rubygems/config_file.rb', line 406

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

#rubygems_api_keyObject

Returns the RubyGems.org API key


290
291
292
293
294
# File 'lib/rubygems/config_file.rb', line 290

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


299
300
301
302
303
# File 'lib/rubygems/config_file.rb', line 299

def rubygems_api_key=(api_key)
  set_api_key :rubygems_api_key, api_key

  @rubygems_api_key = api_key
end

#set_api_key(host, api_key) ⇒ Object

Set a specific host's API key to api_key


308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
# File 'lib/rubygems/config_file.rb', line 308

def set_api_key(host, api_key)
  check_credentials_permissions

  config = load_file(credentials_path).merge(host => 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

  load_api_keys # reload
end

#to_yamlObject

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


416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
# File 'lib/rubygems/config_file.rb', line 416

def to_yaml # :nodoc:
  yaml_hash = {}
  yaml_hash[:backtrace] = @hash.fetch(:backtrace, DEFAULT_BACKTRACE)
  yaml_hash[:bulk_threshold] = @hash.fetch(:bulk_threshold, DEFAULT_BULK_THRESHOLD)
  yaml_hash[:sources] = Gem.sources.to_a
  yaml_hash[:update_sources] = @hash.fetch(:update_sources, DEFAULT_UPDATE_SOURCES)
  yaml_hash[:verbose] = @hash.fetch(:verbose, DEFAULT_VERBOSITY)

  yaml_hash[:concurrent_downloads] =
    @hash.fetch(:concurrent_downloads, DEFAULT_CONCURRENT_DOWNLOADS)

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

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

  yaml_hash[:ssl_client_cert] =
    @hash[:ssl_client_cert] if @hash.key? :ssl_client_cert

  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

#unset_api_key!Object

Remove the ~/.gem/credentials file to clear all the current sessions.


329
330
331
332
333
# File 'lib/rubygems/config_file.rb', line 329

def unset_api_key!
  return false unless File.exist?(credentials_path)

  File.delete(credentials_path)
end

#writeObject

Writes out this config file, replacing its source.


450
451
452
453
454
455
456
457
458
# File 'lib/rubygems/config_file.rb', line 450

def write
  unless File.exist?(File.dirname(config_file_name))
    FileUtils.mkdir_p File.dirname(config_file_name)
  end

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