diff options
Diffstat (limited to 'lib/rubygems/config_file.rb')
| -rw-r--r-- | lib/rubygems/config_file.rb | 126 |
1 files changed, 100 insertions, 26 deletions
diff --git a/lib/rubygems/config_file.rb b/lib/rubygems/config_file.rb index 3562805c62..3498d06540 100644 --- a/lib/rubygems/config_file.rb +++ b/lib/rubygems/config_file.rb @@ -4,10 +4,26 @@ # See LICENSE.txt for permissions. #++ -require 'yaml' - -# Store the gem command options specified in the configuration file. The -# config file object acts much like a hash. +## +# 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 <tt>gem:</tt> to set default arguments for all commands. +# +# RubyGems options use symbol keys. Valid options are: +# +# +:backtrace+:: See #backtrace +# +:benchmark+:: See #benchmark +# +:sources+:: Sets Gem::sources +# +:verbose+:: See #verbose class Gem::ConfigFile @@ -46,49 +62,74 @@ class Gem::ConfigFile SYSTEM_WIDE_CONFIG_FILE = File.join system_config_path, 'gemrc' + ## # List of arguments supplied to the config file object. + attr_reader :args - # Where to look for gems + ## + # Where to look for gems (deprecated) + attr_accessor :path + ## + # Where to install gems (deprecated) + attr_accessor :home + ## # True if we print backtraces on errors. + attr_writer :backtrace + ## # True if we are benchmarking this run. + attr_accessor :benchmark - # Bulk threshold value. If the number of missing gems are above - # this threshold value, then a bulk download technique is used. + ## + # Bulk threshold value. If the number of missing gems are above this + # threshold value, then a bulk download technique is used. (deprecated) + attr_accessor :bulk_threshold + ## # Verbose level of output: # * false -- No output # * true -- Normal output # * :loud -- Extra output + attr_accessor :verbose + ## # True if we want to update the SourceInfoCache every time, false otherwise + attr_accessor :update_sources + ## + # API key for RubyGems.org + + attr_reader :rubygems_api_key + + ## # 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. + # <tt>--config-file</tt>, <tt>--config-file==NAME</tt>:: + # Obviously these need to be handled by the ConfigFile object to ensure we + # get the right config file. # - # * --debug -- Enable Ruby level debug messages. Handled early - # for the same reason as --backtrace. + # <tt>--backtrace</tt>:: + # Backtrace needs to be turned on early so that errors before normal + # option parsing can be properly handled. # + # <tt>--debug</tt>:: + # Enable Ruby level debug messages. Handled early for the same reason as + # --backtrace. + def initialize(arg_list) @config_file_name = nil need_config_file_name = false @@ -125,21 +166,53 @@ class Gem::ConfigFile @hash = @hash.merge user_config # HACK these override command-line args, which is bad - @backtrace = @hash[:backtrace] if @hash.key? :backtrace - @benchmark = @hash[:benchmark] if @hash.key? :benchmark - @bulk_threshold = @hash[:bulk_threshold] if @hash.key? :bulk_threshold - Gem.sources = @hash[:sources] if @hash.key? :sources - @verbose = @hash[:verbose] if @hash.key? :verbose - @update_sources = @hash[:update_sources] if @hash.key? :update_sources - @path = @hash[:gempath] if @hash.key? :gempath - @home = @hash[:gemhome] if @hash.key? :gemhome + @backtrace = @hash[:backtrace] if @hash.key? :backtrace + @benchmark = @hash[:benchmark] if @hash.key? :benchmark + @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 + + load_rubygems_api_key + Gem.sources = @hash[:sources] if @hash.key? :sources handle_arguments arg_list end + ## + # Location of RubyGems.org credentials + + def credentials_path + File.join(Gem.user_home, '.gem', 'credentials') + end + + def load_rubygems_api_key + api_key_hash = File.exists?(credentials_path) ? load_file(credentials_path) : @hash + + @rubygems_api_key = api_key_hash[:rubygems_api_key] if api_key_hash.key? :rubygems_api_key + end + + 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.exists?(dirname) + + require 'yaml' + + File.open(credentials_path, 'w') do |f| + f.write config.to_yaml + end + + @rubygems_api_key = api_key + end + def load_file(filename) + return {} unless filename and File.exists?(filename) begin - YAML.load(File.read(filename)) if filename and File.exist?(filename) + require 'yaml' + YAML.load(File.read(filename)) rescue ArgumentError warn "Failed to load #{config_file_name}" rescue Errno::EACCES @@ -233,8 +306,9 @@ class Gem::ConfigFile # Writes out this config file, replacing its source. def write - File.open config_file_name, 'w' do |fp| - fp.write self.to_yaml + require 'yaml' + open config_file_name, 'w' do |io| + io.write to_yaml end end |