Class: Gem::Command

Inherits:
Object
  • Object
show all
Includes:
UserInteraction
Defined in:
lib/rubygems/command.rb

Overview

Base class for all Gem commands. When creating a new gem command, define #initialize, #execute, #arguments, #defaults_str, #description and #usage (as appropriate). See the above mentioned methods for details.

A very good example to look at is Gem::Commands::ContentsCommand

Instance Attribute Summary collapse

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(command, summary = nil, defaults = {}) ⇒ Command

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.

When defining a new command subclass, use add_option to add command-line switches.

Unhandled arguments (gem names, files, etc.) are left in options[:args].


122
123
124
125
126
127
128
129
130
131
132
# File 'lib/rubygems/command.rb', line 122

def initialize(command, summary=nil, defaults={})
  @command = command
  @summary = summary
  @program_name = "gem #{command}"
  @defaults = defaults
  @options = defaults.dup
  @option_groups = Hash.new { |h,k| h[k] = [] }
  @deprecated_options = { command => {} }
  @parser = nil
  @when_invoked = nil
end

Instance Attribute Details

#commandObject (readonly)

The name of the command.


30
31
32
# File 'lib/rubygems/command.rb', line 30

def command
  @command
end

#defaultsObject

The default options for the command.


40
41
42
# File 'lib/rubygems/command.rb', line 40

def defaults
  @defaults
end

#optionsObject (readonly)

The options for the command.


35
36
37
# File 'lib/rubygems/command.rb', line 35

def options
  @options
end

#program_nameObject

The name of the command for command-line invocation.


45
46
47
# File 'lib/rubygems/command.rb', line 45

def program_name
  @program_name
end

#summaryObject

A short description of the command.


50
51
52
# File 'lib/rubygems/command.rb', line 50

def summary
  @summary
end

Class Method Details

.add_common_option(*args, &handler) ⇒ Object


67
68
69
# File 'lib/rubygems/command.rb', line 67

def self.add_common_option(*args, &handler)
  Gem::Command.common_options << [args, handler]
end

.add_specific_extra_args(cmd, args) ⇒ Object

Add a list of extra arguments for the given command. args may be an array or a string to be split on white space.


96
97
98
99
# File 'lib/rubygems/command.rb', line 96

def self.add_specific_extra_args(cmd,args)
  args = args.split(/\s+/) if args.kind_of? String
  specific_extra_args_hash[cmd] = args
end

.build_argsObject

Arguments used when building gems


55
56
57
# File 'lib/rubygems/command.rb', line 55

def self.build_args
  @build_args ||= []
end

.build_args=(value) ⇒ Object


59
60
61
# File 'lib/rubygems/command.rb', line 59

def self.build_args=(value)
  @build_args = value
end

.common_optionsObject


63
64
65
# File 'lib/rubygems/command.rb', line 63

def self.common_options
  @common_options ||= []
end

.extra_argsObject


71
72
73
# File 'lib/rubygems/command.rb', line 71

def self.extra_args
  @extra_args ||= []
end

.extra_args=(value) ⇒ Object


75
76
77
78
79
80
81
82
# File 'lib/rubygems/command.rb', line 75

def self.extra_args=(value)
  case value
  when Array
    @extra_args = value
  when String
    @extra_args = value.split
  end
end

.specific_extra_args(cmd) ⇒ Object

Return an array of extra arguments for the command. The extra arguments come from the gem configuration file read at program startup.


88
89
90
# File 'lib/rubygems/command.rb', line 88

def self.specific_extra_args(cmd)
  specific_extra_args_hash[cmd]
end

.specific_extra_args_hashObject

Accessor for the specific extra args hash (self initializing).


104
105
106
107
108
# File 'lib/rubygems/command.rb', line 104

def self.specific_extra_args_hash
  @specific_extra_args_hash ||= Hash.new do |h,k|
    h[k] = Array.new
  end
end

Instance Method Details

#add_extra_args(args) ⇒ Object

Adds extra args from ~/.gemrc


451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
# File 'lib/rubygems/command.rb', line 451

def add_extra_args(args)
  result = []

  s_extra = Gem::Command.specific_extra_args(@command)
  extra = Gem::Command.extra_args + s_extra

  until extra.empty? do
    ex = []
    ex << extra.shift
    ex << extra.shift if extra.first.to_s =~ /^[^-]/
    result << ex if handles?(ex)
  end

  result.flatten!
  result.concat(args)
  result
