Extended maintenance of Ruby 1.9.3 ended on February 23, 2015. Read more

In Files

  • rubygems/config_file.rb

Class/Module Index [+]

Quicksearch

Gem::ConfigFile

Constants

CSIDL_COMMON_APPDATA
DEFAULT_BACKTRACE
DEFAULT_BENCHMARK
DEFAULT_BULK_THRESHOLD
DEFAULT_UPDATE_SOURCES
DEFAULT_VERBOSITY
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

SHGetFolderPath
SYSTEM_WIDE_CONFIG_FILE

Attributes

api_keys[R]

Hash of RubyGems.org and alternate API keys

args[R]

List of arguments supplied to the config file object.

backtrace[W]

True if we print backtraces on errors.

benchmark[RW]

True if we are benchmarking this run.

bulk_threshold[RW]

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

hash[R]
home[RW]

Where to install gems (deprecated)

path[RW]

Where to look for gems (deprecated)

rubygems_api_key[R]

API key for RubyGems.org

ssl_ca_cert[R]

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

ssl_verify_mode[R]

openssl verify mode value, used for remote https connection

update_sources[RW]

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

verbose[RW]

Verbose level of output:

  • false – No output

  • true – Normal output

  • :loud – Extra output

Public Class Methods

new(arg_list) click to toggle source

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.

 
               # File rubygems/config_file.rb, line 162
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
  @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

  load_api_keys

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

Public Instance Methods

[](key) click to toggle source

Return the configuration information for key.

 
               # File rubygems/config_file.rb, line 353
def [](key)
  @hash[key.to_s]
end
[]=(key, value) click to toggle source

Set configuration option key to value.

 
               # File rubygems/config_file.rb, line 358
def []=(key, value)
  @hash[key.to_s] = value
end
backtrace() click to toggle source

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

 
               # File rubygems/config_file.rb, line 262
def backtrace
  @backtrace or $DEBUG
end
config_file_name() click to toggle source

The name of the configuration file.

 
               # File rubygems/config_file.rb, line 267
def config_file_name
  @config_file_name || Gem.config_file
end
credentials_path() click to toggle source

Location of RubyGems.org credentials

 
               # File rubygems/config_file.rb, line 217
def credentials_path
  File.join Gem.user_home, '.gem', 'credentials'
end
each(&block) click to toggle source

Delegates to @hash

 
               # File rubygems/config_file.rb, line 272
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) click to toggle source

Handle the command arguments.

 
               # File rubygems/config_file.rb, line 292
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() click to toggle source 
 
               # File rubygems/config_file.rb, line 221
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) click to toggle source 
 
               # File rubygems/config_file.rb, line 248
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() click to toggle source

Really verbose mode gives you extra output.

 
               # File rubygems/config_file.rb, line 310
def really_verbose
  case verbose
  when true, false, nil then false
  else true
  end
end
rubygems_api_key=(api_key) click to toggle source 
 
               # File rubygems/config_file.rb, line 233
def rubygems_api_key=(api_key)
  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

  File.open(credentials_path, 'w') do |f|
    f.write config.to_yaml
  end

  @rubygems_api_key = api_key
end
write() click to toggle source

Writes out this config file, replacing its source.

 
               # File rubygems/config_file.rb, line 346
def write
  open config_file_name, 'w' do |io|
    io.write to_yaml
  end
end

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.