Class: Gem::Commands::ListCommand

Inherits:
QueryCommand show all
Defined in:
lib/rubygems/commands/list_command.rb

Overview

An alternate to Gem::Commands::QueryCommand that searches for gems starting with the the supplied argument.

Instance Attribute Summary

Attributes inherited from Gem::Command

#command, #defaults, #options, #program_name, #summary

Instance Method Summary collapse

Methods inherited from QueryCommand

#execute

Methods included from VersionOption

#add_platform_option, #add_prerelease_option, #add_version_option

Methods included from LocalRemoteOptions

#accept_uri_http, #add_bulk_threshold_option, #add_clear_sources_option, #add_local_remote_options, #add_proxy_option, #add_source_option, #add_update_sources_option, #both?, #local?, #remote?

Methods included from Text

#format_text, #levenshtein_distance

Methods inherited from Gem::Command

add_common_option, #add_extra_args, #add_option, add_specific_extra_args, #begins?, build_args, build_args=, common_options, #execute, extra_args, extra_args=, #get_all_gem_names, #get_all_gem_names_and_versions, #get_one_gem_name, #get_one_optional_argument, #handle_options, #handles?, #invoke, #invoke_with_build_args, #merge_options, #remove_option, #show_help, #show_lookup_failure, specific_extra_args, specific_extra_args_hash, #when_invoked

Methods included from UserInteraction

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

Methods included from DefaultUserInteraction

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

Constructor Details

#initialize ⇒ ListCommand

Returns a new instance of ListCommand.



10
11
12
13
14
 
# File 'lib/rubygems/commands/list_command.rb', line 10

def initialize
  super 'list', 'Display local gems whose name starts with STRING'

  remove_option('--name-matches')
end

Instance Method Details

#arguments ⇒ Object

:nodoc:



16
17
18
 
# File 'lib/rubygems/commands/list_command.rb', line 16

def arguments # :nodoc:
  "STRING        start of gem name to look for"
end

#defaults_str ⇒ Object

:nodoc:



20
21
22
 
# File 'lib/rubygems/commands/list_command.rb', line 20

def defaults_str # :nodoc:
  "--local --no-details"
end

#description ⇒ Object

:nodoc:



24
25
26
27
28
29
30
31
32
33
 
# File 'lib/rubygems/commands/list_command.rb', line 24

def description # :nodoc:
  <<-EOF
The list command is used to view the gems you have installed locally.

The --details option displays additional details including the summary, the
homepage, the author, the locations of different versions of the gem.

To search for remote gems use the search command.
  EOF
end

#usage ⇒ Object

:nodoc:



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

def usage # :nodoc:
  "#{program_name} [STRING ...]"
end