class Gem::ConfigFile

Gem::ConfigFile RubyGems options and gem command options from gemrc.

gemrc is aYAML file that uses strings to match gem command arguments and symbols to match RubyGems options.

Gem command arguments use aString key that matches the command name and allow you to specify default arguments:

install: --no-rdoc --no-riupdate: --no-rdoc --no-ri

You can usegem: to set default arguments for all commands.

RubyGems options use symbol keys. Valid options are:

:backtrace: Seebacktrace
:sources: SetsGem::sources
:verbose: Seeverbose
:concurrent_downloads: Seeconcurrent_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)

Constants

DEFAULT_BACKTRACE
DEFAULT_BULK_THRESHOLD
DEFAULT_CERT_EXPIRATION_LENGTH_DAYS
DEFAULT_CONCURRENT_DOWNLOADS
DEFAULT_INSTALL_EXTENSION_IN_LIB: TODO: Use false as default value for this option in RubyGems 4.0
DEFAULT_IPV4_FALLBACK_ENABLED
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)

cert_expiration_length_days[RW]

Expiration length to sign a certificate

concurrent_downloads[RW]

Number of gem downloads that should be performed concurrently.

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)

install_extension_in_lib[RW]

Install extensions into lib as well as into the extension directory.

ipv4_fallback_enabled[RW]

Experimental ==¶↑

Fallback to IPv4 when IPv6 is not reachable or slow (default: false)

path[RW]

Where to look for gems (deprecated)

sources[RW]

sources to look for gems

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

deep_transform_config_keys!(config)

Source

# File lib/rubygems/config_file.rb, line 563defself.deep_transform_config_keys!(config)config.transform_keys!do|k|ifk.match?(/\A:(.*)\Z/)k[1..-1].to_symelsifk.include?("__")||k.match?(%r{/\Z})ifk.is_a?(Symbol)k.to_s.gsub(/__/,".").gsub(%r{/\Z},"").to_symelsek.dup.gsub(/__/,".").gsub(%r{/\Z},"")endelsekendendconfig.transform_values!do|v|ifv.is_a?(String)ifv.match?(/\A:(.*)\Z/)v[1..-1].to_symelsifv.match?(/\A[+-]?\d+\Z/)v.to_ielsifv.match?(/\Atrue|false\Z/)v=="true"elsifv.empty?nilelsevendelsifv.empty?nilelsifv.is_a?(Hash)deep_transform_config_keys!(v)elsevendendconfigend

dump_with_rubygems_yaml(content)

Source

# File lib/rubygems/config_file.rb, line 545defself.dump_with_rubygems_yaml(content)content.transform_keys!do|k|k.is_a?(Symbol)?":#{k}":kendrequire_relative"yaml_serializer"Gem::YAMLSerializer.dump(content)end

load_with_rubygems_config_hash(yaml)

Source

# File lib/rubygems/config_file.rb, line 554defself.load_with_rubygems_config_hash(yaml)require_relative"yaml_serializer"content =Gem::YAMLSerializer.load(yaml)deep_transform_config_keys!(content)end

new(args)

Source

