rubygems-update 0.9.4 → 0.9.5

data/lib/rubygems/builder.rb

@@ -4,11 +4,6 @@
 # See LICENSE.txt for permissions.
 #++
 
-require "rubygems/package"
-require "rubygems/security"
-require "yaml"
-require 'rubygems/gem_openssl'
-
 module Gem
 
   ##
@@ -24,11 +19,16 @@ module Gem
     # spec:: [Gem::Specification] The specification instance
     #
     def initialize(spec)
+      require "yaml"
+      require "rubygems/package"
+      require "rubygems/security"
+
       @spec = spec
     end
-    
+
     ##
-    # Builds the gem from the specification.  Returns the name of the file written.
+    # Builds the gem from the specification.  Returns the name of the file
+    # written.
     #
     def build
       @spec.mark_version
@@ -47,13 +47,14 @@ module Gem
   File: #{@spec.full_name+'.gem'}
 EOM
     end
-    
+
     private
+
     def sign
       # if the signing key was specified, then load the file, and swap
       # to the public key (TODO: we should probably just omit the
       # signing key in favor of the signing certificate, but that's for
-      # the future, also the signature algorihtm should be configurable)
+      # the future, also the signature algorithm should be configurable)
       signer = nil
       if @spec.respond_to?(:signing_key) && @spec.signing_key
         signer = Gem::Security::Signer.new(@spec.signing_key, @spec.cert_chain)
@@ -62,7 +63,7 @@ EOM
       end
       signer
     end
-    
+
     def write_package
       Package.open(@spec.file_name, "w", @signer) do |pkg|
         pkg.metadata = @spec.to_yaml
@@ -77,3 +78,4 @@ EOM
     end
   end
 end
+

data/lib/rubygems/command.rb

@@ -4,40 +4,96 @@
 # See LICENSE.txt for permissions.
 #++
 
+require 'optparse'
+
 require 'rubygems/user_interaction'
 
 module Gem
 
-  ####################################################################
-  # Base class for all Gem commands.
+  # Base class for all Gem commands.  When creating a new gem command, define
+  # #arguments, #defaults_str, #description and #usage (as appropriate).
   class Command
+
     include UserInteraction
-    
-    Option = Struct.new(:short, :long, :description, :handler)
-    
-    attr_reader :command, :options
-    attr_accessor :summary, :defaults, :program_name
-    
-    # Initialize a generic gem command.
+
+    # The name of the command.
+    attr_reader :command
+
+    # The options for the command.
+    attr_reader :options
+
+    # The default options for the command.
+    attr_accessor :defaults
+
+    # The name of the command for command-line invocation.
+    attr_accessor :program_name
+
+    # A short description of the command.
+    attr_accessor :summary
+
+    # Initializes a generic gem command named +command+.  +summary+ is a short
+    # description displayed in `gem help commands`.  +defaults+ are the
+    # default options.  Defaults should be mirrored in #defaults_str, unless
+    # there are none.
+    #
+    # Use add_option to add command-line switches.
     def initialize(command, summary=nil, defaults={})
       @command = command
       @summary = summary
       @program_name = "gem #{command}"
       @defaults = defaults
       @options = defaults.dup
-      @option_list = []
+      @option_groups = Hash.new { |h,k| h[k] = [] }
       @parser = nil
       @when_invoked = nil
     end
-    
+
+    # True if +long+ begins with the characters from +short+.
+    def begins?(long, short)
+      return false if short.nil?
+      long[0, short.length] == short
+    end
+
     # Override to provide command handling.
     def execute
       fail "Generic command has no actions"
     end
 
