The command manager registers and installs all the individual sub-commands supported by the gem command.
Extra commands can be provided by writing a rubygems_plugin.rb file in an installed gem. You should register your command against the Gem::CommandManager instance, like this:
# file rubygems_plugin.rb
require 'rubygems/command_manager'
class Gem::Commands::EditCommand < Gem::Command
# ...
end
Gem::CommandManager.instance.register_command :edit
See Gem::Command for instructions on writing gem commands.
Methods
- #
- C
- F
- I
- L
- N
- P
- R
- U
Included Modules
Class Public methods
instance()
Link
Return the authoritative instance of the command manager.
new()
Link
Register all the subcommands supported by the gem command.
# File ../ruby/lib/rubygems/command_manager.rb, line 50 def initialize require 'timeout' @commands = {} 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 :outdated register_command :owner register_command :pristine register_command :push register_command :query register_command :rdoc register_command :search register_command :server register_command :sources register_command :specification register_command :stale register_command :uninstall register_command :unpack register_command :update register_command :which end
reset()
Link
Reset the authoritative instance of the command manager.
Instance Public methods
[](command_name)
Link
Return the registered command from the command name.
command_names()
Link
Return a sorted list of all command names (as strings).
find_command(cmd_name)
Link
# File ../ruby/lib/rubygems/command_manager.rb, line 151 def find_command(cmd_name) possibilities = find_command_possibilities cmd_name if possibilities.size > 1 then raise "Ambiguous command #{cmd_name} matches [#{possibilities.join(', ')}]" elsif possibilities.size < 1 then raise "Unknown command #{cmd_name}" end self[possibilities.first] end
find_command_possibilities(cmd_name)
Link
process_args(args)
Link
# File ../ruby/lib/rubygems/command_manager.rb, line 128 def process_args(args) args = args.to_str.split(/\s+/) if args.respond_to?(:to_str) if args.size == 0 say Gem::Command::HELP terminate_interaction(1) end case args[0] when '-h', '--help' say Gem::Command::HELP terminate_interaction(0) when '-v', '--version' say Gem::VERSION terminate_interaction(0) when /^-/ alert_error "Invalid option: #{args[0]}. See 'gem --help'." terminate_interaction(1) else cmd_name = args.shift.downcase cmd = find_command(cmd_name) cmd.invoke(*args) end end
run(args)
Link
Run the config specified by args
.
# File ../ruby/lib/rubygems/command_manager.rb, line 116 def run(args) process_args(args) rescue StandardError, Timeout::Error => ex alert_error "While executing gem ... (#{ex.class})\n #{ex.to_s}" ui.errs.puts "\t#{ex.backtrace.join "\n\t"}" if Gem.configuration.backtrace terminate_interaction(1) rescue Interrupt alert_error "Interrupted" terminate_interaction(1) end
Instance Private methods
load_and_instantiate(command_name)
Link
# File ../ruby/lib/rubygems/command_manager.rb, line 170 def load_and_instantiate(command_name) command_name = command_name.to_s const_name = command_name.capitalize.gsub(/_(.)/) { $1.upcase } << "Command" commands = Gem::Commands retried = false begin commands.const_get(const_name).new rescue NameError raise if retried retried = true begin require "rubygems/commands/#{command_name}_command" rescue Exception => e alert_error "Loading command: #{command_name} (#{e.class})\n #{e}" ui.errs.puts "\t#{e.backtrace.join "\n\t"}" if Gem.configuration.backtrace end retry end end