end

#add_option(*opts, &handler) ⇒ Object

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.

If the first argument of add_option is a Symbol, it's used to group options in output. See `gem help list` for an example.


357
358
359
360
361
# File 'lib/rubygems/command.rb', line 357

def add_option(*opts, &handler) # :yields: value, options
  group_name = Symbol === opts.first ? opts.shift : :options

  @option_groups[group_name] << [opts, handler]
end

#argumentsObject

Override to provide details of the arguments a command takes. It should return a left-justified string, one argument per line.

For example:

def usage
  "#{program_name} FILE [FILE ...]"
end

def arguments
  "FILE          name of file to find"
end

257
258
259
# File 'lib/rubygems/command.rb', line 257

def arguments
  ""
end

#begins?(long, short) ⇒ Boolean

True if long begins with the characters from short.

Returns:

  • (Boolean)

137
138
139
140
# File 'lib/rubygems/command.rb', line 137

def begins?(long, short)
  return false if short.nil?
  long[0, short.length] == short
end

#check_deprecated_options(options) ⇒ Object


394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
# File 'lib/rubygems/command.rb', line 394

def check_deprecated_options(options)
  options.each do |option|
    if option_is_deprecated?(option)
      deprecation = @deprecated_options[command][option]
      version_to_expire = deprecation["rg_version_to_expire"]

      deprecate_option_msg = if version_to_expire
                               "The \"#{option}\" option has been deprecated and will be removed in Rubygems #{version_to_expire}."
                             else
                               "The \"#{option}\" option has been deprecated and will be removed in future versions of Rubygems."
                             end

      extra_msg = deprecation["extra_msg"]

      deprecate_option_msg += " #{extra_msg}" if extra_msg

      alert_warning(deprecate_option_msg)
    end
  end
end

#defaults_strObject

Override to display the default values of the command options. (similar to arguments, but displays the default values).

For example:

def defaults_str
  --no-gems-first --no-all
end

271
272
273
# File 'lib/rubygems/command.rb', line 271

def defaults_str
  ""
end

#deprecate_option(name, version: nil, extra_msg: nil) ⇒ Object

Mark a command-line option as deprecated, and optionally specify a deprecation horizon.

Note that with the current implementation, every version of the option needs to be explicitly deprecated, so to deprecate an option defined as

add_option('-t', '--[no-]test', 'Set test mode') do |value, options|
  # ... stuff ...
end

you would need to explicitly add a call to `deprecate_option` for every version of the option you want to deprecate, like

deprecate_option('-t')
deprecate_option('--test')
deprecate_option('--no-test')

390
391
392
# File 'lib/rubygems/command.rb', line 390

def deprecate_option(name, version: nil, extra_msg: nil)
  @deprecated_options[command].merge!({ name => { "rg_version_to_expire" => version, "extra_msg" => extra_msg } })
end

#descriptionObject

Override to display a longer description of what this command does.


278
279
280
# File 'lib/rubygems/command.rb', line 278

def description
  nil
end

#executeObject

Override to provide command handling.

#options will be filled in with your parsed options, unparsed options will be left in options[:args].

See also: #get_all_gem_names, #get_one_gem_name, #get_one_optional_argument

Raises:


151
152
153
# File 'lib/rubygems/command.rb', line 151

def execute
  raise Gem::Exception, "generic command has no actions"
end

#get_all_gem_namesObject

Get all gem names from the command line.


188
189
190
191
192
193
194
195
196
197
# File 'lib/rubygems/command.rb', line 188

def get_all_gem_names
  args = options[:args]

  if args.nil? or args.empty?
    raise Gem::CommandLineError,
          "Please specify at least one gem name (e.g. gem build GEMNAME)"
  end

  args.select { |arg| arg !~ /^-/ }
end

#get_all_gem_names_and_versionsObject

Get all [gem, version] from the command line.

An argument in the form gem:ver is pull apart into the gen name and version, respectively.


204
205
206
207
208
209
210
211
212
# File 'lib/rubygems/command.rb', line 204