# File lib/rubygems/config_file.rb, line 184definitialize(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@install_extension_in_lib =DEFAULT_INSTALL_EXTENSION_IN_LIB@ipv4_fallback_enabled =ENV["IPV4_FALLBACK_ENABLED"]=="true"||DEFAULT_IPV4_FALLBACK_ENABLEDoperating_system_config =Marshal.loadMarshal.dump(OPERATING_SYSTEM_DEFAULTS)platform_config =Marshal.loadMarshal.dump(PLATFORM_DEFAULTS)system_config =load_fileSYSTEM_WIDE_CONFIG_FILEuser_config =load_fileconfig_file_nameenvironment_config = (ENV["GEMRC"]||"").split(File::PATH_SEPARATOR).inject({})do|result,file|result.mergeload_filefileend@hash =operating_system_config.mergeplatform_configunlessargs.index"--norc"@hash =@hash.mergesystem_config@hash =@hash.mergeuser_config@hash =@hash.mergeenvironment_configend@hash.transform_keys!do|k|# gemhome and gempath are not working with symbol keysif%w[backtrace bulk_threshold verbose update_sources cert_expiration_length_days          install_extension_in_lib ipv4_fallback_enabled sources disable_default_gem_server          ssl_verify_mode ssl_ca_cert ssl_client_cert].include?(k)k.to_symelsekendend# 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@verbose                     =@hash[:verbose]if@hash.key?:verbose@update_sources              =@hash[:update_sources]if@hash.key?:update_sources# TODO: We should handle concurrent_downloads same as other options@cert_expiration_length_days =@hash[:cert_expiration_length_days]if@hash.key?:cert_expiration_length_days@install_extension_in_lib    =@hash[:install_extension_in_lib]if@hash.key?:install_extension_in_lib@ipv4_fallback_enabled       =@hash[:ipv4_fallback_enabled]if@hash.key?:ipv4_fallback_enabled@home                        =@hash[:gemhome]if@hash.key?:gemhome@path                        =@hash[:gempath]if@hash.key?:gempath@sources                     =@hash[:sources]if@hash.key?:sources@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 =nilhandle_argumentsargsend

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 theConfigFile 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)

Source

# File lib/rubygems/config_file.rb, line 524def[](key)@hash[key]||@hash[key.to_s]end

Return the configuration information forkey.

[]=(key, value)

Source

# File lib/rubygems/config_file.rb, line 529def[]=(key,value)@hash[key] =valueend

Set configuration optionkey tovalue.

api_keys()

Source

# File lib/rubygems/config_file.rb, line 251defapi_keysload_api_keysunless@api_keys@api_keysend

Hash of RubyGems.org and alternate API keys

backtrace()

Source

# File lib/rubygems/config_file.rb, line 388defbacktrace@backtrace||$DEBUGend

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

check_credentials_permissions()

Source

# File lib/rubygems/config_file.rb, line 261defcheck_credentials_permissionsreturnifGem.win_platform?# windows doesn't write 0600 as 0600returnunlessFile.exist?credentials_pathexisting_permissions =File.stat(credentials_path).mode&0o777returnifexisting_permissions==0o600alert_error<<-ERRORYour 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/editif you believe they were disclosed to a third party.    ERRORterminate_interaction1end

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

config_file_name()

Source

# File lib/rubygems/config_file.rb, line 407defconfig_file_name@config_file_name||Gem.config_fileend

The name of the configuration file.

credentials_path()

Source

# File lib/rubygems/config_file.rb, line 293defcredentials_pathcredentials =File.joinGem.user_home,".gem","credentials"ifFile.exist?credentialscredentialselseFile.joinGem.data_home,"gem","credentials"endend

Location of RubyGems.org credentials

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

Source

# File lib/rubygems/config_file.rb, line 431defeach(&block)hash =@hash.duphash.delete:update_sourceshash.delete:verbosehash.delete:backtracehash.delete:bulk_thresholdyield:update_sources,@update_sourcesyield:verbose,@verboseyield:backtrace,@backtraceyield:bulk_threshold,@bulk_thresholdyield"config_file_name",@config_file_nameif@config_file_namehash.each(&block)end

Delegates to @hash

handle_arguments(arg_list)

Source

# File lib/rubygems/config_file.rb, line 449defhandle_arguments(arg_list)@args = []arg_list.eachdo|arg|caseargwhen/^--(backtrace|traceback)$/then@backtrace =truewhen/^--debug$/then$DEBUG =truewarn"NOTE:  Debugging mode prints all exceptions even when rescued"else@args<<argendendend

Handle the command arguments.

last_update_check()

Source

# File lib/rubygems/config_file.rb, line 417deflast_update_checkifFile.readable?(state_file_name)File.read(state_file_name).to_ielse0endend

Reads time of last update check from state file

last_update_check=(timestamp)

Source

# File lib/rubygems/config_file.rb, line 426deflast_update_check=(timestamp)File.write(state_file_name,timestamp.to_s)ifstate_file_writable?end

