Class: Gem::ConfigFile
Relationships & Source Files | |
Super Chains via Extension / Inclusion / Inheritance | |
Instance Chain:
|
|
Inherits: | Object |
Defined in: | lib/rubygems/config_file.rb |
Overview
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 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)
Constant Summary
-
DEFAULT_BACKTRACE =
# File 'lib/rubygems/config_file.rb', line 42false
-
DEFAULT_BULK_THRESHOLD =
# File 'lib/rubygems/config_file.rb', line 431000
-
DEFAULT_UPDATE_SOURCES =
# File 'lib/rubygems/config_file.rb', line 45true
-
DEFAULT_VERBOSITY =
# File 'lib/rubygems/config_file.rb', line 44true
-
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 =
# File 'lib/rubygems/config_file.rb', line 90File.join SYSTEM_CONFIG_PATH, 'gemrc'
Class Method Summary
-
.new(args) ⇒ ConfigFile
constructor
Create the config file object.
Instance Attribute Summary
-
#backtrace
rw
True if the backtrace option has been specified, or debug is on.
-
#backtrace=(value)
rw
True if we print backtraces on errors.
-
#bulk_threshold
rw
Bulk threshold value.
-
#disable_default_gem_server
rw
True if we want to force specification of gem server when pushing a gem.
-
#home
rw
Where to install gems (deprecated).
-
#path
rw
Where to look for gems (deprecated).
-
#rubygems_api_key
rw
Returns the
RubyGems.org
API key. -
#rubygems_api_key=(api_key)
rw
Sets the
RubyGems.org
API key toapi_key
-
#ssl_ca_cert
rw
Path name of directory or file of openssl CA certificate, 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. -
#args
readonly
List of arguments supplied to the config file object.
-
#ssl_client_cert
readonly
Path name of directory or file of openssl client certificate, used for remote https connection with client authentication.
-
#ssl_verify_mode
readonly
openssl verify mode value, used for remote https connection.
- #hash readonly protected
DefaultUserInteraction - Included
Instance Method Summary
-
#[](key)
Return the configuration information for
key
. -
#[]=(key, value)
Set configuration option
key
tovalue
. -
#api_keys
Hash of
RubyGems.org
and alternate API keys. -
#check_credentials_permissions
Checks the permissions of the credentials file.
-
#config_file_name
The name of the configuration file.
-
#credentials_path
Location of
RubyGems.org
credentials. -
#each {|:update_sources, @update_sources| ... }
Delegates to @hash.
-
#handle_arguments(arg_list)
Handle the command arguments.
- #load_api_keys
- #load_file(filename)
-
#really_verbose
Really verbose mode gives you extra output.
-
#write
Writes out this config file, replacing its source.
UserInteraction - Included
#alert | Displays an alert |
#alert_error | Displays an error |
#alert_warning | Displays a warning |
#ask | Asks a |
#ask_for_password | Asks for a password with a |
#ask_yes_no | Asks a yes or no |
#choose_from_list | Asks the user to answer |
#say | Displays the given |
#terminate_interaction | Terminates the RubyGems process with the given |
#verbose | Calls |
DefaultUserInteraction - Included
Constructor Details
.new(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.
# File 'lib/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 = 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 = .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
Instance Attribute Details
#args (readonly)
List of arguments supplied to the config file object.
# File 'lib/rubygems/config_file.rb', line 95
attr_reader :args
#backtrace (rw)
True if the backtrace option has been specified, or debug is on.
# File 'lib/rubygems/config_file.rb', line 351
def backtrace @backtrace or $DEBUG end
#backtrace=(value) (rw)
True if we print backtraces on errors.
# File 'lib/rubygems/config_file.rb', line 110
attr_writer :backtrace
#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)
# File 'lib/rubygems/config_file.rb', line 116
attr_accessor :bulk_threshold
#disable_default_gem_server (rw)
True if we want to force specification of gem server when pushing a gem
# File 'lib/rubygems/config_file.rb', line 134
attr_accessor :disable_default_gem_server
#hash (readonly, protected)
[ GitHub ]# File 'lib/rubygems/config_file.rb', line 483
attr_reader :hash
#home (rw)
Where to install gems (deprecated)
# File 'lib/rubygems/config_file.rb', line 105
attr_accessor :home
#path (rw)
Where to look for gems (deprecated)
# File 'lib/rubygems/config_file.rb', line 100
attr_accessor :path
#rubygems_api_key (rw)
Returns the RubyGems.org
API key
# File 'lib/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) (rw)
Sets the RubyGems.org
API key to api_key
# File 'lib/rubygems/config_file.rb', line 308
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 = 0600 & (~File.umask) File.open(credentials_path, 'w', ) do |f| f.write config.to_yaml end @rubygems_api_key = api_key end
#ssl_ca_cert (rw)
Path name of directory or file of openssl CA certificate, used for remote https connection
# File 'lib/rubygems/config_file.rb', line 144
attr_accessor :ssl_ca_cert
#ssl_client_cert (readonly)
Path name of directory or file of openssl client certificate, used for remote https connection with client authentication
# File 'lib/rubygems/config_file.rb', line 149
attr_reader :ssl_client_cert
#ssl_verify_mode (readonly)
openssl verify mode value, used for remote https connection
# File 'lib/rubygems/config_file.rb', line 138
attr_reader :ssl_verify_mode
#update_sources (rw)
True if we want to update the SourceInfoCache every time, false otherwise
# File 'lib/rubygems/config_file.rb', line 129
attr_accessor :update_sources
#verbose (rw)
Verbose level of output:
-
false – No output
-
true – Normal output
-
:loud
– Extra output
# File 'lib/rubygems/config_file.rb', line 124
attr_accessor :verbose
Instance Method Details
#[](key)
Return the configuration information for key
.
# File 'lib/rubygems/config_file.rb', line 465
def [](key) @hash[key.to_s] end
#[]=(key, value)
Set configuration option key
to value
.
# File 'lib/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 'lib/rubygems/config_file.rb', line 234
def api_keys load_api_keys unless @api_keys @api_keys 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 'lib/rubygems/config_file.rb', line 244
def return if Gem.win_platform? # windows doesn't write 0600 as 0600 return unless File.exist? credentials_path = File.stat(credentials_path).mode & 0777 return if == 0600 alert_error <<-ERROR Your gem push credentials file located at: \t#{credentials_path} has file permissions of 0#{ .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 'lib/rubygems/config_file.rb', line 356
def config_file_name @config_file_name || Gem.config_file end
#credentials_path
Location of RubyGems.org
credentials
#each {|:update_sources, @update_sources| ... }
Delegates to @hash
# File 'lib/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 'lib/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
[ GitHub ]# File 'lib/rubygems/config_file.rb', line 280
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)
[ GitHub ]# File 'lib/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 = 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_verbose
Really verbose mode gives you extra output.
# File 'lib/rubygems/config_file.rb', line 397
def really_verbose case verbose when true, false, nil then false else true end end
#write
Writes out this config file, replacing its source.
# File 'lib/rubygems/config_file.rb', line 458
def write open config_file_name, 'w' do |io| io.write to_yaml end end