def get_all_gem_names_and_versions
  get_all_gem_names.map do |name|
    if /\A(.*):(#{Gem::Requirement::PATTERN_RAW})\z/ =~ name
      [$1, $2]
    else
      [name]
    end
  end
end

#get_one_gem_nameObject

Get a single gem name from the command line. Fail if there is no gem name or if there is more than one gem name given.


218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
# File 'lib/rubygems/command.rb', line 218

def get_one_gem_name
  args = options[:args]

  if args.nil? or args.empty?
    raise Gem::CommandLineError,
          "Please specify a gem name on the command line (e.g. gem build GEMNAME)"
  end

  if args.size > 1
    raise Gem::CommandLineError,
          "Too many gem names (#{args.join(', ')}); please specify only one"
  end

  args.first
end

#get_one_optional_argumentObject

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.


238
239
240
241
# File 'lib/rubygems/command.rb', line 238

def get_one_optional_argument
  args = options[:args] || []
  args.first
end

#handle_options(args) ⇒ Object

Handle the given list of arguments by parsing them and recording the results.


440
441
442
443
444
445
446
# File 'lib/rubygems/command.rb', line 440

def handle_options(args)
  args = add_extra_args(args)
  check_deprecated_options(args)
  @options = Marshal.load Marshal.dump @defaults # deep copy
  parser.parse!(args)
  @options[:args] = args
end

#handles?(args) ⇒ Boolean

True if the command handles the given argument list.

Returns:

  • (Boolean)

427
428
429
430
431
432
433
434
# File 'lib/rubygems/command.rb', line 427

def handles?(args)
  begin
    parser.parse!(args.dup)
    return true
  rescue
    return false
  end
end

#invoke(*args) ⇒ Object

Invoke the command with the given list of arguments.


302
303
304
# File 'lib/rubygems/command.rb', line 302

def invoke(*args)
  invoke_with_build_args args, nil
end

#invoke_with_build_args(args, build_args) ⇒ Object

Invoke the command with the given list of normal arguments and additional build arguments.


310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
# File 'lib/rubygems/command.rb', line 310

def invoke_with_build_args(args, build_args)
  handle_options args

  options[:build_args] = build_args

  if options[:silent]
    old_ui = self.ui
    self.ui = ui = Gem::SilentUI.new
  end

  if options[:help]
    show_help
  elsif @when_invoked
    @when_invoked.call options
  else
    execute
  end
ensure
  if ui
    self.ui = old_ui
    ui.close
  end
end

#merge_options(new_options) ⇒ Object

Merge a set of command options with the set of default options (without modifying the default option hash).


419
420
421
422
# File 'lib/rubygems/command.rb', line 419

def merge_options(new_options)
  @options = @defaults.clone
  new_options.each { |k,v| @options[k] = v }
end

#remove_option(name) ⇒ Object

Remove previously defined command-line argument name.


366
367
368
369
370
# File 'lib/rubygems/command.rb', line 366

def remove_option(name)
  @option_groups.each do |_, option_list|
    option_list.reject! { |args, _| args.any? { |x| x.is_a?(String) && x =~ /^#{name}/ } }
  end
end

#show_helpObject

Display the help message for the command.


294
295
296
297
# File 'lib/rubygems/command.rb', line 294

def show_help
  parser.program_name = usage
  say parser
end

#show_lookup_failure(gem_name, version, errors, suppress_suggestions = false, required_by = nil) ⇒ Object

Display to the user that a gem couldn't be found and reasons why –


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

def show_lookup_failure(gem_name, version, errors, suppress_suggestions = false, required_by = nil)
  gem = "'#{gem_name}' (#{version})"
  msg = String.new "Could not find a valid gem #{gem}"

  if errors and !errors.empty?
    msg << ", here is why:\n"
    errors.each { |x| msg << "          #{x.wordy}\n" }
  else
    if required_by and gem != required_by
      msg << " (required by #{required_by}) in any repository"
    else
      msg << " in any repository"
    end
  end

  alert_error msg

  unless suppress_suggestions
    suggestions = Gem::SpecFetcher.fetcher.suggest_gems_from_name gem_name

    unless suggestions.empty?
      alert_error "Possible alternatives: #{suggestions.join(", ")}"
    end
  end
end

#usageObject

Override to display the usage for an individual gem command.

The text “[options]” is automatically appended to the usage text.


287
288
289
# File 'lib/rubygems/command.rb', line 287

def usage
  program_name
end

#when_invoked(&block) ⇒ Object

Call the given block when invoked.

Normal command invocations just executes the execute method of the command. Specifying an invocation block allows the test methods to override the normal action of a command to determine that it has been invoked correctly.


342
343
344
# File 'lib/rubygems/command.rb', line 342

def when_invoked(&block)
  @when_invoked = block
end