-    # Override to display the usage for an individual gem command.
-    def usage
-      program_name
+    # Get all gem names from the command line.
+    def get_all_gem_names
+      args = options[:args]
+
+      if args.nil? or args.empty? then
+        raise Gem::CommandLineError,
+              "Please specify at least one gem name (e.g. gem build GEMNAME)"
+      end
+
+      gem_names = args.select { |arg| arg !~ /^-/ }
+    end
+
+    # Get the single gem name from the command line.  Fail if there is no gem
+    # name or if there is more than one gem name given.
+    def get_one_gem_name
+      args = options[:args]
+
+      if args.nil? or args.empty? then
+        raise Gem::CommandLineError,
+             "Please specify a gem name on the command line (e.g. gem build GEMNAME)"
+      end
+
+      if args.size > 1 then
+        raise Gem::CommandLineError,
+              "Too many gem names (#{args.join(', ')}); please specify only one"
+      end
+
+      args.first
+    end
+
+    # Get a single optional argument from the command line.  If more than one
+    # argument is given, return only the first. Return nil if none are given.
+    def get_one_optional_argument
+      args = options[:args] || []
+      args.first
     end
 
     # Override to provide details of the arguments a command takes.
@@ -53,7 +109,17 @@ module Gem
       ""
     end
 
-    # Display the help message for this command.
+    # Override to display a longer description of what this command does.
+    def description
+      nil
+    end
+
+    # Override to display the usage for an individual gem command.
+    def usage
+      program_name
+    end
+
+    # Display the help message for the command.
     def show_help
       parser.program_name = usage
       say parser
@@ -81,14 +147,23 @@ module Gem
       @when_invoked = block
     end
     
-    # Add a option (and a handler) to this command.
-    def add_option(*args, &handler)
-      @option_list << [args, handler]
+    # Add a command-line option and handler to the command.
+    #
+    # See OptionParser#make_switch for an explanation of +opts+.
+    #
+    # +handler+ will be called with two values, the value of the argument and
+    # the options hash.
+    def add_option(*opts, &handler) # :yields: value, options
+      group_name = Symbol === opts.first ? opts.shift : :options
+
+      @option_groups[group_name] << [opts, handler]
     end
 
-    # Remove a previously defined command option.
+    # Remove previously defined command-line argument +name+.
     def remove_option(name)
