Skip to Content Skip to Search

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'

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 Gem::Command for instructions on writing gem commands.

Methods
#
C
F
I
N
P
R
U
Included Modules

Constants

ALIAS_COMMANDS = { "i" => "install", "login" => "signin", "logout" => "signout", }.freeze
 

Class Public methods

instance()

Return the authoritative instance of the command manager.

Source: show | on GitHub 

# File ruby/lib/rubygems/command_manager.rb, line 87
def self.instance
  @instance ||= new
end

new()

Register all the subcommands supported by the gem command.

Source: show | on GitHub 

# File ruby/lib/rubygems/command_manager.rb, line 109
def initialize
  require_relative "vendored_timeout"
  @commands = {}

  BUILTIN_COMMANDS.each do |name|
    register_command name
  end
end

reset()

Reset the authoritative instance of the command manager.

Source: show | on GitHub 

# File ruby/lib/rubygems/command_manager.rb, line 102
def self.reset
  @instance = nil
end

Instance Public methods

[](command_name)

Returns a Command instance for command_name

Source: show | on GitHub 

# File ruby/lib/rubygems/command_manager.rb, line 135
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.

Source: show | on GitHub 

# File ruby/lib/rubygems/command_manager.rb, line 144
def command_names
  @commands.keys.collect(&:to_s).sort
end

find_alias_command(cmd_name)

Source: show | on GitHub 

# File ruby/lib/rubygems/command_manager.rb, line 213
def find_alias_command(cmd_name)
  alias_name = ALIAS_COMMANDS[cmd_name]
  alias_name ? alias_name : cmd_name
end

find_command(cmd_name)

Source: show | on GitHub 

# File ruby/lib/rubygems/command_manager.rb, line 198
def find_command(cmd_name)
  cmd_name = find_alias_command cmd_name

  possibilities = find_command_possibilities cmd_name

  if possibilities.size > 1
    raise Gem::CommandLineError,
          "Ambiguous command #{cmd_name} matches [#{possibilities.join(", ")}]"
  elsif possibilities.empty?
    raise Gem::UnknownCommandError.new(cmd_name)
  end

  self[possibilities.first]
end

find_command_possibilities(cmd_name)

Source: show | on GitHub 

# File ruby/lib/rubygems/command_manager.rb, line 218
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.

Source: show | on GitHub 

# File ruby/lib/rubygems/command_manager.rb, line 95
def instance
  self
end

process_args(args, build_args=nil)

Source: show | on GitHub 

# File ruby/lib/rubygems/command_manager.rb, line 168
def process_args(args, build_args=nil)
  if args.empty?
    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 "-C" then
    args.shift
    start_point = args.shift
    if Dir.exist?(start_point)
      Dir.chdir(start_point) { invoke_command(args, build_args) }
    else
      alert_error clean_text("#{start_point} isn't a directory.")
      terminate_interaction 1
    end
  when /^-/ then
    alert_error clean_text("Invalid option: #{args.first}. See 'gem --help'.")
    terminate_interaction 1
  else
    invoke_command(args, build_args)
  end
end

register_command(command, obj=false)

Register the Symbol command as a gem command.

Source: show | on GitHub 

# File ruby/lib/rubygems/command_manager.rb, line 121
def register_command(command, obj=false)
  @commands[command] = obj
end

run(args, build_args=nil)

Run the command specified by args.

Source: show | on GitHub 

# File ruby/lib/rubygems/command_manager.rb, line 151
def run(args, build_args=nil)
  process_args(args, build_args)
rescue StandardError, Gem::Timeout::Error => ex
  if ex.respond_to?(:detailed_message)
    msg = ex.detailed_message(highlight: false).sub(/\A(.*?)(?: \(.+?\))/) { $1 }
  else
    msg = ex.message
  end
  alert_error clean_text("While executing gem ... (#{ex.class})\n    #{msg}")
  ui.backtrace ex

  terminate_interaction(1)
rescue Interrupt
  alert_error clean_text("Interrupted")
  terminate_interaction(1)
end

unregister_command(command)

Unregister the Symbol command as a gem command.

Source: show | on GitHub 

# File ruby/lib/rubygems/command_manager.rb, line 128
def unregister_command(command)
  @commands.delete command
end