Class: Gem::ConfigFile (Ruby 2.3.4)

In Files

  • rubygems/config_file.rb

Class/Module Index [+]

Quicksearch

Gem::ConfigFile

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)

Constants

DEFAULT_BACKTRACE
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

SYSTEM_WIDE_CONFIG_FILE

Attributes

args[R]

List of arguments supplied to the config file object.

backtrace[W]

True if we print backtraces on errors.

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)

disable_default_gem_server[RW]

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

hash[R]
home[RW]

Where to install gems (deprecated)

path[RW]

Where to look for gems (deprecated)

ssl_ca_cert[RW]

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

ssl_client_cert[R]

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

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(args)

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 172
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
  unless arg_list.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

  @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

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

Public Instance Methods

[](key)

Return the configuration information for key.

 
               # File rubygems/config_file.rb, line 465
def [](key)
  @hash[key.to_s]
end
[]=(key, value)

Set configuration option key to value.

 
               # File rubygems/config_file.rb, line 470
def []=(key, value)
  @hash[key.to_s] = value
end
api_keys()

Hash of RubyGems.org and alternate API keys

 
               # File rubygems/config_file.rb, line 234
def api_keys
  load_api_keys unless @api_keys

  @api_keys
end
backtrace()

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

 
               # File rubygems/config_file.rb, line 351
def backtrace
  @backtrace or $DEBUG
end
check_credentials_permissions()

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

 
               # File rubygems/config_file.rb, line 244
  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_name()

The name of the configuration file.

 
               # File rubygems/config_file.rb, line 356
def config_file_name
  @config_file_name || Gem.config_file
end
credentials_path()

Location of RubyGems.org credentials

 
               # File rubygems/config_file.rb, line 276
def credentials_path
  File.join Gem.user_home, '.gem', 'credentials'
end
each(&block)

Delegates to @hash

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

Handle the command arguments.

 
               # File rubygems/config_file.rb, line 379
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_keys() 
 
               # File rubygems/config_file.rb, line 280
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) 
 
               # File rubygems/config_file.rb, line 326
def load_file(filename)
  Gem.load_yaml

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

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

  {}
end
really_verbose()

Really verbose mode gives you extra output.

 
               # File rubygems/config_file.rb, line 397
def really_verbose
  case verbose
  when true, false, nil then
    false
  else
    true
  end
end
rubygems_api_key()

Returns the RubyGems.org API key

 
               # File rubygems/config_file.rb, line 299
def rubygems_api_key
  load_api_keys unless @rubygems_api_key

  @rubygems_api_key
end
rubygems_api_key=(api_key)

Sets the RubyGems.org API key to api_key

 
               # File rubygems/config_file.rb, line 308
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
write()

Writes out this config file, replacing its source.

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