-      @option_list.reject! { |args, handler| args.any? { |x| x =~ /^#{name}/ } }
+      @option_groups.each do |_, option_list|
+        option_list.reject! { |args, _| args.any? { |x| x =~ /^#{name}/ } }
+      end
     end
     
     # Merge a set of command options with the set of default options
@@ -108,13 +183,6 @@ module Gem
       end
     end
 
-    private 
-
-    # Return the command manager instance.
-    def command_manager
-      Gem::CommandManager.instance
-    end
-
     # Handle the given list of arguments by parsing them and recording
     # the results.
     def handle_options(args)
@@ -138,7 +206,9 @@ module Gem
       result.concat(args)
       result
     end
-    
+
+    private
+
     # Create on demand parser.
     def parser
       create_option_parser if @parser.nil?
@@ -146,17 +216,19 @@ module Gem
     end
 
     def create_option_parser
-      require 'optparse'
       @parser = OptionParser.new
-      option_names = {}
+
       @parser.separator("")
-      unless @option_list.empty?
-        @parser.separator("  Options:")
-        configure_options(@option_list, option_names)
-        @parser.separator("")
+      regular_options = @option_groups.delete :options
+
+      configure_options "", regular_options
+
+      @option_groups.sort_by { |n,_| n.to_s }.each do |group_name, option_list|
+        configure_options group_name, option_list
       end
-      @parser.separator("  Common Options:")
-      configure_options(Command.common_options, option_names)
+
+      configure_options "Common", Command.common_options
+
       @parser.separator("")
       unless arguments.empty?
         @parser.separator("  Arguments:")
@@ -165,10 +237,24 @@ module Gem
         end
         @parser.separator("")
       end
+
       @parser.separator("  Summary:")
-      wrap(@summary, 80 - 4).each do |line|
+      wrap(@summary, 80 - 4).split("\n").each do |line|
         @parser.separator("    #{line.strip}")
       end
+
+      if description then
+        formatted = description.split("\n\n").map do |chunk|
+          wrap(chunk, 80 - 4)
+        end.join("\n")
+
+        @parser.separator ""
+        @parser.separator "  Description:"
+        formatted.split("\n").each do |line|
+          @parser.separator "    #{line.rstrip}"
+        end
+      end
+
       unless defaults_str.empty?
         @parser.separator("")
         @parser.separator("  Defaults:")
@@ -178,15 +264,20 @@ module Gem
       end
     end
 
-    def configure_options(option_list, option_names)
+    def configure_options(header, option_list)
+      return if option_list.nil? or option_list.empty?
+
+      header = header.to_s.empty? ? '' : "#{header} "
+      @parser.separator "  #{header}Options:"
+
       option_list.each do |args, handler|
         dashes = args.select { |arg| arg =~ /^-/ }
-        next if dashes.any? { |arg| option_names[arg] }
         @parser.on(*args) do |value|
           handler.call(value, @options)
         end
-        dashes.each do |arg| option_names[arg] = true end
       end
+
+      @parser.separator ''
     end
 
     # Wraps +text+ to +width+
@@ -242,21 +333,6 @@ module Gem
 
     # ----------------------------------------------------------------
     # Add the options common to all commands.
-    
-    add_common_option('--source URL', 
-      'Use URL as the remote source for gems') do
-      |value, options|
-      gem("sources")
-      Gem.sources.clear
-      Gem.sources << value
-    end
-
-    add_common_option('-p', '--[no-]http-proxy [URL]',
-      'Use HTTP proxy for remote operations') do 
-      |value, options|
-      options[:http_proxy] = (value == false) ? :no_proxy : value
-      Gem.configuration[:http_proxy] = options[:http_proxy]
-    end
 
     add_common_option('-h', '--help', 
       'Get help on this command') do
@@ -264,10 +340,18 @@ module Gem
       options[:help] = true
     end
 
-    add_common_option('-v', '--verbose', 
-      'Set the verbose level of output') do
-      |value, options|
-      Gem.configuration.verbose = value
+    add_common_option('-V', '--[no-]verbose',
+                      'Set the verbose level of output') do |value, options|
+      # Set us to "really verbose" so the progess meter works
+      if Gem.configuration.verbose and value then
+        Gem.configuration.verbose = 1
+      else
+        Gem.configuration.verbose = value
+      end
+    end
+
+    add_common_option('-q', '--quiet', 'Silence commands') do |value, options|
+      Gem.configuration.verbose = false
     end
 
     # Backtrace and config-file are added so they show up in the help
@@ -285,5 +369,38 @@ module Gem
     add_common_option('--debug',
       'Turn on Ruby debugging') do
     end
+
+    # :stopdoc:
+    HELP = %{
+      RubyGems is a sophisticated package manager for Ruby.  This is a
+      basic help message containing pointers to more information.
+
+        Usage:
+          gem -h/--help
+          gem -v/--version
+          gem command [arguments...] [options...]
+
+        Examples:
+          gem install rake
+          gem list --local
+          gem build package.gemspec
+          gem help install
+
+        Further help:
+          gem help commands            list all 'gem' commands
+          gem help examples            show some examples of usage
+          gem help platforms           show information about platforms
+          gem help <COMMAND>           show help on COMMAND
+                                         (e.g. 'gem help install')
+        Further information:
+          http://rubygems.rubyforge.org
+    }.gsub(/^    /, "")
+
+    # :startdoc:
+
   end # class
-end # module
+
+  # This is where Commands will be placed in the namespace
+  module Commands; end
+
+end

data/lib/rubygems/command_manager.rb

@@ -4,43 +4,17 @@
 # See LICENSE.txt for permissions.
 #++
 
-require 'rubygems'
+require 'timeout'
 require 'rubygems/command'
 require 'rubygems/user_interaction'
-require 'rubygems/gem_commands'
-require 'timeout'
 
 module Gem
 
-  ###################################################################
-  # Signals that local installation will not proceed, not that it has
-  # been tried and failed.  TODO: better name.
-  class LocalInstallationError < Gem::Exception; end
-  
-  ####################################################################
-  # Signals that a file permission error is preventing the user from
-  # installing in the requested directories.
-  class FilePermissionError < Gem::Exception
-    def initialize(path)
-      super("You don't have write permissions into the #{path} directory.")
-    end
-  end
-
-  ####################################################################
-  # Signals that a remote operation cannot be conducted, probably due
-  # to not being connected (or just not finding host).
-  #
-  # TODO: create a method that tests connection to the preferred gems
-  # server.  All code dealing with remote operations will want this.
-  # Failure in that method should raise this error.
-  class RemoteError < Gem::Exception; end
-
   ####################################################################
   # The command manager registers and installs all the individual
   # sub-commands supported by the gem command.
   class CommandManager
     include UserInteraction
-    include Commands
     
     # Return the authoratative instance of the command manager.
     def self.instance
@@ -53,33 +27,41 @@ module Gem
       register_command :build
       register_command :cert
       register_command :check
+      register_command :cleanup
       register_command :contents
       register_command :dependency
       register_command :environment
+      register_command :fetch
+      register_command :generate_index
       register_command :help
       register_command :install
+      register_command :list
+      register_command :lock
+      register_command :mirror
       register_command :outdated
       register_command :pristine
       register_command :query
-      register_command :list
       register_command :rdoc
       register_command :search
+      register_command :server
       register_command :sources
       register_command :specification
       register_command :uninstall
       register_command :unpack
-      register_command :cleanup
       register_command :update
+      register_command :which
     end
     
     # Register the command object.
     def register_command(command_obj)
-      @commands[command_obj] = load_and_instantiate(command_obj)
+      @commands[command_obj] = false
     end
     
     # Return the registered command from the command name.
     def [](command_name)
-      @commands[command_name.intern]
+      command_name = command_name.intern
+      return nil if @commands[command_name].nil?
+      @commands[command_name] ||= load_and_instantiate(command_name)
     end
     
     # Return a list of all command names (as strings).
@@ -92,7 +74,8 @@ module Gem
       process_args(args)
     rescue StandardError, Timeout::Error => ex
       alert_error "While executing gem ... (#{ex.class})\n    #{ex.to_s}"
-      puts ex.backtrace if Gem.configuration.backtrace
+      ui.errs.puts "\t#{ex.backtrace.join "\n\t"}" if
+        Gem.configuration.backtrace
       terminate_interaction(1)
     rescue Interrupt
       alert_error "Interrupted"
@@ -102,12 +85,12 @@ module Gem
     def process_args(args)
       args = args.to_str.split(/\s+/) if args.respond_to?(:to_str)
       if args.size == 0
-        say Gem::HELP
+        say Gem::Command::HELP
         terminate_interaction(1)
       end 
       case args[0]
       when '-h', '--help'
-        say Gem::HELP
+        say Gem::Command::HELP
         terminate_interaction(0)
       when '-v', '--version'
         say Gem::RubyGemsPackageVersion
@@ -130,6 +113,7 @@ module Gem
       if possibilities.size < 1
         raise "Unknown command #{cmd_name}"
       end
+
       self[possibilities.first]
     end
 
@@ -141,11 +125,19 @@ module Gem
     private
     def load_and_instantiate(command_name)
       command_name = command_name.to_s
+      retried = false
+
       begin
-        Gem::Commands.const_get("#{command_name.capitalize}Command").new
-      rescue
-        require "rubygems/commands/#{command_name}_command"
-        retry
+        const_name = command_name.capitalize.gsub(/_(.)/) { $1.upcase }
+        Gem::Commands.const_get("#{const_name}Command").new
+      rescue NameError
+        if retried then
+          raise
+        else
+          retried = true
+          require "rubygems/commands/#{command_name}_command"
+          retry
+        end
       end
     end
   end