Class: Gem::ConfigFile

Class | Gem::ConfigFile
In: | lib/rubygems/config_file.rb
Parent: | Object

Store the gem command options specified in the configuration file. The config file object acts much like a hash.

### Methods

[] []= backtrace config_file_name each handle_arguments load_file new really_verbose write

### Constants

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
CSIDL_COMMON_APPDATA | = | 0x0023
SHGetFolderPath | = | Win32API.new 'shell32', 'SHGetFolderPath', 'PLPLP', 'L', :stdcall
SHGetFolderPath | = | Win32API.new 'shell32', 'SHGetFolderPath', 'LLLLP', 'L'
SYSTEM_WIDE_CONFIG_FILE | = | File.join system_config_path, 'gemrc'

### Attributes

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.
hash | [R] |
home | [RW] |
path | [RW] | Where to look for gems
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)

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 and —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.

### Public Instance methods

[](key)

Return the configuration information for `key`.

[]=(key, value)

Set configuration option `key` to `value`.

backtrace()

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

config_file_name()

The name of the configuration file.

each() {|:update_sources, @update_sources| ...}

Delegates to @hash

handle_arguments(arg_list)

Handle the command arguments.

load_file(filename)
really_verbose()

Really verbose mode gives you extra output.

write()

Writes out this config file, replacing its source.

[Validate]