Class: Gem::ConfigFile
- Inherits:
-
Object
- Object
- Gem::ConfigFile
- Includes:
- UserInteraction
- Defined in:
- lib/rubygems/config_file.rb
Overview
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)
Constant Summary collapse
- DEFAULT_BACKTRACE =
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
Gem.platform_defaults
- SYSTEM_CONFIG_PATH =
:stopdoc:
begin require "etc" Etc.sysconfdir rescue LoadError, NoMethodError begin # TODO: remove after we drop 1.8.7 and 1.9.1 require 'Win32API' CSIDL_COMMON_APPDATA = 0x0023 path = 0.chr * 260 if RUBY_VERSION > '1.9' then SHGetFolderPath = Win32API.new 'shell32', 'SHGetFolderPath', 'PLPLP', 'L', :stdcall SHGetFolderPath.call nil, CSIDL_COMMON_APPDATA, nil, 1, path else SHGetFolderPath = Win32API.new 'shell32', 'SHGetFolderPath', 'LLLLP', 'L' SHGetFolderPath.call 0, CSIDL_COMMON_APPDATA, 0, 1, path end path.strip rescue LoadError RbConfig::CONFIG["sysconfdir"] || "/etc" end end
- SYSTEM_WIDE_CONFIG_FILE =
:startdoc:
File.join SYSTEM_CONFIG_PATH, 'gemrc'
Instance Attribute Summary collapse
-
#args ⇒ Object
readonly
List of arguments supplied to the config file object.
-
#backtrace ⇒ Object
True if the backtrace option has been specified, or debug is on.
-
#bulk_threshold ⇒ Object
Bulk threshold value.
-
#disable_default_gem_server ⇒ Object
True if we want to force specification of gem server when pushing a gem.
-
#home ⇒ Object
Where to install gems (deprecated).
-
#path ⇒ Object
Where to look for gems (deprecated).
-
#sources ⇒ Object
sources to look for gems.
-
#ssl_ca_cert ⇒ Object
Path name of directory or file of openssl CA certificate, used for remote https connection.
-
#ssl_client_cert ⇒ Object
readonly
Path name of directory or file of openssl client certificate, used for remote https connection with client authentication.
-
#ssl_verify_mode ⇒ Object
readonly
openssl verify mode value, used for remote https connection.
-
#update_sources ⇒ Object
True if we want to update the SourceInfoCache every time, false otherwise.
-
#verbose ⇒ Object
Verbose level of output: * false – No output * true – Normal output * :loud – Extra output.
Instance Method Summary collapse
-
#==(other) ⇒ Object
:nodoc:.
-
#[](key) ⇒ Object
Return the configuration information for
key
. -
#[]=(key, value) ⇒ Object
Set configuration option
key
tovalue
. -
#api_keys ⇒ Object
Hash of RubyGems.org and alternate API keys.
-
#check_credentials_permissions ⇒ Object
Checks the permissions of the credentials file.
-
#config_file_name ⇒ Object
The name of the configuration file.
-
#credentials_path ⇒ Object
Location of RubyGems.org credentials.
-
#each {|:update_sources, @update_sources| ... } ⇒ Object
Delegates to @hash.
-
#handle_arguments(arg_list) ⇒ Object
Handle the command arguments.
-
#initialize(args) ⇒ ConfigFile
constructor
Create the config file object.
- #load_api_keys ⇒ Object
- #load_file(filename) ⇒ Object
-
#really_verbose ⇒ Object
Really verbose mode gives you extra output.
-
#rubygems_api_key ⇒ Object
Returns the RubyGems.org API key.
-
#rubygems_api_key=(api_key) ⇒ Object
Sets the RubyGems.org API key to
api_key
. -
#set_api_key(host, api_key) ⇒ Object
Set a specific host’s API key to
api_key
. -
#to_yaml ⇒ Object
to_yaml only overwrites things you can’t override on the command line.
-
#write ⇒ Object
Writes out this config file, replacing its source.
Methods included from UserInteraction
#alert, #alert_error, #alert_warning, #ask, #ask_for_password, #ask_yes_no, #choose_from_list, #say, #terminate_interaction
Methods included from DefaultUserInteraction
ui, #ui, ui=, #ui=, use_ui, #use_ui
Constructor Details
#initialize(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.
– TODO: parse options upstream, pass in options directly
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 |
# File 'lib/rubygems/config_file.rb', line 176 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 @sources = @hash[:sources] if @hash.key? :sources @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 handle_arguments arg_list end |
Instance Attribute Details
#args ⇒ Object (readonly)
List of arguments supplied to the config file object.
95 96 97 |
# File 'lib/rubygems/config_file.rb', line 95 def args @args end |
#backtrace ⇒ Object
True if the backtrace option has been specified, or debug is on.
364 365 366 |
# File 'lib/rubygems/config_file.rb', line 364 def backtrace @backtrace or $DEBUG end |
#bulk_threshold ⇒ Object
Bulk threshold value. If the number of missing gems are above this threshold value, then a bulk download technique is used. (deprecated)
116 117 118 |
# File 'lib/rubygems/config_file.rb', line 116 def bulk_threshold @bulk_threshold end |
#disable_default_gem_server ⇒ Object
True if we want to force specification of gem server when pushing a gem
134 135 136 |
# File 'lib/rubygems/config_file.rb', line 134 def disable_default_gem_server @disable_default_gem_server end |
#home ⇒ Object
Where to install gems (deprecated)
105 106 107 |
# File 'lib/rubygems/config_file.rb', line 105 def home @home end |
#path ⇒ Object
Where to look for gems (deprecated)
100 101 102 |
# File 'lib/rubygems/config_file.rb', line 100 def path @path end |
#sources ⇒ Object
sources to look for gems
148 149 150 |
# File 'lib/rubygems/config_file.rb', line 148 def sources @sources end |
#ssl_ca_cert ⇒ Object
Path name of directory or file of openssl CA certificate, used for remote https connection
144 145 146 |
# File 'lib/rubygems/config_file.rb', line 144 def ssl_ca_cert @ssl_ca_cert end |
#ssl_client_cert ⇒ Object (readonly)
Path name of directory or file of openssl client certificate, used for remote https connection with client authentication
153 154 155 |
# File 'lib/rubygems/config_file.rb', line 153 def ssl_client_cert @ssl_client_cert end |
#ssl_verify_mode ⇒ Object (readonly)
openssl verify mode value, used for remote https connection
138 139 140 |
# File 'lib/rubygems/config_file.rb', line 138 def ssl_verify_mode @ssl_verify_mode end |
#update_sources ⇒ Object
True if we want to update the SourceInfoCache every time, false otherwise
129 130 131 |
# File 'lib/rubygems/config_file.rb', line 129 def update_sources @update_sources end |
#verbose ⇒ Object
Verbose level of output:
-
false – No output
-
true – Normal output
-
:loud – Extra output
124 125 126 |
# File 'lib/rubygems/config_file.rb', line 124 def verbose @verbose end |
Instance Method Details
#==(other) ⇒ Object
:nodoc:
487 488 489 490 491 492 493 494 |
# File 'lib/rubygems/config_file.rb', line 487 def ==(other) # :nodoc: self.class === other and @backtrace == other.backtrace and @bulk_threshold == other.bulk_threshold and @verbose == other.verbose and @update_sources == other.update_sources and @hash == other.hash end |
#[](key) ⇒ Object
Return the configuration information for key
.
478 479 480 |
# File 'lib/rubygems/config_file.rb', line 478 def [](key) @hash[key.to_s] end |
#[]=(key, value) ⇒ Object
Set configuration option key
to value
.
483 484 485 |
# File 'lib/rubygems/config_file.rb', line 483 def []=(key, value) @hash[key.to_s] = value end |
#api_keys ⇒ Object
Hash of RubyGems.org and alternate API keys
238 239 240 241 242 |
# File 'lib/rubygems/config_file.rb', line 238 def api_keys load_api_keys unless @api_keys @api_keys end |
#check_credentials_permissions ⇒ Object
Checks the permissions of the credentials file. If they are not 0600 an error message is displayed and RubyGems aborts.
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 |
# File 'lib/rubygems/config_file.rb', line 248 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 ⇒ Object
The name of the configuration file.
369 370 371 |
# File 'lib/rubygems/config_file.rb', line 369 def config_file_name @config_file_name || Gem.config_file end |
#credentials_path ⇒ Object
Location of RubyGems.org credentials
280 281 282 |
# File 'lib/rubygems/config_file.rb', line 280 def credentials_path File.join Gem.user_home, '.gem', 'credentials' end |
#each {|:update_sources, @update_sources| ... } ⇒ Object
Delegates to @hash
374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 |
# File 'lib/rubygems/config_file.rb', line 374 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) ⇒ Object
Handle the command arguments.
392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 |
# File 'lib/rubygems/config_file.rb', line 392 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 ⇒ Object
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 |
# File 'lib/rubygems/config_file.rb', line 284 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) ⇒ Object
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 |
# File 'lib/rubygems/config_file.rb', line 339 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 ⇒ Object
Really verbose mode gives you extra output.
410 411 412 413 414 415 416 417 |
# File 'lib/rubygems/config_file.rb', line 410 def really_verbose case verbose when true, false, nil then false else true end end |
#rubygems_api_key ⇒ Object
Returns the RubyGems.org API key
303 304 305 306 307 |
# File 'lib/rubygems/config_file.rb', line 303 def rubygems_api_key load_api_keys unless @rubygems_api_key @rubygems_api_key end |
#rubygems_api_key=(api_key) ⇒ Object
Sets the RubyGems.org API key to api_key
312 313 314 315 316 |
# File 'lib/rubygems/config_file.rb', line 312 def rubygems_api_key= api_key set_api_key :rubygems_api_key, api_key @rubygems_api_key = api_key end |
#set_api_key(host, api_key) ⇒ Object
Set a specific host’s API key to api_key
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 |
# File 'lib/rubygems/config_file.rb', line 321 def set_api_key host, api_key config = load_file(credentials_path).merge(host => 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 load_api_keys # reload end |
#to_yaml ⇒ Object
to_yaml only overwrites things you can’t override on the command line.
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 |
# File 'lib/rubygems/config_file.rb', line 420 def to_yaml # :nodoc: yaml_hash = {} yaml_hash[:backtrace] = if @hash.key?(:backtrace) @hash[:backtrace] else DEFAULT_BACKTRACE end yaml_hash[:bulk_threshold] = if @hash.key?(:bulk_threshold) @hash[:bulk_threshold] else DEFAULT_BULK_THRESHOLD end yaml_hash[:sources] = Gem.sources.to_a yaml_hash[:update_sources] = if @hash.key?(:update_sources) @hash[:update_sources] else DEFAULT_UPDATE_SOURCES end yaml_hash[:verbose] = if @hash.key?(:verbose) @hash[:verbose] else DEFAULT_VERBOSITY end yaml_hash[:ssl_verify_mode] = @hash[:ssl_verify_mode] if @hash.key? :ssl_verify_mode yaml_hash[:ssl_ca_cert] = @hash[:ssl_ca_cert] if @hash.key? :ssl_ca_cert yaml_hash[:ssl_client_cert] = @hash[:ssl_client_cert] if @hash.key? :ssl_client_cert keys = yaml_hash.keys.map { |key| key.to_s } keys << 'debug' re = Regexp.union(*keys) @hash.each do |key, value| key = key.to_s next if key =~ re yaml_hash[key.to_s] = value end yaml_hash.to_yaml end |
#write ⇒ Object
Writes out this config file, replacing its source.
471 472 473 474 475 |
# File 'lib/rubygems/config_file.rb', line 471 def write open config_file_name, 'w' do |io| io.write to_yaml end end |