Class: Gem::CommandManager

Inherits:
Object
  • Object
show all
Includes:
Text, UserInteraction
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 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.

Constant Summary collapse

BUILTIN_COMMANDS =

:nodoc:

[ # :nodoc:
  :build,
  :cert,
  :check,
  :cleanup,
  :contents,
  :dependency,
  :environment,
  :fetch,
  :generate_index,
  :help,
  :info,
  :install,
  :list,
  :lock,
  :mirror,
  :open,
  :outdated,
  :owner,
  :pristine,
  :push,
  :query,
  :rdoc,
  :search,
  :server,
  :signin,
  :signout,
  :sources,
  :specification,
  :stale,
  :uninstall,
  :unpack,
  :update,
  :which,
  :yank,
].freeze
ALIAS_COMMANDS = 
{
  'i' => 'install'
}.freeze

Class Method Summary collapse

Instance Method Summary collapse

Methods included from UserInteraction

#alert, #alert_error, #alert_warning, #ask, #ask_for_password, #ask_yes_no, #choose_from_list, #say, #terminate_interaction, #verbose

Methods included from DefaultUserInteraction

ui, #ui, ui=, #ui=, use_ui, #use_ui

Methods included from Text

#clean_text, #format_text, #levenshtein_distance, #min3, #truncate_text

Constructor Details

#initialize ⇒ CommandManager

Register all the subcommands supported by the gem command.



105
106
107
108
109
110
111
112
 
# File 'lib/rubygems/command_manager.rb', line 105

def initialize
  require 'timeout'
  @commands = {}

  BUILTIN_COMMANDS.each do |name|
    register_command name
  end
end

Class Method Details

.instance ⇒ Object

Return the authoritative instance of the command manager.



83
84
85
 
# File 'lib/rubygems/command_manager.rb', line 83

def self.instance
  @command_manager ||= new
end

.reset ⇒ Object

Reset the authoritative instance of the command manager.



98
99
100
 
# File 'lib/rubygems/command_manager.rb', line 98

def self.reset
  @command_manager = nil
end

Instance Method Details

#[](command_name) ⇒ Object

Returns a Command instance for command_name



131
132
133
134
135
 
# File 'lib/rubygems/command_manager.rb', line 131

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 ⇒ Object

Return a sorted list of all command names as strings.



140
141
142
 
# File 'lib/rubygems/command_manager.rb', line 140

def command_names
  @commands.keys.collect {|key| key.to_s}.sort
end

#find_alias_command(cmd_name) ⇒ Object 



197
198
199
200
 
# File 'lib/rubygems/command_manager.rb', line 197

def find_alias_command(cmd_name)
  alias_name = ALIAS_COMMANDS[cmd_name]
  alias_name ? alias_name : cmd_name
end

#find_command(cmd_name) ⇒ Object 



182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/rubygems/command_manager.rb', line 182

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::CommandLineError, "Unknown command #{cmd_name}"
  end

  self[possibilities.first]
end

#find_command_possibilities(cmd_name) ⇒ Object 



202
203
204
205
206
207
208
209
210
 
# File 'lib/rubygems/command_manager.rb', line 202

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 ⇒ Object

Returns self. Allows a CommandManager instance to stand in for the class itself.



91
92
93
 
# File 'lib/rubygems/command_manager.rb', line 91

def instance
  self
end

#process_args(args, build_args = nil) ⇒ Object 



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/rubygems/command_manager.rb', line 159

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 /^-/ then
    alert_error clean_text("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) ⇒ Object

Register the Symbol command as a gem command.



117
118
119
 
# File 'lib/rubygems/command_manager.rb', line 117

def register_command(command, obj=false)
  @commands[command] = obj
end

#run(args, build_args = nil) ⇒ Object

Run the command specified by args.



147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/rubygems/command_manager.rb', line 147

def run(args, build_args=nil)
  process_args(args, build_args)
rescue StandardError, Timeout::Error => ex
  alert_error clean_text("While executing gem ... (#{ex.class})\n    #{ex}")
  ui.backtrace ex

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

#unregister_command(command) ⇒ Object

Unregister the Symbol command as a gem command.



124
125
126
 
# File 'lib/rubygems/command_manager.rb', line 124

def unregister_command(command)
  @commands.delete command
end