123456789_123456789_123456789_123456789_123456789_

Class: Gem::Commands::SearchCommand

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::Gem::Command
Instance Chain:
self, ::Gem::QueryUtils, ::Gem::VersionOption, ::Gem::LocalRemoteOptions, ::Gem::Command, ::Gem::UserInteraction, ::Gem::DefaultUserInteraction, ::Gem::Text
Inherits: Gem::Command
Defined in: lib/rubygems/commands/search_command.rb

Constant Summary

::Gem::Command - Inherited

HELP

Class Attribute Summary

::Gem::Command - Inherited

.build_args

Arguments used when building gems.
.build_args=, .extra_args, .extra_args=

Class Method Summary

::Gem::Command - Inherited

.add_common_option,
.add_specific_extra_args

Add a list of extra arguments for the given command.
.common_options,
.new

Initializes a generic gem command named command.
.specific_extra_args

Return an array of extra arguments for the command.
.specific_extra_args_hash

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

Instance Attribute Summary

::Gem::QueryUtils - Included

#check_installed_gems?, #gem_name?, #show_prereleases?

::Gem::LocalRemoteOptions - Included

#both?

Is fetching of local and remote information enabled?
#local?

Is local fetching enabled?
#remote?

Is remote fetching enabled?

::Gem::Command - Inherited

#command

The name of the command.
#defaults

The default options for the command.
#deprecated?,
#options

The options for the command.
#program_name

The name of the command for command-line invocation.
#summary

A short description of the command.

::Gem::DefaultUserInteraction - Included

#ui

See DefaultUserInteraction.ui
#ui=

See DefaultUserInteraction.ui=

Instance Method Summary

::Gem::QueryUtils - Included

#add_query_options, #execute, #args, #check_installed_gems, #display_header, #entry_details, #entry_versions,
#installed?

Check if gem name version version is installed.
#make_entry, #output_query_results, #output_versions, #prerelease,
#show_gems

Guts of original execute.
#show_local_gems, #show_remote_gems, #spec_authors, #spec_homepage, #spec_license, #spec_loaded_from, #spec_platforms, #spec_summary, #specs_type, #defaults_str

::Gem::VersionOption - Included

#add_platform_option

Add the –platform option to the option parser.
#add_prerelease_option

Add the –prerelease option to the option parser.
#add_version_option

Add the –version option to the option parser.
#get_platform_from_requirements

Extract platform given on the command line.

::Gem::LocalRemoteOptions - Included

#accept_uri_http

Allows ::Gem::OptionParser to handle HTTP URIs.
#add_bulk_threshold_option

Add the –bulk-threshold option.
#add_clear_sources_option

Add the –clear-sources option.
#add_local_remote_options

Add local/remote options to the command line parser.
#add_proxy_option

Add the –http-proxy option.
#add_source_option

Add the –source option.
#add_update_sources_option

Add the –update-sources option.

::Gem::Command - Inherited

#add_extra_args

Adds extra args from ~/.gemrc.
#add_option

Add a command-line option and handler to the command.
#arguments

Override to provide details of the arguments a command takes.
#begins?

True if long begins with the characters from short.
#check_deprecated_options,
#defaults_str

Override to display the default values of the command options.
#deprecate_option

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

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

Override to provide command handling.
#get_all_gem_names

Get all gem names from the command line.
#get_all_gem_names_and_versions

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

Get a single gem name from the command line.
#get_one_optional_argument

Get a single optional argument from the command line.
#handle_options

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

True if the command handles the given argument list.
#invoke

Invoke the command with the given list of arguments.
#invoke_with_build_args

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

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

Remove previously defined command-line argument name.
#show_help

Display the help message for the command.
#show_lookup_failure

Display to the user that a gem couldn’t be found and reasons why –.
#usage

Override to display the usage for an individual gem command.
#when_invoked

Call the given block when invoked.
#add_parser_run_info

Adds a section with title and content to the parser help view.
#configure_options,
#create_option_parser

Creates an option parser and fills it in with the help info for the command.
#option_is_deprecated?,
#parser

Create on demand parser.
#wrap

Wraps text to width
#add_parser_description, #add_parser_options, #add_parser_summary

::Gem::UserInteraction - Included

#alert

Displays an alert statement.
#alert_error

Displays an error statement to the error output location.
#alert_warning

Displays a warning statement to the warning output location.
#ask

Asks a question and returns the answer.
#ask_for_password

Asks for a password with a prompt
#ask_yes_no

Asks a yes or no question.
#choose_from_list

Asks the user to answer question with an answer from the given list.
#say

Displays the given statement on the standard output (or equivalent).
#terminate_interaction

Terminates the RubyGems process with the given exit_code
#verbose

Calls say with msg or the results of the block if really_verbose is true.

::Gem::DefaultUserInteraction - Included

#use_ui

See DefaultUserInteraction.use_ui

::Gem::Text - Included

#clean_text

Remove any non-printable characters and make the text suitable for printing.
#format_text

Wraps text to wrap characters and optionally indents by indent characters.
#levenshtein_distance

This code is based directly on the ::Gem::Text gem implementation Returns a value representing the “cost” of transforming str1 into str2.
#truncate_text, #min3

Constructor Details

.new ⇒ SearchCommand

[ GitHub ] 

  


# File 'lib/rubygems/commands/search_command.rb', line 8



def initialize
  super 'search', 'Display remote gems whose name matches REGEXP',
       :name => //, :domain => :remote, :details => false, :versions => true,
       :installed => nil, :version => Gem::Requirement.default

  add_query_options
end


  







Instance Method Details



  

    #arguments  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/rubygems/commands/search_command.rb', line 16



def arguments # :nodoc:
  "REGEXP        regexp to search for in gem name"
end


  








  

    #defaults_str  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/rubygems/commands/search_command.rb', line 20



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


  








  

    #description  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/rubygems/commands/search_command.rb', line 24



def description # :nodoc:
  <<-EOF
The search command displays remote gems whose name matches the given
regexp.

The --details option displays additional details from the gem but will
take a little longer to complete as it must download the information
individually from the index.

To list local gems use the list command.
  EOF
end


  








  

    #usage  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/rubygems/commands/search_command.rb', line 37



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