Writes time of last update check to state file

load_api_keys()

Source

# File lib/rubygems/config_file.rb, line 302defload_api_keyscheck_credentials_permissions@api_keys =ifFile.exist?credentials_pathload_file(credentials_path)else@hashendif@api_keys.key?:rubygems_api_key@rubygems_api_key    =@api_keys[:rubygems_api_key]@api_keys[:rubygems] =@api_keys.delete:rubygems_api_keyunless@api_keys.key?:rubygemsendend

load_file(filename)

Source

# File lib/rubygems/config_file.rb, line 365defload_file(filename)yaml_errors = [ArgumentError]return {}unlessfilename&&!filename.empty?&&File.exist?(filename)beginconfig =self.class.load_with_rubygems_config_hash(File.read(filename))ifconfig.keys.any? {|k|k.to_s.gsub(%r{https?:\/\/},"").include?(": ") }warn"Failed to load #{filename} because it doesn't contain valid YAML hash"return {}elsereturnconfigendrescue*yaml_errors=>ewarn"Failed to load #{filename}, #{e}"rescueErrno::EACCESwarn"Failed to load #{filename} due to permissions problem."end  {}end

really_verbose()

Source

# File lib/rubygems/config_file.rb, line 467defreally_verbosecaseverbosewhentrue,false,nilthenfalseelsetrueendend

Really verbose mode gives you extra output.

rubygems_api_key()

Source

# File lib/rubygems/config_file.rb, line 321defrubygems_api_keyload_api_keysunless@rubygems_api_key@rubygems_api_keyend

Returns the RubyGems.org API key

rubygems_api_key=(api_key)

Source

# File lib/rubygems/config_file.rb, line 330defrubygems_api_key=(api_key)set_api_key:rubygems_api_key,api_key@rubygems_api_key =api_keyend

Sets the RubyGems.org API key toapi_key

set_api_key(host, api_key)

Source

# File lib/rubygems/config_file.rb, line 339defset_api_key(host,api_key)check_credentials_permissionsconfig =load_file(credentials_path).merge(host=>api_key)dirname =File.dirnamecredentials_pathrequire"fileutils"FileUtils.mkdir_p(dirname)permissions =0o600& (~File.umask)File.open(credentials_path,"w",permissions)do|f|f.writeself.class.dump_with_rubygems_yaml(config)endload_api_keys# reloadend

Set a specific host’s API key toapi_key

state_file_name()

Source

# File lib/rubygems/config_file.rb, line 412defstate_file_nameGem.state_fileend

The name of the state file.

state_file_writable?()

Source

# File lib/rubygems/config_file.rb, line 393defstate_file_writable?ifFile.exist?(state_file_name)File.writable?(state_file_name)elserequire"fileutils"FileUtils.mkdir_pFile.dirname(state_file_name)File.open(state_file_name,"w") {}trueendrescueErrno::EACCESfalseend

Check state file is writable. Creates empty file if not present to ensure we can write to it.

unset_api_key!()

Source

# File lib/rubygems/config_file.rb, line 359defunset_api_key!returnfalseunlessFile.exist?(credentials_path)File.delete(credentials_path)end

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

write()

Source

# File lib/rubygems/config_file.rb, line 514defwriterequire"fileutils"FileUtils.mkdir_pFile.dirname(config_file_name)File.openconfig_file_name,"w"do|io|io.writeto_yamlendend

Writes out this config file, replacing its source.

Private Instance Methods

set_config_file_name(args)

Source

# File lib/rubygems/config_file.rb, line 603defset_config_file_name(args)@config_file_name =ENV["GEMRC"]need_config_file_name =falseargs.eachdo|arg|ifneed_config_file_name@config_file_name =argneed_config_file_name =falseelsifarg=~/^--config-file=(.*)/@config_file_name =$1elsif/^--config-file$/.match?(arg)need_config_file_name =trueendendend

Movatterモバイル変換

class Gem::ConfigFile

Experimental ==¶↑