Class: Gem::CommandManager
Relationships & Source Files | |
Super Chains via Extension / Inclusion / Inheritance | |
Instance Chain:
|
|
Inherits: | Object |
Defined in: | lib/rubygems/command_manager.rb |
Overview
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 CommandManager
instance, like this:
# file rubygems_plugin.rb
require 'rubygems/command_manager'
Gem::CommandManager.instance.register_command :edit
You should put the implementation of your command in rubygems/commands.
# file rubygems/commands/edit_command.rb
class Gem::Commands::EditCommand < Gem::Command
# ...
end
See Command for instructions on writing gem commands.
Class Method Summary
-
.instance
Return the authoritative instance of the command manager.
-
.new ⇒ CommandManager
constructor
Register all the subcommands supported by the gem command.
-
.reset
Reset the authoritative instance of the command manager.
Instance Attribute Summary
DefaultUserInteraction - Included
Instance Method Summary
-
#[](command_name)
Returns a Command instance for
command_name
-
#command_names
Return a sorted list of all command names as strings.
- #find_command(cmd_name)
- #find_command_possibilities(cmd_name)
-
#instance
Returns self.
- #process_args(args, build_args = nil)
-
#register_command(command, obj = false)
Register the Symbol
command
as a gem command. -
#run(args, build_args = nil)
Run the command specified by
args
. -
#unregister_command(command)
Unregister the Symbol
command
as a gem command. - #load_and_instantiate(command_name) private
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 ⇒ CommandManager
Register all the subcommands supported by the gem command.
# File 'lib/rubygems/command_manager.rb', line 96
def initialize require 'timeout' @commands = {} BUILTIN_COMMANDS.each do |name| register_command name end end
Class Method Details
.instance
Return the authoritative instance of the command manager.
# File 'lib/rubygems/command_manager.rb', line 74
def self.instance @command_manager ||= new end
.reset
Reset the authoritative instance of the command manager.
# File 'lib/rubygems/command_manager.rb', line 89
def self.reset @command_manager = nil end
Instance Method Details
#[](command_name)
Returns a Command instance for command_name
# File 'lib/rubygems/command_manager.rb', line 122
def [](command_name) command_name = command_name.intern return nil if @commands[command_name].nil? @commands[command_name] ||= load_and_instantiate(command_name) end
#command_names
Return a sorted list of all command names as strings.
# File 'lib/rubygems/command_manager.rb', line 131
def command_names @commands.keys.collect {|key| key.to_s}.sort end
#find_command(cmd_name)
[ GitHub ]# File 'lib/rubygems/command_manager.rb', line 173
def find_command(cmd_name) possibilities = find_command_possibilities cmd_name if possibilities.size > 1 then raise Gem::CommandLineError, "Ambiguous command #{cmd_name} matches [#{possibilities.join(', ')}]" elsif possibilities.empty? then raise Gem::CommandLineError, "Unknown command #{cmd_name}" end self[possibilities.first] end
#find_command_possibilities(cmd_name)
[ GitHub ]# File 'lib/rubygems/command_manager.rb', line 186
def find_command_possibilities(cmd_name) len = cmd_name.length found = command_names.select { |name| cmd_name == name[0, len] } exact = found.find { |name| name == cmd_name } exact ? [exact] : found end
#instance
Returns self. Allows a CommandManager
instance to stand in for the class itself.
# File 'lib/rubygems/command_manager.rb', line 82
def instance self end
#load_and_instantiate(command_name) (private)
[ GitHub ]# File 'lib/rubygems/command_manager.rb', line 198
def load_and_instantiate(command_name) command_name = command_name.to_s const_name = command_name.capitalize.gsub(/_(.)/) { $1.upcase } << "Command" load_error = nil begin begin require "rubygems/commands/#{command_name}_command" rescue LoadError => e load_error = e end Gem::Commands.const_get(const_name).new rescue Exception => e e = load_error if load_error alert_error "Loading command: #{command_name} (#{e.class})\n\t#{e}" ui.backtrace e end end
#process_args(args, build_args = nil)
[ GitHub ]# File 'lib/rubygems/command_manager.rb', line 150
def process_args(args, build_args=nil) if args.empty? then say Gem::Command::HELP terminate_interaction 1 end case args.first when '-h', '--help' then say Gem::Command::HELP terminate_interaction 0 when '-v', '--version' then say Gem::VERSION terminate_interaction 0 when /^-/ then alert_error "Invalid option: #{args.first}. See 'gem --help'." terminate_interaction 1 else cmd_name = args.shift.downcase cmd = find_command cmd_name cmd.invoke_with_build_args args, build_args end end
#register_command(command, obj = false)
Register the Symbol command
as a gem command.
# File 'lib/rubygems/command_manager.rb', line 108
def register_command(command, obj=false) @commands[command] = obj end
#run(args, build_args = nil)
Run the command specified by args
.
# File 'lib/rubygems/command_manager.rb', line 138
def run(args, build_args=nil) process_args(args, build_args) rescue StandardError, Timeout::Error => ex alert_error "While executing gem ... (#{ex.class})\n #{ex}" ui.backtrace ex terminate_interaction(1) rescue Interrupt alert_error "Interrupted" terminate_interaction(1) end
#unregister_command(command)
Unregister the Symbol command
as a gem command.
# File 'lib/rubygems/command_manager.rb', line 115
def unregister_command(command) @commands.delete command end